.TH "SoSpotLightDragger" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoSpotLightDragger \- .PP The \fBSoSpotLightDragger\fP class provides interactive geometry for manipulating a spotlight\&. .PP Here's how the dragger looks with its default geometry in the inactive state: .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoDragger\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const " .br .RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP" .ti -1c .RI "virtual const \fBSoNodekitCatalog\fP * \fBgetNodekitCatalog\fP (void) const " .br .ti -1c .RI "\fBSoSpotLightDragger\fP (void)" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBSoSFRotation\fP \fBrotation\fP" .br .ti -1c .RI "\fBSoSFVec3f\fP \fBtranslation\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBangle\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const " .br .ti -1c .RI "virtual \fB~SoSpotLightDragger\fP (void)" .br .ti -1c .RI "virtual SbBool \fBsetUpConnections\fP (SbBool onoff, SbBool doitalways=FALSE)" .br .ti -1c .RI "virtual void \fBsetDefaultOnNonWritingFields\fP (void)" .br .ti -1c .RI "void \fBdragStart\fP (void)" .br .ti -1c .RI "void \fBdrag\fP (void)" .br .ti -1c .RI "void \fBdragFinish\fP (void)" .br .ti -1c .RI "void \fBsetBeamScaleFromAngle\fP (float beamangle)" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (void)" .br .ti -1c .RI "static void \fBstartCB\fP (void *f, \fBSoDragger\fP *d)" .br .ti -1c .RI "static void \fBmotionCB\fP (void *f, \fBSoDragger\fP *d)" .br .ti -1c .RI "static void \fBdoneCB\fP (void *f, \fBSoDragger\fP *d)" .br .ti -1c .RI "static void \fBfieldSensorCB\fP (void *f, \fBSoSensor\fP *s)" .br .ti -1c .RI "static void \fBvalueChangedCB\fP (void *f, \fBSoDragger\fP *d)" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBbeam\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBbeamActive\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBbeamPlacement\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBbeamScale\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBbeamSep\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBbeamSwitch\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBmaterial\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBrotator\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBtranslator\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBtranslatorRotInv\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBtranslatorSep\fP" .br .ti -1c .RI "\fBSoFieldSensor\fP * \fBrotFieldSensor\fP" .br .ti -1c .RI "\fBSoFieldSensor\fP * \fBtranslFieldSensor\fP" .br .ti -1c .RI "\fBSoFieldSensor\fP * \fBangleFieldSensor\fP" .br .ti -1c .RI "\fBSbPlaneProjector\fP * \fBplaneProj\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoSpotLightDragger\fP class provides interactive geometry for manipulating a spotlight\&. .PP Here's how the dragger looks with its default geometry in the inactive state: .PP This dragger is well suited for setting up the fields of a \fBSoSpotLight\fP node, as it provides geometry for the end-user to interact with a directional vector for the spotlight, to set up it's position and to control the cut-off angle for the 'lampshade' around the lightsource\&. .PP Note that there is one aspect of \fBSoSpotLight\fP nodes that can not be controlled with this dragger: the \fBSoSpotLight::dropOffRate\fP field\&. .PP The Coin library includes a manipulator class, \fBSoSpotLightManip\fP, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to \fBSoSpotLight\fP node instances in a scenegraph\&. .PP \fBSee also:\fP .RS 4 \fBSoSpotLightManip\fP, \fBSoSpotLight\fP .PP \fBSoDirectionalLightDragger\fP, \fBSoPointLightDragger\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoSpotLightDragger::SoSpotLightDragger (void)" Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry\&. .PP Node kit structure (new entries versus parent class marked with arrow prefix): .PP .PP .nf CLASS SoSpotLightDragger -->"this" "callbackList" "topSeparator" "motionMatrix" --> "material" --> "translatorSep" --> "translatorRotInv" --> "translator" --> "rotator" --> "beamSep" --> "beamPlacement" --> "beamScale" --> "beamSwitch" --> "beam" --> "beamActive" "geomSeparator" .fi .PP .PP (See \fBSoBaseKit::printDiagram()\fP for information about the output formatting\&.) .PP Detailed information on catalog parts: .PP .PP .nf 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 --- .fi .PP .PP (See \fBSoBaseKit::printTable()\fP for information about the output formatting\&.) .SS "SoSpotLightDragger::~SoSpotLightDragger (void)\fC [protected]\fP, \fC [virtual]\fP" Protected destructor\&. .PP (Dragger classes are derived from \fBSoBase\fP, so they are reference counted and automatically destroyed when their reference count goes to 0\&.) .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoSpotLightDragger::getTypeId (void) const\fC [virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. Usage example: .PP .PP .nf void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } } .fi .PP .PP For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP 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 \fBInventor/nodes/SoSubNode\&.h\fP (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine\&.h (for engine classes) and so on\&. .PP For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. .PP Reimplemented from \fBSoDragger\fP\&. .SS "const \fBSoFieldData\fP * SoSpotLightDragger::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. .PP Reimplemented from \fBSoDragger\fP\&. .SS "const \fBSoNodekitCatalog\fP * SoSpotLightDragger::getNodekitCatalog (void) const\fC [virtual]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .PP Reimplemented from \fBSoDragger\fP\&. .SS "SbBool SoSpotLightDragger::setUpConnections (SbBoolonoff, SbBooldoitalways = \fCFALSE\fP)\fC [protected]\fP, \fC [virtual]\fP" Sets up all internal connections for instances of this class\&. .PP (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 \fBSoBaseKit\fP class documentation\&.) .PP Reimplemented from \fBSoInteractionKit\fP\&. .SS "void SoSpotLightDragger::setDefaultOnNonWritingFields (void)\fC [protected]\fP, \fC [virtual]\fP" (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 \fIare\fP writing extensions, see the information in the \fBSoBaseKit\fP class documentation\&.) .PP This is a virtual method, and the code in it should call \fBSoField::setDefault()\fP with argument \fCTRUE\fP on part fields that should not be written upon scenegraph export operations\&. .PP This is typically done when: .PP .PD 0 .IP "1." 4 field value is \fCNULL\fP and part is \fCNULL\fP by default .PP .IP "2." 4 it is a leaf \fBSoGroup\fP or \fBSoSeparator\fP node with no children .PP .IP "3." 4 it is a leaf listpart with no children and an \fBSoGroup\fP or \fBSoSeparator\fP container .PP .IP "4." 4 it is a non-leaf part and it's of \fBSoGroup\fP type and all fields are at their default values .PP .PP .PP Subclasses should usually override this to do additional settings for new member fields\&. From the subclass, do remember to call 'upwards' to your superclass' \fBsetDefaultOnNonWritingFields()\fP method\&. .PP Reimplemented from \fBSoDragger\fP\&. .SS "void SoSpotLightDragger::startCB (void *f, \fBSoDragger\fP *d)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoSpotLightDragger::motionCB (void *f, \fBSoDragger\fP *d)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoSpotLightDragger::doneCB (void *f, \fBSoDragger\fP *d)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoSpotLightDragger::fieldSensorCB (void *d, \fBSoSensor\fP *s)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoSpotLightDragger::valueChangedCB (void *f, \fBSoDragger\fP *d)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "void SoSpotLightDragger::dragStart (void)\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP Called when dragger is selected (picked) by the user\&. .SS "void SoSpotLightDragger::drag (void)\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP Called when user drags the mouse after picking the dragger\&. .SS "void SoSpotLightDragger::dragFinish (void)\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP Called when mouse button is released after picking and interacting with the dragger\&. .SS "void SoSpotLightDragger::setBeamScaleFromAngle (floatbeamangle)\fC [protected]\fP" Scales the geometry representing the 'lampshade' around the lightsource to represent the given \fIbeamangle\fP\&. .SH "Member Data Documentation" .PP .SS "\fBSoSFRotation\fP 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 \fBSoSpotLight\fP node (unless using the \fBSoSpotLightManip\fP class, where this is taken care of automatically)\&. .PP 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 \fBSoSpotLight\fP node specifically\&. .SS "\fBSoSFVec3f\fP SoSpotLightDragger::translation" Continuously updated to contain the current translation from the dragger's local origo position\&. .SS "\fBSoSFFloat\fP SoSpotLightDragger::angle" The cut-off angle for the 'lampshade' around the lightsource\&. .PP Typically connected to a \fBSoSpotLight::cutOffAngle\fP field\&. .SS "\fBSoFieldSensor\fP * SoSpotLightDragger::rotFieldSensor\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "\fBSoFieldSensor\fP * SoSpotLightDragger::translFieldSensor\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "\fBSoFieldSensor\fP * SoSpotLightDragger::angleFieldSensor\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SS "\fBSbPlaneProjector\fP * SoSpotLightDragger::planeProj\fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.