KiCad PCB EDA Suite
WRL2POINTSET Class Reference

#include <vrml2_pointset.h>

Inheritance diagram for WRL2POINTSET:
WRL2NODE

Public Member Functions

 WRL2POINTSET ()
 
 WRL2POINTSET (WRL2NODE *aParent)
 
virtual ~WRL2POINTSET ()
 
bool Read (WRLPROC &proc, WRL2BASE *aTopNode) override
 
bool AddRefNode (WRL2NODE *aNode) override
 
bool AddChildNode (WRL2NODE *aNode) override
 
SGNODETranslateToSG (SGNODE *aParent) override
 Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library. More...
 
bool HasColors (void)
 
bool isDangling (void) override
 Determine whether an object should be moved to a different parent during the VRML to SG* translation. More...
 
void unlinkChildNode (const WRL2NODE *aNode) override
 Remove references to an owned child. More...
 
void unlinkRefNode (const WRL2NODE *aNode) override
 Remove pointers to a referenced node. More...
 
WRL2NODES GetNodeType (void) const
 
WRL2NODEGetParent (void) const
 
virtual bool SetParent (WRL2NODE *aParent, bool doUnlink=true)
 Set the parent WRL2NODE of this object. More...
 
virtual std::string GetName (void)
 
virtual bool SetName (const std::string &aName)
 
const char * GetNodeTypeName (WRL2NODES aNodeType) const
 
virtual WRL2NODEFindNode (const std::string &aNodeName, const WRL2NODE *aCaller)
 Search the tree of linked nodes and returns a reference to the first node found with the given name. More...
 
std::string GetError (void)
 
WRL2NODES getNodeTypeID (const std::string &aNodeName)
 
void addNodeRef (WRL2NODE *aNode)
 Add a pointer to a node which references but does not own this node. More...
 
void delNodeRef (WRL2NODE *aNode)
 Remove a pointer to a node which references but does not own this node. More...
 

Protected Attributes

WRL2NODEm_Parent
 
WRL2NODES m_Type
 
std::string m_Name
 
std::list< WRL2NODE * > m_BackPointers
 
std::list< WRL2NODE * > m_Children
 
std::list< WRL2NODE * > m_Refs
 
std::string m_error
 
SGNODEm_sgNode
 

Private Member Functions

bool checkNodeType (WRL2NODES aType)
 
void setDefaults (void)
 

Private Attributes

WRL2NODEcolor
 
WRL2NODEcoord
 

Detailed Description

Definition at line 40 of file vrml2_pointset.h.

Constructor & Destructor Documentation

◆ WRL2POINTSET() [1/2]

WRL2POINTSET::WRL2POINTSET ( )

Definition at line 37 of file vrml2_pointset.cpp.

37  : WRL2NODE()
38 {
39  setDefaults();
41 }
WRL2NODES m_Type
Definition: vrml2_node.h:170
void setDefaults(void)

References WRL2NODE::m_Type, setDefaults(), and WRL2_POINTSET.

◆ WRL2POINTSET() [2/2]

WRL2POINTSET::WRL2POINTSET ( WRL2NODE aParent)

Definition at line 44 of file vrml2_pointset.cpp.

44  : WRL2NODE()
45 {
46  setDefaults();
48  m_Parent = aParent;
49 
50  if( nullptr != m_Parent )
51  m_Parent->AddChildNode( this );
52 }
WRL2NODES m_Type
Definition: vrml2_node.h:170
WRL2NODE * m_Parent
Definition: vrml2_node.h:169
virtual bool AddChildNode(WRL2NODE *aNode)
Definition: vrml2_node.cpp:356
void setDefaults(void)

References WRL2NODE::AddChildNode(), WRL2NODE::m_Parent, WRL2NODE::m_Type, setDefaults(), and WRL2_POINTSET.

◆ ~WRL2POINTSET()

WRL2POINTSET::~WRL2POINTSET ( )
virtual

Definition at line 55 of file vrml2_pointset.cpp.

56 {
57  wxLogTrace( traceVrmlPlugin,
58  wxT( " * [INFO] Destroying PointSet node with %zu children, %zu"
59  "references, and %zu back pointers." ),
60  m_Children.size(), m_Refs.size(), m_BackPointers.size() );
61 }
std::list< WRL2NODE * > m_Children
Definition: vrml2_node.h:174
std::list< WRL2NODE * > m_Refs
Definition: vrml2_node.h:175
std::list< WRL2NODE * > m_BackPointers
Definition: vrml2_node.h:173
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63

References WRL2NODE::m_BackPointers, WRL2NODE::m_Children, WRL2NODE::m_Refs, and traceVrmlPlugin.

Member Function Documentation

◆ AddChildNode()

bool WRL2POINTSET::AddChildNode ( WRL2NODE aNode)
overridevirtual

Reimplemented from WRL2NODE.

Definition at line 154 of file vrml2_pointset.cpp.

155 {
156  wxCHECK_MSG( aNode, false, wxT( "Invalid node." ) );
157 
158  WRL2NODES type = aNode->GetNodeType();
159 
160  if( !checkNodeType( type ) )
161  {
162  wxLogTrace( traceVrmlPlugin,
163  wxT( "%s:%s:%d\n"
164  " * [INFO] bad file format; unexpected child node '%s'." ),
165  __FILE__, __FUNCTION__, __LINE__, aNode->GetNodeTypeName( type ) );
166 
167  return false;
168  }
169 
170  if( WRL2NODES::WRL2_COLOR == type )
171  {
172  if( nullptr != color )
173  {
174  wxLogTrace( traceVrmlPlugin,
175  wxT( "%s:%s:%d\n"
176  " * [INFO] bad file format; multiple color nodes." ),
177  __FILE__, __FUNCTION__, __LINE__ );
178 
179  return false;
180  }
181 
182  color = aNode;
183  return WRL2NODE::AddChildNode( aNode );
184  }
185 
186  if( WRL2NODES::WRL2_COORDINATE == type )
187  {
188  if( nullptr != coord )
189  {
190  wxLogTrace( traceVrmlPlugin,
191  wxT( "%s:%s:%d\n"
192  " * [INFO] bad file format; multiple coord nodes." ),
193  __FILE__, __FUNCTION__, __LINE__ );
194 
195  return false;
196  }
197 
198  coord = aNode;
199  return WRL2NODE::AddChildNode( aNode );
200  }
201 
202  return WRL2NODE::AddChildNode( aNode );
203 }
WRL2NODE * coord
bool checkNodeType(WRL2NODES aType)
WRL2NODE * color
WRL2NODES GetNodeType(void) const
Definition: vrml2_node.cpp:204
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63
const char * GetNodeTypeName(WRL2NODES aNodeType) const
Definition: vrml2_node.cpp:273
virtual bool AddChildNode(WRL2NODE *aNode)
Definition: vrml2_node.cpp:356
WRL2NODES
Definition: wrltypes.h:124

References WRL2NODE::AddChildNode(), checkNodeType(), color, coord, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), traceVrmlPlugin, WRL2_COLOR, and WRL2_COORDINATE.

◆ addNodeRef()

void WRL2NODE::addNodeRef ( WRL2NODE aNode)
inherited

Add 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 171 of file vrml2_node.cpp.

172 {
173  // the parent node must never be added as a backpointer
174  if( aNode == m_Parent )
175  return;
176 
177  std::list< WRL2NODE* >::iterator np =
178  std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
179 
180  if( np != m_BackPointers.end() )
181  return;
182 
183  m_BackPointers.push_back( aNode );
184 }
WRL2NODE * m_Parent
Definition: vrml2_node.h:169
std::list< WRL2NODE * > m_BackPointers
Definition: vrml2_node.h:173

References WRL2NODE::m_BackPointers, and WRL2NODE::m_Parent.

Referenced by WRL2NODE::AddRefNode().

◆ AddRefNode()

bool WRL2POINTSET::AddRefNode ( WRL2NODE aNode)
overridevirtual

Reimplemented from WRL2NODE.

Definition at line 102 of file vrml2_pointset.cpp.

103 {
104  wxCHECK_MSG( aNode, false, wxT( "Invalid node." ) );
105 
106  WRL2NODES type = aNode->GetNodeType();
107 
108  if( !checkNodeType( type ) )
109  {
110  wxLogTrace( traceVrmlPlugin,
111  wxT( "%s:%s:%d\n"
112  " * [INFO] bad file format; unexpected child node '%s'." ),
113  __FILE__, __FUNCTION__, __LINE__, aNode->GetNodeTypeName( type ) );
114 
115  return false;
116  }
117 
118  if( WRL2NODES::WRL2_COLOR == type )
119  {
120  if( nullptr != color )
121  {
122  wxLogTrace( traceVrmlPlugin,
123  wxT( "%s:%s:%d\n"
124  " * [INFO] bad file format; multiple color nodes." ),
125  __FILE__, __FUNCTION__, __LINE__ );
126 
127  return false;
128  }
129 
130  color = aNode;
131  return WRL2NODE::AddRefNode( aNode );
132  }
133 
134  if( WRL2NODES::WRL2_COORDINATE == type )
135  {
136  if( nullptr != coord )
137  {
138  wxLogTrace( traceVrmlPlugin,
139  wxT( "%s:%s:%d\n"
140  " * [INFO] bad file format; multiple coord nodes." ),
141  __FILE__, __FUNCTION__, __LINE__ );
142 
143  return false;
144  }
145 
146  coord = aNode;
147  return WRL2NODE::AddRefNode( aNode );
148  }
149 
150  return WRL2NODE::AddRefNode( aNode );
151 }
WRL2NODE * coord
bool checkNodeType(WRL2NODES aType)
WRL2NODE * color
WRL2NODES GetNodeType(void) const
Definition: vrml2_node.cpp:204
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63
const char * GetNodeTypeName(WRL2NODES aNodeType) const
Definition: vrml2_node.cpp:273
WRL2NODES
Definition: wrltypes.h:124
virtual bool AddRefNode(WRL2NODE *aNode)
Definition: vrml2_node.cpp:383

References WRL2NODE::AddRefNode(), checkNodeType(), color, coord, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), traceVrmlPlugin, WRL2_COLOR, and WRL2_COORDINATE.

◆ checkNodeType()

bool WRL2POINTSET::checkNodeType ( WRL2NODES  aType)
private
Returns
true if the node type is a valid subnode of PointSet.

Definition at line 71 of file vrml2_pointset.cpp.

72 {
73  // nodes must be one of:
74  // Color
75  // Coordinate
76 
77  switch( aType )
78  {
81  break;
82 
83  default:
84  return false;
85  break;
86  }
87 
88  return true;
89 }

References WRL2_COLOR, and WRL2_COORDINATE.

Referenced by AddChildNode(), and AddRefNode().

◆ delNodeRef()

void WRL2NODE::delNodeRef ( WRL2NODE aNode)
inherited

Remove 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 187 of file vrml2_node.cpp.

188 {
189  std::list< WRL2NODE* >::iterator np =
190  std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
191 
192  if( np != m_BackPointers.end() )
193  {
194  m_BackPointers.erase( np );
195  return;
196  }
197 
198  wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
199  " * [BUG] delNodeRef() did not find its target." ),
200  __FILE__, __FUNCTION__, __LINE__ );
201 }
std::list< WRL2NODE * > m_BackPointers
Definition: vrml2_node.h:173
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63

References WRL2NODE::m_BackPointers, and traceVrmlPlugin.

◆ FindNode()

WRL2NODE * WRL2NODE::FindNode ( const std::string &  aNodeName,
const WRL2NODE aCaller 
)
virtualinherited

Search 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.
aCalleris a pointer to the node invoking this function.
Returns
is a valid node pointer on success or NULL.

Definition at line 305 of file vrml2_node.cpp.

306 {
307  if( aNodeName.empty() )
308  return nullptr;
309 
310  if( !m_Name.compare( aNodeName ) )
311  return this;
312 
313  std::list< WRL2NODE* >::iterator sLA = m_Children.begin();
314  std::list< WRL2NODE* >::iterator eLA = m_Children.end();
315 
316  WRL2NODE* psg = nullptr;
317 
318  while( sLA != eLA )
319  {
320  if( *sLA != aCaller )
321  {
322  psg = (*sLA)->FindNode( aNodeName, this );
323 
324  if( nullptr != psg )
325  return psg;
326 
327  }
328 
329  ++sLA;
330  }
331 
332  if( nullptr != m_Parent && aCaller != m_Parent )
333  return m_Parent->FindNode( aNodeName, this );
334 
335  return nullptr;
336 }
std::list< WRL2NODE * > m_Children
Definition: vrml2_node.h:174
std::string m_Name
Definition: vrml2_node.h:171
WRL2NODE * m_Parent
Definition: vrml2_node.h:169
virtual WRL2NODE * FindNode(const std::string &aNodeName, const WRL2NODE *aCaller)
Search the tree of linked nodes and returns a reference to the first node found with the given name.
Definition: vrml2_node.cpp:305

References WRL2NODE::FindNode(), WRL2NODE::m_Children, WRL2NODE::m_Name, and WRL2NODE::m_Parent.

Referenced by WRL2NODE::FindNode(), and WRL2BASE::implementUse().

◆ GetError()

std::string WRL2NODE::GetError ( void  )
inherited

Definition at line 299 of file vrml2_node.cpp.

300 {
301  return m_error;
302 }
std::string m_error
Definition: vrml2_node.h:176

References WRL2NODE::m_error.

◆ GetName()

std::string WRL2NODE::GetName ( void  )
virtualinherited

Reimplemented in WRL2BASE.

Definition at line 216 of file vrml2_node.cpp.

217 {
218  return m_Name;
219 }
std::string m_Name
Definition: vrml2_node.h:171

References WRL2NODE::m_Name.

◆ GetNodeType()

◆ getNodeTypeID()

WRL2NODES WRL2NODE::getNodeTypeID ( const std::string &  aNodeName)
inherited
Returns
The ID based on the given aNodeName or WRL2_INVALID (WRL2_END) if no such node name exists.

Definition at line 288 of file vrml2_node.cpp.

289 {
290  NODEMAP::iterator it = nodenames.find( aNodeName );
291 
292  if( nodenames.end() != it )
293  return it->second;
294 
296 }
static NODEMAP nodenames
Definition: vrml2_node.cpp:43

References nodenames, and WRL2_INVALID.

Referenced by WRL2BASE::ReadNode().

◆ GetNodeTypeName()

const char * WRL2NODE::GetNodeTypeName ( WRL2NODES  aNodeType) const
inherited

Definition at line 273 of file vrml2_node.cpp.

274 {
275  if( aNodeType < WRL2NODES::WRL2_BASE || aNodeType >= WRL2NODES::WRL2_END )
276  return "*INVALID_TYPE*";
277 
278  if( aNodeType == WRL2NODES::WRL2_BASE )
279  return "*VIRTUAL_BASE*";
280 
281  NODEMAP::iterator it = nodenames.begin();
282  advance( it, (static_cast<int>( aNodeType ) - static_cast<int>( WRL2NODES::WRL2_BEGIN ) ) );
283 
284  return it->first.c_str();
285 }
static NODEMAP nodenames
Definition: vrml2_node.cpp:43

References nodenames, WRL2_BASE, WRL2_BEGIN, and WRL2_END.

Referenced by WRL2APPEARANCE::AddChildNode(), WRL2SHAPE::AddChildNode(), WRL2LINESET::AddChildNode(), AddChildNode(), WRL2FACESET::AddChildNode(), WRL2APPEARANCE::AddRefNode(), WRL2SHAPE::AddRefNode(), WRL2FACESET::AddRefNode(), AddRefNode(), and WRL2LINESET::AddRefNode().

◆ GetParent()

WRL2NODE * WRL2NODE::GetParent ( void  ) const
inherited
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 210 of file vrml2_node.cpp.

211 {
212  return m_Parent;
213 }
WRL2NODE * m_Parent
Definition: vrml2_node.h:169

References WRL2NODE::m_Parent.

Referenced by WRL2NODE::AddChildNode(), WRL2SWITCH::AddRefNode(), WRL2TRANSFORM::AddRefNode(), WRL2APPEARANCE::unlinkChildNode(), unlinkChildNode(), WRL2FACESET::unlinkChildNode(), WRL2LINESET::unlinkChildNode(), WRL2APPEARANCE::unlinkRefNode(), WRL2FACESET::unlinkRefNode(), WRL2LINESET::unlinkRefNode(), and unlinkRefNode().

◆ HasColors()

bool WRL2POINTSET::HasColors ( void  )
Returns
true if the face set has a color node.

Definition at line 336 of file vrml2_pointset.cpp.

337 {
338  if( nullptr == color )
339  return false;
340 
341  return ( (WRL2COLOR*) color )->HasColors();
342 }
WRL2NODE * color

References color.

◆ isDangling()

bool WRL2POINTSET::isDangling ( void  )
overridevirtual

Determine whether an object should be moved to a different parent during the VRML to SG* translation.

Returns
true if the object does not have a parent which is a logical container for the object for example if a Shape has a parent which is a Base node.

Implements WRL2NODE.

Definition at line 92 of file vrml2_pointset.cpp.

93 {
94  // this node is dangling unless it has a parent of type WRL2_SHAPE
95  if( nullptr == m_Parent || m_Parent->GetNodeType() != WRL2NODES::WRL2_SHAPE )
96  return true;
97 
98  return false;
99 }
WRL2NODE * m_Parent
Definition: vrml2_node.h:169
WRL2NODES GetNodeType(void) const
Definition: vrml2_node.cpp:204

References WRL2NODE::GetNodeType(), WRL2NODE::m_Parent, and WRL2_SHAPE.

◆ Read()

bool WRL2POINTSET::Read ( WRLPROC proc,
WRL2BASE aTopNode 
)
overridevirtual

Implements WRL2NODE.

Definition at line 207 of file vrml2_pointset.cpp.

208 {
209  char tok = proc.Peek();
210 
211  if( proc.eof() )
212  {
213  wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
214  " * [INFO] bad file format; unexpected eof %s." ),
215  __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition() );
216 
217  return false;
218  }
219 
220  if( '{' != tok )
221  {
222  wxLogTrace( traceVrmlPlugin,
223  wxT( "%s:%s:%d\n"
224  " * [INFO] bad file format; expecting '{' but got '%s' %s." ),
225  __FILE__, __FUNCTION__, __LINE__, tok, proc.GetFilePosition() );
226 
227  return false;
228  }
229 
230  proc.Pop();
231  std::string glob;
232 
233  while( true )
234  {
235  if( proc.Peek() == '}' )
236  {
237  proc.Pop();
238  break;
239  }
240 
241  if( !proc.ReadName( glob ) )
242  {
243  wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
244  "%s" ),
245  __FILE__, __FUNCTION__, __LINE__ , proc.GetError() );
246 
247  return false;
248  }
249 
250  // expecting one of:
251  // color
252  // coord
253  if( !glob.compare( "color" ) )
254  {
255  if( !aTopNode->ReadNode( proc, this, nullptr ) )
256  {
257  wxLogTrace( traceVrmlPlugin,
258  wxT( "%s:%s:%d\n"
259  " * [INFO] could not read color node information." ),
260  __FILE__, __FUNCTION__, __LINE__ );
261 
262  return false;
263  }
264  }
265  else if( !glob.compare( "coord" ) )
266  {
267  if( !aTopNode->ReadNode( proc, this, nullptr ) )
268  {
269  wxLogTrace( traceVrmlPlugin,
270  wxT( "%s:%s:%d\n"
271  " * [INFO] could not read coord node information." ),
272  __FILE__, __FUNCTION__, __LINE__ );
273 
274  return false;
275  }
276  }
277  else
278  {
279  wxLogTrace( traceVrmlPlugin,
280  wxT( "%s:%s:%d\n"
281  " * [INFO] invalid PointSet %s (no closing brace)\n"
282  " * [INFO] file: '%s'\n" ),
283  __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition(),
284  proc.GetFileName() );
285 
286  return false;
287  }
288  } // while( true ) -- reading contents of PointSet{}
289 
290  return true;
291 }
void Pop(void)
Definition: wrlproc.cpp:2035
bool ReadNode(WRLPROC &proc, WRL2NODE *aParent, WRL2NODE **aNode)
Definition: vrml2_base.cpp:276
std::string GetFilePosition() const
Definition: wrlproc.cpp:1982
char Peek(void)
Definition: wrlproc.cpp:2007
std::string GetFileName(void)
Definition: wrlproc.cpp:1995
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63
bool ReadName(std::string &aName)
Definition: wrlproc.cpp:289
std::string GetError(void)
Definition: wrlproc.cpp:1960
bool eof(void)
Definition: wrlproc.cpp:1954

References WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFileName(), WRLPROC::GetFilePosition(), WRLPROC::Peek(), WRLPROC::Pop(), WRLPROC::ReadName(), WRL2BASE::ReadNode(), and traceVrmlPlugin.

Referenced by WRL2BASE::readPointSet().

◆ setDefaults()

void WRL2POINTSET::setDefaults ( void  )
private

Definition at line 64 of file vrml2_pointset.cpp.

65 {
66  color = nullptr;
67  coord = nullptr;
68 }
WRL2NODE * coord
WRL2NODE * color

References color, and coord.

Referenced by WRL2POINTSET().

◆ SetName()

bool WRL2NODE::SetName ( const std::string &  aName)
virtualinherited

Reimplemented in WRL2BASE.

Definition at line 222 of file vrml2_node.cpp.

223 {
224  if( aName.empty() )
225  return false;
226 
227  std::set< std::string >::iterator item = badNames.find( aName );
228 
229  if( item != badNames.end() )
230  {
231  wxLogTrace( traceVrmlPlugin,
232  wxT( "%s:%s:%d\n"
233  " * [INFO] invalid node name '%s' (matches restricted word)" ),
234  __FILE__, __FUNCTION__, __LINE__, *item );
235 
236  return false;
237  }
238 
239 
240  if( isdigit( aName[0] ) )
241  {
242  wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
243  " * [INFO] invalid node name '%s' (begins with digit)" ),
244  __FILE__, __FUNCTION__, __LINE__, aName );
245 
246  return false;
247  }
248 
249  // The characters '+' and '-' are not allowed in names as per the VRML2 specification;
250  // however many parsers accept them and many bad generators use them so the rules
251  // have been relaxed here.
252  // #define BAD_CHARS1 "\"\'#+,-.\\[]{}\x00\x01\x02\x03\x04\x05\x06\x09\x0A\x0B\x0C\x0D\x0E\x0F"
253  #define BAD_CHARS1 "\"\'#,.\\[]{}\x00\x01\x02\x03\x04\x05\x06\x09\x0A\x0B\x0C\x0D\x0E\x0F"
254  #define BAD_CHARS2 "\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F"
255 
256  if( std::string::npos != aName.find_first_of( BAD_CHARS1 )
257  || std::string::npos != aName.find_first_of( BAD_CHARS2 ) )
258  {
259  wxLogTrace( traceVrmlPlugin,
260  wxT( "%s:%s:%d\n"
261  " * [INFO] invalid node name '%s' (contains invalid character)" ),
262  __FILE__, __FUNCTION__, __LINE__, aName );
263 
264  return false;
265  }
266 
267  m_Name = aName;
268 
269  return true;
270 }
#define BAD_CHARS1
#define BAD_CHARS2
std::string m_Name
Definition: vrml2_node.h:171
const wxChar *const traceVrmlPlugin
Flag to enable VRML plugin trace output.
Definition: vrml.cpp:63
static std::set< std::string > badNames
Definition: vrml2_node.cpp:39

References BAD_CHARS1, BAD_CHARS2, badNames, WRL2NODE::m_Name, and traceVrmlPlugin.

Referenced by WRL2BASE::implementDef().

◆ SetParent()

bool WRL2NODE::SetParent ( WRL2NODE aParent,
bool  doUnlink = true 
)
virtualinherited

Set the parent WRL2NODE 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 of false if the given node is not allowed to be a parent to the derived object.

Reimplemented in WRL2BASE.

Definition at line 339 of file vrml2_node.cpp.

340 {
341  if( aParent == m_Parent )
342  return true;
343 
344  if( nullptr != m_Parent && doUnlink )
345  m_Parent->unlinkChildNode( this );
346 
347  m_Parent = aParent;
348 
349  if( nullptr != m_Parent )
350  m_Parent->AddChildNode( this );
351 
352  return true;
353 }
WRL2NODE * m_Parent
Definition: vrml2_node.h:169
virtual bool AddChildNode(WRL2NODE *aNode)
Definition: vrml2_node.cpp:356
virtual void unlinkChildNode(const WRL2NODE *aNode)
Remove references to an owned child.
Definition: vrml2_node.cpp:407

References WRL2NODE::AddChildNode(), WRL2NODE::m_Parent, and WRL2NODE::unlinkChildNode().

Referenced by WRL2NODE::AddChildNode(), WRL2TRANSFORM::AddRefNode(), and WRL2SWITCH::AddRefNode().

◆ TranslateToSG()

SGNODE * WRL2POINTSET::TranslateToSG ( SGNODE aParent)
overridevirtual

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

Implements WRL2NODE.

Definition at line 294 of file vrml2_pointset.cpp.

295 {
296  // note: there are no plans to support drawing of points
297  return nullptr;
298 }

◆ unlinkChildNode()

void WRL2POINTSET::unlinkChildNode ( const WRL2NODE aNode)
overridevirtual

Remove 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 from WRL2NODE.

Definition at line 301 of file vrml2_pointset.cpp.

302 {
303  if( nullptr == aNode )
304  return;
305 
306  if( aNode->GetParent() == this )
307  {
308  if( aNode == color )
309  color = nullptr;
310  else if( aNode == coord )
311  coord = nullptr;
312  }
313 
314  WRL2NODE::unlinkChildNode( aNode );
315 }
WRL2NODE * coord
WRL2NODE * color
WRL2NODE * GetParent(void) const
Definition: vrml2_node.cpp:210
virtual void unlinkChildNode(const WRL2NODE *aNode)
Remove references to an owned child.
Definition: vrml2_node.cpp:407

References color, coord, WRL2NODE::GetParent(), and WRL2NODE::unlinkChildNode().

◆ unlinkRefNode()

void WRL2POINTSET::unlinkRefNode ( const WRL2NODE aNode)
overridevirtual

Remove 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 from WRL2NODE.

Definition at line 318 of file vrml2_pointset.cpp.

319 {
320  if( nullptr == aNode )
321  return;
322 
323  if( aNode->GetParent() != this )
324  {
325  if( aNode == color )
326  color = nullptr;
327  else if( aNode == coord )
328  coord = nullptr;
329 
330  }
331 
332  WRL2NODE::unlinkRefNode( aNode );
333 }
WRL2NODE * coord
WRL2NODE * color
virtual void unlinkRefNode(const WRL2NODE *aNode)
Remove pointers to a referenced node.
Definition: vrml2_node.cpp:425
WRL2NODE * GetParent(void) const
Definition: vrml2_node.cpp:210

References color, coord, WRL2NODE::GetParent(), and WRL2NODE::unlinkRefNode().

Member Data Documentation

◆ color

WRL2NODE* WRL2POINTSET::color
private

◆ coord

WRL2NODE* WRL2POINTSET::coord
private

◆ m_BackPointers

◆ m_Children

◆ m_error

std::string WRL2NODE::m_error
protectedinherited

Definition at line 176 of file vrml2_node.h.

Referenced by WRL2NODE::GetError().

◆ m_Name

std::string WRL2NODE::m_Name
protectedinherited

Definition at line 171 of file vrml2_node.h.

Referenced by WRL2NODE::FindNode(), WRL2NODE::GetName(), and WRL2NODE::SetName().

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type


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