The base class of all VRML1 nodes. More...

#include <vrml1_node.h>

Inheritance diagram for WRL1NODE:

Public Member Functions
void	cancelDict (void)

WRL1NODES	getNodeTypeID (const std::string &aNodeName)
	Return the ID based on the given aNodeName or WRL1_INVALID (WRL1_END) if no such node name exists. More...

virtual void	unlinkChildNode (const WRL1NODE *aNode)
	Remove 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 WRL1NODE *aNode)
	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. More...

void	addNodeRef (WRL1NODE *aNode)
	Add a pointer to a node which references, but does not own, this node. More...

void	delNodeRef (WRL1NODE *aNode)
	Remove a pointer to a node which references, but does not own, this node. More...

	WRL1NODE (NAMEREGISTER *aDictionary)

virtual	~WRL1NODE ()

virtual bool	Read (WRLPROC &proc, WRL1BASE *aTopNode)=0

WRL1NODES	GetNodeType (void) const
	Return the type of this node instance. More...

WRL1NODE *	GetParent (void) const
	Return a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie. More...

virtual bool	SetParent (WRL1NODE *aParent, bool doUnlink=true)
	Set the parent WRL1NODE of this object. More...

virtual std::string	GetName (void)

virtual bool	SetName (const std::string &aName)

const char *	GetNodeTypeName (WRL1NODES aNodeType) const

size_t	GetNItems (void) const

virtual WRL1NODE *	FindNode (const std::string &aNodeName)
	Search the tree of linked nodes and returns a reference to the current node with the given name. More...

virtual bool	AddChildNode (WRL1NODE *aNode)

virtual bool	AddRefNode (WRL1NODE *aNode)

std::string	GetError (void)

virtual SGNODE *	TranslateToSG (SGNODE aParent, WRL1STATUS sp)=0
	Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library. More...

Protected Attributes
WRL1NODE *	m_Parent

WRL1NODES	m_Type

std::string	m_Name

std::list< WRL1NODE * >	m_BackPointers

std::list< WRL1NODE * >	m_Children

std::list< WRL1NODE * >	m_Refs

std::list< WRL1NODE * >	m_Items

std::string	m_error

WRL1STATUS	m_current

SGNODE *	m_sgNode

NAMEREGISTER *	m_dictionary

Private Member Functions
void	addItem (WRL1NODE *aNode)

void	delItem (const WRL1NODE *aNode)

Detailed Description

The base class of all VRML1 nodes.

Definition at line 116 of file vrml1_node.h.

Constructor & Destructor Documentation

◆ WRL1NODE()

WRL1NODE::WRL1NODE ( NAMEREGISTER * aDictionary )

Definition at line 91 of file vrml1_node.cpp.

References m_dictionary, m_Parent, m_sgNode, m_Type, and nodenames.

◆ ~WRL1NODE()

WRL1NODE::~WRL1NODE ( )

virtual

Definition at line 139 of file vrml1_node.cpp.

References NAMEREGISTER::DelName(), m_BackPointers, m_Children, m_dictionary, m_Items, m_Name, m_Parent, m_Refs, m_Type, traceVrmlPlugin, and unlinkChildNode().

Member Function Documentation

◆ AddChildNode()

bool WRL1NODE::AddChildNode ( WRL1NODE * aNode )

virtual

Reimplemented in WRL1COORDS, WRL1FACESET, WRL1MATBINDING, WRL1MATERIAL, WRL1SHAPEHINTS, and WRL1TRANSFORM.

Definition at line 376 of file vrml1_node.cpp.

References addItem(), GetNodeType(), GetParent(), m_Children, and SetParent().

Referenced by SetParent(), WRL1COORDS::WRL1COORDS(), WRL1FACESET::WRL1FACESET(), WRL1GROUP::WRL1GROUP(), WRL1MATBINDING::WRL1MATBINDING(), WRL1MATERIAL::WRL1MATERIAL(), WRL1SEPARATOR::WRL1SEPARATOR(), WRL1SHAPEHINTS::WRL1SHAPEHINTS(), WRL1SWITCH::WRL1SWITCH(), and WRL1TRANSFORM::WRL1TRANSFORM().

◆ addItem()

void WRL1NODE::addItem ( WRL1NODE * aNode )

private

Definition at line 458 of file vrml1_node.cpp.

References m_Items.

Referenced by AddChildNode(), and AddRefNode().

◆ addNodeRef()

void WRL1NODE::addNodeRef ( WRL1NODE * aNode )

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

aNode is the node holding a reference to this object.

Definition at line 216 of file vrml1_node.cpp.

References m_BackPointers, and m_Parent.

Referenced by AddRefNode().

◆ AddRefNode()

bool WRL1NODE::AddRefNode ( WRL1NODE * aNode )

virtual

Reimplemented in WRL1COORDS, WRL1FACESET, WRL1MATBINDING, WRL1MATERIAL, WRL1SHAPEHINTS, and WRL1TRANSFORM.

Definition at line 403 of file vrml1_node.cpp.

References addItem(), addNodeRef(), GetNodeType(), and m_Refs.

Referenced by WRL1BASE::implementUse().

◆ cancelDict()

void WRL1NODE::cancelDict ( void )

Definition at line 198 of file vrml1_node.cpp.

References m_Children, m_dictionary, and m_Type.

Referenced by WRL1BASE::~WRL1BASE().

◆ delItem()

void WRL1NODE::delItem ( const WRL1NODE * aNode )

private

Definition at line 464 of file vrml1_node.cpp.

References m_Items.

Referenced by unlinkChildNode(), and unlinkRefNode().

◆ delNodeRef()

void WRL1NODE::delNodeRef ( WRL1NODE * aNode )

Remove a pointer to a node which references, but does not own, this node.

Parameters

aNode is the node holding a reference to this object.

Definition at line 237 of file vrml1_node.cpp.

References m_BackPointers, and traceVrmlPlugin.

◆ FindNode()

WRL1NODE * WRL1NODE::FindNode ( const std::string & aNodeName )

virtual

Search the tree of linked nodes and returns a reference to the current node with the given name.

The reference is then typically added to another node via AddRefNode().

Parameters

aNodeName is the name of the node to search for.

Returns: is a valid node pointer on success, otherwise NULL.

Definition at line 350 of file vrml1_node.cpp.

References NAMEREGISTER::FindName(), and m_dictionary.

Referenced by WRL1BASE::implementUse().

◆ GetError()

std::string WRL1NODE::GetError ( void )

Definition at line 344 of file vrml1_node.cpp.

References m_error.

◆ GetName()

std::string WRL1NODE::GetName ( void )

virtual

Reimplemented in WRL1BASE.

Definition at line 266 of file vrml1_node.cpp.

References m_Name.

◆ GetNItems()

size_t WRL1NODE::GetNItems ( void ) const

Definition at line 338 of file vrml1_node.cpp.

References m_Items.

◆ GetNodeType()

WRL1NODES WRL1NODE::GetNodeType ( void ) const

Return the type of this node instance.

Definition at line 254 of file vrml1_node.cpp.

References m_Type.

Referenced by AddChildNode(), AddRefNode(), WRL1BASE::implementUse(), WRL1GROUP::TranslateToSG(), and WRL1TRANSFORM::TranslateToSG().

◆ getNodeTypeID()

WRL1NODES WRL1NODE::getNodeTypeID ( const std::string & aNodeName )

Return the ID based on the given aNodeName or WRL1_INVALID (WRL1_END) if no such node name exists.

Definition at line 327 of file vrml1_node.cpp.

References nodenames.

Referenced by WRL1BASE::ReadNode().

◆ GetNodeTypeName()

const char * WRL1NODE::GetNodeTypeName ( WRL1NODES aNodeType ) const

Definition at line 312 of file vrml1_node.cpp.

References nodenames.

Referenced by WRL1BASE::implementUse().

◆ GetParent()

WRL1NODE * WRL1NODE::GetParent ( void ) const

Return a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.

top level transform).

Definition at line 260 of file vrml1_node.cpp.

References m_Parent.

Referenced by AddChildNode().

◆ Read()

virtual bool WRL1NODE::Read	(	WRLPROC &	proc,
		WRL1BASE *	aTopNode
	)

pure virtual

Implemented in WRL1BASE, WRL1COORDS, WRL1FACESET, WRL1GROUP, WRL1MATBINDING, WRL1MATERIAL, WRL1SEPARATOR, WRL1SHAPEHINTS, WRL1SWITCH, and WRL1TRANSFORM.

◆ SetName()

bool WRL1NODE::SetName ( const std::string & aName )

virtual

Reimplemented in WRL1BASE.

Definition at line 272 of file vrml1_node.cpp.

References NAMEREGISTER::AddName(), BAD_CHARS1, BAD_CHARS2, m_dictionary, m_Name, and traceVrmlPlugin.

Referenced by WRL1BASE::implementDef().

◆ SetParent()

bool WRL1NODE::SetParent	(	WRL1NODE *	aParent,
		bool	doUnlink = `true`
	)

virtual

Set the parent WRL1NODE of this object.

Parameters

aParent	[in] is the desired parent node.
doUnlink	indicates 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.

Reimplemented in WRL1BASE.

Definition at line 359 of file vrml1_node.cpp.

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

Referenced by AddChildNode().

◆ TranslateToSG()

virtual SGNODE * WRL1NODE::TranslateToSG	(	SGNODE *	aParent,
		WRL1STATUS *	sp
	)

pure virtual

Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library.

Parameters

aParent is a pointer to the parent SG node.

Returns: is non-NULL on success.

Implemented in WRL1BASE, WRL1COORDS, WRL1FACESET, WRL1GROUP, WRL1MATBINDING, WRL1MATERIAL, WRL1SEPARATOR, WRL1SHAPEHINTS, WRL1SWITCH, and WRL1TRANSFORM.

◆ unlinkChildNode()

void WRL1NODE::unlinkChildNode ( const WRL1NODE * aNode )

virtual

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

Parameters

aNode is the child which is being deleted.

Definition at line 420 of file vrml1_node.cpp.

References delItem(), and m_Children.

Referenced by SetParent(), and ~WRL1NODE().

◆ unlinkRefNode()

void WRL1NODE::unlinkRefNode ( const WRL1NODE * aNode )

virtual

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

aNode is the node which is being deleted.

Definition at line 439 of file vrml1_node.cpp.

References delItem(), and m_Refs.

Member Data Documentation

◆ m_BackPointers

std::list< WRL1NODE* > WRL1NODE::m_BackPointers

protected

Definition at line 230 of file vrml1_node.h.

Referenced by addNodeRef(), delNodeRef(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), ~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_Children

std::list< WRL1NODE* > WRL1NODE::m_Children

protected

Definition at line 231 of file vrml1_node.h.

Referenced by AddChildNode(), cancelDict(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), unlinkChildNode(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), ~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_current

WRL1STATUS WRL1NODE::m_current

protected

Definition at line 236 of file vrml1_node.h.

Referenced by WRL1BASE::TranslateToSG(), WRL1FACESET::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), and WRL1SWITCH::TranslateToSG().

◆ m_dictionary

NAMEREGISTER* WRL1NODE::m_dictionary

protected

Definition at line 246 of file vrml1_node.h.

Referenced by cancelDict(), FindNode(), WRL1BASE::implementDef(), WRL1BASE::readCoords(), WRL1BASE::readFaceSet(), WRL1BASE::readGroup(), WRL1BASE::readMatBinding(), WRL1BASE::readMaterial(), WRL1BASE::readSeparator(), WRL1BASE::readShapeHints(), WRL1BASE::readSwitch(), WRL1BASE::readTransform(), SetName(), WRL1BASE::WRL1BASE(), WRL1NODE(), and ~WRL1NODE().

◆ m_error

std::string WRL1NODE::m_error

protected

Definition at line 234 of file vrml1_node.h.

Referenced by GetError().

◆ m_Items

std::list< WRL1NODE* > WRL1NODE::m_Items

protected

Definition at line 233 of file vrml1_node.h.

Referenced by addItem(), delItem(), GetNItems(), WRL1BASE::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), and ~WRL1NODE().

◆ m_Name

std::string WRL1NODE::m_Name

protected

Definition at line 228 of file vrml1_node.h.

Referenced by GetName(), SetName(), and ~WRL1NODE().

◆ m_Parent

WRL1NODE* WRL1NODE::m_Parent

protected

◆ m_Refs

std::list< WRL1NODE* > WRL1NODE::m_Refs

protected

Definition at line 232 of file vrml1_node.h.

Referenced by AddRefNode(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), unlinkRefNode(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), ~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_sgNode

SGNODE* WRL1NODE::m_sgNode

protected

Definition at line 237 of file vrml1_node.h.

Referenced by WRL1NODE().

◆ m_Type

WRL1NODES WRL1NODE::m_Type

protected

Definition at line 227 of file vrml1_node.h.

Referenced by cancelDict(), GetNodeType(), WRL1BASE::WRL1BASE(), WRL1COORDS::WRL1COORDS(), WRL1FACESET::WRL1FACESET(), WRL1GROUP::WRL1GROUP(), WRL1MATBINDING::WRL1MATBINDING(), WRL1MATERIAL::WRL1MATERIAL(), WRL1NODE(), WRL1SEPARATOR::WRL1SEPARATOR(), WRL1SHAPEHINTS::WRL1SHAPEHINTS(), WRL1SWITCH::WRL1SWITCH(), WRL1TRANSFORM::WRL1TRANSFORM(), and ~WRL1NODE().

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WRL1NODE()

◆ ~WRL1NODE()

Member Function Documentation

◆ AddChildNode()

◆ addItem()

◆ addNodeRef()

◆ AddRefNode()

◆ cancelDict()

◆ delItem()

◆ delNodeRef()

◆ FindNode()

◆ GetError()

◆ GetName()

◆ GetNItems()

◆ GetNodeType()

◆ getNodeTypeID()

◆ GetNodeTypeName()

◆ GetParent()

◆ Read()

◆ SetName()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ m_BackPointers

◆ m_Children

◆ m_current

◆ m_dictionary

◆ m_error

◆ m_Items

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type