SoShadowSpotLight Class Reference

The SoShadowSpotLight class is a node for setting up a spot light which casts shadows. More...

#include <Inventor/annex/FXViz/nodes/SoShadowSpotLight.h>

Inheritance diagram for SoShadowSpotLight:

Public Member Functions
	SoShadowSpotLight (void)
virtual SoType	getTypeId (void) const
virtual void	GLRender (SoGLRenderAction *action)
Public Member Functions inherited from SoSpotLight
	SoSpotLight (void)
Public Member Functions inherited from SoLight
virtual void	callback (SoCallbackAction *action)
Public Member Functions inherited from SoNode
virtual SoNode *	addToCopyDict (void) const
virtual SbBool	affectsState (void) const
virtual void	audioRender (SoAudioRenderAction *action)
virtual SoNode *	copy (SbBool copyconnections=FALSE) const
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer *	copyThroughConnection (void) const
virtual void	doAction (SoAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual SoChildList *	getChildren (void) const
virtual void	getMatrix (SoGetMatrixAction *action)
SbUniqueId	getNodeId (void) const
NodeType	getNodeType (void) const
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	grabEventsCleanup (void)
virtual void	grabEventsSetup (void)
virtual void	handleEvent (SoHandleEventAction *action)
SbBool	isOverride (void) const
virtual void	notify (SoNotList *l)
virtual void	pick (SoPickAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
void	setNodeType (const NodeType type)
void	setOverride (const SbBool state)
virtual void	startNotify (void)
virtual void	write (SoWriteAction *action)
virtual void	writeInstance (SoOutput *out)
Public Member Functions inherited from SoFieldContainer
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
SbBool	enableNotify (const SbBool flag)
SbBool	fieldsAreEqual (const SoFieldContainer *container) const
void	get (SbString &fielddata)
void	get (SbString &fielddata, SoOutput *out)
virtual int	getAllFields (SoFieldList &l) const
virtual SoField *	getEventIn (const SbName &name) const
virtual SoField *	getEventOut (const SbName &name) const
virtual SoField *	getField (const SbName &name) const
SbBool	getFieldName (const SoField *const field, SbName &name) const
virtual int	getFields (SoFieldList &l) const
virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
SbBool	getIsBuiltIn (void) const
void *	getUserData (void) const
SbBool	hasDefaultValues (void) const
SbBool	isNotifyEnabled (void) const
SbBool	set (const char *const fielddata)
SbBool	set (const char *fielddata, SoInput *input)
void	setToDefaults (void)
void	setUserData (void *userdata) const
virtual SbBool	validateNewFieldValue (SoField *field, void *newval)
Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)
void	assertAlive (void) const
const SoAuditorList &	getAuditors (void) const
virtual SbName	getName (void) const
int32_t	getRefCount (void) const
SbBool	isOfType (SoType type) const
	Returns TRUE if the type of this object is either of the same type or inherited from type.
void	ref (void) const
void	removeAuditor (void *const auditor, const SoNotRec::Type type)
virtual void	setName (const SbName &newname)
SbBool	shouldWrite (void)
void	touch (void)
void	unref (void) const
void	unrefNoDelete (void) const

Static Public Member Functions
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoSpotLight
static SoType	getClassTypeId (void)
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.
Static Public Member Functions inherited from SoLight
static SoType	getClassTypeId (void)
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.
Static Public Member Functions inherited from SoNode
static void	audioRenderS (SoAction *action, SoNode *node)
static void	callbackS (SoAction *action, SoNode *node)
static int	getActionMethodIndex (const SoType type)
static void	getBoundingBoxS (SoAction *action, SoNode *node)
static SoNode *	getByName (const SbName &name)
static int	getByName (const SbName &name, SoNodeList &l)
static SoType	getClassTypeId (void)
static uint32_t	getCompatibilityTypes (const SoType &nodetype)
static void	getMatrixS (SoAction *action, SoNode *node)
static SbUniqueId	getNextNodeId (void)
static void	getPrimitiveCountS (SoAction *action, SoNode *node)
static void	GLRenderS (SoAction *action, SoNode *node)
static void	handleEventS (SoAction *action, SoNode *node)
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.
static void	initClasses (void)
static void	pickS (SoAction *action, SoNode *node)
static void	rayPickS (SoAction *action, SoNode *node)
static void	searchS (SoAction *action, SoNode *node)
static void	writeS (SoAction *action, SoNode *node)
Static Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
static void	cleanupClass (void)
static void	copyDone (void)
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
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.
static void	initCopyDict (void)
Static Public Member Functions inherited from SoBase
static void	addName (SoBase *const base, const char *const name)
static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static void	decrementCurrentWriteCounter (void)
static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.
static SoBase *	getNamedBase (const SbName &name, SoType type)
static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool	getTraceRefs (void)
static void	incrementCurrentWriteCounter (void)
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.
static SbBool	read (SoInput *input, SoBase *&base, SoType expectedtype)
static SbBool	readRoute (SoInput *input)
static void	removeName (SoBase *const base, const char *const name)
static void	setInstancePrefix (const SbString &c)
static void	setTraceRefs (SbBool trace)

Public Attributes
SoSFFloat	farDistance
SoSFFloat	nearDistance
SoSFNode	shadowMapScene
Public Attributes inherited from SoSpotLight
SoSFFloat	cutOffAngle
SoSFVec3f	direction
SoSFFloat	dropOffRate
SoSFVec3f	location
Public Attributes inherited from SoLight
SoSFColor	color
SoSFFloat	intensity
SoSFBool	on

Protected Member Functions
virtual	~SoShadowSpotLight ()
virtual const SoFieldData *	getFieldData (void) const
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 SoNotRec	createNotRec (void)
virtual void	destroy (void)
virtual const char *	getFileFormatName (void) const
SbBool	hasMultipleWriteRefs (void) const
void	writeFooter (SoOutput *out) const
SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Static Protected Member Functions
static const SoFieldData **	getFieldDataPtr (void)
Static Protected Member Functions inherited from SoSpotLight
static const SoFieldData **	getFieldDataPtr (void)
Static Protected Member Functions inherited from SoLight
static const SoFieldData **	getFieldDataPtr (void)
Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)
static int	getNextActionMethodIndex (void)
static void	incNextActionMethodIndex (void)
static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
static void	setNextActionMethodIndex (int index)
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)
static void	staticDataLock (void)
static void	staticDataUnlock (void)

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 }
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
Protected Attributes inherited from SoNode
SbUniqueId	uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn
Static Protected Attributes inherited from SoNode
static int	nextActionMethodIndex = 0
static SbUniqueId	nextUniqueId = 1

Detailed Description

The SoShadowSpotLight class is a node for setting up a spot light which casts shadows.

This node can be used instead of a normal spot light if you need to improve the performance by supplying a simplified scene graph to be used when rendering the shadow map(s). For instance, the shadow map scene graph doesn't need any textures or materials, and any non-casters can also be excluded from this scene graph. It's more optimal to use this node than to use the SoShadowStyle node to control this, at the cost of some extra application complexity.

It's especially useful if you have a scene with few shadow caster nodes and lots of shadow receiver nodes.

Currently, this node must be placed somewhere in the SoShadowGroup subgraph to cast shadows.

FILE FORMAT/DEFAULTS:

ShadowSpotLight {
  shadowMapScene NULL
  nearDistance -1
  farDistance -1
}

Here is the example from SoShadowGroup, modified to use SoShadowSpotLight instead of a normal SoSpotLight. Notice that only the sphere casts shadows.

DirectionalLight { direction 0 0 -1 intensity 0.2 }
 
ShadowGroup {
  quality 1 # to get per pixel lighting
 
  ShadowSpotLight {
    location -8 -8 8.0
    direction 1 1 -1
    cutOffAngle 0.35
    dropOffRate 0.7
 
    shadowMapScene
    DEF sphere Separator {
        Complexity { value 1.0 }
        Material { diffuseColor 1 1 0 specularColor 1 1 1 shininess 0.9 }
        Shuttle { translation0 -3 1 0 translation1 3 -5 0 speed 0.25 on TRUE }
        Translation { translation -5 0 2 }
        Sphere { radius 2.0 }
      }
  }
  # need to insert the sphere in the regular scene graph as well
  USE sphere
 
  Separator {
    Material { diffuseColor 1 0 0 specularColor 1 1 1 shininess 0.9 }
    Shuttle { translation0 0 -5 0 translation1 0 5 0 speed 0.15 on TRUE }
    Translation { translation 0 0 -3 }
    Cube { depth 1.8 }
  }
  Separator {
    Material { diffuseColor 0 1 0 specularColor 1 1 1 shininess 0.9 }
    Shuttle { translation0 -5 0 0 translation1 5 0 0 speed 0.3 on TRUE }
    Translation { translation 0 0 -3 }
    Cube { }
  }
 
  Coordinate3 { point [ -10 -10 -3, 10 -10 -3, 10 10 -3, -10 10 -3 ] }
  Material { specularColor 1 1 1 shininess 0.9 }
 
  Complexity { textureQuality 0.1 }
  Texture2 { image 2 2 3 0xffffff 0x225588 0x225588 0xffffff }
  Texture2Transform { scaleFactor 4 4 }
  FaceSet { numVertices 4 }
}

Since

Coin 3.0

Constructor & Destructor Documentation

SoShadowSpotLight()

SoShadowSpotLight::SoShadowSpotLight

(

void

)

Constructor.

~SoShadowSpotLight()

SoShadowSpotLight::~SoShadowSpotLight ( )

protectedvirtual

Destructor.

Member Function Documentation

getClassTypeId()

SoType SoShadowSpotLight::getClassTypeId ( void )

static

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

getFieldData()

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

getFieldDataPtr()

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

Returns the SoFieldData class which holds information about fields in this node.

getTypeId()

SoType SoShadowSpotLight::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoSpotLight.

GLRender()

void SoShadowSpotLight::GLRender ( SoGLRenderAction * action )

virtual

Action method for the SoGLRenderAction.

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

Reimplemented from SoSpotLight.

initClass()

void SoShadowSpotLight::initClass ( void )

static

Member Data Documentation

farDistance

SoSFFloat SoShadowSpotLight::farDistance

Can be used to set a fixed far distance for this spot light. The value in this field will be used if it is set to > 0.0. Default value is -1.0.

nearDistance

SoSFFloat SoShadowSpotLight::nearDistance

Can be used to set a fixed near distance for this spot light. The value in this field will be used if it is set to > 0.0. Default value is -1.0.

shadowMapScene

SoSFNode SoShadowSpotLight::shadowMapScene

The shadow map scene graph. If this is NULL (the default), the node will behave as a normal SoSpotLight node.

---

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

• SoShadowSpotLight.h
• SoShadowSpotLight.cpp