#include <vrml2_shape.h>

Inheritance diagram for WRL2SHAPE:

Public Member Functions
	WRL2SHAPE ()

	WRL2SHAPE (WRL2NODE *aParent)

virtual	~WRL2SHAPE ()

bool	Read (WRLPROC &proc, WRL2BASE *aTopNode) override

bool	AddRefNode (WRL2NODE *aNode) override

bool	AddChildNode (WRL2NODE *aNode) override

SGNODE *	TranslateToSG (SGNODE *aParent) override
	Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library.

bool	isDangling (void) override
	Determine whether an object should be moved to a different parent during the VRML to SG* translation.

WRL2NODES	GetNodeType (void) const

WRL2NODE *	GetParent (void) const

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

virtual std::string	GetName (void)

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

const char *	GetNodeTypeName (WRL2NODES aNodeType) const

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.

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.

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

Protected Attributes
WRL2NODE *	m_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

SGNODE *	m_sgNode

Private Member Functions
bool	checkNodeType (WRL2NODES aType)

void	unlinkChildNode (const WRL2NODE *aNode) override
	Remove references to an owned child.

void	unlinkRefNode (const WRL2NODE *aNode) override
	Remove pointers to a referenced node.

Private Attributes
WRL2NODE *	appearance

WRL2NODE *	geometry

Detailed Description

Definition at line 38 of file vrml2_shape.h.

Constructor & Destructor Documentation

◆ WRL2SHAPE() [1/2]

WRL2SHAPE::WRL2SHAPE ( )

Definition at line 36 of file vrml2_shape.cpp.

References appearance, geometry, and WRL2NODE::m_Type.

◆ WRL2SHAPE() [2/2]

WRL2SHAPE::WRL2SHAPE ( WRL2NODE * aParent )

Definition at line 44 of file vrml2_shape.cpp.

References WRL2NODE::AddChildNode(), appearance, geometry, WRL2NODE::m_Parent, and WRL2NODE::m_Type.

◆ ~WRL2SHAPE()

WRL2SHAPE::~WRL2SHAPE ( )

virtual

Definition at line 56 of file vrml2_shape.cpp.

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

Member Function Documentation

◆ AddChildNode()

bool WRL2SHAPE::AddChildNode ( WRL2NODE * aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 127 of file vrml2_shape.cpp.

References WRL2NODE::AddChildNode(), appearance, checkNodeType(), geometry, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), and traceVrmlPlugin.

◆ 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

aNode is the node holding a reference to this object.

Definition at line 171 of file vrml2_node.cpp.

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

Referenced by WRL2NODE::AddRefNode().

◆ AddRefNode()

bool WRL2SHAPE::AddRefNode ( WRL2NODE * aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 80 of file vrml2_shape.cpp.

References WRL2NODE::AddRefNode(), appearance, checkNodeType(), geometry, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), and traceVrmlPlugin.

◆ checkNodeType()

bool WRL2SHAPE::checkNodeType ( WRL2NODES aType )

private

Returns: true if the node type is an appearance or geometry class.

Definition at line 174 of file vrml2_shape.cpp.

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

aNode is the node holding a reference to this object

Definition at line 187 of file vrml2_node.cpp.

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

aNodeName	is the name of the node to search for.
aCaller	is 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.

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.

References WRL2NODE::m_error.

◆ GetName()

std::string WRL2NODE::GetName ( void )

virtualinherited

Reimplemented in WRL2BASE.

Definition at line 216 of file vrml2_node.cpp.

References WRL2NODE::m_Name.

◆ GetNodeType()

WRL2NODES WRL2NODE::GetNodeType ( void ) const

inherited

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

References nodenames.

Referenced by WRL2BASE::ReadNode().

◆ GetNodeTypeName()

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

inherited

Definition at line 273 of file vrml2_node.cpp.

References nodenames.

Referenced by WRL2APPEARANCE::AddChildNode(), WRL2FACESET::AddChildNode(), WRL2LINESET::AddChildNode(), WRL2POINTSET::AddChildNode(), AddChildNode(), WRL2APPEARANCE::AddRefNode(), WRL2FACESET::AddRefNode(), WRL2LINESET::AddRefNode(), WRL2POINTSET::AddRefNode(), and 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.

References WRL2NODE::m_Parent.

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

◆ isDangling()

bool WRL2SHAPE::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 65 of file vrml2_shape.cpp.

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

◆ Read()

bool WRL2SHAPE::Read	(	WRLPROC &	proc,
		WRL2BASE *	aTopNode
	)

overridevirtual

Implements WRL2NODE.

Definition at line 200 of file vrml2_shape.cpp.

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

Referenced by WRL2BASE::readShape().

◆ SetName()

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

virtualinherited

Reimplemented in WRL2BASE.

Definition at line 222 of file vrml2_node.cpp.

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.
doUnlink	indicates 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.

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

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

◆ TranslateToSG()

SGNODE * WRL2SHAPE::TranslateToSG ( SGNODE * aParent )

overridevirtual

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.

Implements WRL2NODE.

Definition at line 289 of file vrml2_shape.cpp.

References S3D::AddSGNodeChild(), S3D::AddSGNodeRef(), appearance, IFSG_FACESET::Attach(), IFSG_NODE::Destroy(), geometry, WRL2NODE::GetNodeType(), IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), S3D::GetSGNodeType(), WRL2NODE::m_BackPointers, WRL2NODE::m_Children, WRL2NODE::m_Refs, WRL2NODE::m_sgNode, S3D::SGTYPE_TRANSFORM, traceVrmlPlugin, and WRL2NODE::TranslateToSG().

◆ unlinkChildNode()

void WRL2SHAPE::unlinkChildNode ( const WRL2NODE * aNode )

overrideprivatevirtual

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.

Reimplemented from WRL2NODE.

Definition at line 386 of file vrml2_shape.cpp.

References appearance, geometry, and WRL2NODE::unlinkChildNode().

◆ unlinkRefNode()

void WRL2SHAPE::unlinkRefNode ( const WRL2NODE * aNode )

overrideprivatevirtual

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.

Reimplemented from WRL2NODE.

Definition at line 400 of file vrml2_shape.cpp.

References appearance, geometry, and WRL2NODE::unlinkRefNode().

Member Data Documentation

◆ appearance

WRL2NODE* WRL2SHAPE::appearance

private

Definition at line 61 of file vrml2_shape.h.

Referenced by AddChildNode(), AddRefNode(), TranslateToSG(), unlinkChildNode(), unlinkRefNode(), and WRL2SHAPE().

◆ geometry

WRL2NODE* WRL2SHAPE::geometry

private

Definition at line 62 of file vrml2_shape.h.

Referenced by AddChildNode(), AddRefNode(), TranslateToSG(), unlinkChildNode(), unlinkRefNode(), and WRL2SHAPE().

◆ m_BackPointers

std::list< WRL2NODE* > WRL2NODE::m_BackPointers

protectedinherited

Definition at line 173 of file vrml2_node.h.

Referenced by WRL2NODE::addNodeRef(), WRL2NODE::delNodeRef(), WRL2APPEARANCE::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), ~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

◆ m_Children

std::list< WRL2NODE* > WRL2NODE::m_Children

protectedinherited

◆ 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

WRL2NODE* WRL2NODE::m_Parent

protectedinherited

◆ m_Refs

std::list< WRL2NODE* > WRL2NODE::m_Refs

protectedinherited

Definition at line 175 of file vrml2_node.h.

Referenced by WRL2NODE::AddRefNode(), WRL2APPEARANCE::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2NODE::unlinkRefNode(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), ~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

◆ m_sgNode

SGNODE* WRL2NODE::m_sgNode

protectedinherited

Definition at line 178 of file vrml2_node.h.

Referenced by WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), and WRL2NODE::WRL2NODE().

◆ m_Type

WRL2NODES WRL2NODE::m_Type

protectedinherited

Definition at line 170 of file vrml2_node.h.

Referenced by WRL2NODE::GetNodeType(), WRL2APPEARANCE::WRL2APPEARANCE(), WRL2BASE::WRL2BASE(), WRL2BOX::WRL2BOX(), WRL2COLOR::WRL2COLOR(), WRL2COORDS::WRL2COORDS(), WRL2FACESET::WRL2FACESET(), WRL2INLINE::WRL2INLINE(), WRL2LINESET::WRL2LINESET(), WRL2MATERIAL::WRL2MATERIAL(), WRL2NODE::WRL2NODE(), WRL2NORMS::WRL2NORMS(), WRL2POINTSET::WRL2POINTSET(), WRL2SHAPE(), WRL2SWITCH::WRL2SWITCH(), and WRL2TRANSFORM::WRL2TRANSFORM().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WRL2SHAPE() [1/2]

◆ WRL2SHAPE() [2/2]

◆ ~WRL2SHAPE()

Member Function Documentation

◆ AddChildNode()

◆ addNodeRef()

◆ AddRefNode()

◆ checkNodeType()

◆ delNodeRef()

◆ FindNode()

◆ GetError()

◆ GetName()

◆ GetNodeType()

◆ getNodeTypeID()

◆ GetNodeTypeName()

◆ GetParent()

◆ isDangling()

◆ Read()

◆ SetName()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ appearance

◆ geometry

◆ m_BackPointers

◆ m_Children

◆ m_error

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type