IFSG_COLORS is the wrapper for SGCOLORS. More...

#include <ifsg_colors.h>

Inheritance diagram for IFSG_COLORS:

Public Member Functions
	IFSG_COLORS (bool create)

	IFSG_COLORS (SGNODE *aParent)

	IFSG_COLORS (IFSG_NODE &aParent)

bool	Attach (SGNODE *aNode) override
	Function Attach associates a given SGNODE* with this wrapper.

bool	NewNode (SGNODE *aParent) override
	Function NewNode creates a new node to associate with this wrapper.

bool	NewNode (IFSG_NODE &aParent) override

bool	GetColorList (size_t &aListSize, SGCOLOR *&aColorList)

bool	SetColorList (size_t aListSize, const SGCOLOR *aColorList)

bool	AddColor (double aRedValue, double aGreenValue, double aBlueValue)

bool	AddColor (const SGCOLOR &aColor)

void	Destroy (void)
	Function Destroy deletes the object held by this wrapper.

SGNODE *	GetRawPtr (void) noexcept
	Function GetRawPtr() returns the raw internal SGNODE pointer.

S3D::SGTYPES	GetNodeType (void) const
	Function GetNodeType returns the type of this node instance.

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

bool	SetParent (SGNODE *aParent)
	Function SetParent sets the parent SGNODE of this object.

const char *	GetName (void)
	Function GetName returns a pointer to the node name (NULL if no name assigned)

bool	SetName (const char *aName)
	Function SetName sets the node's name; if the pointer passed is NULL then the node's name is erased.

const char *	GetNodeTypeName (S3D::SGTYPES aNodeType) const
	Function GetNodeTypeName returns the text representation of the node type or NULL if the node somehow has an invalid type.

SGNODE *	FindNode (const char *aNodeName)
	Function FindNode searches the tree of linked nodes and returns a reference to the first node found with the given name.

bool	AddRefNode (SGNODE *aNode)
	Function AddRefNode adds a reference to an existing node which is not owned by (not a child of) this node.

bool	AddRefNode (IFSG_NODE &aNode)

bool	AddChildNode (SGNODE *aNode)
	Function AddChildNode adds a node as a child owned by this node.

bool	AddChildNode (IFSG_NODE &aNode)

Protected Attributes
SGNODE *	m_node

Detailed Description

IFSG_COLORS is the wrapper for SGCOLORS.

Definition at line 41 of file ifsg_colors.h.

Constructor & Destructor Documentation

◆ IFSG_COLORS() [1/3]

IFSG_COLORS::IFSG_COLORS ( bool create )

Definition at line 37 of file ifsg_colors.cpp.

References SGNODE::AssociateWrapper(), and IFSG_NODE::m_node.

◆ IFSG_COLORS() [2/3]

IFSG_COLORS::IFSG_COLORS ( SGNODE * aParent )

Definition at line 50 of file ifsg_colors.cpp.

References SGNODE::AssociateWrapper(), IFSG_NODE::m_node, and SGNODE::SetParent().

◆ IFSG_COLORS() [3/3]

IFSG_COLORS::IFSG_COLORS ( IFSG_NODE & aParent )

Definition at line 68 of file ifsg_colors.cpp.

References SGNODE::AssociateWrapper(), BadParent, IFSG_NODE::GetRawPtr(), IFSG_NODE::m_node, SGNODE::SetParent(), and WrongParent.

Member Function Documentation

◆ AddChildNode() [1/2]

bool IFSG_NODE::AddChildNode ( IFSG_NODE & aNode )

inherited

Definition at line 156 of file ifsg_node.cpp.

References SGNODE::AddChildNode(), IFSG_NODE::GetRawPtr(), and IFSG_NODE::m_node.

◆ AddChildNode() [2/2]

bool IFSG_NODE::AddChildNode ( SGNODE * aNode )

inherited

Function AddChildNode adds a node as a child owned by this node.

Returns: true on success

Definition at line 148 of file ifsg_node.cpp.

References SGNODE::AddChildNode(), and IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape(), EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), and makeComponents().

◆ AddColor() [1/2]

bool IFSG_COLORS::AddColor ( const SGCOLOR & aColor )

Definition at line 182 of file ifsg_colors.cpp.

References IFSG_NODE::m_node.

◆ AddColor() [2/2]

bool IFSG_COLORS::AddColor	(	double	aRedValue,
		double	aGreenValue,
		double	aBlueValue
	)

Definition at line 172 of file ifsg_colors.cpp.

References IFSG_NODE::m_node.

◆ AddRefNode() [1/2]

bool IFSG_NODE::AddRefNode ( IFSG_NODE & aNode )

inherited

Definition at line 136 of file ifsg_node.cpp.

References SGNODE::AddRefNode(), IFSG_NODE::GetRawPtr(), and IFSG_NODE::m_node.

◆ AddRefNode() [2/2]

bool IFSG_NODE::AddRefNode ( SGNODE * aNode )

inherited

Function AddRefNode adds a reference to an existing node which is not owned by (not a child of) this node.

Returns: true on success

Definition at line 128 of file ifsg_node.cpp.

References SGNODE::AddRefNode(), and IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape(), EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), makeComponents(), and vrmlToSG().

◆ Attach()

bool IFSG_COLORS::Attach ( SGNODE * aNode )

overridevirtual

Function Attach associates a given SGNODE* with this wrapper.

Implements IFSG_NODE.

Definition at line 98 of file ifsg_colors.cpp.

References SGNODE::AssociateWrapper(), SGNODE::DisassociateWrapper(), SGNODE::GetNodeType(), IFSG_NODE::m_node, and S3D::SGTYPE_COLORS.

◆ Destroy()

void IFSG_NODE::Destroy ( void )

inherited

Function Destroy deletes the object held by this wrapper.

Definition at line 55 of file ifsg_node.cpp.

References SGNODE::DisassociateWrapper(), and IFSG_NODE::m_node.

Referenced by loadIDFBoard(), processSolidOrShell(), WRL2BASE::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), WRL1BASE::TranslateToSG(), WRL1GROUP::TranslateToSG(), WRL1SEPARATOR::TranslateToSG(), and EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML().

◆ FindNode()

SGNODE * IFSG_NODE::FindNode ( const char * aNodeName )

inherited

Function FindNode searches 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

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

Definition at line 120 of file ifsg_node.cpp.

References SGNODE::FindNode(), and IFSG_NODE::m_node.

◆ GetColorList()

bool IFSG_COLORS::GetColorList	(	size_t &	aListSize,
		SGCOLOR *&	aColorList
	)

Definition at line 154 of file ifsg_colors.cpp.

References IFSG_NODE::m_node.

◆ GetName()

const char * IFSG_NODE::GetName ( void )

inherited

Function GetName returns a pointer to the node name (NULL if no name assigned)

Definition at line 95 of file ifsg_node.cpp.

References SGNODE::GetName(), and IFSG_NODE::m_node.

◆ GetNodeType()

S3D::SGTYPES IFSG_NODE::GetNodeType ( void ) const

inherited

Function GetNodeType returns the type of this node instance.

Definition at line 71 of file ifsg_node.cpp.

References SGNODE::GetNodeType(), IFSG_NODE::m_node, and S3D::SGTYPE_END.

◆ GetNodeTypeName()

const char * IFSG_NODE::GetNodeTypeName ( S3D::SGTYPES aNodeType ) const

inherited

Function GetNodeTypeName returns the text representation of the node type or NULL if the node somehow has an invalid type.

Definition at line 112 of file ifsg_node.cpp.

References SGNODE::GetNodeTypeName(), and IFSG_NODE::m_node.

◆ GetParent()

SGNODE * IFSG_NODE::GetParent ( void ) const

inherited

Function GetParent 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 79 of file ifsg_node.cpp.

References SGNODE::GetParent(), and IFSG_NODE::m_node.

Referenced by makeComponents().

◆ GetRawPtr()

SGNODE * IFSG_NODE::GetRawPtr ( void )

noexceptinherited

Function GetRawPtr() returns the raw internal SGNODE pointer.

Definition at line 65 of file ifsg_node.cpp.

◆ NewNode() [1/2]

bool IFSG_COLORS::NewNode ( IFSG_NODE & aParent )

overridevirtual

Implements IFSG_NODE.

Definition at line 144 of file ifsg_colors.cpp.

References IFSG_NODE::GetRawPtr(), and NewNode().

◆ NewNode() [2/2]

bool IFSG_COLORS::NewNode ( SGNODE * aParent )

overridevirtual

Function NewNode creates a new node to associate with this wrapper.

Implements IFSG_NODE.

Definition at line 120 of file ifsg_colors.cpp.

References SGNODE::AssociateWrapper(), SGNODE::DisassociateWrapper(), SGNODE::GetNodeType(), SGNODE::GetNodeTypeName(), SGNODE::GetParent(), and IFSG_NODE::m_node.

Referenced by NewNode().

◆ SetColorList()

bool IFSG_COLORS::SetColorList	(	size_t	aListSize,
		const SGCOLOR *	aColorList
	)

Definition at line 162 of file ifsg_colors.cpp.

References IFSG_NODE::m_node.

Referenced by SHAPE::CalcShape().

◆ SetName()

bool IFSG_NODE::SetName ( const char * aName )

inherited

Function SetName sets the node's name; if the pointer passed is NULL then the node's name is erased.

Returns: true on success

Definition at line 103 of file ifsg_node.cpp.

References IFSG_NODE::m_node, and SGNODE::SetName().

◆ SetParent()

bool IFSG_NODE::SetParent ( SGNODE * aParent )

inherited

Function SetParent sets the parent SGNODE of this object.

Parameters

aParent [in] is the desired parent node

Returns: true if the operation succeeds; false if the given node is not allowed to be a parent to the derived object

Definition at line 87 of file ifsg_node.cpp.

References IFSG_NODE::m_node, and SGNODE::SetParent().

Referenced by processFace(), and EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML().

Member Data Documentation

◆ m_node

SGNODE* IFSG_NODE::m_node

protectedinherited

Definition at line 57 of file ifsg_node.h.

Referenced by IFSG_NODE::AddChildNode(), AddColor(), IFSG_COORDS::AddCoord(), IFSG_INDEX::AddIndex(), IFSG_NORMALS::AddNormal(), IFSG_NODE::AddRefNode(), IFSG_APPEARANCE::Attach(), Attach(), IFSG_COORDINDEX::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_NORMALS::Attach(), IFSG_SHAPE::Attach(), IFSG_TRANSFORM::Attach(), IFSG_FACESET::CalcNormals(), IFSG_NODE::Destroy(), IFSG_NODE::FindNode(), GetColorList(), IFSG_COORDS::GetCoordsList(), IFSG_INDEX::GetIndices(), IFSG_NODE::GetName(), IFSG_NODE::GetNodeType(), IFSG_NODE::GetNodeTypeName(), IFSG_NORMALS::GetNormalList(), IFSG_NODE::GetParent(), IFSG_APPEARANCE::IFSG_APPEARANCE(), IFSG_COLORS(), IFSG_COORDINDEX::IFSG_COORDINDEX(), IFSG_COORDS::IFSG_COORDS(), IFSG_FACESET::IFSG_FACESET(), IFSG_NODE::IFSG_NODE(), IFSG_NORMALS::IFSG_NORMALS(), IFSG_SHAPE::IFSG_SHAPE(), IFSG_TRANSFORM::IFSG_TRANSFORM(), IFSG_APPEARANCE::NewNode(), NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_TRANSFORM::NewNode(), IFSG_APPEARANCE::SetAmbient(), SetColorList(), IFSG_COORDS::SetCoordsList(), IFSG_APPEARANCE::SetDiffuse(), IFSG_APPEARANCE::SetEmissive(), IFSG_INDEX::SetIndices(), IFSG_NODE::SetName(), IFSG_NORMALS::SetNormalList(), IFSG_NODE::SetParent(), IFSG_TRANSFORM::SetRotation(), IFSG_TRANSFORM::SetScale(), IFSG_TRANSFORM::SetScaleOrientation(), IFSG_APPEARANCE::SetSpecular(), and IFSG_NODE::~IFSG_NODE().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IFSG_COLORS() [1/3]

◆ IFSG_COLORS() [2/3]

◆ IFSG_COLORS() [3/3]

Member Function Documentation

◆ AddChildNode() [1/2]

◆ AddChildNode() [2/2]

◆ AddColor() [1/2]

◆ AddColor() [2/2]

◆ AddRefNode() [1/2]

◆ AddRefNode() [2/2]

◆ Attach()

◆ Destroy()

◆ FindNode()

◆ GetColorList()

◆ GetName()

◆ GetNodeType()

◆ GetNodeTypeName()

◆ GetParent()

◆ GetRawPtr()

◆ NewNode() [1/2]

◆ NewNode() [2/2]

◆ SetColorList()

◆ SetName()

◆ SetParent()

Member Data Documentation

◆ m_node