#include <x3d_appearance.h>

Inheritance diagram for X3DAPP:

Public Member Functions
	X3DAPP ()

	X3DAPP (X3DNODE *aParent)

virtual	~X3DAPP ()

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)
	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
WRLVEC3F	diffuseColor

WRLVEC3F	emissiveColor

WRLVEC3F	specularColor

float	ambientIntensity

float	shininess

float	transparency

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 Member Functions
void	init ()

void	readFields (wxXmlNode *aNode)

Private Attributes
wxString	m_MatName

Detailed Description

Definition at line 39 of file x3d_appearance.h.

Constructor & Destructor Documentation

◆ X3DAPP() [1/2]

X3DAPP::X3DAPP ( )

Definition at line 35 of file x3d_appearance.cpp.

References init(), X3DNODE::m_Type, and X3D_APPEARANCE.

◆ X3DAPP() [2/2]

X3DAPP::X3DAPP ( X3DNODE * aParent )

Definition at line 42 of file x3d_appearance.cpp.

References X3DNODE::AddChildNode(), X3DNODE::GetNodeType(), init(), X3DNODE::m_Parent, X3DNODE::m_Type, X3D_APPEARANCE, and X3D_SHAPE.

◆ ~X3DAPP()

X3DAPP::~X3DAPP ( )

virtual

Definition at line 60 of file x3d_appearance.cpp.

References X3D_DICT::DelName(), X3DNODE::m_Dict, m_MatName, and traceVrmlPlugin.

Member Function Documentation

◆ AddChildNode()

bool X3DAPP::AddChildNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 219 of file x3d_appearance.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 X3DAPP::AddRefNode ( X3DNODE * aNode )

overridevirtual

Implements X3DNODE.

Definition at line 225 of file x3d_appearance.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.

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

◆ init()

void X3DAPP::init ( )

private

Definition at line 69 of file x3d_appearance.cpp.

References ambientIntensity, diffuseColor, emissiveColor, shininess, specularColor, and transparency.

Referenced by X3DAPP().

◆ Read()

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

overridevirtual

Implements X3DNODE.

Definition at line 154 of file x3d_appearance.cpp.

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

◆ readFields()

void X3DAPP::readFields ( wxXmlNode * aNode )

private

Definition at line 90 of file x3d_appearance.cpp.

References X3D_DICT::AddName(), ambientIntensity, diffuseColor, emissiveColor, X3D_DICT::FindName(), X3DNODE::GetNodeType(), X3DNODE::m_Dict, m_MatName, X3D::ParseSFFloat(), X3D::ParseSFVec3(), shininess, specularColor, transparency, and X3D_APPEARANCE.

Referenced by Read().

◆ SetParent()

bool X3DAPP::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 194 of file x3d_appearance.cpp.

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

Referenced by Read().

◆ TranslateToSG()

SGNODE * X3DAPP::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 231 of file x3d_appearance.cpp.

References S3D::AddSGNodeChild(), S3D::AddSGNodeRef(), ambientIntensity, diffuseColor, emissiveColor, IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), S3D::GetSGNodeType(), X3DNODE::m_BackPointers, X3DNODE::m_Children, X3DNODE::m_Refs, X3DNODE::m_sgNode, IFSG_APPEARANCE::SetAmbient(), IFSG_APPEARANCE::SetDiffuse(), IFSG_APPEARANCE::SetEmissive(), IFSG_APPEARANCE::SetShininess(), IFSG_APPEARANCE::SetSpecular(), IFSG_APPEARANCE::SetTransparency(), S3D::SGTYPE_SHAPE, shininess, specularColor, traceVrmlPlugin, and transparency.

◆ 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 SetParent(), X3DCOORDS::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

◆ ambientIntensity

float X3DAPP::ambientIntensity

protected

Definition at line 61 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

◆ diffuseColor

WRLVEC3F X3DAPP::diffuseColor

protected

Definition at line 58 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

◆ emissiveColor

WRLVEC3F X3DAPP::emissiveColor

protected

Definition at line 59 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

◆ m_BackPointers

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

protectedinherited

Definition at line 163 of file x3d_base.h.

Referenced by X3DNODE::addNodeRef(), X3DNODE::delNodeRef(), 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(), 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 Read(), X3DCOORDS::Read(), X3DIFACESET::Read(), X3DSHAPE::Read(), X3DTRANSFORM::Read(), readFields(), X3DIFACESET::readFields(), X3DTRANSFORM::readFields(), X3DNODE::X3DNODE(), ~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_MatName

wxString X3DAPP::m_MatName

private

Definition at line 66 of file x3d_appearance.h.

Referenced by readFields(), and ~X3DAPP().

◆ m_Name

wxString X3DNODE::m_Name

protectedinherited

Definition at line 168 of file x3d_base.h.

Referenced by X3DNODE::GetName(), Read(), X3DCOORDS::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(), SetParent(), X3DCOORDS::SetParent(), X3DIFACESET::SetParent(), X3DSHAPE::SetParent(), X3DTRANSFORM::SetParent(), X3DAPP(), X3DCOORDS::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(), 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 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(), X3DCOORDS::X3DCOORDS(), X3DIFACESET::X3DIFACESET(), X3DNODE::X3DNODE(), X3DSHAPE::X3DSHAPE(), and X3DTRANSFORM::X3DTRANSFORM().

◆ shininess

float X3DAPP::shininess

protected

Definition at line 62 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

◆ specularColor

WRLVEC3F X3DAPP::specularColor

protected

Definition at line 60 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

◆ transparency

float X3DAPP::transparency

protected

Definition at line 63 of file x3d_appearance.h.

Referenced by init(), readFields(), and TranslateToSG().

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

◆ X3DAPP() [1/2]

◆ X3DAPP() [2/2]

◆ ~X3DAPP()

Member Function Documentation

◆ AddChildNode()

◆ addNodeRef()

◆ AddRefNode()

◆ delNodeRef()

◆ GetError()

◆ GetName()

◆ GetNodeType()

◆ GetParent()

◆ init()

◆ Read()

◆ readFields()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ ambientIntensity

◆ diffuseColor

◆ emissiveColor

◆ m_BackPointers

◆ m_Children

◆ m_Dict

◆ m_error

◆ m_MatName

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type

◆ shininess

◆ specularColor

◆ transparency