KiCad PCB EDA Suite
IFSG_TRANSFORM Class Reference

IFSG_TRANSFORM is the wrapper for the VRML compatible TRANSFORM block class SCENEGRAPH. More...

#include <ifsg_transform.h>

Inheritance diagram for IFSG_TRANSFORM:
IFSG_NODE

Public Member Functions

 IFSG_TRANSFORM (bool create)
 
 IFSG_TRANSFORM (SGNODE *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 SetScaleOrientation (const SGVECTOR &aScaleAxis, double aAngle)
 
bool SetRotation (const SGVECTOR &aRotationAxis, double aAngle)
 
bool SetScale (const SGPOINT &aScale) noexcept
 
bool SetScale (double aScale)
 
bool SetCenter (const SGPOINT &aCenter) noexcept
 
bool SetTranslation (const SGPOINT &aTranslation) noexcept
 
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_TRANSFORM is the wrapper for the VRML compatible TRANSFORM block class SCENEGRAPH.

Definition at line 40 of file ifsg_transform.h.

Constructor & Destructor Documentation

◆ IFSG_TRANSFORM() [1/2]

IFSG_TRANSFORM::IFSG_TRANSFORM ( bool  create)

Definition at line 37 of file ifsg_transform.cpp.

38 {
39  m_node = nullptr;
40 
41  if( !create )
42  return;
43 
44  m_node = new SCENEGRAPH( nullptr );
45 
47 }
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
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

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

◆ IFSG_TRANSFORM() [2/2]

IFSG_TRANSFORM::IFSG_TRANSFORM ( SGNODE aParent)

Definition at line 50 of file ifsg_transform.cpp.

51 {
52  m_node = new SCENEGRAPH( 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 %s", __FILE__, __FUNCTION__, __LINE__, WrongParent );
60 
61  return;
62  }
63 
65 }
char WrongParent[]
Definition: ifsg_node.cpp:39
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.
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

References SGNODE::AssociateWrapper(), 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(), export_vrml_footprint(), 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.

◆ 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(), export_vrml_footprint(), 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_TRANSFORM::Attach ( SGNODE aNode)
overridevirtual

Function Attach associates a given SGNODE* with this wrapper.

Implements IFSG_NODE.

Definition at line 68 of file ifsg_transform.cpp.

69 {
70  if( m_node )
72 
73  m_node = nullptr;
74 
75  if( !aNode )
76  return false;
77 
78  if( S3D::SGTYPE_TRANSFORM != aNode->GetNodeType() )
79  {
80  return false;
81  }
82 
83  m_node = aNode;
85 
86  return true;
87 }
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_TRANSFORM.

Referenced by makeComponents(), and MODEL_VRML::~MODEL_VRML().

◆ 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(), processComp(), processSolid(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL1BASE::TranslateToSG(), WRL2BASE::TranslateToSG(), and MODEL_VRML::~MODEL_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.

◆ 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_TRANSFORM::NewNode ( SGNODE aParent)
overridevirtual

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

Implements IFSG_NODE.

Definition at line 90 of file ifsg_transform.cpp.

91 {
92  if( m_node )
94 
95  m_node = new SCENEGRAPH( aParent );
96 
97  if( aParent != m_node->GetParent() )
98  {
99  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] invalid SGNODE parent (%s) to SCENEGRAPH",
100  __FILE__, __FUNCTION__, __LINE__,
101  aParent->GetNodeTypeName( aParent->GetNodeType() ) );
102 
103  delete m_node;
104  m_node = nullptr;
105  return false;
106  }
107 
109 
110  return true;
111 }
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
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44
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_TRANSFORM::NewNode ( IFSG_NODE aParent)
overridevirtual

Implements IFSG_NODE.

Definition at line 114 of file ifsg_transform.cpp.

115 {
116  SGNODE* np = aParent.GetRawPtr();
117 
118  wxCHECK( np, false );
119 
120  return NewNode( np );
121 }
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().

◆ SetCenter()

bool IFSG_TRANSFORM::SetCenter ( const SGPOINT aCenter)
noexcept

Definition at line 184 of file ifsg_transform.cpp.

185 {
186  wxCHECK( m_node, false );
187 
188  ( (SCENEGRAPH*) m_node )->center = aCenter;
189 
190  return true;
191 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

Referenced by X3DTRANSFORM::TranslateToSG(), and WRL2TRANSFORM::TranslateToSG().

◆ 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 MODEL_VRML::~MODEL_VRML().

◆ SetRotation()

bool IFSG_TRANSFORM::SetRotation ( const SGVECTOR aRotationAxis,
double  aAngle 
)

Definition at line 124 of file ifsg_transform.cpp.

125 {
126  wxCHECK( m_node, false );
127 
128  ( (SCENEGRAPH*) m_node )->rotation_axis = aRotationAxis;
129  ( (SCENEGRAPH*) m_node )->rotation_angle = aAngle;
130 
131  return true;
132 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

References IFSG_NODE::m_node.

Referenced by export_vrml_footprint(), makeComponents(), processComp(), processSolid(), X3DTRANSFORM::TranslateToSG(), and WRL2TRANSFORM::TranslateToSG().

◆ SetScale() [1/2]

bool IFSG_TRANSFORM::SetScale ( const SGPOINT aScale)
noexcept

Definition at line 135 of file ifsg_transform.cpp.

136 {
137  wxCHECK( m_node, false );
138 
139  ( (SCENEGRAPH*) m_node )->scale = aScale;
140 
141  return true;
142 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

Referenced by export_vrml_footprint(), MODEL_VRML::SetScale(), X3DTRANSFORM::TranslateToSG(), and WRL2TRANSFORM::TranslateToSG().

◆ SetScale() [2/2]

bool IFSG_TRANSFORM::SetScale ( double  aScale)

Definition at line 145 of file ifsg_transform.cpp.

146 {
147  wxCHECK( m_node, false );
148 
149  if( aScale < 1e-8 && aScale > -1e-8 )
150  {
151  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] |scale| is < 1e-8 - this seems strange",
152  __FILE__, __FUNCTION__, __LINE__ );
153 
154  return false;
155  }
156 
157  ( (SCENEGRAPH*) m_node )->scale = SGPOINT( aScale, aScale, aScale );
158 
159  return true;
160 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

References IFSG_NODE::m_node.

◆ SetScaleOrientation()

bool IFSG_TRANSFORM::SetScaleOrientation ( const SGVECTOR aScaleAxis,
double  aAngle 
)

Definition at line 173 of file ifsg_transform.cpp.

174 {
175  wxCHECK( m_node, false );
176 
177  ( (SCENEGRAPH*) m_node )->scale_axis = aScaleAxis;
178  ( (SCENEGRAPH*) m_node )->scale_angle = aAngle;
179 
180  return true;
181 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

References IFSG_NODE::m_node.

Referenced by X3DTRANSFORM::TranslateToSG(), and WRL2TRANSFORM::TranslateToSG().

◆ SetTranslation()

bool IFSG_TRANSFORM::SetTranslation ( const SGPOINT aTranslation)
noexcept

Definition at line 163 of file ifsg_transform.cpp.

164 {
165  wxCHECK( m_node, false );
166 
167  ( (SCENEGRAPH*) m_node )->translation = aTranslation;
168 
169  return true;
170 }
SGNODE * m_node
Definition: ifsg_node.h:57
Define the basic data set required to represent a 3D model.
Definition: scenegraph.h:44

Referenced by export_vrml_footprint(), makeComponents(), processComp(), processSolid(), X3DTRANSFORM::TranslateToSG(), and WRL2TRANSFORM::TranslateToSG().

Member Data Documentation

◆ m_node

SGNODE* IFSG_NODE::m_node
protectedinherited

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