SoAppearanceKit Class Reference

Appearance nodekit class. More...

#include <Inventor/nodekits/SoAppearanceKit.h>

Inheritance diagram for SoAppearanceKit:

Public Member Functions
	SoAppearanceKit ()
	Constructor.
Public Member Functions inherited from SoBaseKit
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance of SoBaseKit.
	SoBaseKit ()
	Constructor.
virtual SoNode *	getPart (const SbName &partName, bool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
virtual SoNodeKitPath *	createPathToPart (const SbName &partName, bool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.
virtual bool	setPart (const SbName &partName, SoNode *from)
	Inserts the given node (not a copy) as the new part specified by partName.
bool	set (char *nameValuePairListString)
	SETTING FIELDS OF PARTS.
bool	set (char *partNameString, char *parameterString)
virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.
virtual void	callback (SoCallbackAction *action)
	These functions implement all actions for nodekits.
virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
virtual void	write (SoWriteAction *action)
virtual SoChildList *	getChildren () const
	Returns pointer to children.
void	printDiagram ()
void	printSubDiagram (const SbName &rootName, int level)
void	printTable ()
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Overrides the default method to use countMyFields() instead of the regular SoFieldData writing mechanism.
bool	forceChildDrivenWriteRefs (SoOutput *out)
	This returns TRUE if the nodekit intends to write out.
Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off.
bool	isOverride () const
	Returns the state of the override flag.
SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual bool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	pick (SoPickAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).
virtual void	grabEventsCleanup ()
virtual void	startNotify ()
	Initiates notification from an instance.
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
SbNodeIdType	getNodeId () const
	Returns the unique id for a node.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.)
virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.
bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
bool	set (const char *fieldDataString, SoInput *dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.
virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.
void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.
Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.
void	unref () const
void	unrefNoDelete () const
void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.
void	removeAuditor (void *auditor, SoNotRec::Type type)
const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
int	getRefCount () const
	Returns current reference count.
bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.

Static Public Member Functions
static void	initClass ()
Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.
static bool	isSearchingChildren ()
	Sets and queries if nodekit children are searched during SoSearchAction traversal.
static void	setSearchingChildren (bool newVal)
	Sets and queries if nodekit children are searched during SoSearchAction traversal.
static void	initClass ()
static SoNode *	typeCheck (const SbName &partName, const SoType &partType, SoNode *node)
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class.
static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name.
static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to list pointers to those nodes.
static void	initClass ()
	Initializes base node class.
static void	initClasses ()
	Initialize ALL Inventor node classes.
static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id.
static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
static void	initClass ()
	Setup type information.
static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
	Adds an instance to the dictionary.
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.
static void	copyDone ()
	Cleans up the dictionary when done.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
	Setup type information.
static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.
static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.
static void	addName (SoBase *, const char *)
	Internal methods used to maintain the global name dictionary.
static void	removeName (SoBase *, const char *)
static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.
static int	getNamedBases (const SbName &, SoBaseList &, SoType)
static bool	read (SoInput *in, SoBase *&base, SoType expectedType)
	Reads one instance of some subclass of SoBase.
static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.

Protected Member Functions
virtual	~SoAppearanceKit ()
Protected Member Functions inherited from SoBaseKit
	SO_KIT_CATALOG_ENTRY_HEADER (callbackList)
	Define fields for the new parts of the kit...
virtual SoNode *	addToCopyDict () const
	Redefines this to add this node and all part nodes to the dictionary.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given nodekit into this instance.
SoGroup *	getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE)
	Returns the containerNode within the SoNodeKitListPart given by listName.
virtual SoNode *	getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
	like their public versions, but are allowed access to non-leaf and private parts.
virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)
virtual bool	setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)
void	createNodekitPartsList ()
	called during construction to create parts list
virtual void	createDefaultParts ()
	called during construction to create any parts that are created by default (such as the cube in the SoCubeKit)
const SoNodekitParts *	getNodekitPartsList () const
	Return the node's partsList.
void	catalogError ()
	Prints an Error when there's trouble building a catalog.
virtual bool	setUpConnections (bool onOff, bool doItAlways=FALSE)
	detach/attach any sensors, callbacks, and/or field connections.
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads in from file. Takes care of setting parts and stuff.
virtual void	setDefaultOnNonWritingFields ()
	This is called during countMyFields() method.
void	countMyFields (SoOutput *out)
	This is called during addWriteReference() to write the fields.
virtual	~SoBaseKit ()
Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.
virtual	~SoNode ()
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()
	~SoFieldContainer ()
Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.
virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.
virtual void	destroy ()
	Actually deletes an instance.
bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.
bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)

Additional Inherited Members
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...
Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr ()
	...end of contents of SO_KIT_HEADER
Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.
Protected Attributes inherited from SoBaseKit
SoChildList *	children
SoNodekitParts *	nodekitPartsList
	parts list.
bool	connectionsSetUp
Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.
Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass?
Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.
static int	nextActionMethodIndex
	Next index into the action method table.

Detailed Description

The SoAppearanceKit is used to create a group of property nodes that will be used to affect subsequent shape nodes or nodekits in the scene graph.

This nodekit defines seven new parts: lightModel, environment, drawStyle, material, complexity, texture2, and font. Note that it does not include binding nodes such as SoMaterialBinding.

SoAppearanceKit is derived from SoBaseKit and thus also includes a callbackList part for adding callback nodes.

NOTE Note that SoSeparatorKit includes an SoAppearanceKit as a part.

Parts

lightModel
An SoLightModel node that affects any shapes that follow this nodekit in the scene graph. This part is NULL by default.

environment
An SoEnvironment node that affects any nodes that follow this nodekit in the scene graph. This part is NULL by default.

drawStyle
An SoDrawStyle node that affects any shapes that follow this nodekit in the scene graph. This part is NULL by default.

material
An SoMaterial node that affects any shapes that follow this nodekit in the scene graph. This part is NULL by default.

complexity
An SoComplexity node that affects any shapes that follow this nodekit in the scene graph. This part is NULL by default.

texture2
An SoTexture2 node that affects any shapes that follow this nodekit in the scene graph. This part is NULL by default.

font
An SoFont node that affects any text nodes that follow this nodekit in the scene graph. This part is NULL by default.

See Also

SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit

Definition at line 115 of file SoAppearanceKit.h.

Constructor & Destructor Documentation

SoAppearanceKit()

SoAppearanceKit::SoAppearanceKit

(

)

References SoINTERNAL.

~SoAppearanceKit()

virtual SoAppearanceKit::~SoAppearanceKit ( )

protectedvirtual

Member Function Documentation

initClass()

static void SoAppearanceKit::initClass ( )

static

---

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

• C:/jh/mevislab/4.1.3_0/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodekits/SoAppearanceKit.h