KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SGAPPEARANCE Class Reference

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

#include <sg_appearance.h>

Inheritance diagram for SGAPPEARANCE:
SGNODE

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)
 
SGNODEFindNode (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...
 
SGNODEGetParent (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...
 
SGNODEm_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::~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.

◆ 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
aNodeis the node holding a reference to this object.

Definition at line 170 of file sg_node.cpp.

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.

◆ AssociateWrapper()

void SGNODE::AssociateWrapper ( SGNODE **  aWrapperRef)
noexceptinherited

◆ delNodeRef()

void SGNODE::delNodeRef ( const SGNODE aNode)
inherited

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

Parameters
aNodeis the node holding a reference to this object.

Definition at line 185 of file sg_node.cpp.

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

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

◆ DisassociateWrapper()

◆ 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
aNodeNameis the name of the node to search for.
aCalleris 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.

Referenced by SGSHAPE::FindNode().

◆ GetName()

◆ GetNodeType()

◆ GetNodeTypeName()

◆ GetParent()

◆ 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.

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.

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.

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.

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.

References ambient, and SGCOLOR::SetColor().

◆ SetAmbient() [2/3]

bool SGAPPEARANCE::SetAmbient ( const SGCOLOR aRGBColor)

Definition at line 159 of file sg_appearance.cpp.

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.

References ambient, and SGCOLOR::SetColor().

◆ SetDiffuse() [1/3]

bool SGAPPEARANCE::SetDiffuse ( const SGCOLOR aRGBColor)

Definition at line 128 of file sg_appearance.cpp.

References diffuse, and SGCOLOR::SetColor().

◆ SetDiffuse() [2/3]

bool SGAPPEARANCE::SetDiffuse ( const SGCOLOR aRGBColor)

Definition at line 120 of file sg_appearance.cpp.

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.

References diffuse, and SGCOLOR::SetColor().

◆ SetEmissive() [1/3]

bool SGAPPEARANCE::SetEmissive ( const SGCOLOR aRGBColor)

Definition at line 108 of file sg_appearance.cpp.

References emissive, and SGCOLOR::SetColor().

◆ SetEmissive() [2/3]

bool SGAPPEARANCE::SetEmissive ( const SGCOLOR aRGBColor)

Definition at line 100 of file sg_appearance.cpp.

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.

References emissive, and SGCOLOR::SetColor().

◆ SetName()

void SGNODE::SetName ( const char *  aName)
inherited

◆ 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.

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.

References SGCOLOR::SetColor(), and specular.

◆ SetSpecular() [2/3]

bool SGAPPEARANCE::SetSpecular ( const SGCOLOR aRGBColor)

Definition at line 140 of file sg_appearance.cpp.

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.

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
aNewParentwill 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.

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
aNodeis the child which is being deleted.

Implements SGNODE.

Definition at line 185 of file sg_appearance.cpp.

◆ 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
aNodeis the node which is being deleted.

Implements SGNODE.

Definition at line 192 of file sg_appearance.cpp.

◆ 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.

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.

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

◆ diffuse

SGCOLOR SGAPPEARANCE::diffuse

◆ 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

◆ m_Parent

◆ m_SGtype

◆ m_written

◆ shininess

float SGAPPEARANCE::shininess

◆ specular

SGCOLOR SGAPPEARANCE::specular

◆ transparency

float SGAPPEARANCE::transparency

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