SoLightKit Class Reference

The SoLightKit class provides a kit with a transform, a light and a shape or subgraph. More...

#include <Inventor/nodekits/SoLightKit.h>

Inheritance diagram for SoLightKit:

Public Member Functions
	SoLightKit (void)
virtual const SoNodekitCatalog *	getNodekitCatalog (void) const
virtual SoType	getTypeId (void) const
Public Member Functions inherited from SoBaseKit
	SoBaseKit (void)
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
virtual void	callback (SoCallbackAction *action)
virtual SoNodeKitPath *	createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
virtual void	doAction (SoAction *action)
SbBool	forceChildDrivenWriteRefs (SoOutput *out)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual SoChildList *	getChildren (void) const
virtual void	getMatrix (SoGetMatrixAction *action)
virtual SoNode *	getPart (const SbName &partname, SbBool makeifneeded)
SbString	getPartString (const SoBase *part)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
void	printDiagram (void)
void	printSubDiagram (const SbName &rootname, int level)
void	printTable (void)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
SbBool	set (const char *namevaluepairliststring)
SbBool	set (const char *partnamestring, const char *parameterstring)
virtual SbBool	setPart (const SbName &partname, SoNode *from)
virtual void	write (SoWriteAction *action)
Public Member Functions inherited from SoNode
virtual SbBool	affectsState (void) const
virtual void	audioRender (SoAudioRenderAction *action)
virtual SoNode *	copy (SbBool copyconnections=FALSE) const
virtual SoFieldContainer *	copyThroughConnection (void) const
SbUniqueId	getNodeId (void) const
NodeType	getNodeType (void) const
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	grabEventsCleanup (void)
virtual void	grabEventsSetup (void)
SbBool	isOverride (void) const
virtual void	notify (SoNotList *l)
virtual void	pick (SoPickAction *action)
void	setNodeType (const NodeType type)
void	setOverride (const SbBool state)
virtual void	startNotify (void)
virtual void	writeInstance (SoOutput *out)
Public Member Functions inherited from SoFieldContainer
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 const SoNodekitCatalog *	getClassNodekitCatalog (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
static SbBool	isSearchingChildren (void)
static void	setSearchingChildren (const SbBool newval)
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)

Protected Member Functions
virtual	~SoLightKit ()
virtual const SoFieldData *	getFieldData (void) const
Protected Member Functions inherited from SoBaseKit
virtual	~SoBaseKit ()
virtual SoNode *	addToCopyDict (void) const
void	catalogError (void)
virtual void	copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
void	countMyFields (SoOutput *out)
virtual void	createDefaultParts (void)
void	createFieldList (void)
void	createNodekitPartsList (void)
virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
virtual SoNode *	getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
const SbList< SoSFNode * > &	getCatalogInstances (void) const
SoGroup *	getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
const SoNodekitParts *	getNodekitPartsList (void) const
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
virtual SbBool	setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
virtual void	setDefaultOnNonWritingFields (void)
virtual SbBool	setPart (const int partNum, SoNode *node)
virtual SbBool	setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
Protected Member Functions inherited from SoNode
	SoNode (void)
virtual	~SoNode ()
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 SoNodekitCatalog **	getClassNodekitCatalogPtr (void)
static const SoFieldData **	getFieldDataPtr (void)
Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)
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)

Protected Attributes
SoSFNode	icon
SoSFNode	iconSeparator
SoSFNode	light
SoSFNode	transform
SoSFNode	transformGroup
Protected Attributes inherited from SoBaseKit
SoSFNode	callbackList
SoChildList *	children
SbBool	connectionsSetUp
Protected Attributes inherited from SoNode
SbUniqueId	uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

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 }
Static Protected Attributes inherited from SoNode
static int	nextActionMethodIndex = 0
static SbUniqueId	nextUniqueId = 1

Detailed Description

The SoLightKit class provides a kit with a transform, a light and a shape or subgraph.

Nodekit structure (new entries versus parent class marked with arrow prefix):

CLASS SoLightKit
-->"this"
      "callbackList"
-->   "transformGroup"
-->      "transform"
-->      "light"
-->      "iconSeparator"
-->         "icon"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoLightKit
PVT   "this",  SoLightKit  --- 
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
PVT   "transformGroup",  SoTransformSeparator  --- 
      "transform",  SoTransform  --- 
      "light",  SoLight  --- , (default type = SoDirectionalLight)
PVT   "iconSeparator",  SoSeparator  --- 
      "icon",  SoNode  --- , (default type = SoCube)

(See SoBaseKit::printTable() for information about the output formatting.)

Constructor & Destructor Documentation

SoLightKit()

SoLightKit::SoLightKit

(

void

)

Constructor.

~SoLightKit()

SoLightKit::~SoLightKit ( )

protectedvirtual

Destructor.

Member Function Documentation

getClassNodekitCatalog()

const SoNodekitCatalog * SoLightKit::getClassNodekitCatalog ( void )

static

Returns the nodekit catalog which defines the layout of this class' kit.

getClassNodekitCatalogPtr()

const SoNodekitCatalog ** SoLightKit::getClassNodekitCatalogPtr ( void )

staticprotected

Returns the pointer to the pointer of the nodekit catalog for this class.

getClassTypeId()

SoType SoLightKit::getClassTypeId ( void )

static

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

getFieldData()

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

getFieldDataPtr()

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

getNodekitCatalog()

const SoNodekitCatalog * SoLightKit::getNodekitCatalog ( void ) const

virtual

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

getTypeId()

SoType SoLightKit::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 SoBaseKit.

initClass()

void SoLightKit::initClass ( void )

static

---

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

• SoLightKit.h
• SoLightKit.cpp