Linux Certif

Toute la documentation sur la certification Linux LPI

SoSpotLightManip.3coin2

NAME

SoSpotLightManip -

The SoSpotLightManip class is used to manipulate spot light nodes.

SYNOPSIS

#include <Inventor/manips/SoSpotLightManip.h>

Inherits SoSpotLight.

Public Member Functions

SoSpotLightManip (void)

SoDragger * getDragger (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 SoChildList * getChildren (void) const

Static Public Member Functions

static void initClass (void)

Protected Member Functions

~SoSpotLightManip ()

void setDragger (SoDragger *newdragger)

virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)

Static Protected Member Functions

static void transferFieldValues (const SoSpotLight *from, SoSpotLight *to)

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

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

Protected Attributes

SoFieldSensor * locationFieldSensor

SoFieldSensor * directionFieldSensor

SoFieldSensor * angleFieldSensor

SoFieldSensor * colorFieldSensor

SoChildList * children

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.

References angleFieldSensor, children, colorFieldSensor, directionFieldSensor, fieldSensorCB(), locationFieldSensor, setDragger(), and SoDelayQueueSensor::setPriority().

SoSpotLightManip::~SoSpotLightManip () [protected]Destructor.

References angleFieldSensor, children, colorFieldSensor, directionFieldSensor, locationFieldSensor, and setDragger().

Member Function Documentation

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, SoNode::getClassTypeId(), SbPList::getLength(), SoBase::isOfType(), and SoDebugError::post().

Referenced by fieldSensorCB(), and setDragger().

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.

References fieldSensorCB(), SoNode::getClassTypeId(), SoFullPath::getLength(), SoFullPath::getNodeFromTail(), SoBaseKit::getPart(), SoBaseKit::getPartString(), SoPath::getTail(), SoFullPath::getTail(), SoBase::isOfType(), SoDebugError::post(), SoBase::ref(), SoBaseKit::setPart(), transferFieldValues(), and SoBase::unrefNoDelete().

SbBool SoSpotLightManip::replaceManip (SoPath * path, SoSpotLight * newone) constReplaces 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]Set dragger to use for user interaction.

References SoDragger::addValueChangedCallback(), SoChildList::append(), children, fieldSensorCB(), getDragger(), SbPList::getLength(), SoChildList::remove(), SoDragger::removeValueChangedCallback(), SoChildList::set(), and valueChangedCB().

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

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 SoSpotLight::cutOffAngle, SoSpotLight::direction, SoNode::getClassTypeId(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SbVec3f::getValue(), SoBase::isOfType(), SoSpotLight::location, SbMatrix::multDirMatrix(), SbVec3f::normalize(), and SoDebugError::post().

Referenced by setDragger().

void SoSpotLightManip::fieldSensorCB (void * m, SoSensor * 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.

Updates the dragger whenever a field is modified.

References SoSpotLightDragger::angle, SoLight::color, SoSpotLight::cutOffAngle, SoMaterial::diffuseColor, SoSpotLight::direction, SoMaterial::emissiveColor, SoNode::getClassTypeId(), getDragger(), SoDragger::getMotionMatrix(), SoMField::getNum(), SoBaseKit::getPart(), SbMatrix::getTransform(), SoBase::isOfType(), SoSpotLight::location, SoDragger::setMotionMatrix(), SoInteractionKit::setPart(), SbMatrix::setTransform(), and SbRotation::setValue().

Referenced by replaceNode(), setDragger(), and SoSpotLightManip().

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.

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

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.

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

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.

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

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.

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

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.

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

Author

Generated automatically by Doxygen for Coin from the source code.