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

#include <ifsg_appearance.h>

Inheritance diagram for IFSG_APPEARANCE:
IFSG_NODE

Public Member Functions

 IFSG_APPEARANCE (bool create)
 
 IFSG_APPEARANCE (SGNODE *aParent)
 
 IFSG_APPEARANCE (IFSG_NODE &aParent)
 
bool Attach (SGNODE *aNode) override
 Function Attach associates a given SGNODE* with this wrapper.
 
bool NewNode (SGNODE *aParent) override
 Function NewNode creates a new node to associate with this wrapper.
 
bool NewNode (IFSG_NODE &aParent) override
 
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)
 
bool SetShininess (float aShininess) noexcept
 
bool SetTransparency (float aTransparency) noexcept
 
void Destroy (void)
 Function Destroy deletes the object held by this wrapper.
 
SGNODEGetRawPtr (void) noexcept
 Function GetRawPtr() returns the raw internal SGNODE pointer.
 
S3D::SGTYPES GetNodeType (void) const
 Function GetNodeType returns the type of this node instance.
 
SGNODEGetParent (void) const
 Function GetParent returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.
 
bool SetParent (SGNODE *aParent)
 Function SetParent sets the parent SGNODE of this object.
 
const char * GetName (void)
 Function GetName returns a pointer to the node name (NULL if no name assigned)
 
bool SetName (const char *aName)
 Function SetName sets the node's name; if the pointer passed is NULL then the node's name is erased.
 
const char * GetNodeTypeName (S3D::SGTYPES aNodeType) const
 Function GetNodeTypeName returns the text representation of the node type or NULL if the node somehow has an invalid type.
 
SGNODEFindNode (const char *aNodeName)
 Function FindNode searches the tree of linked nodes and returns a reference to the first node found with the given name.
 
bool AddRefNode (SGNODE *aNode)
 Function AddRefNode adds a reference to an existing node which is not owned by (not a child of) this node.
 
bool AddRefNode (IFSG_NODE &aNode)
 
bool AddChildNode (SGNODE *aNode)
 Function AddChildNode adds a node as a child owned by this node.
 
bool AddChildNode (IFSG_NODE &aNode)
 

Protected Attributes

SGNODEm_node
 

Detailed Description

Definition at line 34 of file ifsg_appearance.h.

Constructor & Destructor Documentation

◆ IFSG_APPEARANCE() [1/3]

IFSG_APPEARANCE::IFSG_APPEARANCE ( bool  create)

Definition at line 37 of file ifsg_appearance.cpp.

References SGNODE::AssociateWrapper(), and IFSG_NODE::m_node.

◆ IFSG_APPEARANCE() [2/3]

IFSG_APPEARANCE::IFSG_APPEARANCE ( SGNODE aParent)

◆ IFSG_APPEARANCE() [3/3]

IFSG_APPEARANCE::IFSG_APPEARANCE ( IFSG_NODE aParent)

Member Function Documentation

◆ AddChildNode() [1/2]

bool IFSG_NODE::AddChildNode ( IFSG_NODE aNode)
inherited

Definition at line 156 of file ifsg_node.cpp.

References SGNODE::AddChildNode(), IFSG_NODE::GetRawPtr(), and IFSG_NODE::m_node.

◆ AddChildNode() [2/2]

bool IFSG_NODE::AddChildNode ( SGNODE aNode)
inherited

Function AddChildNode adds a node as a child owned by this node.

Returns
true on success

Definition at line 148 of file ifsg_node.cpp.

References SGNODE::AddChildNode(), and IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape(), EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), and makeComponents().

◆ AddRefNode() [1/2]

bool IFSG_NODE::AddRefNode ( IFSG_NODE aNode)
inherited

Definition at line 136 of file ifsg_node.cpp.

References SGNODE::AddRefNode(), IFSG_NODE::GetRawPtr(), and IFSG_NODE::m_node.

◆ AddRefNode() [2/2]

bool IFSG_NODE::AddRefNode ( SGNODE aNode)
inherited

Function AddRefNode adds a reference to an existing node which is not owned by (not a child of) this node.

Returns
true on success

Definition at line 128 of file ifsg_node.cpp.

References SGNODE::AddRefNode(), and IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape(), EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), makeComponents(), and vrmlToSG().

◆ Attach()

bool IFSG_APPEARANCE::Attach ( SGNODE aNode)
overridevirtual

Function Attach associates a given SGNODE* with this wrapper.

Implements IFSG_NODE.

Definition at line 98 of file ifsg_appearance.cpp.

References SGNODE::AssociateWrapper(), SGNODE::DisassociateWrapper(), SGNODE::GetNodeType(), IFSG_NODE::m_node, and S3D::SGTYPE_APPEARANCE.

Referenced by X3DSHAPE::TranslateToSG().

◆ Destroy()

◆ FindNode()

SGNODE * IFSG_NODE::FindNode ( const char *  aNodeName)
inherited

Function FindNode searches the tree of linked nodes and returns 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
Returns
is a valid node pointer on success, otherwise NULL

Definition at line 120 of file ifsg_node.cpp.

References SGNODE::FindNode(), and IFSG_NODE::m_node.

◆ GetName()

const char * IFSG_NODE::GetName ( void  )
inherited

Function GetName returns a pointer to the node name (NULL if no name assigned)

Definition at line 95 of file ifsg_node.cpp.

References SGNODE::GetName(), and IFSG_NODE::m_node.

◆ GetNodeType()

S3D::SGTYPES IFSG_NODE::GetNodeType ( void  ) const
inherited

Function GetNodeType returns the type of this node instance.

Definition at line 71 of file ifsg_node.cpp.

References SGNODE::GetNodeType(), IFSG_NODE::m_node, and S3D::SGTYPE_END.

◆ GetNodeTypeName()

const char * IFSG_NODE::GetNodeTypeName ( S3D::SGTYPES  aNodeType) const
inherited

Function GetNodeTypeName returns the text representation of the node type or NULL if the node somehow has an invalid type.

Definition at line 112 of file ifsg_node.cpp.

References SGNODE::GetNodeTypeName(), and IFSG_NODE::m_node.

◆ GetParent()

SGNODE * IFSG_NODE::GetParent ( void  ) const
inherited

Function GetParent 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 79 of file ifsg_node.cpp.

References SGNODE::GetParent(), and IFSG_NODE::m_node.

Referenced by makeComponents().

◆ GetRawPtr()

◆ NewNode() [1/2]

bool IFSG_APPEARANCE::NewNode ( IFSG_NODE aParent)
overridevirtual

Implements IFSG_NODE.

Definition at line 145 of file ifsg_appearance.cpp.

References IFSG_NODE::GetRawPtr(), and NewNode().

◆ NewNode() [2/2]

bool IFSG_APPEARANCE::NewNode ( SGNODE aParent)
overridevirtual

Function NewNode creates a new node to associate with this wrapper.

Implements IFSG_NODE.

Definition at line 120 of file ifsg_appearance.cpp.

References SGNODE::AssociateWrapper(), SGNODE::DisassociateWrapper(), SGNODE::GetNodeType(), SGNODE::GetNodeTypeName(), SGNODE::GetParent(), and IFSG_NODE::m_node.

Referenced by NewNode().

◆ SetAmbient() [1/3]

bool IFSG_APPEARANCE::SetAmbient ( const SGCOLOR aRGBColor)

Definition at line 243 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetAmbient() [2/3]

bool IFSG_APPEARANCE::SetAmbient ( const SGCOLOR aRGBColor)

Definition at line 235 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetAmbient() [3/3]

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

◆ SetDiffuse() [1/3]

bool IFSG_APPEARANCE::SetDiffuse ( const SGCOLOR aRGBColor)

Definition at line 195 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetDiffuse() [2/3]

bool IFSG_APPEARANCE::SetDiffuse ( const SGCOLOR aRGBColor)

Definition at line 187 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetDiffuse() [3/3]

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

◆ SetEmissive() [1/3]

bool IFSG_APPEARANCE::SetEmissive ( const SGCOLOR aRGBColor)

Definition at line 171 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetEmissive() [2/3]

bool IFSG_APPEARANCE::SetEmissive ( const SGCOLOR aRGBColor)

Definition at line 163 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetEmissive() [3/3]

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

◆ SetName()

bool IFSG_NODE::SetName ( const char *  aName)
inherited

Function SetName sets the node's name; if the pointer passed is NULL then the node's name is erased.

Returns
true on success

Definition at line 103 of file ifsg_node.cpp.

References IFSG_NODE::m_node, and SGNODE::SetName().

◆ SetParent()

bool IFSG_NODE::SetParent ( SGNODE aParent)
inherited

Function SetParent sets 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

Definition at line 87 of file ifsg_node.cpp.

References IFSG_NODE::m_node, and SGNODE::SetParent().

Referenced by processFace(), and EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML().

◆ SetShininess()

bool IFSG_APPEARANCE::SetShininess ( float  aShininess)
noexcept

◆ SetSpecular() [1/3]

bool IFSG_APPEARANCE::SetSpecular ( const SGCOLOR aRGBColor)

Definition at line 219 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetSpecular() [2/3]

bool IFSG_APPEARANCE::SetSpecular ( const SGCOLOR aRGBColor)

Definition at line 211 of file ifsg_appearance.cpp.

References IFSG_NODE::m_node.

◆ SetSpecular() [3/3]

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

◆ SetTransparency()

bool IFSG_APPEARANCE::SetTransparency ( float  aTransparency)
noexcept

Member Data Documentation

◆ m_node

SGNODE* IFSG_NODE::m_node
protectedinherited

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