KiCad PCB EDA Suite
X3DNODE Class Referenceabstract

X3DNODE represents the base class of all X3D nodes. More...

#include <x3d_base.h>

Inheritance diagram for X3DNODE:
X3DAPP X3DCOORDS X3DIFACESET X3DSHAPE X3DTRANSFORM

Public Member Functions

virtual void unlinkChildNode (const X3DNODE *aNode)
 Function unlinkChild removes references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references. More...
 
virtual void unlinkRefNode (const X3DNODE *aNode)
 Function unlinkRef removes pointers to a referenced node; it is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references. More...
 
void addNodeRef (X3DNODE *aNode)
 Function addNodeRef adds a pointer to a node which references, but does not own, this node. More...
 
void delNodeRef (X3DNODE *aNode)
 Function delNodeRef removes a pointer to a node which references, but does not own, this node. More...
 
 X3DNODE ()
 
virtual ~X3DNODE ()
 
virtual bool Read (wxXmlNode *aNode, X3DNODE *aTopNode, X3D_DICT &aDict)=0
 
X3DNODES GetNodeType (void) const
 Function GetNodeType returns the type of this node instance. More...
 
X3DNODEGetParent (void) const
 Function GetParent returns a pointer to the parent node of this object or NULL if the object has no parent (ie. More...
 
wxString GetName (void) const
 Function GetName returns the name of this object. More...
 
virtual bool SetParent (X3DNODE *aParent, bool doUnlink=true)=0
 Function SetParent sets the parent X3DNODE of this object. More...
 
virtual bool AddChildNode (X3DNODE *aNode)=0
 
virtual bool AddRefNode (X3DNODE *aNode)=0
 
std::string GetError (void)
 
virtual SGNODETranslateToSG (SGNODE *aParent)=0
 Function TranslateToSG produces a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library. More...
 

Protected Attributes

X3DNODEm_Parent
 
X3DNODES m_Type
 
X3D_DICTm_Dict
 
std::list< X3DNODE * > m_BackPointers
 
std::list< X3DNODE * > m_Children
 
std::list< X3DNODE * > m_Refs
 
std::string m_error
 
wxString m_Name
 
SGNODEm_sgNode
 

Detailed Description

X3DNODE represents the base class of all X3D nodes.

Definition at line 75 of file x3d_base.h.

Constructor & Destructor Documentation

◆ X3DNODE()

X3DNODE::X3DNODE ( )

Definition at line 82 of file x3d_base.cpp.

83 {
85  m_Parent = nullptr;
86  m_sgNode = nullptr;
87  m_Dict = nullptr;
88 
89  return;
90 }
X3DNODES m_Type
Definition: x3d_base.h:79
SGNODE * m_sgNode
Definition: x3d_base.h:88
X3DNODE * m_Parent
Definition: x3d_base.h:78
X3D_DICT * m_Dict
Definition: x3d_base.h:80

References m_Dict, m_Parent, m_sgNode, m_Type, and X3D_INVALID.

◆ ~X3DNODE()

X3DNODE::~X3DNODE ( )
virtual

Definition at line 93 of file x3d_base.cpp.

94 {
95  if( !m_Name.empty() && nullptr != m_Dict )
96  m_Dict->DelName( m_Name, this );
97 
98  return;
99 }
bool DelName(const wxString &aName, X3DNODE *aNode)
Definition: x3d_base.cpp:51
wxString m_Name
Definition: x3d_base.h:87
X3D_DICT * m_Dict
Definition: x3d_base.h:80

References X3D_DICT::DelName(), m_Dict, and m_Name.

Member Function Documentation

◆ AddChildNode()

◆ addNodeRef()

void X3DNODE::addNodeRef ( X3DNODE aNode)

Function addNodeRef adds a pointer to a node which references, but does not own, this node.

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 142 of file x3d_base.cpp.

143 {
144  // the parent node must never be added as a backpointer
145  if( aNode == m_Parent )
146  return;
147 
148  std::list< X3DNODE* >::iterator sR = m_BackPointers.begin();
149  std::list< X3DNODE* >::iterator eR = m_BackPointers.end();
150 
151  while( sR != eR )
152  {
153  if( *sR == aNode )
154  return;
155 
156  ++sR;
157  }
158 
159  m_BackPointers.push_back( aNode );
160 
161  return;
162 }
std::list< X3DNODE * > m_BackPointers
Definition: x3d_base.h:82
X3DNODE * m_Parent
Definition: x3d_base.h:78

References m_BackPointers, and m_Parent.

Referenced by X3DSHAPE::AddRefNode(), X3DIFACESET::AddRefNode(), and X3DTRANSFORM::AddRefNode().

◆ AddRefNode()

virtual bool X3DNODE::AddRefNode ( X3DNODE aNode)
pure virtual

◆ delNodeRef()

void X3DNODE::delNodeRef ( X3DNODE aNode)

Function delNodeRef removes a pointer to a node which references, but does not own, this node.

Parameters
aNodeis the node holding a reference to this object

Definition at line 165 of file x3d_base.cpp.

166 {
167  std::list< X3DNODE* >::iterator np =
168  std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
169 
170  if( np != m_BackPointers.end() )
171  {
172  m_BackPointers.erase( np );
173  return;
174  }
175 
176 #ifdef DEBUG_X3D
177  std::ostringstream ostr;
178  ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
179  ostr << " * [BUG] delNodeRef() did not find its target";
180  wxLogTrace( MASK_VRML, "%s\n", ostr.str().c_str() );
181 #endif
182 
183  return;
184 }
std::list< X3DNODE * > m_BackPointers
Definition: x3d_base.h:82
#define MASK_VRML
Definition: wrltypes.h:37

References m_BackPointers, and MASK_VRML.

◆ GetError()

std::string X3DNODE::GetError ( void  )

Definition at line 205 of file x3d_base.cpp.

206 {
207  return m_error;
208 }
std::string m_error
Definition: x3d_base.h:85

References m_error.

◆ GetName()

wxString X3DNODE::GetName ( void  ) const

Function GetName returns the name of this object.

Definition at line 199 of file x3d_base.cpp.

200 {
201  return m_Name;
202 }
wxString m_Name
Definition: x3d_base.h:87

References m_Name.

◆ GetNodeType()

◆ GetParent()

X3DNODE * X3DNODE::GetParent ( void  ) const

Function GetParent returns a pointer to the parent node of this object or NULL if the object has no parent (ie.

top level transform)

Definition at line 193 of file x3d_base.cpp.

194 {
195  return m_Parent;
196 }
X3DNODE * m_Parent
Definition: x3d_base.h:78

References m_Parent.

Referenced by X3DSHAPE::AddChildNode(), X3DIFACESET::AddChildNode(), and X3DTRANSFORM::AddChildNode().

◆ Read()

virtual bool X3DNODE::Read ( wxXmlNode *  aNode,
X3DNODE aTopNode,
X3D_DICT aDict 
)
pure virtual

◆ SetParent()

virtual bool X3DNODE::SetParent ( X3DNODE aParent,
bool  doUnlink = true 
)
pure virtual

Function SetParent sets the parent X3DNODE of this object.

Parameters
aParent[in] is the desired parent node
doUnlinkindicates that the child must be unlinked from the parent
Returns
true if the operation succeeds; false if the given node is not allowed to be a parent to the derived object.

Implemented in X3DAPP, X3DTRANSFORM, X3DIFACESET, X3DSHAPE, and X3DCOORDS.

Referenced by X3DSHAPE::AddChildNode(), X3DIFACESET::AddChildNode(), and X3DTRANSFORM::AddChildNode().

◆ TranslateToSG()

virtual SGNODE* X3DNODE::TranslateToSG ( SGNODE aParent)
pure virtual

Function TranslateToSG produces a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library.

Parameters
aParentis a pointer to the parent SG node
Returns
is non-NULL on success

Implemented in X3DAPP, X3DTRANSFORM, X3DIFACESET, X3DSHAPE, and X3DCOORDS.

Referenced by X3DPARSER::Load(), and X3DSHAPE::TranslateToSG().

◆ unlinkChildNode()

void X3DNODE::unlinkChildNode ( const X3DNODE aNode)
virtual

Function unlinkChild removes references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references.

Parameters
aNodeis the child which is being deleted

Reimplemented in X3DSHAPE.

Definition at line 102 of file x3d_base.cpp.

103 {
104  std::list< X3DNODE* >::iterator sL = m_Children.begin();
105  std::list< X3DNODE* >::iterator eL = m_Children.end();
106 
107  while( sL != eL )
108  {
109  if( *sL == aNode )
110  {
111  m_Children.erase( sL );
112  return;
113  }
114 
115  ++sL;
116  }
117 
118  return;
119 }
std::list< X3DNODE * > m_Children
Definition: x3d_base.h:83

References m_Children.

Referenced by X3DCOORDS::SetParent(), X3DSHAPE::SetParent(), X3DIFACESET::SetParent(), X3DTRANSFORM::SetParent(), X3DAPP::SetParent(), and X3DSHAPE::unlinkChildNode().

◆ unlinkRefNode()

void X3DNODE::unlinkRefNode ( const X3DNODE aNode)
virtual

Function unlinkRef removes pointers to a referenced node; it 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

Reimplemented in X3DSHAPE.

Definition at line 122 of file x3d_base.cpp.

123 {
124  std::list< X3DNODE* >::iterator sL = m_Refs.begin();
125  std::list< X3DNODE* >::iterator eL = m_Refs.end();
126 
127  while( sL != eL )
128  {
129  if( *sL == aNode )
130  {
131  m_Refs.erase( sL );
132  return;
133  }
134 
135  ++sL;
136  }
137 
138  return;
139 }
std::list< X3DNODE * > m_Refs
Definition: x3d_base.h:84

References m_Refs.

Referenced by X3DSHAPE::unlinkRefNode().

Member Data Documentation

◆ m_BackPointers

◆ m_Children

◆ m_Dict

◆ m_error

std::string X3DNODE::m_error
protected

Definition at line 85 of file x3d_base.h.

Referenced by GetError().

◆ m_Name

wxString X3DNODE::m_Name
protected

◆ m_Parent

◆ m_Refs

◆ m_sgNode

SGNODE* X3DNODE::m_sgNode
protected

◆ m_Type


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