KiCad PCB EDA Suite
IFSG_COLORS Class Reference

IFSG_COLORS is the wrapper for SGCOLORS. More...

#include <ifsg_colors.h>

Inheritance diagram for IFSG_COLORS:
IFSG_NODE

Public Member Functions

 IFSG_COLORS (bool create)
 
 IFSG_COLORS (SGNODE *aParent)
 
 IFSG_COLORS (IFSG_NODE &aParent)
 
bool Attach (SGNODE *aNode) override
 Function Attach associates a given SGNODE* with this wrapper. More...
 
bool NewNode (SGNODE *aParent) override
 Function NewNode creates a new node to associate with this wrapper. More...
 
bool NewNode (IFSG_NODE &aParent) override
 
bool GetColorList (size_t &aListSize, SGCOLOR *&aColorList)
 
bool SetColorList (size_t aListSize, const SGCOLOR *aColorList)
 
bool AddColor (double aRedValue, double aGreenValue, double aBlueValue)
 
bool AddColor (const SGCOLOR &aColor)
 
void Destroy (void)
 Function Destroy deletes the object held by this wrapper. More...
 
SGNODEGetRawPtr (void) noexcept
 Function GetRawPtr() returns the raw internal SGNODE pointer. More...
 
S3D::SGTYPES GetNodeType (void) const
 Function GetNodeType returns the type of this node instance. More...
 
SGNODEGetParent (void) const
 Function GetParent returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie. More...
 
bool SetParent (SGNODE *aParent)
 Function SetParent sets the parent SGNODE of this object. More...
 
const char * GetName (void)
 Function GetName returns a pointer to the node name (NULL if no name assigned) More...
 
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. More...
 
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. More...
 
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. More...
 
bool AddRefNode (SGNODE *aNode)
 Function AddRefNode adds a reference to an existing node which is not owned by (not a child of) this node. More...
 
bool AddRefNode (IFSG_NODE &aNode)
 
bool AddChildNode (SGNODE *aNode)
 Function AddChildNode adds a node as a child owned by this node. More...
 
bool AddChildNode (IFSG_NODE &aNode)
 

Protected Attributes

SGNODEm_node
 

Detailed Description

IFSG_COLORS is the wrapper for SGCOLORS.

Definition at line 41 of file ifsg_colors.h.

Constructor & Destructor Documentation

◆ IFSG_COLORS() [1/3]

IFSG_COLORS::IFSG_COLORS ( bool  create)

Definition at line 37 of file ifsg_colors.cpp.

38 {
39  m_node = nullptr;
40 
41  if( !create )
42  return;
43 
44  m_node = new SGCOLORS( nullptr );
45 
47 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57

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

◆ IFSG_COLORS() [2/3]

IFSG_COLORS::IFSG_COLORS ( SGNODE aParent)

Definition at line 50 of file ifsg_colors.cpp.

51 {
52  m_node = new SGCOLORS( nullptr );
53 
54  if( !m_node->SetParent( aParent ) )
55  {
56  delete m_node;
57  m_node = nullptr;
58 
59  wxLogTrace( MASK_3D_SG, "%s:%s:%d", __FILE__, __FUNCTION__, __LINE__ );
60 
61  return;
62  }
63 
65 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.

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

◆ IFSG_COLORS() [3/3]

IFSG_COLORS::IFSG_COLORS ( IFSG_NODE aParent)

Definition at line 68 of file ifsg_colors.cpp.

69 {
70  SGNODE* pp = aParent.GetRawPtr();
71 
72 #ifdef DEBUG
73  // Braces needed due to dangling else warning from wxLogTrace macro
74  if( !pp )
75  {
76  wxLogTrace( MASK_3D_SG, "%s:%s:%d %s", __FILE__, __FUNCTION__, __LINE__, BadParent );
77  }
78 #endif
79 
80  m_node = new SGCOLORS( nullptr );
81 
82  if( !m_node->SetParent( pp ) )
83  {
84  delete m_node;
85  m_node = nullptr;
86 
87  wxLogTrace( MASK_3D_SG, "%s:%s:%d %s", __FILE__, __FUNCTION__, __LINE__,
88  WrongParent );
89 
90  return;
91  }
92 
94 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
char WrongParent[]
Definition: ifsg_node.cpp:39
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
char BadParent[]
Definition: ifsg_node.cpp:38
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.

References SGNODE::AssociateWrapper(), BadParent, IFSG_NODE::GetRawPtr(), IFSG_NODE::m_node, SGNODE::SetParent(), and WrongParent.

Member Function Documentation

◆ AddChildNode() [1/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.

149 {
150  wxCHECK( m_node, false );
151 
152  return m_node->AddChildNode( aNode );
153 }
SGNODE * m_node
Definition: ifsg_node.h:57
virtual bool AddChildNode(SGNODE *aNode)=0

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

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

◆ AddChildNode() [2/2]

bool IFSG_NODE::AddChildNode ( IFSG_NODE aNode)
inherited

Definition at line 156 of file ifsg_node.cpp.

157 {
158  wxCHECK( m_node, false );
159 
160  SGNODE* np = aNode.GetRawPtr();
161 
162  wxCHECK( np, false );
163 
164  return m_node->AddChildNode( np );
165 }
SGNODE * m_node
Definition: ifsg_node.h:57
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
virtual bool AddChildNode(SGNODE *aNode)=0

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

◆ AddColor() [1/2]

bool IFSG_COLORS::AddColor ( double  aRedValue,
double  aGreenValue,
double  aBlueValue 
)

Definition at line 171 of file ifsg_colors.cpp.

172 {
173  wxCHECK( m_node, false );
174 
175  ( (SGCOLORS*) m_node )->AddColor( aRedValue, aGreenValue, aBlueValue );
176 
177  return true;
178 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
SGNODE * m_node
Definition: ifsg_node.h:57

References IFSG_NODE::m_node.

◆ AddColor() [2/2]

bool IFSG_COLORS::AddColor ( const SGCOLOR aColor)

Definition at line 181 of file ifsg_colors.cpp.

182 {
183  wxCHECK( m_node, false );
184 
185  ( (SGCOLORS*) m_node )->AddColor( aColor );
186 
187  return true;
188 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
SGNODE * m_node
Definition: ifsg_node.h:57

References IFSG_NODE::m_node.

◆ AddRefNode() [1/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.

129 {
130  wxCHECK( m_node, false );
131 
132  return m_node->AddRefNode( aNode );
133 }
virtual bool AddRefNode(SGNODE *aNode)=0
SGNODE * m_node
Definition: ifsg_node.h:57

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

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

◆ AddRefNode() [2/2]

bool IFSG_NODE::AddRefNode ( IFSG_NODE aNode)
inherited

Definition at line 136 of file ifsg_node.cpp.

137 {
138  wxCHECK( m_node, false );
139 
140  SGNODE* np = aNode.GetRawPtr();
141 
142  wxCHECK( np, false );
143 
144  return m_node->AddRefNode( np );
145 }
virtual bool AddRefNode(SGNODE *aNode)=0
SGNODE * m_node
Definition: ifsg_node.h:57
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65

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

◆ Attach()

bool IFSG_COLORS::Attach ( SGNODE aNode)
overridevirtual

Function Attach associates a given SGNODE* with this wrapper.

Implements IFSG_NODE.

Definition at line 97 of file ifsg_colors.cpp.

98 {
99  if( m_node )
101 
102  m_node = nullptr;
103 
104  if( !aNode )
105  return false;
106 
107  if( S3D::SGTYPE_COLORS != aNode->GetNodeType() )
108  {
109  return false;
110  }
111 
112  m_node = aNode;
114 
115  return true;
116 }
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:223
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104

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

◆ Destroy()

void IFSG_NODE::Destroy ( void  )
inherited

Function Destroy deletes the object held by this wrapper.

Definition at line 55 of file ifsg_node.cpp.

56 {
57  if( m_node )
59 
60  delete m_node;
61  m_node = nullptr;
62 }
SGNODE * m_node
Definition: ifsg_node.h:57
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:223

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

Referenced by loadIDFBoard(), processSolid(), WRL1SEPARATOR::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DSHAPE::TranslateToSG(), WRL1BASE::TranslateToSG(), WRL2BASE::TranslateToSG(), and EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML().

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

121 {
122  wxCHECK( m_node, nullptr );
123 
124  return m_node->FindNode( aNodeName, nullptr );
125 }
SGNODE * m_node
Definition: ifsg_node.h:57
virtual SGNODE * FindNode(const char *aNodeName, const SGNODE *aCaller)=0
Search the tree of linked nodes and return a reference to the first node found with the given name.

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

◆ GetColorList()

bool IFSG_COLORS::GetColorList ( size_t &  aListSize,
SGCOLOR *&  aColorList 
)

Definition at line 153 of file ifsg_colors.cpp.

154 {
155  wxCHECK( m_node, false );
156 
157  return ( (SGCOLORS*) m_node )->GetColorList( aListSize, aColorList );
158 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
SGNODE * m_node
Definition: ifsg_node.h:57

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

96 {
97  wxCHECK( m_node, nullptr );
98 
99  return m_node->GetName();
100 }
SGNODE * m_node
Definition: ifsg_node.h:57
const char * GetName(void)
Definition: sg_node.cpp:146

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.

72 {
73  wxCHECK( m_node, S3D::SGTYPE_END );
74 
75  return m_node->GetNodeType();
76 }
SGNODE * m_node
Definition: ifsg_node.h:57
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104

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.

113 {
114  wxCHECK( m_node, nullptr );
115 
116  return m_node->GetNodeTypeName( aNodeType );
117 }
SGNODE * m_node
Definition: ifsg_node.h:57
const char * GetNodeTypeName(S3D::SGTYPES aNodeType) const noexcept
Definition: sg_node.cpp:164

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.

80 {
81  wxCHECK( m_node, nullptr );
82 
83  return m_node->GetParent();
84 }
SGNODE * m_node
Definition: ifsg_node.h:57
SGNODE * GetParent(void) const noexcept
Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.
Definition: sg_node.cpp:110

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

Referenced by makeComponents().

◆ GetRawPtr()

◆ NewNode() [1/2]

bool IFSG_COLORS::NewNode ( SGNODE aParent)
overridevirtual

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

Implements IFSG_NODE.

Definition at line 119 of file ifsg_colors.cpp.

120 {
121  if( m_node )
123 
124  m_node = new SGCOLORS( aParent );
125 
126  if( aParent != m_node->GetParent() )
127  {
128  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] invalid SGNODE parent (%s) to SGCOLORS",
129  __FILE__, __FUNCTION__, __LINE__,
130  aParent->GetNodeTypeName( aParent->GetNodeType() ) );
131 
132  delete m_node;
133  m_node = nullptr;
134  return false;
135  }
136 
138 
139  return true;
140 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:223
const char * GetNodeTypeName(S3D::SGTYPES aNodeType) const noexcept
Definition: sg_node.cpp:164
SGNODE * GetParent(void) const noexcept
Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.
Definition: sg_node.cpp:110
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104

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

Referenced by NewNode().

◆ NewNode() [2/2]

bool IFSG_COLORS::NewNode ( IFSG_NODE aParent)
overridevirtual

Implements IFSG_NODE.

Definition at line 143 of file ifsg_colors.cpp.

144 {
145  SGNODE* np = aParent.GetRawPtr();
146 
147  wxCHECK( np, false );
148 
149  return NewNode( np );
150 }
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
bool NewNode(SGNODE *aParent) override
Function NewNode creates a new node to associate with this wrapper.

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

◆ SetColorList()

bool IFSG_COLORS::SetColorList ( size_t  aListSize,
const SGCOLOR aColorList 
)

Definition at line 161 of file ifsg_colors.cpp.

162 {
163  wxCHECK( m_node, false );
164 
165  ( (SGCOLORS*) m_node )->SetColorList( aListSize, aColorList );
166 
167  return true;
168 }
Define an RGB color set for a scenegraph object.
Definition: sg_colors.h:38
SGNODE * m_node
Definition: ifsg_node.h:57

References IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape().

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

104 {
105  wxCHECK( m_node, false );
106 
107  m_node->SetName( aName );
108  return true;
109 }
SGNODE * m_node
Definition: ifsg_node.h:57
void SetName(const char *aName)
Definition: sg_node.cpp:155

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.

88 {
89  wxCHECK( m_node, false );
90 
91  return m_node->SetParent( aParent );
92 }
SGNODE * m_node
Definition: ifsg_node.h:57
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.

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

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

Member Data Documentation

◆ m_node

SGNODE* IFSG_NODE::m_node
protectedinherited

Definition at line 57 of file ifsg_node.h.

Referenced by IFSG_NODE::AddChildNode(), AddColor(), IFSG_COORDS::AddCoord(), IFSG_INDEX::AddIndex(), IFSG_NORMALS::AddNormal(), IFSG_NODE::AddRefNode(), IFSG_APPEARANCE::Attach(), IFSG_COORDS::Attach(), IFSG_NORMALS::Attach(), IFSG_FACESET::Attach(), IFSG_SHAPE::Attach(), IFSG_COORDINDEX::Attach(), Attach(), IFSG_TRANSFORM::Attach(), IFSG_FACESET::CalcNormals(), IFSG_NODE::Destroy(), IFSG_NODE::FindNode(), GetColorList(), IFSG_COORDS::GetCoordsList(), IFSG_INDEX::GetIndices(), IFSG_NODE::GetName(), IFSG_NODE::GetNodeType(), IFSG_NODE::GetNodeTypeName(), IFSG_NORMALS::GetNormalList(), IFSG_NODE::GetParent(), IFSG_APPEARANCE::IFSG_APPEARANCE(), IFSG_COLORS(), IFSG_COORDINDEX::IFSG_COORDINDEX(), IFSG_COORDS::IFSG_COORDS(), IFSG_FACESET::IFSG_FACESET(), IFSG_NODE::IFSG_NODE(), IFSG_NORMALS::IFSG_NORMALS(), IFSG_SHAPE::IFSG_SHAPE(), IFSG_TRANSFORM::IFSG_TRANSFORM(), IFSG_APPEARANCE::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_SHAPE::NewNode(), NewNode(), IFSG_TRANSFORM::NewNode(), IFSG_APPEARANCE::SetAmbient(), SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_APPEARANCE::SetDiffuse(), IFSG_APPEARANCE::SetEmissive(), IFSG_INDEX::SetIndices(), IFSG_NODE::SetName(), IFSG_NORMALS::SetNormalList(), IFSG_NODE::SetParent(), IFSG_TRANSFORM::SetRotation(), IFSG_TRANSFORM::SetScale(), IFSG_TRANSFORM::SetScaleOrientation(), IFSG_APPEARANCE::SetSpecular(), and IFSG_NODE::~IFSG_NODE().


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