Coin Logo http://www.sim.no
http://www.coin3d.org

SoSpotLightManip Class Reference
[Manipulators]

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

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 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

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 ~SoSpotLightManip ()
void setDragger (SoDragger *newdragger)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)

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


Detailed Description

The SoSpotLightManip class is used to manipulate spot light nodes.

.

spotlight.png

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   ) 

SoSpotLightManip::~SoSpotLightManip (  )  [protected]


Member Function Documentation

SoType SoSpotLightManip::getClassTypeId ( void   )  [static]

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

Reimplemented from SoSpotLight.

Referenced by copyContents(), and SoIntersectionDetectionAction::isTypeEnabled().

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
    }
    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 SoSpotLight.

const SoFieldData ** SoSpotLightManip::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 SoSpotLight.

const SoFieldData * SoSpotLightManip::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 SoSpotLight.

void SoSpotLightManip::initClass ( void   )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoSpotLight.

Referenced by SoInteraction::init().

SoDragger * SoSpotLightManip::getDragger ( void   ) 

Returns pointer to internal dragger.

References children, SoDragger::getClassTypeId(), SbPList::getLength(), SoBase::isOfType(), and SoDebugError::post().

Referenced by fieldSensorCB(), and setDragger().

SbBool SoSpotLightManip::replaceNode ( SoPath path  ) 

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.

References children, SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

Referenced by callback(), GLRender(), handleEvent(), pick(), and search().

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.

References doAction().

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.

References doAction().

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.

References children, SoGetBoundingBoxAction::getCenter(), SbPList::getLength(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().

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.

References children, SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

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.

References doAction().

void SoSpotLightManip::pick ( SoPickAction action  )  [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

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.

References doAction(), SoSearchAction::isFound(), and SoNode::search().

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.

References children.

void SoSpotLightManip::setDragger ( SoDragger newdragger  )  [protected]

void SoSpotLightManip::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
) [protected, virtual]

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

This is the protected 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
  MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                    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.

References SoNode::copyContents(), getClassTypeId(), SoBase::isOfType(), and setDragger().

void SoSpotLightManip::transferFieldValues ( const SoSpotLight from,
SoSpotLight to 
) [static, protected]

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.

References SoLight::color, SoSpotLight::cutOffAngle, SoSpotLight::direction, and SoSpotLight::location.

Referenced by replaceNode().

void SoSpotLightManip::valueChangedCB ( void *  m,
SoDragger dragger 
) [static, protected]

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.

References attachSensors(), SoSpotLight::cutOffAngle, SoSpotLight::direction, SoSpotLightDragger::getClassTypeId(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SbVec3f::getValue(), SoSFFloat::getValue(), SoSFVec3f::getValue(), SoBase::isOfType(), SoSpotLight::location, SbMatrix::multDirMatrix(), SbVec3f::normalize(), and SoDebugError::post().

Referenced by setDragger().

void SoSpotLightManip::fieldSensorCB ( void *  m,
SoSensor d 
) [static, protected]


Member Data Documentation

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

Referenced by SoSpotLightManip(), and ~SoSpotLightManip().

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

Referenced by SoSpotLightManip(), and ~SoSpotLightManip().

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

Referenced by SoSpotLightManip(), and ~SoSpotLightManip().

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

Referenced by SoSpotLightManip(), and ~SoSpotLightManip().

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

Referenced by doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoSpotLightManip(), and ~SoSpotLightManip().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:01 2009 for Coin by Doxygen. 1.5.8