#include <x3d_shape.h>

Inheritance diagram for X3DSHAPE:

Public Member Functions
	X3DSHAPE ()

	X3DSHAPE (X3DNODE *aParent)

virtual	~X3DSHAPE ()

bool	Read (wxXmlNode aNode, X3DNODE aTopNode, X3D_DICT &aDict) override

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

bool	AddChildNode (X3DNODE *aNode) override

bool	AddRefNode (X3DNODE *aNode) override

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

virtual void	unlinkChildNode (const X3DNODE *aNode) override
	Remove references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references.

virtual void	unlinkRefNode (const X3DNODE *aNode) override
	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.

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

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

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

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

wxString	GetName (void) const
	Return the name of this object.

std::string	GetError (void)

Protected Attributes
X3DNODE *	m_Parent

X3DNODES	m_Type

X3D_DICT *	m_Dict

std::list< X3DNODE * >	m_BackPointers

std::list< X3DNODE * >	m_Children

std::list< X3DNODE * >	m_Refs

std::string	m_error

wxString	m_Name

SGNODE *	m_sgNode

Private Attributes
X3DNODE *	appearance

X3DNODE *	geometry

Detailed Description

Definition at line 39 of file x3d_shape.h.

Constructor & Destructor Documentation

◆ X3DSHAPE() [1/2]

X3DSHAPE::X3DSHAPE ( )

Definition at line 35 of file x3d_shape.cpp.

References appearance, geometry, X3DNODE::m_Type, and X3D_SHAPE.

◆ X3DSHAPE() [2/2]

X3DSHAPE::X3DSHAPE ( X3DNODE * aParent )

Definition at line 43 of file x3d_shape.cpp.

References X3DNODE::AddChildNode(), appearance, geometry, X3DNODE::GetNodeType(), X3DNODE::m_Parent, X3DNODE::m_Type, X3D_SHAPE, X3D_SWITCH, and X3D_TRANSFORM.

◆ ~X3DSHAPE()

X3DSHAPE::~X3DSHAPE ( )

virtual

Definition at line 62 of file x3d_shape.cpp.

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

Member Function Documentation

◆ AddChildNode()

bool X3DSHAPE::AddChildNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 138 of file x3d_shape.cpp.

References appearance, geometry, X3DNODE::GetNodeType(), X3DNODE::GetParent(), X3DNODE::m_Children, X3DNODE::SetParent(), X3D_APPEARANCE, and X3D_INDEXED_FACE_SET.

◆ addNodeRef()

void X3DNODE::addNodeRef ( X3DNODE * 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 142 of file x3d_base.cpp.

References X3DNODE::m_BackPointers, and X3DNODE::m_Parent.

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

◆ AddRefNode()

bool X3DSHAPE::AddRefNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 191 of file x3d_shape.cpp.

References X3DNODE::addNodeRef(), appearance, geometry, X3DNODE::GetNodeType(), X3DNODE::m_Refs, X3D_APPEARANCE, and X3D_INDEXED_FACE_SET.

◆ delNodeRef()

void X3DNODE::delNodeRef ( X3DNODE * 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 165 of file x3d_base.cpp.

References X3DNODE::m_BackPointers, and traceVrmlPlugin.

◆ GetError()

std::string X3DNODE::GetError ( void )

inherited

Definition at line 202 of file x3d_base.cpp.

References X3DNODE::m_error.

◆ GetName()

wxString X3DNODE::GetName ( void ) const

inherited

Return the name of this object.

Definition at line 196 of file x3d_base.cpp.

References X3DNODE::m_Name.

◆ GetNodeType()

X3DNODES X3DNODE::GetNodeType ( void ) const

inherited

Return the type of this node instance.

Definition at line 184 of file x3d_base.cpp.

References X3DNODE::m_Type.

Referenced by X3DIFACESET::AddChildNode(), AddChildNode(), X3DTRANSFORM::AddChildNode(), X3DIFACESET::AddRefNode(), AddRefNode(), X3DTRANSFORM::AddRefNode(), X3DAPP::readFields(), X3DAPP::SetParent(), X3DCOORDS::SetParent(), X3DIFACESET::SetParent(), SetParent(), X3DTRANSFORM::SetParent(), X3DAPP::X3DAPP(), X3DCOORDS::X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DSHAPE(), and X3DTRANSFORM::X3DTRANSFORM().

◆ GetParent()

X3DNODE * X3DNODE::GetParent ( void ) const

inherited

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

top level transform).

Definition at line 190 of file x3d_base.cpp.

References X3DNODE::m_Parent.

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

◆ Read()

bool X3DSHAPE::Read	(	wxXmlNode *	aNode,
		X3DNODE *	aTopNode,
		X3D_DICT &	aDict
	)

overridevirtual

Implements X3DNODE.

Definition at line 71 of file x3d_shape.cpp.

References X3D_DICT::AddName(), appearance, geometry, X3DNODE::m_Dict, X3DNODE::m_Name, name, X3D::ReadAppearance(), X3D::ReadIndexedFaceSet(), and SetParent().

◆ SetParent()

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

overridevirtual

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

Implements X3DNODE.

Definition at line 113 of file x3d_shape.cpp.

References X3DNODE::AddChildNode(), X3DNODE::GetNodeType(), X3DNODE::m_Parent, X3DNODE::unlinkChildNode(), X3D_SWITCH, and X3D_TRANSFORM.

Referenced by Read().

◆ TranslateToSG()

SGNODE * X3DSHAPE::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 X3DNODE.

Definition at line 243 of file x3d_shape.cpp.

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

◆ unlinkChildNode()

void X3DSHAPE::unlinkChildNode ( const X3DNODE * 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

aNode is the child which is being deleted.

Reimplemented from X3DNODE.

Definition at line 315 of file x3d_shape.cpp.

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

◆ unlinkRefNode()

void X3DSHAPE::unlinkRefNode ( const X3DNODE * 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

aNode is the node which is being deleted.

Reimplemented from X3DNODE.

Definition at line 329 of file x3d_shape.cpp.

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

Member Data Documentation

◆ appearance

X3DNODE* X3DSHAPE::appearance

private

Definition at line 56 of file x3d_shape.h.

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

◆ geometry

X3DNODE* X3DSHAPE::geometry

private

Definition at line 57 of file x3d_shape.h.

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

◆ m_BackPointers

std::list< X3DNODE* > X3DNODE::m_BackPointers

protectedinherited

Definition at line 163 of file x3d_base.h.

Referenced by X3DNODE::addNodeRef(), X3DNODE::delNodeRef(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), TranslateToSG(), X3DTRANSFORM::TranslateToSG(), ~X3DSHAPE(), and X3DTRANSFORM::~X3DTRANSFORM().

◆ m_Children

std::list< X3DNODE* > X3DNODE::m_Children

protectedinherited

Definition at line 164 of file x3d_base.h.

Referenced by X3DIFACESET::AddChildNode(), AddChildNode(), X3DTRANSFORM::AddChildNode(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DNODE::unlinkChildNode(), ~X3DSHAPE(), and X3DTRANSFORM::~X3DTRANSFORM().

◆ m_Dict

X3D_DICT* X3DNODE::m_Dict

protectedinherited

Definition at line 161 of file x3d_base.h.

Referenced by X3DAPP::Read(), X3DCOORDS::Read(), X3DIFACESET::Read(), Read(), X3DTRANSFORM::Read(), X3DAPP::readFields(), X3DIFACESET::readFields(), X3DTRANSFORM::readFields(), X3DNODE::X3DNODE(), X3DAPP::~X3DAPP(), and X3DNODE::~X3DNODE().

◆ m_error

std::string X3DNODE::m_error

protectedinherited

Definition at line 166 of file x3d_base.h.

Referenced by X3DNODE::GetError().

◆ m_Name

wxString X3DNODE::m_Name

protectedinherited

Definition at line 168 of file x3d_base.h.

Referenced by X3DNODE::GetName(), X3DAPP::Read(), X3DCOORDS::Read(), Read(), X3DIFACESET::readFields(), X3DTRANSFORM::readFields(), and X3DNODE::~X3DNODE().

◆ m_Parent

X3DNODE* X3DNODE::m_Parent

protectedinherited

Definition at line 159 of file x3d_base.h.

Referenced by X3DNODE::addNodeRef(), X3DNODE::GetParent(), X3DAPP::SetParent(), X3DCOORDS::SetParent(), X3DIFACESET::SetParent(), SetParent(), X3DTRANSFORM::SetParent(), X3DAPP::X3DAPP(), X3DCOORDS::X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DNODE::X3DNODE(), X3DSHAPE(), and X3DTRANSFORM::X3DTRANSFORM().

◆ m_Refs

std::list< X3DNODE* > X3DNODE::m_Refs

protectedinherited

Definition at line 165 of file x3d_base.h.

Referenced by X3DIFACESET::AddRefNode(), AddRefNode(), X3DTRANSFORM::AddRefNode(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DNODE::unlinkRefNode(), ~X3DSHAPE(), and X3DTRANSFORM::~X3DTRANSFORM().

◆ m_sgNode

SGNODE* X3DNODE::m_sgNode

protectedinherited

Definition at line 169 of file x3d_base.h.

Referenced by X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), TranslateToSG(), X3DTRANSFORM::TranslateToSG(), and X3DNODE::X3DNODE().

◆ m_Type

X3DNODES X3DNODE::m_Type

protectedinherited

Definition at line 160 of file x3d_base.h.

Referenced by X3DNODE::GetNodeType(), X3DAPP::X3DAPP(), X3DCOORDS::X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DNODE::X3DNODE(), X3DSHAPE(), and X3DTRANSFORM::X3DTRANSFORM().

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ X3DSHAPE() [1/2]

◆ X3DSHAPE() [2/2]

◆ ~X3DSHAPE()

Member Function Documentation

◆ AddChildNode()

◆ addNodeRef()

◆ AddRefNode()

◆ delNodeRef()

◆ GetError()

◆ GetName()

◆ GetNodeType()

◆ GetParent()

◆ Read()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ appearance

◆ geometry

◆ m_BackPointers

◆ m_Children

◆ m_Dict

◆ m_error

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type