The SoVRMLAppearance class specifies visual properties for shapes. More...

#include <Inventor/VRMLnodes/SoVRMLAppearance.h>

Inheritance diagram for SoVRMLAppearance:

Public Member Functions
	SoVRMLAppearance (void)

virtual void	callback (SoCallbackAction *action)

virtual void	copyContents (const SoFieldContainer *from, SbBool copyConn)

virtual void	doAction (SoAction *action)

virtual SoChildList *	getChildren (void) const

virtual SoType	getTypeId (void) const

virtual void	GLRender (SoGLRenderAction *action)

virtual void	notify (SoNotList *list)

virtual void	search (SoSearchAction *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 SoFieldContainer *	copyThroughConnection (void) const

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

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	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *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 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
SoSFNode	material

SoSFNode	texture

SoSFNode	textureTransform

Protected Member Functions
virtual	~SoVRMLAppearance ()

virtual const SoFieldData *	getFieldData (void) const

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 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 SoVRMLAppearance class specifies visual properties for shapes.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

Appearance {
  exposedField SFNode material          NULL
  exposedField SFNode texture           NULL
  exposedField SFNode textureTransform  NULL
}

The Appearance node specifies the visual properties of geometry. The value for each of the fields in this node may be NULL. However, if the field is non-NULL, it shall contain one node of the appropriate type. The material field, if specified, shall contain a VRMLMaterial node. If the material field is NULL or unspecified, lighting is off (all lights are ignored during rendering of the object that references this Appearance) and the unlit object color is (1, 1, 1). Details of the VRML lighting model are in 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14).

The texture field, if specified, shall contain one of the various types of texture nodes (VRMLImageTexture, VRMLMovieTexture, or VRMLPixelTexture). If the texture node is NULL or the texture field is unspecified, the object that references this Appearance is not textured. The textureTransform field, if specified, shall contain a VRMLTextureTransform node. If the textureTransform is NULL or unspecified, the textureTransform field has no effect.

Constructor & Destructor Documentation

◆ SoVRMLAppearance()

SoVRMLAppearance::SoVRMLAppearance ( void )

Constructor.

◆ ~SoVRMLAppearance()

SoVRMLAppearance::~SoVRMLAppearance ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ callback()

void SoVRMLAppearance::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 SoNode.

◆ copyContents()

void SoVRMLAppearance::copyContents	(	const SoFieldContainer *	from,
		SbBool	copyconnections )

virtual

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

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need 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();

SbList

The SbList class is a template container class for lists.

Definition SbList.h:70

SbList::copy

void copy(const SbList< Type > &l)

Definition SbList.h:92

SoNode

The SoNode class is the base class for nodes used in scene graphs.

Definition SoNode.h:56

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 its 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.)
  SoNode::copyContents(from, copyconnections);
 
  // [..then copy internal data..]
}

Reimplemented from SoNode.

◆ doAction()

void SoVRMLAppearance::doAction ( SoAction * action )

virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

◆ getChildren()

SoChildList * SoVRMLAppearance::getChildren ( void ) const

virtual

Returns list of children for this node.

Reimplemented from SoNode.

◆ getClassTypeId()

SoType SoVRMLAppearance::getClassTypeId ( void )

static

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

◆ getFieldData()

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

◆ getFieldDataPtr()

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

Implements SoBase.

◆ GLRender()

void SoVRMLAppearance::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 SoNode.

◆ initClass()

void SoVRMLAppearance::initClass ( void )

static

◆ notify()

void SoVRMLAppearance::notify ( SoNotList * l )

virtual

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

◆ search()

void SoVRMLAppearance::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.

Member Data Documentation

◆ material

SoSFNode SoVRMLAppearance::material

Can contain an SoVRMLMaterial node. Is NULL by default.

◆ texture

SoSFNode SoVRMLAppearance::texture

Can contain a texture node. Is NULL by default.

◆ textureTransform

SoSFNode SoVRMLAppearance::textureTransform

Can contain an SoVRMLTextureTransform node. Is NULL by default.

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

SoVRMLAppearance.h
Appearance.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoVRMLAppearance()

◆ ~SoVRMLAppearance()

Member Function Documentation

◆ callback()

◆ copyContents()

◆ doAction()

◆ getChildren()

◆ getClassTypeId()

◆ getFieldData()

◆ getFieldDataPtr()

◆ getTypeId()

◆ GLRender()

◆ initClass()

◆ notify()

◆ search()

Member Data Documentation

◆ material

◆ texture

◆ textureTransform