|
Open Inventor Release 2024.1.1
|
|
| |
|
Open Inventor Release 2024.1.1
|
|
|
| |
Base class to draw a scene graph in screen space.
More...
#include <Inventor/drawers/SoScreenDrawer.h>
Inheritance diagram for SoScreenDrawer:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoScreenDrawer () | |
| Constructor. | |
| virtual void | reset () |
| Resets internal state to initial values. | |
| 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 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 | |
| SoSFNode | sceneGraph |
| Scene graph to render. | |
Base class to draw a scene graph in screen space.
This node displays the scene graph specified by the sceneGraph field in screen space normalized in the range ([-1, 1]x[-1, 1]x[-1, 1]) relative to the current viewport.
The specified scene graph is automatically rendered using an SoAnnotation node, an SoPickStyle node with style = UNPICKABLE, and an SoOrthographicCamera node.
Classes derived from SoScreenDrawer are normally used to implement dynamically drawing a 2D shape, for example a rectangle, in response to mouse events. Applications will typically use one of these derived classes, for example, SoEllipseScreenDrawer, SoRectangleScreenDrawer, SoPolygonScreenDrawer or SoLassoScreenDrawer.
Please see SoPolyLineScreenDrawer for important notes about these classes and a code example.
Applications may also implement their own custom screen drawer classes. The convenient onMouseDown(), onMouseMove(), ... methods can be implemented by sub-classes to customize behaviors for specific events, but the application can also reimplement the handleEvent() method to handle any event.
There should only be one SoScreenDrawer derived node in the sceneGraph (to avoid conflicts in mouse events).
NOTE: This node and its subclasses use screen coordinates ranging from -1 to 1. (Because this is the default view volume for an SoOrthographicCamera node.) Be careful because other classes in Open Inventor use normalized screen coordinates ranging from 0 to 1. In particular the SbViewportRegion normalize() method and the SbViewVolume methods that project from 3D to 2D and vice-versa.
[C++]
Screen drawer classes must be initialized by calling SoInteraction::init(). High level viewer init methods, like SoWin::init(), automatically do this. However, if the application is calling SoDB::init() directly, then it is usually necessary to also call SoInteraction::init() before using the screen drawer classes.
SoEllipseScreenDrawer SoLassoScreenDrawer SoPolygonScreenDrawer SoPolyLineScreenDrawer SoRectangleScreenDrawer
Definition at line 84 of file SoScreenDrawer.h.
| SoScreenDrawer::SoScreenDrawer | ( | ) |
Constructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoNode.
Reimplemented in SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolygonScreenDrawer, SoPolyLineScreenDrawer, and SoRectangleScreenDrawer.
|
virtual |
Resets internal state to initial values.
This cancels any current drawing.
Since Open Inventor 10.7.3
Reimplemented in SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolyLineScreenDrawer, and SoRectangleScreenDrawer.
| SoSFNode SoScreenDrawer::sceneGraph |
Scene graph to render.
Definition at line 91 of file SoScreenDrawer.h.
1.9.8 