other versions
- wheezy-backports 3.1.4~abc9f50-3~bpo70+1
- jessie 3.1.4~abc9f50-7
SoSpotLightDragger(3) | Coin | SoSpotLightDragger(3) |
NAME¶
SoSpotLightDragger - The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. Here's how the dragger looks with its default geometry in the inactive state:SYNOPSIS¶
#include <Inventor/draggers/SoSpotLightDragger.h> Inherits SoDragger.Public Member Functions¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static SoType getClassTypeId (void)
Public Attributes¶
SoSFRotation rotation
Protected Member Functions¶
virtual const SoFieldData * getFieldData (void) const
Static Protected Member Functions¶
static const SoFieldData ** getFieldDataPtr (void)
Protected Attributes¶
SoSFNode beam
Additional Inherited Members¶
Detailed Description¶
The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. Here's how the dragger looks with its default geometry in the inactive state:SoSpotLightManip, SoSpotLight
SoDirectionalLightDragger, SoPointLightDragger
Constructor & Destructor Documentation¶
SoSpotLightDragger::SoSpotLightDragger (void)¶
Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry. Node kit 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.)
SoSpotLightDragger::~SoSpotLightDragger (void) [protected], [virtual]¶
Protected destructor. (Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)Member Function Documentation¶
SoType SoSpotLightDragger::getTypeId (void) const [virtual]¶
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. Usage example:void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } }For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Reimplemented from SoDragger.
const SoFieldData ** SoSpotLightDragger::getFieldDataPtr (void) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Reimplemented from SoDragger.const SoFieldData * SoSpotLightDragger::getFieldData (void) const [protected], [virtual]¶
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from SoDragger.const SoNodekitCatalog * SoSpotLightDragger::getClassNodekitCatalog (void) [static]¶
Returns the nodekit catalog which defines the layout of this class' kit. Reimplemented from SoDragger.const SoNodekitCatalog * SoSpotLightDragger::getNodekitCatalog (void) const [virtual]¶
Returns the nodekit catalog which defines the layout of this class' kit. Reimplemented from SoDragger.const SoNodekitCatalog ** SoSpotLightDragger::getClassNodekitCatalogPtr (void) [static], [protected]¶
Returns the pointer to the pointer of the nodekit catalog for this class. Reimplemented from SoDragger.void SoSpotLightDragger::initClass (void) [static]¶
Initializes type system for this dragger class. Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init(). Reimplemented from SoDragger.SbBool SoSpotLightDragger::setUpConnections (SbBoolonoff, SbBooldoitalways = FALSE) [protected], [virtual]¶
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.void SoSpotLightDragger::setDefaultOnNonWritingFields (void) [protected], [virtual]¶
(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 scenegraph export operations. This is typically done when:- 1.
- field value is NULL and part is NULL by default
- 2.
- it is a leaf SoGroup or SoSeparator node with no children
- 3.
- it is a leaf listpart with no children and an SoGroup or SoSeparator container
- 4.
- it is a non-leaf part and it's of SoGroup type and all fields are at their default values
void SoSpotLightDragger::startCB (void *f, SoDragger *d) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.void SoSpotLightDragger::motionCB (void *f, SoDragger *d) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.void SoSpotLightDragger::doneCB (void *f, SoDragger *d) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.void SoSpotLightDragger::fieldSensorCB (void *d, SoSensor *s) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Reimplemented from SoInteractionKit.void SoSpotLightDragger::valueChangedCB (void *f, SoDragger *d) [static], [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.void SoSpotLightDragger::dragStart (void) [protected]¶
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.void SoSpotLightDragger::drag (void) [protected]¶
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.void SoSpotLightDragger::dragFinish (void) [protected]¶
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.void SoSpotLightDragger::setBeamScaleFromAngle (floatbeamangle) [protected]¶
Scales the geometry representing the 'lampshade' around the lightsource to represent the given beamangle.Member Data Documentation¶
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 scenegraph geometry, it does not have to part of a SoSpotLight node specifically.SoSFVec3f SoSpotLightDragger::translation¶
Continuously updated to contain the current translation from the dragger's local origo position.SoSFFloat SoSpotLightDragger::angle¶
The cut-off angle for the 'lampshade' around the lightsource. Typically connected to a SoSpotLight::cutOffAngle field.SoFieldSensor * SoSpotLightDragger::rotFieldSensor [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.SoFieldSensor * SoSpotLightDragger::translFieldSensor [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.SoFieldSensor * SoSpotLightDragger::angleFieldSensor [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.SbPlaneProjector * SoSpotLightDragger::planeProj [protected]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.Author¶
Generated automatically by Doxygen for Coin from the source code.Sat Oct 12 2013 | Version 4.0.0a |