SGAPPEARANCE Class Reference

Defines the generic material appearance of a scenegraph object. More...

#include <sg_appearance.h>

Inheritance diagram for SGAPPEARANCE:

Public Member Functions
void	unlinkChildNode (const SGNODE *aNode) noexcept override
	Remove references to an owned child. More...
void	unlinkRefNode (const SGNODE *aNode) noexcept override
	Remove pointers to a referenced node. More...
	SGAPPEARANCE (SGNODE *aParent)
virtual	~SGAPPEARANCE ()
virtual bool	SetParent (SGNODE *aParent, bool notify=true) override
	Set the parent SGNODE of this object. More...
bool	SetEmissive (float aRVal, float aGVal, float aBVal)
bool	SetEmissive (const SGCOLOR *aRGBColor)
bool	SetEmissive (const SGCOLOR &aRGBColor)
bool	SetDiffuse (float aRVal, float aGVal, float aBVal)
bool	SetDiffuse (const SGCOLOR *aRGBColor)
bool	SetDiffuse (const SGCOLOR &aRGBColor)
bool	SetSpecular (float aRVal, float aGVal, float aBVal)
bool	SetSpecular (const SGCOLOR *aRGBColor)
bool	SetSpecular (const SGCOLOR &aRGBColor)
bool	SetAmbient (float aRVal, float aGVal, float aBVal)
bool	SetAmbient (const SGCOLOR *aRGBColor)
bool	SetAmbient (const SGCOLOR &aRGBColor)
SGNODE *	FindNode (const char *aNodeName, const SGNODE *aCaller) noexcept override
	Search the tree of linked nodes and return a reference to the first node found with the given name. More...
bool	AddRefNode (SGNODE *aNode) noexcept override
bool	AddChildNode (SGNODE *aNode) noexcept override
void	ReNameNodes (void) override
	Rename a node and all its child nodes in preparation for write operations. More...
bool	WriteVRML (std::ostream &aFile, bool aReuseFlag) override
	Writes this node's data to a VRML file. More...
bool	WriteCache (std::ostream &aFile, SGNODE *parentNode) override
	Write this node's data to a binary cache file. More...
bool	ReadCache (std::istream &aFile, SGNODE *parentNode) override
	Reads binary format data from a cache file. More...
S3D::SGTYPES	GetNodeType (void) const noexcept
	Return the type of this node instance. More...
SGNODE *	GetParent (void) const noexcept
	Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie. More...
bool	SwapParent (SGNODE *aNewParent)
	Swap the ownership with the given parent. More...
const char *	GetName (void)
void	SetName (const char *aName)
const char *	GetNodeTypeName (S3D::SGTYPES aNodeType) const noexcept
void	AssociateWrapper (SGNODE **aWrapperRef) noexcept
	Associate this object with a handle to itself. More...
void	DisassociateWrapper (SGNODE **aWrapperRef) noexcept
	Remove the association between an IFSG* wrapper object and this object. More...
void	ResetNodeIndex (void) noexcept
	Reset the global SG* node indices in preparation for write operations. More...
void	addNodeRef (SGNODE *aNode)
	Add a pointer to a node which references this node, but does not own. More...
void	delNodeRef (const SGNODE *aNode)
	Remove a pointer to a node which references this node, but does not own. More...
bool	isWritten (void) noexcept
	Return true if the object had already been written to a cache file or VRML file. More...

Public Attributes
float	shininess
float	transparency
SGCOLOR	ambient
SGCOLOR	diffuse
SGCOLOR	emissive
SGCOLOR	specular

Protected Attributes
std::list< SGNODE * >	m_BackPointers
	nodes which hold a reference to this. More...
SGNODE *	m_Parent
	Pointer to parent node; may be NULL for top level transform. More...
S3D::SGTYPES	m_SGtype
	Type of Scene Graph node. More...
std::string	m_Name
	name to use for referencing the entity by name. More...
bool	m_written
	Set to true when the object has been written after a ReNameNodes(). More...

Private Attributes
SGNODE **	m_Association
	Handle to the instance held by a wrapper. More...

Detailed Description

Defines the generic material appearance of a scenegraph object.

Definition at line 37 of file sg_appearance.h.

Constructor & Destructor Documentation

SGAPPEARANCE()

SGAPPEARANCE::SGAPPEARANCE

(

SGNODE *

aParent

)

Definition at line 34 of file sg_appearance.cpp.

 : SGNODE( aParent )
{
 m_SGtype = S3D::SGTYPE_APPEARANCE;
 
 // defaults in accord with VRML2.0 spec
 ambient.SetColor( 0.05317f, 0.17879f, 0.01804f );
 shininess = 0.2f;
 transparency = 0.0f;
 diffuse.SetColor( 0.8f, 0.8f, 0.8f );
 
 if( nullptr != aParent && S3D::SGTYPE_SHAPE != aParent->GetNodeType() )
 {
 m_Parent = nullptr;
 
 wxLogTrace( MASK_3D_SG,
 wxT( "%s:%s:%d * [BUG] inappropriate parent to SGAPPEARANCE (type %s )" ),
 __FILE__, __FUNCTION__, __LINE__, aParent->GetNodeType() );
 }
 else if( nullptr != aParent && S3D::SGTYPE_SHAPE == aParent->GetNodeType() )
 {
 m_Parent->AddChildNode( this );
 }
}

References SGNODE::AddChildNode(), ambient, diffuse, SGNODE::GetNodeType(), SGNODE::m_Parent, SGNODE::m_SGtype, SGCOLOR::SetColor(), S3D::SGTYPE_APPEARANCE, S3D::SGTYPE_SHAPE, shininess, and transparency.

~SGAPPEARANCE()

SGAPPEARANCE::~SGAPPEARANCE ( )

virtual

Definition at line 59 of file sg_appearance.cpp.

{
}

Member Function Documentation

AddChildNode()

bool SGAPPEARANCE::AddChildNode ( SGNODE *  aNode )

overridevirtualnoexcept

Implements SGNODE.

Definition at line 208 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "this node does not accept children or refs" ) );
 
 // This is redundant but it keeps gcc from generating a warning on debug builds.
 return false;
}

addNodeRef()

void SGNODE::addNodeRef ( SGNODE *  aNode )

inherited

Add a pointer to a node which references this node, but does not own.

Such back-pointers are required to ensure that invalidated references are removed when a node is deleted.

Parameters

aNode

is the node holding a reference to this object.

Definition at line 170 of file sg_node.cpp.

{
 if( nullptr == aNode )
 return;
 
 std::list< SGNODE* >::iterator np =
 std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
 
 if( np != m_BackPointers.end() )
 return;
 
 m_BackPointers.push_back( aNode );
}

References SGNODE::m_BackPointers.

Referenced by SGFACESET::addNode(), SGSHAPE::addNode(), SGFACESET::ReadCache(), and SGSHAPE::ReadCache().

AddRefNode()

bool SGAPPEARANCE::AddRefNode ( SGNODE *  aNode )

overridevirtualnoexcept

Implements SGNODE.

Definition at line 199 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "this node does not accept children or refs" ) );
 
 // This is redundant but it keeps gcc from generating a warning on debug builds.
 return false;
}

AssociateWrapper()

void SGNODE::AssociateWrapper ( SGNODE **  aWrapperRef )

noexceptinherited

Associate this object with a handle to itself.

The handle is typically held by an IFSG* wrapper and the pointer which it refers to is set to NULL upon destruction of this object. This mechanism provides a scheme by which a wrapper can be notified of the destruction of the object which it wraps.

Definition at line 207 of file sg_node.cpp.

{
 wxCHECK( aWrapperRef && *aWrapperRef == this, /* void */ );
 
 // if there is an existing association then break it and emit a warning
 // just in case the behavior is undesired
 if( m_Association )
 {
 *m_Association = nullptr;
 
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [WARNING] association being broken with "
 "previous wrapper" ),
 __FILE__, __FUNCTION__, __LINE__ );
 }
 
 m_Association = aWrapperRef;
}

Referenced by S3D::AssociateSGNodeWrapper(), IFSG_APPEARANCE::Attach(), IFSG_COLORS::Attach(), IFSG_COORDINDEX::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_NORMALS::Attach(), IFSG_SHAPE::Attach(), IFSG_TRANSFORM::Attach(), IFSG_APPEARANCE::IFSG_APPEARANCE(), IFSG_COLORS::IFSG_COLORS(), IFSG_COORDINDEX::IFSG_COORDINDEX(), IFSG_COORDS::IFSG_COORDS(), IFSG_FACESET::IFSG_FACESET(), IFSG_NORMALS::IFSG_NORMALS(), IFSG_SHAPE::IFSG_SHAPE(), IFSG_TRANSFORM::IFSG_TRANSFORM(), IFSG_APPEARANCE::NewNode(), IFSG_COLORS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), and IFSG_TRANSFORM::NewNode().

delNodeRef()

void SGNODE::delNodeRef ( const SGNODE *  aNode )

inherited

Remove a pointer to a node which references this node, but does not own.

Parameters

aNode

is the node holding a reference to this object.

Definition at line 185 of file sg_node.cpp.

{
 if( nullptr == aNode )
 return;
 
 std::list< SGNODE* >::iterator np =
 std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
 
 if( np != m_BackPointers.end() )
 {
 m_BackPointers.erase( np );
 return;
 }
 
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] delNodeRef() did not find its target, this "
 "node type %d, referenced node type %d" ),
 __FILE__, __FUNCTION__, __LINE__,
 m_SGtype,
 aNode->GetNodeType() );
}

References SGNODE::GetNodeType(), SGNODE::m_BackPointers, and SGNODE::m_SGtype.

Referenced by SGFACESET::unlinkNode(), SGSHAPE::unlinkNode(), SGFACESET::~SGFACESET(), and SGSHAPE::~SGSHAPE().

DisassociateWrapper()

void SGNODE::DisassociateWrapper ( SGNODE **  aWrapperRef )

noexceptinherited

Remove the association between an IFSG* wrapper object and this object.

Definition at line 225 of file sg_node.cpp.

{
 if( !m_Association )
 return;
 
 wxCHECK( aWrapperRef, /* void */ );
 
 wxCHECK( *aWrapperRef == *m_Association && aWrapperRef == m_Association, /* void */ );
 
 m_Association = nullptr;
}

Referenced by IFSG_APPEARANCE::Attach(), IFSG_COLORS::Attach(), IFSG_COORDINDEX::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_NORMALS::Attach(), IFSG_SHAPE::Attach(), IFSG_TRANSFORM::Attach(), IFSG_NODE::Destroy(), IFSG_APPEARANCE::NewNode(), IFSG_COLORS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_TRANSFORM::NewNode(), and IFSG_NODE::~IFSG_NODE().

FindNode()

SGNODE * SGAPPEARANCE::FindNode ( const char *  aNodeName, const SGNODE *  aCaller  )

overridevirtualnoexcept

Search the tree of linked nodes and return a reference to the first node found with the given name.

The reference is then typically added to another node via AddRefNode().

Parameters

aNodeName	is the name of the node to search for.
aCaller	is a pointer to the node invoking this function.

Returns

is a valid node pointer on success, otherwise NULL.

Implements SGNODE.

Definition at line 173 of file sg_appearance.cpp.

{
 if( nullptr == aNodeName || 0 == aNodeName[0] )
 return nullptr;
 
 if( !m_Name.compare( aNodeName ) )
 return this;
 
 return nullptr;
}

Referenced by SGSHAPE::FindNode().

GetName()

const char * SGNODE::GetName ( void  )

inherited

Definition at line 146 of file sg_node.cpp.

{
 if( m_Name.empty() )
 getNodeName( m_SGtype, m_Name );
 
 return m_Name.c_str();
}

References getNodeName(), SGNODE::m_Name, and SGNODE::m_SGtype.

Referenced by SCENEGRAPH::addNode(), SGFACESET::addNode(), SGSHAPE::addNode(), IFSG_NODE::GetName(), SCENEGRAPH::ReNameNodes(), ReNameNodes(), SGCOLORS::ReNameNodes(), SGCOORDS::ReNameNodes(), SGFACESET::ReNameNodes(), SGINDEX::ReNameNodes(), SGNORMALS::ReNameNodes(), SGSHAPE::ReNameNodes(), SCENEGRAPH::WriteCache(), WriteCache(), SGCOLORS::WriteCache(), SGCOORDS::WriteCache(), SGFACESET::WriteCache(), SGINDEX::WriteCache(), SGNORMALS::WriteCache(), SGSHAPE::WriteCache(), SCENEGRAPH::WriteVRML(), WriteVRML(), SGCOLORS::WriteVRML(), SGCOORDS::WriteVRML(), SGFACESET::WriteVRML(), SGNORMALS::WriteVRML(), and SGSHAPE::WriteVRML().

GetNodeType()

S3D::SGTYPES SGNODE::GetNodeType ( void  ) const

noexceptinherited

Return the type of this node instance.

Definition at line 104 of file sg_node.cpp.

{
 return m_SGtype;
}

Referenced by SCENEGRAPH::addNode(), SGFACESET::addNode(), SGSHAPE::addNode(), IFSG_APPEARANCE::Attach(), IFSG_COLORS::Attach(), IFSG_COORDINDEX::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_NORMALS::Attach(), IFSG_SHAPE::Attach(), IFSG_TRANSFORM::Attach(), SGNODE::delNodeRef(), S3D::GetMatIndex(), S3D::GetModel(), IFSG_NODE::GetNodeType(), S3D::GetSGNodeType(), IFSG_APPEARANCE::NewNode(), IFSG_COLORS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_TRANSFORM::NewNode(), SCENEGRAPH::ReadCache(), SGFACESET::ReadCache(), SGSHAPE::ReadCache(), SCENEGRAPH::SCENEGRAPH(), SCENEGRAPH::SetParent(), SetParent(), SGCOLORS::SetParent(), SGCOORDS::SetParent(), SGFACESET::SetParent(), SGINDEX::SetParent(), SGNORMALS::SetParent(), SGSHAPE::SetParent(), SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET::SGFACESET(), SGINDEX::SGINDEX(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), SGNODE::SwapParent(), SCENEGRAPH::unlinkNode(), and S3D::WriteVRML().

GetNodeTypeName()

const char * SGNODE::GetNodeTypeName ( S3D::SGTYPES  aNodeType ) const

noexceptinherited

Definition at line 164 of file sg_node.cpp.

{
 return node_names[aNodeType].c_str();
}

References node_names.

Referenced by IFSG_NODE::GetNodeTypeName(), IFSG_APPEARANCE::NewNode(), IFSG_COLORS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), and IFSG_TRANSFORM::NewNode().

GetParent()

SGNODE * SGNODE::GetParent ( void  ) const

noexceptinherited

Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.

top level transform).

Definition at line 110 of file sg_node.cpp.

{
 return m_Parent;
}

Referenced by IFSG_NODE::GetParent(), S3D::GetSGNodeParent(), IFSG_APPEARANCE::NewNode(), IFSG_COLORS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_TRANSFORM::NewNode(), SCENEGRAPH::WriteCache(), WriteCache(), SGCOLORS::WriteCache(), SGCOORDS::WriteCache(), SGFACESET::WriteCache(), SGINDEX::WriteCache(), SGNORMALS::WriteCache(), and SGSHAPE::WriteCache().

isWritten()

bool SGNODE::isWritten ( void  )

inlinenoexceptinherited

Return true if the object had already been written to a cache file or VRML file.

For internal use only.

Definition at line 220 of file sg_node.h.

 {
 return m_written;
 }

References SGNODE::m_written.

Referenced by SCENEGRAPH::WriteCache(), SGFACESET::WriteCache(), and SGSHAPE::WriteCache().

ReadCache()

bool SGAPPEARANCE::ReadCache ( std::istream &  aFile, SGNODE *  parentNode  )

overridevirtual

Reads binary format data from a cache file.

To read a cache file, open the file for reading and invoke this function from a new SCENEGRAPH node.

Implements SGNODE.

Definition at line 350 of file sg_appearance.cpp.

{
 S3D::ReadColor( aFile, ambient );
 aFile.read( (char*) &shininess, sizeof( shininess ) );
 aFile.read( (char*) &transparency, sizeof( transparency ) );
 S3D::ReadColor( aFile, diffuse );
 S3D::ReadColor( aFile, emissive );
 S3D::ReadColor( aFile, specular );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References ambient, diffuse, emissive, S3D::ReadColor(), shininess, specular, and transparency.

Referenced by SGSHAPE::ReadCache().

ReNameNodes()

void SGAPPEARANCE::ReNameNodes ( void  )

overridevirtual

Rename a node and all its child nodes in preparation for write operations.

Implements SGNODE.

Definition at line 217 of file sg_appearance.cpp.

{
 m_written = false;
 
 // rename this node
 m_Name.clear();
 GetName();
}

References SGNODE::GetName(), SGNODE::m_Name, and SGNODE::m_written.

Referenced by SGSHAPE::ReNameNodes().

ResetNodeIndex()

void SGNODE::ResetNodeIndex ( void  )

noexceptinherited

Reset the global SG* node indices in preparation for write operations.

Definition at line 238 of file sg_node.cpp.

{
 for( int i = 0; i < (int)S3D::SGTYPE_END; ++i )
 node_counts[i] = 1;
}

References node_counts, and S3D::SGTYPE_END.

Referenced by S3D::ResetNodeIndex(), SCENEGRAPH::WriteCache(), and S3D::WriteVRML().

SetAmbient() [1/3]

bool SGAPPEARANCE::SetAmbient

(

const SGCOLOR &

aRGBColor

)

Definition at line 167 of file sg_appearance.cpp.

{
 return ambient.SetColor( aRGBColor );
}

References ambient, and SGCOLOR::SetColor().

SetAmbient() [2/3]

bool SGAPPEARANCE::SetAmbient

(

const SGCOLOR *

aRGBColor

)

Definition at line 159 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aRGBColor, false, wxT( "NULL pointer passed for aRGBColor" ) );
 
 return ambient.SetColor( aRGBColor );
}

References ambient, and SGCOLOR::SetColor().

SetAmbient() [3/3]

bool SGAPPEARANCE::SetAmbient	(	float	aRVal,
		float	aGVal,
		float	aBVal
	)

Definition at line 153 of file sg_appearance.cpp.

{
 return ambient.SetColor( aRVal, aGVal, aBVal );
}

References ambient, and SGCOLOR::SetColor().

SetDiffuse() [1/3]

bool SGAPPEARANCE::SetDiffuse

(

const SGCOLOR &

aRGBColor

)

Definition at line 128 of file sg_appearance.cpp.

{
 return diffuse.SetColor( aRGBColor );
}

References diffuse, and SGCOLOR::SetColor().

SetDiffuse() [2/3]

bool SGAPPEARANCE::SetDiffuse

(

const SGCOLOR *

aRGBColor

)

Definition at line 120 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aRGBColor, false, wxT( "NULL pointer passed for aRGBColor" ) );
 
 return diffuse.SetColor( aRGBColor );
}

References diffuse, and SGCOLOR::SetColor().

SetDiffuse() [3/3]

bool SGAPPEARANCE::SetDiffuse	(	float	aRVal,
		float	aGVal,
		float	aBVal
	)

Definition at line 114 of file sg_appearance.cpp.

{
 return diffuse.SetColor( aRVal, aGVal, aBVal );
}

References diffuse, and SGCOLOR::SetColor().

SetEmissive() [1/3]

bool SGAPPEARANCE::SetEmissive

(

const SGCOLOR &

aRGBColor

)

Definition at line 108 of file sg_appearance.cpp.

{
 return emissive.SetColor( aRGBColor );
}

References emissive, and SGCOLOR::SetColor().

SetEmissive() [2/3]

bool SGAPPEARANCE::SetEmissive

(

const SGCOLOR *

aRGBColor

)

Definition at line 100 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aRGBColor, false, wxT( "NULL pointer passed for aRGBColor" ) );
 
 return emissive.SetColor( aRGBColor );
}

References emissive, and SGCOLOR::SetColor().

SetEmissive() [3/3]

bool SGAPPEARANCE::SetEmissive	(	float	aRVal,
		float	aGVal,
		float	aBVal
	)

Definition at line 94 of file sg_appearance.cpp.

{
 return emissive.SetColor( aRVal, aGVal, aBVal );
}

References emissive, and SGCOLOR::SetColor().

SetName()

void SGNODE::SetName ( const char *  aName )

inherited

Definition at line 155 of file sg_node.cpp.

{
 if( nullptr == aName || 0 == aName[0] )
 getNodeName( m_SGtype, m_Name );
 else
 m_Name = aName;
}

References getNodeName(), SGNODE::m_Name, and SGNODE::m_SGtype.

Referenced by SCENEGRAPH::ReadCache(), SGFACESET::ReadCache(), SGSHAPE::ReadCache(), and IFSG_NODE::SetName().

SetParent()

bool SGAPPEARANCE::SetParent ( SGNODE *  aParent, bool  notify = true  )

overridevirtual

Set the parent SGNODE of this object.

Parameters

aParent

[in] is the desired parent node

Returns

true if the operation succeeds; false if the given node is not allowed to be a parent to the derived object.

Implements SGNODE.

Definition at line 64 of file sg_appearance.cpp.

{
 if( nullptr != m_Parent )
 {
 if( aParent == m_Parent )
 return true;
 
 // handle the change in parents
 if( notify )
 m_Parent->unlinkChildNode( this );
 
 m_Parent = nullptr;
 
 if( nullptr == aParent )
 return true;
 }
 
 // only a SGSHAPE may be parent to a SGAPPEARANCE
 if( nullptr != aParent && S3D::SGTYPE_SHAPE != aParent->GetNodeType() )
 return false;
 
 m_Parent = aParent;
 
 if( m_Parent )
 m_Parent->AddChildNode( this );
 
 return true;
}

References SGNODE::AddChildNode(), SGNODE::GetNodeType(), SGNODE::m_Parent, S3D::SGTYPE_SHAPE, and SGNODE::unlinkChildNode().

Referenced by SGSHAPE::addNode(), and SGSHAPE::~SGSHAPE().

SetSpecular() [1/3]

bool SGAPPEARANCE::SetSpecular

(

const SGCOLOR &

aRGBColor

)

Definition at line 147 of file sg_appearance.cpp.

{
 return specular.SetColor( aRGBColor );
}

References SGCOLOR::SetColor(), and specular.

SetSpecular() [2/3]

bool SGAPPEARANCE::SetSpecular

(

const SGCOLOR *

aRGBColor

)

Definition at line 140 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aRGBColor, false, wxT( "NULL pointer passed for aRGBColor" ) );
 
 return specular.SetColor( aRGBColor );
}

References SGCOLOR::SetColor(), and specular.

SetSpecular() [3/3]

bool SGAPPEARANCE::SetSpecular	(	float	aRVal,
		float	aGVal,
		float	aBVal
	)

Definition at line 134 of file sg_appearance.cpp.

{
 return specular.SetColor( aRVal, aGVal, aBVal );
}

References SGCOLOR::SetColor(), and specular.

SwapParent()

bool SGNODE::SwapParent ( SGNODE *  aNewParent )

inherited

Swap the ownership with the given parent.

This operation may be required when reordering nodes for optimization.

Parameters

aNewParent

will become the new parent to the object; it must be the same type as the parent of this instance.

Definition at line 116 of file sg_node.cpp.

{
 if( aNewParent == m_Parent )
 return true;
 
 if( nullptr == aNewParent )
 return false;
 
 if( nullptr == m_Parent )
 {
 if( aNewParent->AddChildNode( this ) )
 return true;
 
 return false;
 }
 
 if( aNewParent->GetNodeType() != m_Parent->GetNodeType() )
 return false;
 
 SGNODE* oldParent = m_Parent;
 m_Parent->unlinkChildNode( this );
 m_Parent = nullptr;
 aNewParent->unlinkRefNode( this );
 aNewParent->AddChildNode( this );
 oldParent->AddRefNode( this );
 
 return true;
}

References SGNODE::AddChildNode(), SGNODE::AddRefNode(), SGNODE::GetNodeType(), SGNODE::m_Parent, SGNODE::unlinkChildNode(), and SGNODE::unlinkRefNode().

Referenced by SGFACESET::WriteCache(), and SGSHAPE::WriteCache().

unlinkChildNode()

void SGAPPEARANCE::unlinkChildNode ( const SGNODE *  aNode )

overridevirtualnoexcept

Remove references to an owned child.

This is invoked by the child upon destruction to ensure that the parent has no invalid references.

Parameters

aNode

is the child which is being deleted.

Implements SGNODE.

Definition at line 185 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aCaller, /* void */,
 wxT( "unexpected code branch; node should have no children or refs" ) );
}

unlinkRefNode()

void SGAPPEARANCE::unlinkRefNode ( const SGNODE *  aNode )

overridevirtualnoexcept

Remove pointers to a referenced node.

This is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references.

Parameters

aNode

is the node which is being deleted.

Implements SGNODE.

Definition at line 192 of file sg_appearance.cpp.

{
 wxCHECK_MSG( aCaller, /* void */,
 wxT( "unexpected code branch; node should have no children or refs" ) );
}

WriteCache()

bool SGAPPEARANCE::WriteCache ( std::ostream &  aFile, SGNODE *  parentNode  )

overridevirtual

Write this node's data to a binary cache file.

The data includes all data of children and references to children. If this function is invoked by the user, parentNode must be set to NULL in order to ensure coherent data.

Implements SGNODE.

Definition at line 304 of file sg_appearance.cpp.

{
 if( nullptr == parentNode )
 {
 wxCHECK_MSG( m_Parent, false, wxT( "corrupt data; m_aParent is NULL" ) );
 
 SGNODE* np = m_Parent;
 
 while( nullptr != np->GetParent() )
 np = np->GetParent();
 
 if( np->WriteCache( aFile, nullptr ) )
 {
 m_written = true;
 return true;
 }
 
 return false;
 }
 
 wxCHECK_MSG( parentNode == m_Parent, false, wxT( "corrupt data; parentNode != m_aParent" ) );
 
 if( !aFile.good() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] bad stream" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 aFile << "[" << GetName() << "]";
 S3D::WriteColor( aFile, ambient );
 aFile.write( (char*) &shininess, sizeof( shininess ) );
 aFile.write( (char*) &transparency, sizeof( transparency ) );
 S3D::WriteColor( aFile, diffuse );
 S3D::WriteColor( aFile, emissive );
 S3D::WriteColor( aFile, specular );
 
 if( aFile.fail() )
 return false;
 
 m_written = true;
 return true;
}

References ambient, diffuse, emissive, SGNODE::GetName(), SGNODE::GetParent(), SGNODE::m_Parent, SGNODE::m_written, shininess, specular, transparency, SGNODE::WriteCache(), and S3D::WriteColor().

Referenced by SGSHAPE::WriteCache().

WriteVRML()

bool SGAPPEARANCE::WriteVRML ( std::ostream &  aFile, bool  aReuseFlag  )

overridevirtual

Writes this node's data to a VRML file.

This includes all data of child and referenced nodes.

Implements SGNODE.

Definition at line 227 of file sg_appearance.cpp.

{
 if( aReuseFlag )
 {
 if( !m_written )
 {
 aFile << " appearance DEF " << GetName() << " Appearance {\n";
 m_written = true;
 }
 else
 {
 aFile << " appearance USE " << GetName() << "\n";
 return true;
 }
 }
 else
 {
 aFile << " appearance Appearance {\n";
 }
 
 aFile << " material Material {\n";
 
 std::string tmp;
 float ambr, ambg, ambb;
 ambient.GetColor( ambr, ambg, ambb );
 float amb = ( 0.212671 * ambr + 0.71516 * ambg + 0.072169 * ambb );
 diffuse.GetColor( ambr, ambg, ambb );
 float den = ( 0.212671 * ambr + 0.71516 * ambg + 0.072169 * ambb );
 
 if( den < 0.004f )
 den = 0.004f;
 
 amb /= den;
 
 if( amb > 1.0f )
 amb = 1.0f;
 
 S3D::FormatFloat( tmp, amb );
 aFile << " ambientIntensity " << tmp << "\n";
 
 float red, green, blue;
 diffuse.GetColor( red, green, blue );
 S3D::FormatFloat( tmp, red );
 aFile << " diffuseColor " << tmp << " ";
 S3D::FormatFloat( tmp, green );
 aFile << tmp << " ";
 S3D::FormatFloat( tmp, blue);
 aFile << tmp << "\n";
 
 emissive.GetColor( red, green, blue );
 S3D::FormatFloat( tmp, red );
 aFile << " emissiveColor " << tmp << " ";
 S3D::FormatFloat( tmp, green );
 aFile << tmp << " ";
 S3D::FormatFloat( tmp, blue);
 aFile << tmp << "\n";
 
 S3D::FormatFloat( tmp, shininess );
 aFile << " shininess " << tmp << "\n";
 
 specular.GetColor( red, green, blue );
 S3D::FormatFloat( tmp, red );
 aFile << " specularColor " << tmp << " ";
 S3D::FormatFloat( tmp, green );
 aFile << tmp << " ";
 S3D::FormatFloat( tmp, blue);
 aFile << tmp << "\n";
 
 S3D::FormatFloat( tmp, transparency );
 aFile << " transparency " << tmp << "\n";
 
 aFile << "} }\n";
 
 return true;
}

References ambient, diffuse, emissive, S3D::FormatFloat(), SGCOLOR::GetColor(), SGNODE::GetName(), SGNODE::m_written, red, shininess, specular, and transparency.

Referenced by SGSHAPE::WriteVRML().

Member Data Documentation

ambient

SGCOLOR SGAPPEARANCE::ambient

Definition at line 76 of file sg_appearance.h.

Referenced by formatMaterial(), S3D::GetModel(), ReadCache(), SetAmbient(), SGAPPEARANCE(), WriteCache(), and WriteVRML().

diffuse

SGCOLOR SGAPPEARANCE::diffuse

Definition at line 77 of file sg_appearance.h.

Referenced by formatMaterial(), S3D::GetModel(), ReadCache(), SetDiffuse(), SGAPPEARANCE(), WriteCache(), and WriteVRML().

emissive

SGCOLOR SGAPPEARANCE::emissive

Definition at line 78 of file sg_appearance.h.

Referenced by formatMaterial(), ReadCache(), SetEmissive(), WriteCache(), and WriteVRML().

m_Association

SGNODE** SGNODE::m_Association

privateinherited

Handle to the instance held by a wrapper.

Definition at line 233 of file sg_node.h.

Referenced by SGNODE::SGNODE(), and SGNODE::~SGNODE().

m_BackPointers

std::list< SGNODE* > SGNODE::m_BackPointers

protectedinherited

nodes which hold a reference to this.

Definition at line 226 of file sg_node.h.

Referenced by SGNODE::addNodeRef(), SGCOORDS::CalcNormals(), SGNODE::delNodeRef(), and SGNODE::~SGNODE().

m_Name

std::string SGNODE::m_Name

protectedinherited

name to use for referencing the entity by name.

Definition at line 229 of file sg_node.h.

Referenced by SCENEGRAPH::FindNode(), SGFACESET::FindNode(), SGSHAPE::FindNode(), SGNODE::GetName(), SCENEGRAPH::ReadCache(), SCENEGRAPH::ReNameNodes(), ReNameNodes(), SGCOLORS::ReNameNodes(), SGCOORDS::ReNameNodes(), SGFACESET::ReNameNodes(), SGINDEX::ReNameNodes(), SGNORMALS::ReNameNodes(), SGSHAPE::ReNameNodes(), and SGNODE::SetName().

m_Parent

SGNODE* SGNODE::m_Parent

protectedinherited

Pointer to parent node; may be NULL for top level transform.

Definition at line 227 of file sg_node.h.

Referenced by SGCOORDS::CalcNormals(), SCENEGRAPH::FindNode(), SGFACESET::FindNode(), SGSHAPE::FindNode(), SCENEGRAPH::SCENEGRAPH(), SCENEGRAPH::SetParent(), SetParent(), SGCOLORS::SetParent(), SGCOORDS::SetParent(), SGFACESET::SetParent(), SGINDEX::SetParent(), SGNORMALS::SetParent(), SGSHAPE::SetParent(), SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET::SGFACESET(), SGINDEX::SGINDEX(), SGNODE::SGNODE(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), SGNODE::SwapParent(), SCENEGRAPH::WriteCache(), WriteCache(), SGCOLORS::WriteCache(), SGCOORDS::WriteCache(), SGFACESET::WriteCache(), SGINDEX::WriteCache(), SGNORMALS::WriteCache(), SGSHAPE::WriteCache(), and SGNODE::~SGNODE().

m_SGtype

S3D::SGTYPES SGNODE::m_SGtype

protectedinherited

Type of Scene Graph node.

Definition at line 228 of file sg_node.h.

Referenced by SGNODE::delNodeRef(), SGNODE::GetName(), SCENEGRAPH::SCENEGRAPH(), SGNODE::SetName(), SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET::SGFACESET(), SGNODE::SGNODE(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), and SGINDEX::WriteVRML().

m_written

bool SGNODE::m_written

protectedinherited

Set to true when the object has been written after a ReNameNodes().

Definition at line 230 of file sg_node.h.

Referenced by SGNODE::isWritten(), SCENEGRAPH::ReNameNodes(), ReNameNodes(), SGCOLORS::ReNameNodes(), SGCOORDS::ReNameNodes(), SGFACESET::ReNameNodes(), SGINDEX::ReNameNodes(), SGNORMALS::ReNameNodes(), SGSHAPE::ReNameNodes(), SGNODE::SGNODE(), SCENEGRAPH::WriteCache(), WriteCache(), SGCOLORS::WriteCache(), SGCOORDS::WriteCache(), SGFACESET::WriteCache(), SGINDEX::WriteCache(), SGNORMALS::WriteCache(), SGSHAPE::WriteCache(), SCENEGRAPH::WriteVRML(), WriteVRML(), SGCOLORS::WriteVRML(), SGCOORDS::WriteVRML(), SGFACESET::WriteVRML(), SGNORMALS::WriteVRML(), and SGSHAPE::WriteVRML().

shininess

float SGAPPEARANCE::shininess

Definition at line 74 of file sg_appearance.h.

Referenced by formatMaterial(), S3D::GetModel(), ReadCache(), SGAPPEARANCE(), WriteCache(), and WriteVRML().

specular

SGCOLOR SGAPPEARANCE::specular

Definition at line 79 of file sg_appearance.h.

Referenced by formatMaterial(), S3D::GetModel(), ReadCache(), SetSpecular(), WriteCache(), and WriteVRML().

transparency

float SGAPPEARANCE::transparency

Definition at line 75 of file sg_appearance.h.

Referenced by formatMaterial(), S3D::GetModel(), ReadCache(), SGAPPEARANCE(), WriteCache(), and WriteVRML().

---

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

• sg_appearance.h
• sg_appearance.cpp