Linux Certif

Toute la documentation sur la certification Linux LPI

SoSpotLightDragger.3sim

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

virtual const SoNodekitCatalog * getNodekitCatalog (void) const

SoSpotLightDragger (void)

Static Public Member Functions

static SoType getClassTypeId (void)

static const SoNodekitCatalog * getClassNodekitCatalog (void)

static void initClass (void)

Public Attributes

SoSFRotation rotation

SoSFVec3f translation

SoSFFloat angle

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

~SoSpotLightDragger ()

virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)

virtual void setDefaultOnNonWritingFields (void)

void dragStart (void)

void drag (void)

void dragFinish (void)

void setBeamScaleFromAngle (float beamangle)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

static void startCB (void *f, SoDragger *d)

static void motionCB (void *f, SoDragger *d)

static void doneCB (void *f, SoDragger *d)

static void fieldSensorCB (void *f, SoSensor *s)

static void valueChangedCB (void *f, SoDragger *d)

Protected Attributes

SoSFNode beam

SoSFNode beamActive

SoSFNode beamPlacement

SoSFNode beamScale

SoSFNode beamSep

SoSFNode beamSwitch

SoSFNode material

SoSFNode rotator

SoSFNode translator

SoSFNode translatorRotInv

SoSFNode translatorSep

SoFieldSensor * rotFieldSensor

SoFieldSensor * translFieldSensor

SoFieldSensor * angleFieldSensor

SbPlaneProjector * planeProj

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:.

  

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 it's position and to control the cut-off angle for the 'lampshade' around the lightsource.

Note that there is one aspect of SoSpotLight nodes that can not 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 scenegraph.

See also:

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"
   .fi
 
 
 (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  --- 
   .fi
 
 
 (See SoBaseKit::printTable() for information about the output formatting.) 
 
 References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), angle, angleFieldSensor, doneCB(), fieldSensorCB(), motionCB(), planeProj, SoInteractionKit::readDefaultParts(), rotation, rotFieldSensor, setBeamScaleFromAngle(), SoField::setDefault(), SoInteractionKit::setPartAsDefault(), SoDelayQueueSensor::setPriority(), SoInteractionKit::setSwitchValue(), setUpConnections(), startCB(), translation, translFieldSensor, and valueChangedCB().
 

 

SoSpotLightDragger::~SoSpotLightDragger () [protected]

Protected destructor.

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

References angleFieldSensor, planeProj, rotFieldSensor, and translFieldSensor.

Member Function Documentation

SoType SoSpotLightDragger::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoDragger.

Referenced by SoSpotLightManip::fieldSensorCB(), and SoSpotLightManip::valueChangedCB().

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
     }
     else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
       SoGroup * group = (SoGroup *)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 (SbBool onoff, SbBool doitalways = 0) [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.

References angle, angleFieldSensor, SoFieldSensor::attach(), SoBaseKit::connectionsSetUp, SoFieldSensor::detach(), SoBaseKit::getAnyPart(), SoFieldSensor::getAttachedField(), SoDragger::registerChildDragger(), rotation, rotFieldSensor, SoInteractionKit::setPartAsDefault(), SoInteractionKit::setUpConnections(), translation, translFieldSensor, and SoDragger::unregisterChildDragger().

Referenced by SoSpotLightDragger().

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

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.

References angle, SoSFFloat::getValue(), SoField::isConnected(), SoField::isConnectionEnabled(), SoField::setDefault(), and SoDragger::setDefaultOnNonWritingFields().

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.

References dragStart().

Referenced by SoSpotLightDragger().

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.

References drag().

Referenced by SoSpotLightDragger().

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.

References dragFinish().

Referenced by SoSpotLightDragger().

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.

References angle, angleFieldSensor, SoDragger::getMotionMatrix(), SoSFFloat::getValue(), SoScale::scaleFactor, SoDragger::setMotionMatrix(), SoDragger::valueChanged(), and SoDragger::workFieldsIntoTransform().

Referenced by SoSpotLightDragger().

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.

References SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SoSFRotation::getValue(), SoSFVec3f::getValue(), SbRotation::inverse(), SoRotation::rotation, rotation, rotFieldSensor, translation, and translFieldSensor.

Referenced by SoSpotLightDragger().

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.

References SoDragger::getActiveChildDragger(), SoDragger::getLocalStartingPoint(), planeProj, SbPlaneProjector::setPlane(), and SoInteractionKit::setSwitchValue().

Referenced by startCB().

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.

References SbVec3f::dot(), SoDragger::getActiveChildDragger(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getViewVolume(), SbVec3f::length(), planeProj, SbPlaneProjector::project(), setBeamScaleFromAngle(), SbProjector::setViewVolume(), and SbProjector::setWorkingSpace().

Referenced by motionCB().

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.

References SoDragger::getActiveChildDragger(), and SoInteractionKit::setSwitchValue().

Referenced by doneCB().

void SoSpotLightDragger::setBeamScaleFromAngle (float beamangle) [protected]

Scales the geometry representing the 'lampshade' around the lightsource to represent the given beamangle.

References angle, and SoScale::scaleFactor.

Referenced by drag(), and SoSpotLightDragger().

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.

Referenced by setUpConnections(), SoSpotLightDragger(), and valueChangedCB().

SoSFVec3f SoSpotLightDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position.

Referenced by setUpConnections(), SoSpotLightDragger(), and valueChangedCB().

SoSFFloat SoSpotLightDragger::angle

The cut-off angle for the 'lampshade' around the lightsource.

Typically connected to a SoSpotLight::cutOffAngle field.

Referenced by SoSpotLightManip::fieldSensorCB(), fieldSensorCB(), setBeamScaleFromAngle(), setDefaultOnNonWritingFields(), setUpConnections(), and SoSpotLightDragger().

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.

Referenced by setUpConnections(), SoSpotLightDragger(), valueChangedCB(), and ~SoSpotLightDragger().

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.

Referenced by setUpConnections(), SoSpotLightDragger(), valueChangedCB(), and ~SoSpotLightDragger().

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.

Referenced by fieldSensorCB(), setUpConnections(), SoSpotLightDragger(), and ~SoSpotLightDragger().

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.

Referenced by drag(), dragStart(), SoSpotLightDragger(), and ~SoSpotLightDragger().

Author

Generated automatically by Doxygen for Coin from the source code.