 |
Coin
4.0.3
Coin3D core library
|
|
Coin
4.0.3
Coin3D core library
|
The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. More...
#include <Inventor/draggers/SoSpotLightDragger.h>
Public Attributes | |
| SoSFFloat | angle |
| SoSFRotation | rotation |
| SoSFVec3f | translation |
 Public Attributes inherited from SoDragger | |
| SoSFBool | isActive |
| Public Attributes inherited from SoInteractionKit | |
| SoSFEnum | boundingBoxCaching |
| SoSFEnum | pickCulling |
| SoSFEnum | renderCaching |
| SoSFEnum | renderCulling |
Protected Attributes | |
| SoFieldSensor * | angleFieldSensor |
| SoSFNode | beam |
| SoSFNode | beamActive |
| SoSFNode | beamPlacement |
| SoSFNode | beamScale |
| SoSFNode | beamSep |
| SoSFNode | beamSwitch |
| SoSFNode | material |
| SbPlaneProjector * | planeProj |
| SoSFNode | rotator |
| SoFieldSensor * | rotFieldSensor |
| SoSFNode | translator |
| SoSFNode | translatorRotInv |
| SoSFNode | translatorSep |
| SoFieldSensor * | translFieldSensor |
| Protected Attributes inherited from SoDragger | |
| SoSFNode | motionMatrix |
| Protected Attributes inherited from SoInteractionKit | |
| SoFieldSensor * | fieldSensor |
| SoSFNode | geomSeparator |
| SoSeparator * | oldTopSep |
| SoSFNode | topSeparator |
| Protected Attributes inherited from SoBaseKit | |
| SoSFNode | callbackList |
| SoChildList * | children |
| SbBool | connectionsSetUp |
| Protected Attributes inherited from SoNode | |
| SbUniqueId | uniqueId |
| Protected Attributes inherited from SoFieldContainer | |
| SbBool | isBuiltIn |
Additional Inherited Members | |
| Public Types inherited from SoDragger | |
| enum | ProjectorFrontSetting { FRONT , BACK , USE_PICK } |
| Public Types inherited from SoInteractionKit | |
| enum | CacheEnabled { OFF , ON , AUTO } |
| Public Types inherited from SoNode | |
| enum | NodeType { INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 , INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 , COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 , COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 , COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000 } |
| Protected Types inherited from SoBase | |
| enum | BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 } |
| Static Protected Attributes inherited from SoNode | |
| static int | nextActionMethodIndex = 0 |
| static SbUniqueId | nextUniqueId = 1 |
The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight.
Here's how the dragger looks with its default geometry in the inactive state:
This dragger is well suited for setting up the fields of a SoSpotLight node, as it provides geometry for the end-user to interact with a directional vector for the spotlight, to set up its position and to control the cut-off angle for the "lampshade" around the light source.
Note that there is one aspect of SoSpotLight nodes that cannot be controlled with this dragger: the SoSpotLight::dropOffRate field.
The Coin library includes a manipulator class, SoSpotLightManip, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to SoSpotLight node instances in a scene graph.
| SoSpotLightDragger::SoSpotLightDragger | ( | void | ) |
Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.
Nodekit structure (new entries versus parent class marked with arrow prefix):
CLASS SoSpotLightDragger
-->"this"
"callbackList"
"topSeparator"
"motionMatrix"
--> "material"
--> "translatorSep"
--> "translatorRotInv"
--> "translator"
--> "rotator"
--> "beamSep"
--> "beamPlacement"
--> "beamScale"
--> "beamSwitch"
--> "beam"
--> "beamActive"
"geomSeparator"
(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
CLASS SoSpotLightDragger
PVT "this", SoSpotLightDragger ---
"callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT "topSeparator", SoSeparator ---
PVT "motionMatrix", SoMatrixTransform ---
"material", SoMaterial ---
PVT "translatorSep", SoSeparator ---
PVT "translatorRotInv", SoRotation ---
"translator", SoDragPointDragger ---
"rotator", SoRotateSphericalDragger ---
PVT "beamSep", SoSeparator ---
"beamPlacement", SoTranslation ---
"beamScale", SoScale ---
PVT "beamSwitch", SoSwitch ---
"beam", SoSeparator ---
"beamActive", SoSeparator ---
PVT "geomSeparator", SoSeparator ---
(See SoBaseKit::printTable() for information about the output formatting.)
|
protectedvirtual |
Protected destructor.
(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called when user drags the mouse after picking the dragger.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called when mouse button is released after picking and interacting with the dragger.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called when dragger is selected (picked) by the user.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
static |
Returns the nodekit catalog which defines the layout of this class' kit.
|
staticprotected |
Returns the pointer to the pointer of the nodekit catalog for this class.
This static method returns the SoType object associated with objects of this class.
|
protectedvirtual |
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.
Reimplemented from SoDragger.
|
staticprotected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Returns the SoFieldData class which holds information about fields in this node.
|
virtual |
Returns the nodekit catalog which defines the layout of this class' kit.
Reimplemented from SoDragger.
Initializes type system for this dragger class.
Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
protected |
Scales the geometry representing the "lampshade" around the light source to represent the given beamangle.
(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)
This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scene graph export operations.
This is typically done when:
field value is NULL and part is NULL by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
it is a non-leaf part and it is of SoGroup type and all fields are at their default values
Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.
Reimplemented from SoDragger.
|
protectedvirtual |
Sets up all internal connections for instances of this class.
(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)
Reimplemented from SoInteractionKit.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
| SoSFFloat SoSpotLightDragger::angle |
The cut-off angle for the "lampshade" around the light source.
Typically connected to a SoSpotLight::cutOffAngle field.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
| SoSFRotation SoSpotLightDragger::rotation |
This field is continuously updated to contain the rotation of the current direction vector. The application programmer will typically connect this to the rotation field of a SoSpotLight node (unless using the SoSpotLightManip class, where this is taken care of automatically).
It may also of course be connected to any other rotation field controlling the direction of scene graph geometry, it does not have to part of a SoSpotLight node specifically.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
| SoSFVec3f SoSpotLightDragger::translation |
Continuously updated to contain the current translation from the dragger's local origo position.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
1.10.0