Interactively draw a polyline in normalized screen space. More...
#include <Inventor/drawers/SoPolyLineScreenDrawer.h>
Classes | |
struct | EventArg |
Structure given to callback when an event is raised. More... | |
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
SoPolyLineScreenDrawer () | |
Constructor. | |
virtual void | clear () |
Convenience method to clear the points in the line. | |
virtual void | reset () |
Clears the points in the line and resets internal state to initial values. | |
Public Member Functions inherited from SoScreenDrawer | |
SoScreenDrawer () | |
Constructor. | |
Public Member Functions inherited from SoNode | |
virtual void | setOverride (const SbBool state) |
Turns the override flag on or off. | |
virtual SbBool | isOverride () const |
Returns the state of the override flag. | |
virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
Creates and returns an exact copy of the node. | |
virtual SbBool | affectsState () const |
Returns TRUE if a node has an effect on the state during traversal. | |
virtual void | touch () |
Marks an instance as modified, simulating a change to it. | |
Public Member Functions inherited from SoFieldContainer | |
void | setToDefaults () |
Sets all fields in this object to their default values. | |
SbBool | hasDefaultValues () const |
Returns TRUE if all of the object's fields have their default values. | |
SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
SoNONUNICODE SbBool | set (const char *fieldDataString) |
Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
SbBool | set (const SbString &fieldDataString) |
Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
void | get (SbString &fieldDataString) |
Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
virtual int | getFields (SoFieldList &list) const |
Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
virtual int | getAllFields (SoFieldList &list) const |
Returns a list of fields, including the eventIn's and eventOut's. | |
virtual SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (const SbName &fieldName) const |
Returns the eventOut with the given name. | |
SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
SbBool | enableNotify (SbBool flag) |
Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
SbBool | isNotifyEnabled () const |
Notification is the process of telling interested objects that this object has changed. | |
virtual void | setUserData (void *data) |
Sets application data. | |
void * | getUserData (void) const |
Gets user application data. | |
Public Member Functions inherited from SoBase | |
virtual SbName | getName () const |
Returns the name of an instance. | |
virtual void | setName (const SbName &name) |
Sets the name of an instance. | |
void | setSynchronizable (const bool b) |
Sets this to be a ScaleViz synchronizable object. | |
bool | isSynchronizable () const |
Gets the ScaleViz synchronizable state of this object. | |
Public Member Functions inherited from SoRefCounter | |
void | ref () const |
Adds a reference to an instance. | |
void | unref () const |
Removes a reference from an instance. | |
void | unrefNoDelete () const |
unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
int | getRefCount () const |
Returns current reference count. | |
void | lock () const |
lock this instance. | |
void | unlock () const |
unlock this instance. | |
Public Member Functions inherited from SoTypedObject | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoScreenDrawer | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoNode | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SoNode * | getByName (const SbName &name) |
A node's name can be set using SoBase::setName(). | |
static int | getByName (const SbName &name, SoNodeList &list) |
A node's name can be set using SoBase::setName(). | |
Static Public Member Functions inherited from SoFieldContainer | |
static SoType | getClassTypeId () |
Returns the type of this class. | |
Static Public Member Functions inherited from SoBase | |
static SoType | getClassTypeId () |
Returns type identifier for this class. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Public Attributes | |
SoSFUInt32 | simplificationThreshold |
Threshold (in pixels) used to simplify line when it is finished. | |
SoSFBool | doCCW |
Make the line counter-clockwise when it is finalized. | |
SoSFColor | color |
Color of line. | |
SoMFVec2f | point |
Points of line. | |
SoSFBool | isClosed |
Close the line during display (connect last point to first point). | |
SoSFUShort | linePattern |
Stipple pattern. | |
SoSFInt32 | linePatternScaleFactor |
Stipple pattern scale factor. | |
SoSFFloat | lineWidth |
Width of lines. | |
SbEventHandler< const EventArg & > | onStart |
Event raised when starting to draw a polyline. | |
SbEventHandler< const EventArg & > | onMove |
Event raised during polyline drawing. | |
SbEventHandler< EventArg & > | onFinish |
Event raised when the line is finished. | |
Public Attributes inherited from SoScreenDrawer | |
SoSFNode | sceneGraph |
Scene graph to render. | |
Interactively draw a polyline in normalized screen space.
This class is a base class used to allow the user to dynamically draw line-based shapes (lasso, circle, rectangle, ...) on screen. The geometry is defined in normalized screen space ([-1, 1]x[-1, 1]).
Applications will typically use one of the derived classes, for example, SoEllipseScreenDrawer, SoRectangleScreenDrawer, SoPolygonScreenDrawer or SoLassoScreenDrawer.
The line color is specified by the color field (default is red).
SoPolyLineScreenDrawer classes can automatically reduce the number of points in the shape drawn by the user. This is especially useful with SoLassoScreenDrawer. See the simplificationThreshold field.
Sub-classes can implement the onMouseDown, onMouseMove, etc... methods, to add and edit points.
Notes:
A finish callback that gets the number of points created by the screen drawer:
SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolygonScreenDrawer, SoRectangleScreenDrawer, SoScreenDrawer
Definition at line 213 of file SoPolyLineScreenDrawer.h.
SoPolyLineScreenDrawer::SoPolyLineScreenDrawer | ( | ) |
Constructor.
|
inlinevirtual |
Convenience method to clear the points in the line.
Reimplemented in SoPolygonScreenDrawer.
Definition at line 337 of file SoPolyLineScreenDrawer.h.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoScreenDrawer.
Reimplemented in SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolygonScreenDrawer, and SoRectangleScreenDrawer.
|
virtual |
Clears the points in the line and resets internal state to initial values.
This cancels any current drawing.
Since Open Inventor 10.7.3
Reimplemented from SoScreenDrawer.
Reimplemented in SoEllipseScreenDrawer, SoLassoScreenDrawer, and SoRectangleScreenDrawer.
SoSFColor SoPolyLineScreenDrawer::color |
SoSFBool SoPolyLineScreenDrawer::doCCW |
Make the line counter-clockwise when it is finalized.
This can change order of points. Default is TRUE.
NOTE: field available since Open Inventor 9.0
Definition at line 235 of file SoPolyLineScreenDrawer.h.
SoSFBool SoPolyLineScreenDrawer::isClosed |
Close the line during display (connect last point to first point).
Default is FALSE (but most sub-classes automatically set it to TRUE).
Definition at line 248 of file SoPolyLineScreenDrawer.h.
SoSFUShort SoPolyLineScreenDrawer::linePattern |
Stipple pattern.
This specifies how dashed or dotted lines will be drawn. The pattern is a 16-bit series of 0s and 1s and is repeated as necessary to stipple a given line. A 1 indicates that drawing occurs, and a 0 that it does not, on a pixel-by-pixel basis, starting with the low-order bits of the pattern. Values can range from 0 (invisible) to 0xffff (solid). Default is 0xffff.
The line pattern can be stretched using the linePatternScaleFactor field.
Definition at line 261 of file SoPolyLineScreenDrawer.h.
SoSFInt32 SoPolyLineScreenDrawer::linePatternScaleFactor |
Stipple pattern scale factor.
It stretches the line pattern (see linePattern) by multiplying each subseries of consecutive 1s and 0s. Scale factors are clamped to lie between 1 and 255. Default is 1.
Definition at line 268 of file SoPolyLineScreenDrawer.h.
SoSFFloat SoPolyLineScreenDrawer::lineWidth |
Width of lines.
The default line width is 0, meaning to use the default OpenGL value (1). Line widths greater than zero are considered to be specified in printer's points, where 1 inch = 72 printer's points. However the default pixels-per-inch value (managed by SbViewportRegion) is also 72. So effectively line width is specified in pixels unless the application sets a different pixels-per-inch value.
Definition at line 278 of file SoPolyLineScreenDrawer.h.
SbEventHandler<EventArg&> SoPolyLineScreenDrawer::onFinish |
Event raised when the line is finished.
See SbEventHandler for methods to set a callback to be notified when this event is raised. The callback will be called with a line drawer specific EventArg from which you can query the current action and drawer objects. Note that the callback parameter in this case is not const.
Definition at line 334 of file SoPolyLineScreenDrawer.h.
SbEventHandler<const EventArg&> SoPolyLineScreenDrawer::onMove |
Event raised during polyline drawing.
See SbEventHandler for methods to set a callback to be notified when this event is raised. The callback will be called with an EventArg from which it can query the current action and drawer objects. Note that the callback parameter must be declared const .
Definition at line 325 of file SoPolyLineScreenDrawer.h.
SbEventHandler<const EventArg&> SoPolyLineScreenDrawer::onStart |
Event raised when starting to draw a polyline.
See SbEventHandler for methods to set a callback to be notified when this event is raised. The callback will be called with an EventArg from which it can query the current action and drawer objects.
Note that the callback parameter must be declared const .
Definition at line 316 of file SoPolyLineScreenDrawer.h.
SoMFVec2f SoPolyLineScreenDrawer::point |
SoSFUInt32 SoPolyLineScreenDrawer::simplificationThreshold |
Threshold (in pixels) used to simplify line when it is finished.
A value of 0 means no simplification. Default value is 5 pixels.
Definition at line 225 of file SoPolyLineScreenDrawer.h.