KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SGCOORDS Class Reference

Define a vertex coordinate set for a scenegraph object. More...

#include <sg_coords.h>

Inheritance diagram for SGCOORDS:
SGNODE

Public Member Functions

 SGCOORDS (SGNODE *aParent)
 
virtual ~SGCOORDS ()
 
void unlinkChildNode (const SGNODE *aNode) noexcept override
 Remove references to an owned child.
 
void unlinkRefNode (const SGNODE *aNode) noexcept override
 Remove pointers to a referenced node.
 
virtual bool SetParent (SGNODE *aParent, bool notify=true) override
 Set the parent SGNODE of this object.
 
SGNODEFindNode (const char *aNodeName, const SGNODE *aCaller) noexcept override
 Search the tree of linked nodes and return a reference to the first node found with the given name.
 
bool AddRefNode (SGNODE *aNode) noexcept override
 
bool AddChildNode (SGNODE *aNode) noexcept override
 
bool GetCoordsList (size_t &aListSize, SGPOINT *&aCoordsList)
 
void SetCoordsList (size_t aListSize, const SGPOINT *aCoordsList)
 
void AddCoord (double aXValue, double aYValue, double aZValue)
 
void AddCoord (const SGPOINT &aPoint)
 
bool CalcNormals (SGFACESET *callingNode, SGNODE **aPtr=nullptr)
 Calculate normals for this coordinate list and sets the normals list in the parent SGFACESET.
 
void ReNameNodes (void) override
 Rename a node and all its child nodes in preparation for write operations.
 
bool WriteVRML (std::ostream &aFile, bool aReuseFlag) override
 Writes this node's data to a VRML file.
 
bool WriteCache (std::ostream &aFile, SGNODE *parentNode) override
 Write this node's data to a binary cache file.
 
bool ReadCache (std::istream &aFile, SGNODE *parentNode) override
 Reads binary format data from a cache file.
 
S3D::SGTYPES GetNodeType (void) const noexcept
 Return the type of this node instance.
 
SGNODEGetParent (void) const noexcept
 Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.
 
bool SwapParent (SGNODE *aNewParent)
 Swap the ownership with the given parent.
 
const char * GetName (void)
 
void SetName (const char *aName)
 
const char * GetNodeTypeName (S3D::SGTYPES aNodeType) const noexcept
 
void AssociateWrapper (SGNODE **aWrapperRef) noexcept
 Associate this object with a handle to itself.
 
void DisassociateWrapper (SGNODE **aWrapperRef) noexcept
 Remove the association between an IFSG* wrapper object and this object.
 
void ResetNodeIndex (void) noexcept
 Reset the global SG* node indices in preparation for write operations.
 
void addNodeRef (SGNODE *aNode)
 Add a pointer to a node which references this node, but does not own.
 
void delNodeRef (const SGNODE *aNode)
 Remove a pointer to a node which references this node, but does not own.
 
bool isWritten (void) noexcept
 Return true if the object had already been written to a cache file or VRML file.
 

Public Attributes

std::vector< SGPOINTcoords
 

Protected Attributes

std::list< SGNODE * > m_BackPointers
 nodes which hold a reference to this.
 
SGNODEm_Parent
 Pointer to parent node; may be NULL for top level transform.
 
S3D::SGTYPES m_SGtype
 Type of Scene Graph node.
 
std::string m_Name
 name to use for referencing the entity by name.
 
bool m_written
 Set to true when the object has been written after a ReNameNodes().
 

Private Attributes

SGNODE ** m_Association
 Handle to the instance held by a wrapper.
 

Detailed Description

Define a vertex coordinate set for a scenegraph object.

Definition at line 40 of file sg_coords.h.

Constructor & Destructor Documentation

◆ SGCOORDS()

SGCOORDS::SGCOORDS ( SGNODE aParent)

◆ ~SGCOORDS()

SGCOORDS::~SGCOORDS ( )
virtual

Definition at line 54 of file sg_coords.cpp.

References coords.

Member Function Documentation

◆ AddChildNode()

bool SGCOORDS::AddChildNode ( SGNODE aNode)
overridevirtualnoexcept

Implements SGNODE.

Definition at line 122 of file sg_coords.cpp.

◆ AddCoord() [1/2]

void SGCOORDS::AddCoord ( const SGPOINT aPoint)

Definition at line 163 of file sg_coords.cpp.

References coords.

◆ AddCoord() [2/2]

void SGCOORDS::AddCoord ( double  aXValue,
double  aYValue,
double  aZValue 
)

Definition at line 157 of file sg_coords.cpp.

References coords.

◆ addNodeRef()

void SGNODE::addNodeRef ( SGNODE aNode)
inherited

Add a pointer to a node which references this node, but does not own.

Such back-pointers are required to ensure that invalidated references are removed when a node is deleted.

Parameters
aNodeis the node holding a reference to this object.

Definition at line 170 of file sg_node.cpp.

References SGNODE::m_BackPointers.

Referenced by SGFACESET::addNode(), SGSHAPE::addNode(), SGFACESET::ReadCache(), and SGSHAPE::ReadCache().

◆ AddRefNode()

bool SGCOORDS::AddRefNode ( SGNODE aNode)
overridevirtualnoexcept

Implements SGNODE.

Definition at line 114 of file sg_coords.cpp.

◆ AssociateWrapper()

void SGNODE::AssociateWrapper ( SGNODE **  aWrapperRef)
noexceptinherited

◆ CalcNormals()

bool SGCOORDS::CalcNormals ( SGFACESET callingNode,
SGNODE **  aPtr = nullptr 
)

Calculate normals for this coordinate list and sets the normals list in the parent SGFACESET.

Definition at line 309 of file sg_coords.cpp.

References S3D::CalcTriangleNormals(), coords, SGFACESET::GatherCoordIndices(), SGNODE::m_BackPointers, SGFACESET::m_Normals, SGNODE::m_Parent, and SGNORMALS::norms.

Referenced by SGFACESET::CalcNormals().

◆ delNodeRef()

void SGNODE::delNodeRef ( const SGNODE aNode)
inherited

Remove a pointer to a node which references this node, but does not own.

Parameters
aNodeis the node holding a reference to this object.

Definition at line 185 of file sg_node.cpp.

References SGNODE::GetNodeType(), SGNODE::m_BackPointers, and SGNODE::m_SGtype.

Referenced by SGFACESET::unlinkNode(), SGSHAPE::unlinkNode(), SGFACESET::~SGFACESET(), and SGSHAPE::~SGSHAPE().

◆ DisassociateWrapper()

◆ FindNode()

SGNODE * SGCOORDS::FindNode ( const char *  aNodeName,
const SGNODE aCaller 
)
overridevirtualnoexcept

Search the tree of linked nodes and return a reference to the first node found with the given name.

The reference is then typically added to another node via AddRefNode().

Parameters
aNodeNameis the name of the node to search for.
aCalleris a pointer to the node invoking this function.
Returns
is a valid node pointer on success, otherwise NULL.

Implements SGNODE.

Definition at line 90 of file sg_coords.cpp.

Referenced by SGFACESET::FindNode().

◆ GetCoordsList()

bool SGCOORDS::GetCoordsList ( size_t &  aListSize,
SGPOINT *&  aCoordsList 
)

Definition at line 130 of file sg_coords.cpp.

References coords.

Referenced by SGSHAPE::Prepare(), and SGFACESET::validate().

◆ GetName()

◆ GetNodeType()

◆ GetNodeTypeName()

◆ GetParent()

◆ isWritten()

bool SGNODE::isWritten ( void  )
inlinenoexceptinherited

Return true if the object had already been written to a cache file or VRML file.

For internal use only.

Definition at line 220 of file sg_node.h.

References SGNODE::m_written.

Referenced by SCENEGRAPH::WriteCache(), SGFACESET::WriteCache(), and SGSHAPE::WriteCache().

◆ ReadCache()

bool SGCOORDS::ReadCache ( std::istream &  aFile,
SGNODE parentNode 
)
overridevirtual

Reads binary format data from a cache file.

To read a cache file, open the file for reading and invoke this function from a new SCENEGRAPH node.

Implements SGNODE.

Definition at line 286 of file sg_coords.cpp.

References coords, and S3D::ReadPoint().

Referenced by SGFACESET::ReadCache().

◆ ReNameNodes()

void SGCOORDS::ReNameNodes ( void  )
overridevirtual

Rename a node and all its child nodes in preparation for write operations.

Implements SGNODE.

Definition at line 169 of file sg_coords.cpp.

References SGNODE::GetName(), SGNODE::m_Name, and SGNODE::m_written.

Referenced by SGFACESET::ReNameNodes().

◆ ResetNodeIndex()

void SGNODE::ResetNodeIndex ( void  )
noexceptinherited

Reset the global SG* node indices in preparation for write operations.

Definition at line 238 of file sg_node.cpp.

References node_counts, and S3D::SGTYPE_END.

Referenced by S3D::ResetNodeIndex(), SCENEGRAPH::WriteCache(), and S3D::WriteVRML().

◆ SetCoordsList()

void SGCOORDS::SetCoordsList ( size_t  aListSize,
const SGPOINT aCoordsList 
)

Definition at line 145 of file sg_coords.cpp.

References coords.

◆ SetName()

void SGNODE::SetName ( const char *  aName)
inherited

◆ SetParent()

bool SGCOORDS::SetParent ( SGNODE aParent,
bool  notify = true 
)
overridevirtual

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

Implements SGNODE.

Definition at line 60 of file sg_coords.cpp.

References SGNODE::AddChildNode(), SGNODE::GetNodeType(), SGNODE::m_Parent, S3D::SGTYPE_FACESET, and SGNODE::unlinkChildNode().

Referenced by SGFACESET::addNode(), and SGFACESET::~SGFACESET().

◆ SwapParent()

bool SGNODE::SwapParent ( SGNODE aNewParent)
inherited

Swap the ownership with the given parent.

This operation may be required when reordering nodes for optimization.

Parameters
aNewParentwill become the new parent to the object; it must be the same type as the parent of this instance.

Definition at line 116 of file sg_node.cpp.

References SGNODE::AddChildNode(), SGNODE::AddRefNode(), SGNODE::GetNodeType(), SGNODE::m_Parent, SGNODE::unlinkChildNode(), and SGNODE::unlinkRefNode().

Referenced by SGFACESET::WriteCache(), and SGSHAPE::WriteCache().

◆ unlinkChildNode()

void SGCOORDS::unlinkChildNode ( const SGNODE aNode)
overridevirtualnoexcept

Remove references to an owned child.

This is invoked by the child upon destruction to ensure that the parent has no invalid references.

Parameters
aNodeis the child which is being deleted.

Implements SGNODE.

Definition at line 102 of file sg_coords.cpp.

◆ unlinkRefNode()

void SGCOORDS::unlinkRefNode ( const SGNODE aNode)
overridevirtualnoexcept

Remove pointers to a referenced node.

This is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references.

Parameters
aNodeis the node which is being deleted.

Implements SGNODE.

Definition at line 108 of file sg_coords.cpp.

◆ WriteCache()

bool SGCOORDS::WriteCache ( std::ostream &  aFile,
SGNODE parentNode 
)
overridevirtual

Write this node's data to a binary cache file.

The data includes all data of children and references to children. If this function is invoked by the user, parentNode must be set to NULL in order to ensure coherent data.

Implements SGNODE.

Definition at line 241 of file sg_coords.cpp.

References coords, SGNODE::GetName(), SGNODE::GetParent(), SGNODE::m_Parent, SGNODE::m_written, SGNODE::WriteCache(), and S3D::WritePoint().

Referenced by SGFACESET::WriteCache().

◆ WriteVRML()

bool SGCOORDS::WriteVRML ( std::ostream &  aFile,
bool  aReuseFlag 
)
overridevirtual

Writes this node's data to a VRML file.

This includes all data of child and referenced nodes.

Implements SGNODE.

Definition at line 179 of file sg_coords.cpp.

References coords, S3D::FormatPoint(), SGNODE::GetName(), SGNODE::m_written, SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by SGFACESET::WriteVRML().

Member Data Documentation

◆ coords

std::vector< SGPOINT > SGCOORDS::coords

◆ m_Association

SGNODE** SGNODE::m_Association
privateinherited

Handle to the instance held by a wrapper.

Definition at line 233 of file sg_node.h.

Referenced by SGNODE::SGNODE(), and SGNODE::~SGNODE().

◆ m_BackPointers

std::list< SGNODE* > SGNODE::m_BackPointers
protectedinherited

nodes which hold a reference to this.

Definition at line 226 of file sg_node.h.

Referenced by SGNODE::addNodeRef(), CalcNormals(), SGNODE::delNodeRef(), and SGNODE::~SGNODE().

◆ m_Name

◆ m_Parent

◆ m_SGtype

◆ m_written


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