#include <x3d_coords.h>

Inheritance diagram for X3DCOORDS:

Public Member Functions
	X3DCOORDS ()

	X3DCOORDS (X3DNODE *aParent)

virtual	~X3DCOORDS ()

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.

void	GetCoords (WRLVEC3F *&aCoordList, size_t &aListSize)

virtual void	unlinkChildNode (const X3DNODE *aNode)
	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)
	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
std::vector< WRLVEC3F >	points

Detailed Description

Definition at line 39 of file x3d_coords.h.

Constructor & Destructor Documentation

◆ X3DCOORDS() [1/2]

X3DCOORDS::X3DCOORDS ( )

Definition at line 34 of file x3d_coords.cpp.

References X3DNODE::m_Type, and X3D_COORDINATE.

◆ X3DCOORDS() [2/2]

X3DCOORDS::X3DCOORDS ( X3DNODE * aParent )

Definition at line 40 of file x3d_coords.cpp.

References X3DNODE::AddChildNode(), X3DNODE::GetNodeType(), X3DNODE::m_Parent, X3DNODE::m_Type, X3D_COORDINATE, and X3D_INDEXED_FACE_SET.

◆ ~X3DCOORDS()

X3DCOORDS::~X3DCOORDS ( )

virtual

Definition at line 57 of file x3d_coords.cpp.

References traceVrmlPlugin.

Member Function Documentation

◆ AddChildNode()

bool X3DCOORDS::AddChildNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 157 of file x3d_coords.cpp.

◆ 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(), X3DSHAPE::AddRefNode(), and X3DTRANSFORM::AddRefNode().

◆ AddRefNode()

bool X3DCOORDS::AddRefNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 163 of file x3d_coords.cpp.

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

◆ GetCoords()

void X3DCOORDS::GetCoords	(	WRLVEC3F *&	aCoordList,
		size_t &	aListSize
	)

Definition at line 169 of file x3d_coords.cpp.

References points.

◆ 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(), X3DSHAPE::AddChildNode(), X3DTRANSFORM::AddChildNode(), X3DIFACESET::AddRefNode(), X3DSHAPE::AddRefNode(), X3DTRANSFORM::AddRefNode(), X3DAPP::readFields(), X3DAPP::SetParent(), SetParent(), X3DIFACESET::SetParent(), X3DSHAPE::SetParent(), X3DTRANSFORM::SetParent(), X3DAPP::X3DAPP(), X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DSHAPE::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(), X3DSHAPE::AddChildNode(), and X3DTRANSFORM::AddChildNode().

◆ Read()

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

overridevirtual

Implements X3DNODE.

Definition at line 63 of file x3d_coords.cpp.

References X3D_DICT::AddName(), X3DNODE::m_Dict, X3DNODE::m_Name, points, and SetParent().

◆ SetParent()

bool X3DCOORDS::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 132 of file x3d_coords.cpp.

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

Referenced by Read().

◆ TranslateToSG()

SGNODE * X3DCOORDS::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 183 of file x3d_coords.cpp.

◆ unlinkChildNode()

void X3DNODE::unlinkChildNode ( const X3DNODE * aNode )

virtualinherited

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 in X3DSHAPE.

Definition at line 102 of file x3d_base.cpp.

References X3DNODE::m_Children.

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

◆ unlinkRefNode()

void X3DNODE::unlinkRefNode ( const X3DNODE * aNode )

virtualinherited

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 in X3DSHAPE.

Definition at line 122 of file x3d_base.cpp.

References X3DNODE::m_Refs.

Referenced by X3DSHAPE::unlinkRefNode().

Member Data Documentation

◆ 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(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DSHAPE::~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(), X3DSHAPE::AddChildNode(), X3DTRANSFORM::AddChildNode(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DNODE::unlinkChildNode(), X3DSHAPE::~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(), Read(), X3DIFACESET::Read(), X3DSHAPE::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(), Read(), X3DSHAPE::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(), SetParent(), X3DIFACESET::SetParent(), X3DSHAPE::SetParent(), X3DTRANSFORM::SetParent(), X3DAPP::X3DAPP(), X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DNODE::X3DNODE(), X3DSHAPE::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(), X3DSHAPE::AddRefNode(), X3DTRANSFORM::AddRefNode(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), X3DNODE::unlinkRefNode(), X3DSHAPE::~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(), X3DSHAPE::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(), X3DIFACESET::X3DIFACESET(), X3DNODE::X3DNODE(), X3DSHAPE::X3DSHAPE(), and X3DTRANSFORM::X3DTRANSFORM().

◆ points

std::vector< WRLVEC3F > X3DCOORDS::points

private

Definition at line 56 of file x3d_coords.h.

Referenced by GetCoords(), and Read().

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ X3DCOORDS() [1/2]

◆ X3DCOORDS() [2/2]

◆ ~X3DCOORDS()

Member Function Documentation

◆ AddChildNode()

◆ addNodeRef()

◆ AddRefNode()

◆ delNodeRef()

◆ GetCoords()

◆ GetError()

◆ GetName()

◆ GetNodeType()

◆ GetParent()

◆ Read()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ m_BackPointers

◆ m_Children

◆ m_Dict

◆ m_error

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type

◆ points