KiCad PCB EDA Suite
IFSG_NORMALS Class Reference

IFSG_NORMALS is the wrapper for the SGNORMALS class. More...

#include <ifsg_normals.h>

Inheritance diagram for IFSG_NORMALS:
IFSG_NODE

Public Member Functions

 IFSG_NORMALS (bool create)
 
 IFSG_NORMALS (SGNODE *aParent)
 
 IFSG_NORMALS (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 GetNormalList (size_t &aListSize, SGVECTOR *&aNormalList)
 
bool SetNormalList (size_t aListSize, const SGVECTOR *aNormalList)
 
bool AddNormal (double aXValue, double aYValue, double aZValue)
 
bool AddNormal (const SGVECTOR &aNormal)
 
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_NORMALS is the wrapper for the SGNORMALS class.

Definition at line 40 of file ifsg_normals.h.

Constructor & Destructor Documentation

◆ IFSG_NORMALS() [1/3]

IFSG_NORMALS::IFSG_NORMALS ( bool  create)

Definition at line 38 of file ifsg_normals.cpp.

39{
40 m_node = nullptr;
41
42 if( !create )
43 return;
44
45 m_node = new SGNORMALS( nullptr );
46
48}
SGNODE * m_node
Definition: ifsg_node.h:57
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:207
Define a set of vertex normals for a scene graph object.
Definition: sg_normals.h:39

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

◆ IFSG_NORMALS() [2/3]

IFSG_NORMALS::IFSG_NORMALS ( SGNODE aParent)

Definition at line 51 of file ifsg_normals.cpp.

52{
53 m_node = new SGNORMALS( nullptr );
54
55 if( !m_node->SetParent( aParent ) )
56 {
57 delete m_node;
58 m_node = nullptr;
59
60 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
62
63 return;
64 }
65
67}
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.
char WrongParent[]
Definition: ifsg_node.cpp:39

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

◆ IFSG_NORMALS() [3/3]

IFSG_NORMALS::IFSG_NORMALS ( IFSG_NODE aParent)

Definition at line 70 of file ifsg_normals.cpp.

71{
72 SGNODE* pp = aParent.GetRawPtr();
73
74#ifdef DEBUG
75 if( ! pp )
76 {
77 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
78 BadParent );
79 }
80#endif
81
82 m_node = new SGNORMALS( nullptr );
83
84 if( !m_node->SetParent( pp ) )
85 {
86 delete m_node;
87 m_node = nullptr;
88
89 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
91
92 return;
93 }
94
96}
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
The base class of all Scene Graph nodes.
Definition: sg_node.h:75
char BadParent[]
Definition: ifsg_node.cpp:38

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 ( 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}
virtual bool AddChildNode(SGNODE *aNode)=0

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.

149{
150 wxCHECK( m_node, false );
151
152 return m_node->AddChildNode( aNode );
153}

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().

◆ AddNormal() [1/2]

bool IFSG_NORMALS::AddNormal ( const SGVECTOR aNormal)

Definition at line 181 of file ifsg_normals.cpp.

182{
183 wxCHECK( m_node, false );
184
185 ( (SGNORMALS*) m_node )->AddNormal( aNormal );
186 return true;
187}

References IFSG_NODE::m_node.

◆ AddNormal() [2/2]

bool IFSG_NORMALS::AddNormal ( double  aXValue,
double  aYValue,
double  aZValue 
)

Definition at line 172 of file ifsg_normals.cpp.

173{
174 wxCHECK( m_node, false );
175
176 ( (SGNORMALS*) m_node )->AddNormal( aXValue, aYValue, aZValue );
177 return true;
178}

References IFSG_NODE::m_node.

Referenced by EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), and vrmlToSG().

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

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.

129{
130 wxCHECK( m_node, false );
131
132 return m_node->AddRefNode( aNode );
133}

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_NORMALS::Attach ( SGNODE aNode)
overridevirtual

Function Attach associates a given SGNODE* with this wrapper.

Implements IFSG_NODE.

Definition at line 99 of file ifsg_normals.cpp.

100{
101 if( m_node )
103
104 m_node = nullptr;
105
106 if( !aNode )
107 return false;
108
109 if( S3D::SGTYPE_NORMALS != aNode->GetNodeType() )
110 {
111 return false;
112 }
113
114 m_node = aNode;
116
117 return true;
118}
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:225
@ SGTYPE_NORMALS
Definition: sg_types.h:43

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

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

121{
122 wxCHECK( m_node, nullptr );
123
124 return m_node->FindNode( aNodeName, nullptr );
125}
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.

◆ 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}
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}
@ SGTYPE_END
Definition: sg_types.h:45

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}
const char * GetNodeTypeName(S3D::SGTYPES aNodeType) const noexcept
Definition: sg_node.cpp:164

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

◆ GetNormalList()

bool IFSG_NORMALS::GetNormalList ( size_t &  aListSize,
SGVECTOR *&  aNormalList 
)

Definition at line 155 of file ifsg_normals.cpp.

156{
157 wxCHECK( m_node, false );
158
159 return ( (SGNORMALS*) m_node )->GetNormalList( aListSize, aNormalList );
160}

References 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 * 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_NORMALS::NewNode ( IFSG_NODE aParent)
overridevirtual

Implements IFSG_NODE.

Definition at line 145 of file ifsg_normals.cpp.

146{
147 SGNODE* np = aParent.GetRawPtr();
148
149 wxCHECK( np, false );
150
151 return NewNode( np );
152}
bool NewNode(SGNODE *aParent) override
Function NewNode creates a new node to associate with this wrapper.

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

◆ NewNode() [2/2]

bool IFSG_NORMALS::NewNode ( SGNODE aParent)
overridevirtual

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

Implements IFSG_NODE.

Definition at line 121 of file ifsg_normals.cpp.

122{
123 if( m_node )
125
126 m_node = new SGNORMALS( aParent );
127
128 if( aParent != m_node->GetParent() )
129 {
130 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] invalid SGNODE parent (%s) to SGNORMALS" ),
131 __FILE__, __FUNCTION__, __LINE__,
132 aParent->GetNodeTypeName( aParent->GetNodeType() ) );
133
134 delete m_node;
135 m_node = nullptr;
136 return false;
137 }
138
140
141 return true;
142}

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

Referenced by EXPORTER_PCB_VRML::create_vrml_shell(), NewNode(), and vrmlToSG().

◆ 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}
void SetName(const char *aName)
Definition: sg_node.cpp:155

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

◆ SetNormalList()

bool IFSG_NORMALS::SetNormalList ( size_t  aListSize,
const SGVECTOR aNormalList 
)

Definition at line 163 of file ifsg_normals.cpp.

164{
165 wxCHECK( m_node, false );
166
167 ( (SGNORMALS*) m_node )->SetNormalList( aListSize, aNormalList );
168 return true;
169}

References IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape(), and WRL2BOX::TranslateToSG().

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

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(), IFSG_COLORS::AddColor(), IFSG_COORDS::AddCoord(), IFSG_INDEX::AddIndex(), AddNormal(), IFSG_NODE::AddRefNode(), IFSG_APPEARANCE::Attach(), IFSG_COLORS::Attach(), IFSG_COORDINDEX::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), Attach(), IFSG_SHAPE::Attach(), IFSG_TRANSFORM::Attach(), IFSG_FACESET::CalcNormals(), IFSG_NODE::Destroy(), IFSG_NODE::FindNode(), IFSG_COLORS::GetColorList(), IFSG_COORDS::GetCoordsList(), IFSG_INDEX::GetIndices(), IFSG_NODE::GetName(), IFSG_NODE::GetNodeType(), IFSG_NODE::GetNodeTypeName(), GetNormalList(), IFSG_NODE::GetParent(), IFSG_APPEARANCE::IFSG_APPEARANCE(), IFSG_COLORS::IFSG_COLORS(), IFSG_COORDINDEX::IFSG_COORDINDEX(), IFSG_COORDS::IFSG_COORDS(), IFSG_FACESET::IFSG_FACESET(), IFSG_NODE::IFSG_NODE(), 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(), NewNode(), IFSG_SHAPE::NewNode(), IFSG_TRANSFORM::NewNode(), IFSG_APPEARANCE::SetAmbient(), IFSG_COLORS::SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_APPEARANCE::SetDiffuse(), IFSG_APPEARANCE::SetEmissive(), IFSG_INDEX::SetIndices(), IFSG_NODE::SetName(), 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: