#include <vrml1_material.h>

Inheritance diagram for WRL1MATERIAL:

Public Member Functions
	WRL1MATERIAL (NAMEREGISTER *aDictionary)

	WRL1MATERIAL (NAMEREGISTER aDictionary, WRL1NODE aParent)

virtual	~WRL1MATERIAL ()

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

bool	AddRefNode (WRL1NODE *aNode) override

bool	AddChildNode (WRL1NODE *aNode) override

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

SGNODE *	GetAppearance (int aIndex)
	Return an SGAPPEARANCE node representing the appearance for an IndexedFaceSet.

void	GetColor (SGCOLOR *aColor, int aIndex)
	Compute an SGCOLOR representing the appearance of a vertex or face.

void	Reclaim (SGNODE *aColor)
	Destroy the given color node if it does not have a parent.

void	cancelDict (void)

WRL1NODES	getNodeTypeID (const std::string &aNodeName)
	Return the ID based on the given aNodeName or WRL1_INVALID (WRL1_END) if no such node name exists.

virtual void	unlinkChildNode (const WRL1NODE *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 WRL1NODE *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 (WRL1NODE *aNode)
	Add a pointer to a node which references, but does not own, this node.

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

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

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

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

virtual std::string	GetName (void)

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

const char *	GetNodeTypeName (WRL1NODES aNodeType) const

size_t	GetNItems (void) const

virtual WRL1NODE *	FindNode (const std::string &aNodeName)
	Search the tree of linked nodes and returns a reference to the current node with the given name.

std::string	GetError (void)

Protected Attributes
WRL1NODE *	m_Parent

WRL1NODES	m_Type

std::string	m_Name

std::list< WRL1NODE * >	m_BackPointers

std::list< WRL1NODE * >	m_Children

std::list< WRL1NODE * >	m_Refs

std::list< WRL1NODE * >	m_Items

std::string	m_error

WRL1STATUS	m_current

SGNODE *	m_sgNode

NAMEREGISTER *	m_dictionary

Private Member Functions
void	checkRange (float &aValue)

void	addItem (WRL1NODE *aNode)

void	delItem (const WRL1NODE *aNode)

Private Attributes
std::vector< WRLVEC3F >	diffuseColor

std::vector< WRLVEC3F >	emissiveColor

std::vector< WRLVEC3F >	specularColor

std::vector< WRLVEC3F >	ambientColor

std::vector< float >	shininess

std::vector< float >	transparency

SGNODE *	colors [2]

Detailed Description

Definition at line 41 of file vrml1_material.h.

Constructor & Destructor Documentation

◆ WRL1MATERIAL() [1/2]

WRL1MATERIAL::WRL1MATERIAL ( NAMEREGISTER * aDictionary )

Definition at line 35 of file vrml1_material.cpp.

References colors, and WRL1NODE::m_Type.

◆ WRL1MATERIAL() [2/2]

WRL1MATERIAL::WRL1MATERIAL	(	NAMEREGISTER *	aDictionary,
		WRL1NODE *	aParent
	)

Definition at line 43 of file vrml1_material.cpp.

References WRL1NODE::AddChildNode(), colors, WRL1NODE::m_Parent, and WRL1NODE::m_Type.

◆ ~WRL1MATERIAL()

WRL1MATERIAL::~WRL1MATERIAL ( )

virtual

Definition at line 56 of file vrml1_material.cpp.

References colors, S3D::DestroyNode(), S3D::GetSGNodeParent(), and traceVrmlPlugin.

Member Function Documentation

◆ AddChildNode()

bool WRL1MATERIAL::AddChildNode ( WRL1NODE * aNode )

overridevirtual

Reimplemented from WRL1NODE.

Definition at line 81 of file vrml1_material.cpp.

◆ addItem()

void WRL1NODE::addItem ( WRL1NODE * aNode )

privateinherited

Definition at line 458 of file vrml1_node.cpp.

References WRL1NODE::m_Items.

Referenced by WRL1NODE::AddChildNode(), and WRL1NODE::AddRefNode().

◆ addNodeRef()

void WRL1NODE::addNodeRef ( WRL1NODE * 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 216 of file vrml1_node.cpp.

References WRL1NODE::m_BackPointers, and WRL1NODE::m_Parent.

Referenced by WRL1NODE::AddRefNode().

◆ AddRefNode()

bool WRL1MATERIAL::AddRefNode ( WRL1NODE * aNode )

overridevirtual

Reimplemented from WRL1NODE.

Definition at line 74 of file vrml1_material.cpp.

◆ cancelDict()

void WRL1NODE::cancelDict ( void )

inherited

Definition at line 198 of file vrml1_node.cpp.

References WRL1NODE::m_Children, WRL1NODE::m_dictionary, and WRL1NODE::m_Type.

Referenced by WRL1BASE::~WRL1BASE().

◆ checkRange()

void WRL1MATERIAL::checkRange ( float & aValue )

private

Definition at line 533 of file vrml1_material.cpp.

Referenced by GetAppearance(), and GetColor().

◆ delItem()

void WRL1NODE::delItem ( const WRL1NODE * aNode )

privateinherited

Definition at line 464 of file vrml1_node.cpp.

References WRL1NODE::m_Items.

Referenced by WRL1NODE::unlinkChildNode(), and WRL1NODE::unlinkRefNode().

◆ delNodeRef()

void WRL1NODE::delNodeRef ( WRL1NODE * 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 237 of file vrml1_node.cpp.

References WRL1NODE::m_BackPointers, and traceVrmlPlugin.

◆ FindNode()

WRL1NODE * WRL1NODE::FindNode ( const std::string & aNodeName )

virtualinherited

Search the tree of linked nodes and returns a reference to the current node 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.

Returns: is a valid node pointer on success, otherwise NULL.

Definition at line 350 of file vrml1_node.cpp.

References NAMEREGISTER::FindName(), and WRL1NODE::m_dictionary.

Referenced by WRL1BASE::implementUse().

◆ GetAppearance()

SGNODE * WRL1MATERIAL::GetAppearance ( int aIndex )

Return an SGAPPEARANCE node representing the appearance for an IndexedFaceSet.

Definition at line 255 of file vrml1_material.cpp.

References ambientColor, checkRange(), colors, diffuseColor, emissiveColor, IFSG_NODE::GetRawPtr(), red, IFSG_APPEARANCE::SetAmbient(), IFSG_APPEARANCE::SetDiffuse(), IFSG_APPEARANCE::SetEmissive(), IFSG_APPEARANCE::SetShininess(), IFSG_APPEARANCE::SetSpecular(), IFSG_APPEARANCE::SetTransparency(), shininess, specularColor, and transparency.

Referenced by WRL1FACESET::TranslateToSG().

◆ GetColor()

void WRL1MATERIAL::GetColor	(	SGCOLOR *	aColor,
		int	aIndex
	)

Compute an SGCOLOR representing the appearance of a vertex or face.

Definition at line 364 of file vrml1_material.cpp.

References ambientColor, checkRange(), diffuseColor, emissiveColor, red, SGCOLOR::SetColor(), shininess, and specularColor.

Referenced by WRL1FACESET::TranslateToSG().

◆ GetError()

std::string WRL1NODE::GetError ( void )

inherited

Definition at line 344 of file vrml1_node.cpp.

References WRL1NODE::m_error.

◆ GetName()

std::string WRL1NODE::GetName ( void )

virtualinherited

Reimplemented in WRL1BASE.

Definition at line 266 of file vrml1_node.cpp.

References WRL1NODE::m_Name.

◆ GetNItems()

size_t WRL1NODE::GetNItems ( void ) const

inherited

Definition at line 338 of file vrml1_node.cpp.

References WRL1NODE::m_Items.

◆ GetNodeType()

WRL1NODES WRL1NODE::GetNodeType ( void ) const

inherited

Return the type of this node instance.

Definition at line 254 of file vrml1_node.cpp.

References WRL1NODE::m_Type.

Referenced by WRL1NODE::AddChildNode(), WRL1NODE::AddRefNode(), WRL1BASE::implementUse(), WRL1GROUP::TranslateToSG(), and WRL1TRANSFORM::TranslateToSG().

◆ getNodeTypeID()

WRL1NODES WRL1NODE::getNodeTypeID ( const std::string & aNodeName )

inherited

Return the ID based on the given aNodeName or WRL1_INVALID (WRL1_END) if no such node name exists.

Definition at line 327 of file vrml1_node.cpp.

References nodenames.

Referenced by WRL1BASE::ReadNode().

◆ GetNodeTypeName()

const char * WRL1NODE::GetNodeTypeName ( WRL1NODES aNodeType ) const

inherited

Definition at line 312 of file vrml1_node.cpp.

References nodenames.

Referenced by WRL1BASE::implementUse().

◆ GetParent()

WRL1NODE * WRL1NODE::GetParent ( void ) const

inherited

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

top level transform).

Definition at line 260 of file vrml1_node.cpp.

References WRL1NODE::m_Parent.

Referenced by WRL1NODE::AddChildNode().

◆ Read()

bool WRL1MATERIAL::Read	(	WRLPROC &	proc,
		WRL1BASE *	aTopNode
	)

overridevirtual

Implements WRL1NODE.

Definition at line 88 of file vrml1_material.cpp.

References ambientColor, diffuseColor, emissiveColor, WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFileName(), WRLPROC::GetFilePosition(), WRLPROC::Peek(), WRLPROC::Pop(), WRLPROC::ReadMFFloat(), WRLPROC::ReadMFVec3f(), WRLPROC::ReadName(), shininess, specularColor, traceVrmlPlugin, and transparency.

Referenced by WRL1BASE::readMaterial().

◆ Reclaim()

void WRL1MATERIAL::Reclaim ( SGNODE * aColor )

Destroy the given color node if it does not have a parent.

Definition at line 542 of file vrml1_material.cpp.

References colors, S3D::DestroyNode(), and S3D::GetSGNodeParent().

◆ SetName()

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

virtualinherited

Reimplemented in WRL1BASE.

Definition at line 272 of file vrml1_node.cpp.

References NAMEREGISTER::AddName(), BAD_CHARS1, BAD_CHARS2, WRL1NODE::m_dictionary, WRL1NODE::m_Name, and traceVrmlPlugin.

Referenced by WRL1BASE::implementDef().

◆ SetParent()

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

virtualinherited

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

Reimplemented in WRL1BASE.

Definition at line 359 of file vrml1_node.cpp.

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

Referenced by WRL1NODE::AddChildNode().

◆ TranslateToSG()

SGNODE * WRL1MATERIAL::TranslateToSG	(	SGNODE *	aParent,
		WRL1STATUS *	sp
	)

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

Definition at line 245 of file vrml1_material.cpp.

References WRL1STATUS::mat.

◆ unlinkChildNode()

void WRL1NODE::unlinkChildNode ( const WRL1NODE * 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.

Definition at line 420 of file vrml1_node.cpp.

References WRL1NODE::delItem(), and WRL1NODE::m_Children.

Referenced by WRL1NODE::SetParent(), and WRL1NODE::~WRL1NODE().

◆ unlinkRefNode()

void WRL1NODE::unlinkRefNode ( const WRL1NODE * 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.

Definition at line 439 of file vrml1_node.cpp.

References WRL1NODE::delItem(), and WRL1NODE::m_Refs.

Member Data Documentation

◆ ambientColor

std::vector< WRLVEC3F > WRL1MATERIAL::ambientColor

private

Definition at line 74 of file vrml1_material.h.

Referenced by GetAppearance(), GetColor(), and Read().

◆ colors

SGNODE* WRL1MATERIAL::colors[2]

private

Definition at line 78 of file vrml1_material.h.

Referenced by GetAppearance(), Reclaim(), WRL1MATERIAL(), and ~WRL1MATERIAL().

◆ diffuseColor

std::vector< WRLVEC3F > WRL1MATERIAL::diffuseColor

private

Definition at line 71 of file vrml1_material.h.

Referenced by GetAppearance(), GetColor(), and Read().

◆ emissiveColor

std::vector< WRLVEC3F > WRL1MATERIAL::emissiveColor

private

Definition at line 72 of file vrml1_material.h.

Referenced by GetAppearance(), GetColor(), and Read().

◆ m_BackPointers

std::list< WRL1NODE* > WRL1NODE::m_BackPointers

protectedinherited

Definition at line 230 of file vrml1_node.h.

Referenced by WRL1NODE::addNodeRef(), WRL1NODE::delNodeRef(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), WRL1NODE::~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_Children

std::list< WRL1NODE* > WRL1NODE::m_Children

protectedinherited

Definition at line 231 of file vrml1_node.h.

Referenced by WRL1NODE::AddChildNode(), WRL1NODE::cancelDict(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), WRL1NODE::unlinkChildNode(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), WRL1NODE::~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_current

WRL1STATUS WRL1NODE::m_current

protectedinherited

Definition at line 236 of file vrml1_node.h.

Referenced by WRL1BASE::TranslateToSG(), WRL1FACESET::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), and WRL1SWITCH::TranslateToSG().

◆ m_dictionary

NAMEREGISTER* WRL1NODE::m_dictionary

protectedinherited

Definition at line 246 of file vrml1_node.h.

Referenced by WRL1NODE::cancelDict(), WRL1NODE::FindNode(), WRL1BASE::implementDef(), WRL1BASE::readCoords(), WRL1BASE::readFaceSet(), WRL1BASE::readGroup(), WRL1BASE::readMatBinding(), WRL1BASE::readMaterial(), WRL1BASE::readSeparator(), WRL1BASE::readShapeHints(), WRL1BASE::readSwitch(), WRL1BASE::readTransform(), WRL1NODE::SetName(), WRL1BASE::WRL1BASE(), WRL1NODE::WRL1NODE(), and WRL1NODE::~WRL1NODE().

◆ m_error

std::string WRL1NODE::m_error

protectedinherited

Definition at line 234 of file vrml1_node.h.

Referenced by WRL1NODE::GetError().

◆ m_Items

std::list< WRL1NODE* > WRL1NODE::m_Items

protectedinherited

Definition at line 233 of file vrml1_node.h.

Referenced by WRL1NODE::addItem(), WRL1NODE::delItem(), WRL1NODE::GetNItems(), WRL1BASE::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), and WRL1NODE::~WRL1NODE().

◆ m_Name

std::string WRL1NODE::m_Name

protectedinherited

Definition at line 228 of file vrml1_node.h.

Referenced by WRL1NODE::GetName(), WRL1NODE::SetName(), and WRL1NODE::~WRL1NODE().

◆ m_Parent

WRL1NODE* WRL1NODE::m_Parent

protectedinherited

◆ m_Refs

std::list< WRL1NODE* > WRL1NODE::m_Refs

protectedinherited

Definition at line 232 of file vrml1_node.h.

Referenced by WRL1NODE::AddRefNode(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), WRL1SWITCH::TranslateToSG(), WRL1NODE::unlinkRefNode(), WRL1FACESET::~WRL1FACESET(), WRL1GROUP::~WRL1GROUP(), WRL1NODE::~WRL1NODE(), WRL1SEPARATOR::~WRL1SEPARATOR(), WRL1SWITCH::~WRL1SWITCH(), and WRL1TRANSFORM::~WRL1TRANSFORM().

◆ m_sgNode

SGNODE* WRL1NODE::m_sgNode

protectedinherited

Definition at line 237 of file vrml1_node.h.

Referenced by WRL1NODE::WRL1NODE().

◆ m_Type

WRL1NODES WRL1NODE::m_Type

protectedinherited

Definition at line 227 of file vrml1_node.h.

Referenced by WRL1NODE::cancelDict(), WRL1NODE::GetNodeType(), WRL1BASE::WRL1BASE(), WRL1COORDS::WRL1COORDS(), WRL1FACESET::WRL1FACESET(), WRL1GROUP::WRL1GROUP(), WRL1MATBINDING::WRL1MATBINDING(), WRL1MATERIAL(), WRL1NODE::WRL1NODE(), WRL1SEPARATOR::WRL1SEPARATOR(), WRL1SHAPEHINTS::WRL1SHAPEHINTS(), WRL1SWITCH::WRL1SWITCH(), WRL1TRANSFORM::WRL1TRANSFORM(), and WRL1NODE::~WRL1NODE().

◆ shininess

std::vector< float > WRL1MATERIAL::shininess

private

Definition at line 75 of file vrml1_material.h.

Referenced by GetAppearance(), GetColor(), and Read().

◆ specularColor

std::vector< WRLVEC3F > WRL1MATERIAL::specularColor

private

Definition at line 73 of file vrml1_material.h.

Referenced by GetAppearance(), GetColor(), and Read().

◆ transparency

std::vector< float > WRL1MATERIAL::transparency

private

Definition at line 76 of file vrml1_material.h.

Referenced by GetAppearance(), and Read().

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

◆ WRL1MATERIAL() [1/2]

◆ WRL1MATERIAL() [2/2]

◆ ~WRL1MATERIAL()

Member Function Documentation

◆ AddChildNode()

◆ addItem()

◆ addNodeRef()

◆ AddRefNode()

◆ cancelDict()

◆ checkRange()

◆ delItem()

◆ delNodeRef()

◆ FindNode()

◆ GetAppearance()

◆ GetColor()

◆ GetError()

◆ GetName()

◆ GetNItems()

◆ GetNodeType()

◆ getNodeTypeID()

◆ GetNodeTypeName()

◆ GetParent()

◆ Read()

◆ Reclaim()

◆ SetName()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ ambientColor

◆ colors

◆ diffuseColor

◆ emissiveColor

◆ m_BackPointers

◆ m_Children

◆ m_current

◆ m_dictionary

◆ m_error

◆ m_Items

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type

◆ shininess

◆ specularColor

◆ transparency