Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SoSpotLightManip Class Reference

The SoSpotLightManip class is used to manipulate spot light nodes.

More...

#include <Inventor/manips/SoSpotLightManip.h>

Inheritance diagram for SoSpotLightManip:
SoSpotLight SoLight SoNode SoFieldContainer SoBase

Public Member Functions

virtual SoType getTypeId (void) const
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.
 SoSpotLightManip (void)
SoDraggergetDragger (void)
SbBool replaceNode (SoPath *p)
SbBool replaceManip (SoPath *p, SoSpotLight *newone) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void search (SoSearchAction *action)
virtual SoChildListgetChildren (void) const
- Public Member Functions inherited from SoSpotLight
 SoSpotLight (void)

Static Public Member Functions

static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoSpotLightManip (void)
void setDragger (SoDragger *newdragger)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
- Protected Member Functions inherited from SoSpotLight
virtual ~SoSpotLight ()
- Protected Member Functions inherited from SoLight
 SoLight (void)
virtual ~SoLight ()
- Protected Member Functions inherited from SoNode
 SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
virtual ~SoFieldContainer ()
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const
virtual SoNotRec createNotRec (void)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static void transferFieldValues (const SoSpotLight *from, SoSpotLight *to)
static void valueChangedCB (void *f, SoDragger *d)
static void fieldSensorCB (void *f, SoSensor *d)

Protected Attributes

SoFieldSensorlocationFieldSensor
SoFieldSensordirectionFieldSensor
SoFieldSensorangleFieldSensor
SoFieldSensorcolorFieldSensor
SoChildListchildren

Additional Inherited Members

- 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
}
- Public Attributes inherited from SoSpotLight
SoSFVec3f location
SoSFVec3f direction
SoSFFloat dropOffRate
SoSFFloat cutOffAngle
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
- Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

Detailed Description

The SoSpotLightManip class is used to manipulate spot light nodes.

A manipulator is used by replacing the node you want to edit in the graph with the manipulator. Draggers are used to to manipulate the node. When manipulation is finished, the node is put back into the graph, replacing the manipulator.

Constructor & Destructor Documentation

SoSpotLightManip::SoSpotLightManip ( void  )

The constructor sets up the internal SoSpotLightDragger used for manipulation.

SoSpotLightManip::~SoSpotLightManip ( void  )
protectedvirtual

Destructor.

Member Function Documentation

SoType SoSpotLightManip::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 SoSpotLight.

const SoFieldData ** SoSpotLightManip::getFieldDataPtr ( void  )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoSpotLight.

const SoFieldData * SoSpotLightManip::getFieldData ( void  ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoSpotLight.

SoDragger * SoSpotLightManip::getDragger ( void  )

Returns pointer to internal dragger.

SbBool SoSpotLightManip::replaceNode ( SoPath path)

Replaces the node specified by path with this manipulator. The manipulator will copy the field data from the node, to make it affect the state in the same way as the node.

SbBool SoSpotLightManip::replaceManip ( SoPath path,
SoSpotLight newone 
) const

Replaces this manipulator from the position specified by path with newnode. If newnode is NULL, an SoSpotLight will be created for you.

void SoSpotLightManip::doAction ( SoAction action)
virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

void SoSpotLightManip::callback ( SoCallbackAction action)
virtual

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoLight.

void SoSpotLightManip::GLRender ( SoGLRenderAction action)
virtual

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoSpotLight.

void SoSpotLightManip::getBoundingBox ( SoGetBoundingBoxAction action)
virtual

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

void SoSpotLightManip::getMatrix ( SoGetMatrixAction action)
virtual

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

void SoSpotLightManip::handleEvent ( SoHandleEventAction action)
virtual

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoNode.

void SoSpotLightManip::pick ( SoPickAction action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

void SoSpotLightManip::search ( SoSearchAction action)
virtual

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction – if any of the requested criteria is a miss, the search is not deemed successful for the node.

See Also
SoSearchAction

Reimplemented from SoNode.

SoChildList * SoSpotLightManip::getChildren ( void  ) const
virtual

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the children of this node. This node only has the dragger as a child.

Reimplemented from SoNode.

void SoSpotLightManip::setDragger ( SoDragger newdragger)
protected

Set dragger to use for user interaction.

void SoSpotLightManip::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
)
protectedvirtual

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
SbBool copyconnections)
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc etc)
SoNode::copyContents(from, copyconnections);
// [..then copy internal data..]
}

Reimplemented from SoNode.

void SoSpotLightManip::transferFieldValues ( const SoSpotLight from,
SoSpotLight to 
)
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Copies field values.

void SoSpotLightManip::valueChangedCB ( void *  m,
SoDragger dragger 
)
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Updates the fields when the motion matrix changes.

void SoSpotLightManip::fieldSensorCB ( void *  m,
SoSensor d 
)
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Updates the dragger whenever a field is modified.

Member Data Documentation

SoFieldSensor * SoSpotLightManip::locationFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

SoFieldSensor * SoSpotLightManip::directionFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

SoFieldSensor * SoSpotLightManip::angleFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

SoFieldSensor * SoSpotLightManip::colorFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

SoChildList * SoSpotLightManip::children
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.


The documentation for this class was generated from the following files:

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Sat Oct 12 2013 06:27:58 for Coin by Doxygen 1.8.1.2.