WRL2MATERIAL Class Reference

#include <vrml2_material.h>

Inheritance diagram for WRL2MATERIAL:

Public Member Functions
	WRL2MATERIAL ()
	WRL2MATERIAL (WRL2NODE *aParent)
virtual	~WRL2MATERIAL ()
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)
virtual void	unlinkChildNode (const WRL2NODE *aNode)
	Remove references to an owned child.
virtual void	unlinkRefNode (const WRL2NODE *aNode)
	Remove pointers to a referenced node.
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
void	setDefaults (void)

Private Attributes
WRLVEC3F	diffuseColor
WRLVEC3F	emissiveColor
WRLVEC3F	specularColor
float	ambientIntensity
float	shininess
float	transparency

Detailed Description

Definition at line 38 of file vrml2_material.h.

Constructor & Destructor Documentation

WRL2MATERIAL() [1/2]

WRL2MATERIAL::WRL2MATERIAL

(

)

Definition at line 35 of file vrml2_material.cpp.

References WRL2NODE::m_Type, and setDefaults().

WRL2MATERIAL() [2/2]

WRL2MATERIAL::WRL2MATERIAL

(

WRL2NODE *

aParent

)

Definition at line 42 of file vrml2_material.cpp.

References WRL2NODE::AddChildNode(), WRL2NODE::m_Parent, WRL2NODE::m_Type, and setDefaults().

~WRL2MATERIAL()

WRL2MATERIAL::~WRL2MATERIAL ( )

virtual

Definition at line 53 of file vrml2_material.cpp.

References traceVrmlPlugin.

Member Function Documentation

AddChildNode()

bool WRL2MATERIAL::AddChildNode ( WRL2NODE *  aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 96 of file vrml2_material.cpp.

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 WRL2MATERIAL::AddRefNode ( WRL2NODE *  aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 89 of file vrml2_material.cpp.

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

Returns

the type of this node instance.

Definition at line 204 of file vrml2_node.cpp.

References WRL2NODE::m_Type.

Referenced by WRL2NODE::AddChildNode(), WRL2APPEARANCE::AddChildNode(), WRL2FACESET::AddChildNode(), WRL2LINESET::AddChildNode(), WRL2POINTSET::AddChildNode(), WRL2SHAPE::AddChildNode(), WRL2NODE::AddRefNode(), WRL2APPEARANCE::AddRefNode(), WRL2FACESET::AddRefNode(), WRL2LINESET::AddRefNode(), WRL2POINTSET::AddRefNode(), WRL2SHAPE::AddRefNode(), WRL2SWITCH::AddRefNode(), WRL2TRANSFORM::AddRefNode(), WRL2BASE::implementUse(), WRL2APPEARANCE::isDangling(), WRL2BOX::isDangling(), WRL2COLOR::isDangling(), WRL2COORDS::isDangling(), WRL2FACESET::isDangling(), WRL2LINESET::isDangling(), isDangling(), WRL2NORMS::isDangling(), WRL2POINTSET::isDangling(), WRL2SHAPE::isDangling(), WRL2INLINE::Read(), and WRL2SHAPE::TranslateToSG().

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(), WRL2SHAPE::AddChildNode(), WRL2APPEARANCE::AddRefNode(), WRL2FACESET::AddRefNode(), WRL2LINESET::AddRefNode(), WRL2POINTSET::AddRefNode(), and WRL2SHAPE::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 WRL2MATERIAL::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 78 of file vrml2_material.cpp.

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

Read()

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

overridevirtual

Implements WRL2NODE.

Definition at line 103 of file vrml2_material.cpp.

References ambientIntensity, diffuseColor, emissiveColor, WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFileName(), WRLPROC::GetFilePosition(), WRLPROC::Peek(), WRLPROC::Pop(), WRLPROC::ReadName(), WRLPROC::ReadSFFloat(), WRLPROC::ReadSFVec3f(), shininess, specularColor, traceVrmlPlugin, and transparency.

Referenced by WRL2BASE::readMaterial().

setDefaults()

void WRL2MATERIAL::setDefaults ( void  )

private

Definition at line 59 of file vrml2_material.cpp.

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

Referenced by WRL2MATERIAL().

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 * WRL2MATERIAL::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 256 of file vrml2_material.cpp.

References S3D::AddSGNodeChild(), S3D::AddSGNodeRef(), ambientIntensity, diffuseColor, emissiveColor, IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), S3D::GetSGNodeType(), WRL2NODE::m_BackPointers, WRL2NODE::m_Children, WRL2NODE::m_Refs, WRL2NODE::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 WRL2NODE::unlinkChildNode ( const WRL2NODE *  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 WRL2APPEARANCE, WRL2FACESET, WRL2LINESET, WRL2POINTSET, and WRL2SHAPE.

Definition at line 407 of file vrml2_node.cpp.

References WRL2NODE::m_Children.

Referenced by WRL2NODE::SetParent(), WRL2APPEARANCE::unlinkChildNode(), WRL2FACESET::unlinkChildNode(), WRL2LINESET::unlinkChildNode(), WRL2POINTSET::unlinkChildNode(), WRL2SHAPE::unlinkChildNode(), and WRL2NODE::~WRL2NODE().

unlinkRefNode()

void WRL2NODE::unlinkRefNode ( const WRL2NODE *  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 WRL2APPEARANCE, WRL2FACESET, WRL2LINESET, WRL2POINTSET, and WRL2SHAPE.

Definition at line 425 of file vrml2_node.cpp.

References WRL2NODE::m_Refs.

Referenced by WRL2APPEARANCE::unlinkRefNode(), WRL2FACESET::unlinkRefNode(), WRL2LINESET::unlinkRefNode(), WRL2POINTSET::unlinkRefNode(), and WRL2SHAPE::unlinkRefNode().

Member Data Documentation

ambientIntensity

float WRL2MATERIAL::ambientIntensity

private

Definition at line 58 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

diffuseColor

WRLVEC3F WRL2MATERIAL::diffuseColor

private

Definition at line 55 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

emissiveColor

WRLVEC3F WRL2MATERIAL::emissiveColor

private

Definition at line 56 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

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(), TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), WRL2SHAPE::~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

m_Children

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

protectedinherited

Definition at line 174 of file vrml2_node.h.

Referenced by WRL2NODE::AddChildNode(), WRL2NODE::FindNode(), WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2FACESET::TranslateToSG(), TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2NODE::unlinkChildNode(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), WRL2SHAPE::~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

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

Definition at line 169 of file vrml2_node.h.

Referenced by WRL2NODE::addNodeRef(), WRL2NODE::FindNode(), WRL2NODE::GetParent(), WRL2APPEARANCE::isDangling(), WRL2BOX::isDangling(), WRL2COLOR::isDangling(), WRL2COORDS::isDangling(), WRL2FACESET::isDangling(), WRL2LINESET::isDangling(), isDangling(), WRL2NORMS::isDangling(), WRL2POINTSET::isDangling(), WRL2SHAPE::isDangling(), WRL2NODE::SetParent(), WRL2APPEARANCE::WRL2APPEARANCE(), WRL2BOX::WRL2BOX(), WRL2COLOR::WRL2COLOR(), WRL2COORDS::WRL2COORDS(), WRL2FACESET::WRL2FACESET(), WRL2INLINE::WRL2INLINE(), WRL2LINESET::WRL2LINESET(), WRL2MATERIAL(), WRL2NODE::WRL2NODE(), WRL2NORMS::WRL2NORMS(), WRL2POINTSET::WRL2POINTSET(), WRL2SHAPE::WRL2SHAPE(), WRL2SWITCH::WRL2SWITCH(), WRL2TRANSFORM::WRL2TRANSFORM(), and WRL2NODE::~WRL2NODE().

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(), TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2NODE::unlinkRefNode(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), WRL2SHAPE::~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(), TranslateToSG(), WRL2SHAPE::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(), WRL2NODE::WRL2NODE(), WRL2NORMS::WRL2NORMS(), WRL2POINTSET::WRL2POINTSET(), WRL2SHAPE::WRL2SHAPE(), WRL2SWITCH::WRL2SWITCH(), and WRL2TRANSFORM::WRL2TRANSFORM().

shininess

float WRL2MATERIAL::shininess

private

Definition at line 59 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

specularColor

WRLVEC3F WRL2MATERIAL::specularColor

private

Definition at line 57 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

transparency

float WRL2MATERIAL::transparency

private

Definition at line 60 of file vrml2_material.h.

Referenced by Read(), setDefaults(), and TranslateToSG().

---

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

• vrml2_material.h
• vrml2_material.cpp