SGFACESET Class Reference

#include <sg_faceset.h>

Inheritance diagram for SGFACESET:

Public Member Functions
void	unlinkChildNode (const SGNODE *aNode) override
	Function unlinkChild removes references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references. More...
void	unlinkRefNode (const SGNODE *aNode) override
	Function unlinkRef removes pointers to a referenced node; it is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references. More...
bool	validate (void)
	SGFACESET (SGNODE *aParent)
virtual	~SGFACESET ()
virtual bool	SetParent (SGNODE *aParent, bool notify=true) override
	Function SetParent sets the parent SGNODE of this object. More...
SGNODE *	FindNode (const char *aNodeName, const SGNODE *aCaller) override
	Function FindNode searches the tree of linked nodes and returns a reference to the first node found with the given name. More...
bool	AddRefNode (SGNODE *aNode) override
bool	AddChildNode (SGNODE *aNode) override
bool	CalcNormals (SGNODE **aPtr)
void	ReNameNodes (void) override
	Function ReNameNodes renames a node and all its child nodes in preparation for Write() operations. More...
bool	WriteVRML (std::ostream &aFile, bool aReuseFlag) override
	Function WriteVRML writes this node's data to a VRML file; this includes all data of child and referenced nodes. More...
bool	WriteCache (std::ostream &aFile, SGNODE *parentNode) override
	Function WriteCache write's this node's data to a binary cache file; the data includes all data of children and references to children. More...
bool	ReadCache (std::istream &aFile, SGNODE *parentNode) override
	Function ReadCache Reads binary format data from a cache file. More...
void	GatherCoordIndices (std::vector< int > &aIndexList)
	Function GatherCoordIndices adds all internal coordinate indices to the given list in preparation for a normals calculation. More...
void	addNodeRef (SGNODE *aNode)
	Function addNodeRef adds a pointer to a node which references, but does not own, this node. More...
void	delNodeRef (const SGNODE *aNode)
	Function delNodeRef removes a pointer to a node which references, but does not own, this node. More...
bool	isWritten (void)
	Function IsWritten returns true if the object had already been written to a cache file or VRML file; for internal use only. More...
S3D::SGTYPES	GetNodeType (void) const
	Function GetNodeType returns the type of this node instance. More...
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. More...
bool	SwapParent (SGNODE *aNewParent)
	Function SwapParent swaps the ownership with the given parent. More...
const char *	GetName (void)
void	SetName (const char *aName)
const char *	GetNodeTypeName (S3D::SGTYPES aNodeType) const
void	AssociateWrapper (SGNODE **aWrapperRef)
	Function AssociateWrapper associates this object with a handle to itself; this handle is typically held by an IFSG* wrapper and the pointer which it refers to is set to NULL upon destruction of this object. More...
void	DisassociateWrapper (SGNODE **aWrapperRef)
	Function DisassociateWrapper removes the association between an IFSG* wrapper object and this object. More...
void	ResetNodeIndex (void)
	Function ResetNodeIndex resets the global SG* node indices in preparation for Write() operations. More...

Public Attributes
SGCOLORS *	m_Colors
SGCOORDS *	m_Coords
SGCOORDINDEX *	m_CoordIndices
SGNORMALS *	m_Normals
SGCOLORS *	m_RColors
SGCOORDS *	m_RCoords
SGNORMALS *	m_RNormals

Protected Attributes
std::list< SGNODE *>	m_BackPointers
SGNODE *	m_Parent
S3D::SGTYPES	m_SGtype
std::string	m_Name
bool	m_written

Private Member Functions
void	unlinkNode (const SGNODE *aNode, bool isChild)
bool	addNode (SGNODE *aNode, bool isChild)

Private Attributes
bool	valid
bool	validated

Detailed Description

Definition at line 43 of file sg_faceset.h.

Constructor & Destructor Documentation

SGFACESET()

SGFACESET::SGFACESET

(

SGNODE *

aParent

)

Definition at line 36 of file sg_faceset.cpp.

References SGNODE::AddChildNode(), SGNODE::GetNodeType(), m_Colors, m_CoordIndices, m_Coords, m_Normals, SGNODE::m_Parent, m_RColors, m_RCoords, m_RNormals, SGNODE::m_SGtype, S3D::SGTYPE_FACESET, S3D::SGTYPE_SHAPE, valid, and validated.

                                      : SGNODE( aParent )
{
    m_SGtype = S3D::SGTYPE_FACESET;
    m_Colors = NULL;
    m_Coords = NULL;
    m_CoordIndices = NULL;
    m_Normals = NULL;
    m_RColors = NULL;
    m_RCoords = NULL;
    m_RNormals = NULL;
    valid = false;
    validated = false;

    if( NULL != aParent && S3D::SGTYPE_SHAPE != aParent->GetNodeType() )
    {
        m_Parent = NULL;

#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] inappropriate parent to SGFACESET (type ";
        ostr << aParent->GetNodeType() << ")";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
    }
    else if( NULL != aParent && S3D::SGTYPE_SHAPE == aParent->GetNodeType() )
    {
        m_Parent->AddChildNode( this );
    }

    return;
}

~SGFACESET()

SGFACESET::~SGFACESET ( )

virtual

Definition at line 70 of file sg_faceset.cpp.

References SGNODE::delNodeRef(), m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, SGCOLORS::SetParent(), SGNORMALS::SetParent(), SGCOORDS::SetParent(), and SGINDEX::SetParent().

{
    // drop references
    if( m_RColors )
    {
        m_RColors->delNodeRef( this );
        m_RColors = NULL;
    }

    if( m_RCoords )
    {
        m_RCoords->delNodeRef( this );
        m_RCoords = NULL;
    }

    if( m_RNormals )
    {
        m_RNormals->delNodeRef( this );
        m_RNormals = NULL;
    }

    // delete owned objects
    if( m_Colors )
    {
        m_Colors->SetParent( NULL, false );
        delete m_Colors;
        m_Colors = NULL;
    }

    if( m_Coords )
    {
        m_Coords->SetParent( NULL, false );
        delete m_Coords;
        m_Coords = NULL;
    }

    if( m_Normals )
    {
        m_Normals->SetParent( NULL, false );
        delete m_Normals;
        m_Normals = NULL;
    }

    if( m_CoordIndices )
    {
        m_CoordIndices->SetParent( NULL, false );
        delete m_CoordIndices;
        m_CoordIndices = NULL;
    }

    return;
}

Member Function Documentation

AddChildNode()

bool SGFACESET::AddChildNode ( SGNODE *  aNode )

overridevirtual

Implements SGNODE.

Definition at line 452 of file sg_faceset.cpp.

References addNode().

{
    return addNode( aNode, true );
}

addNode()

bool SGFACESET::addNode ( SGNODE *  aNode, bool  isChild  )

private

Definition at line 290 of file sg_faceset.cpp.

References SGNODE::addNodeRef(), SGNODE::GetName(), SGNODE::GetNodeType(), m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, SGNORMALS::SetParent(), SGCOLORS::SetParent(), SGCOORDS::SetParent(), SGINDEX::SetParent(), S3D::SGTYPE_COLORS, S3D::SGTYPE_COORDINDEX, S3D::SGTYPE_COORDS, S3D::SGTYPE_NORMALS, valid, and validated.

Referenced by AddChildNode(), and AddRefNode().

{
    if( NULL == aNode )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] NULL pointer passed for aNode";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

    valid = false;
    validated = false;

    if( S3D::SGTYPE_COLORS == aNode->GetNodeType() )
    {
        if( m_Colors || m_RColors )
        {
            if( aNode != m_Colors && aNode != m_RColors )
            {
                #ifdef DEBUG
                std::ostringstream ostr;
                ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
                ostr << " * [BUG] assigning multiple Colors nodes";
                wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
                #endif

                return false;
            }

            return true;
        }

        if( isChild )
        {
            m_Colors = (SGCOLORS*)aNode;
            m_Colors->SetParent( this );
        }
        else
        {
            m_RColors = (SGCOLORS*)aNode;
            m_RColors->addNodeRef( this );
        }

        return true;
    }

    if( S3D::SGTYPE_COORDS == aNode->GetNodeType() )
    {
        if( m_Coords || m_RCoords )
        {
            if( aNode != m_Coords && aNode != m_RCoords )
            {
                #ifdef DEBUG
                std::ostringstream ostr;
                ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
                ostr << " * [BUG] assigning multiple Coords nodes";
                wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
                #endif

                return false;
            }

            return true;
        }

        if( isChild )
        {
            m_Coords = (SGCOORDS*)aNode;
            m_Coords->SetParent( this );
        }
        else
        {
            m_RCoords = (SGCOORDS*)aNode;
            m_RCoords->addNodeRef( this );
        }

        return true;
    }

    if( S3D::SGTYPE_NORMALS == aNode->GetNodeType() )
    {
        if( m_Normals || m_RNormals )
        {
            if( aNode != m_Normals && aNode != m_RNormals )
            {
                #ifdef DEBUG
                std::ostringstream ostr;
                ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
                ostr << " * [BUG] assigning multiple Normals nodes";
                wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
                #endif

                return false;
            }

            return true;
        }

        if( isChild )
        {
            m_Normals = (SGNORMALS*)aNode;
            m_Normals->SetParent( this );
        }
        else
        {
            m_RNormals = (SGNORMALS*)aNode;
            m_RNormals->addNodeRef( this );
        }

        return true;
    }

    if( S3D::SGTYPE_COORDINDEX == aNode->GetNodeType() )
    {
        if( m_CoordIndices )
        {
            if( aNode != m_CoordIndices )
            {
                #ifdef DEBUG
                std::ostringstream ostr;
                ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
                ostr << " * [BUG] assigning multiple CoordIndex nodes";
                wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
                #endif

                return false;
            }

            return true;
        }

        m_CoordIndices = (SGCOORDINDEX*)aNode;
        m_CoordIndices->SetParent( this );

        return true;
    }

    #ifdef DEBUG
    do {
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] object '" << aNode->GetName();
        ostr << "' (type " << aNode->GetNodeType();
        ostr << ") is not a valid type for this object (" << aNode->GetNodeType() << ")";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
    } while( 0 );
    #endif

    return false;
}

addNodeRef()

void SGNODE::addNodeRef ( SGNODE *  aNode )

inherited

Function addNodeRef adds 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 176 of file sg_node.cpp.

References SGNODE::m_BackPointers.

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

{
    if( NULL == aNode )
        return;

    std::list< SGNODE* >::iterator np =
        std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );

    if( np != m_BackPointers.end() )
        return;

    m_BackPointers.push_back( aNode );
    return;
}

AddRefNode()

bool SGFACESET::AddRefNode ( SGNODE *  aNode )

overridevirtual

Implements SGNODE.

Definition at line 446 of file sg_faceset.cpp.

References addNode().

{
    return addNode( aNode, false );
}

AssociateWrapper()

void SGNODE::AssociateWrapper ( SGNODE **  aWrapperRef )

inherited

Function AssociateWrapper associates this object with a handle to itself; this handle is typically held by an IFSG* wrapper and the pointer which it refers to is set to NULL upon destruction of this object.

This mechanism provides a scheme by which a wrapper can be notified of the destruction of the object which it wraps.

Definition at line 219 of file sg_node.cpp.

References SGNODE::m_Association.

Referenced by S3D::AssociateSGNodeWrapper(), IFSG_APPEARANCE::Attach(), IFSG_SHAPE::Attach(), IFSG_COORDINDEX::Attach(), IFSG_NORMALS::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_COLORS::Attach(), IFSG_TRANSFORM::Attach(), IFSG_APPEARANCE::IFSG_APPEARANCE(), IFSG_COLORS::IFSG_COLORS(), IFSG_COORDINDEX::IFSG_COORDINDEX(), IFSG_COORDS::IFSG_COORDS(), IFSG_FACESET::IFSG_FACESET(), IFSG_NORMALS::IFSG_NORMALS(), IFSG_SHAPE::IFSG_SHAPE(), IFSG_TRANSFORM::IFSG_TRANSFORM(), IFSG_APPEARANCE::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_FACESET::NewNode(), IFSG_COORDS::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COLORS::NewNode(), and IFSG_TRANSFORM::NewNode().

{
    if( NULL == aWrapperRef )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] NULL handle";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return;
    }

    if( *aWrapperRef != this )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] handle value does not match this object's pointer";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return;
    }

    // if there is an existing association then break it and emit a warning
    // just in case the behavior is undesired
    if( m_Association )
    {
        *m_Association = NULL;

        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [WARNING] association being broken with previous wrapper";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif
    }

    m_Association = aWrapperRef;

    return;
}

CalcNormals()

bool SGFACESET::CalcNormals

(

SGNODE **

aPtr

)

Definition at line 1120 of file sg_faceset.cpp.

References SGCOORDS::CalcNormals(), SGCOORDS::coords, m_Coords, m_Normals, m_RCoords, m_RNormals, and SGNORMALS::norms.

{
    SGCOORDS* coords = m_Coords;

    if( m_RCoords )
        coords = m_RCoords;

    if( NULL == coords || coords->coords.empty() )
        return false;

    if( m_Normals && !m_Normals->norms.empty( ) )
        return true;

    if( m_RNormals && !m_RNormals->norms.empty( ) )
        return true;

    return coords->CalcNormals( this, aPtr );
}

delNodeRef()

void SGNODE::delNodeRef ( const SGNODE *  aNode )

inherited

Function delNodeRef removes 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 192 of file sg_node.cpp.

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

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

{
    if( NULL == aNode )
        return;

    std::list< SGNODE* >::iterator np =
        std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );

    if( np != m_BackPointers.end() )
    {
        m_BackPointers.erase( np );
        return;
    }

    #ifdef DEBUG
    std::ostringstream ostr;
    ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
    ostr << " * [BUG] delNodeRef() did not find its target\n";
    ostr << " * This Node Type: " << m_SGtype << ", Referenced node type: ";
    ostr << aNode->GetNodeType() << "\n";
    wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
    #endif

    return;
}

DisassociateWrapper()

void SGNODE::DisassociateWrapper ( SGNODE **  aWrapperRef )

inherited

Function DisassociateWrapper removes the association between an IFSG* wrapper object and this object.

Definition at line 264 of file sg_node.cpp.

References SGNODE::GetName(), SGNODE::m_Association, SGNODE::m_SGtype, and node_names.

Referenced by IFSG_APPEARANCE::Attach(), IFSG_COORDINDEX::Attach(), IFSG_NORMALS::Attach(), IFSG_FACESET::Attach(), IFSG_COORDS::Attach(), IFSG_SHAPE::Attach(), IFSG_COLORS::Attach(), IFSG_TRANSFORM::Attach(), IFSG_NODE::Destroy(), IFSG_APPEARANCE::NewNode(), IFSG_COORDS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_NORMALS::NewNode(), IFSG_FACESET::NewNode(), IFSG_COLORS::NewNode(), IFSG_TRANSFORM::NewNode(), and IFSG_NODE::~IFSG_NODE().

{
    if( !m_Association )
        return;

    if( !aWrapperRef )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] invalid handle value aWrapperRef";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return;
    }

    if( *aWrapperRef != *m_Association || aWrapperRef != m_Association )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] *aWrapperRef (" << *aWrapperRef;
        ostr << ") does not match *m_Association (" << *m_Association << ") in type ";
        ostr << node_names[ m_SGtype] << "\n";
        ostr << " * [INFO] OR aWrapperRef(" << aWrapperRef << ") != m_Association(";
        ostr << m_Association << ")\n";
        ostr << " * [INFO] node name: " << GetName();
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return;
    }

    m_Association = NULL;

    return;
}

FindNode()

SGNODE * SGFACESET::FindNode ( const char *  aNodeName, const SGNODE *  aCaller  )

overridevirtual

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
aCaller	is a pointer to the node invoking this function

Returns

is a valid node pointer on success, otherwise NULL

Implements SGNODE.

Definition at line 154 of file sg_faceset.cpp.

References SGCOLORS::FindNode(), SGNORMALS::FindNode(), SGCOORDS::FindNode(), SGINDEX::FindNode(), SGNODE::FindNode(), m_Colors, m_CoordIndices, m_Coords, SGNODE::m_Name, m_Normals, and SGNODE::m_Parent.

Referenced by SGSHAPE::FindNode(), and ReadCache().

{
    if( NULL == aNodeName || 0 == aNodeName[0] )
        return NULL;

    if( !m_Name.compare( aNodeName ) )
        return this;

    SGNODE* np = NULL;

    if( m_Colors )
    {
        np = m_Colors->FindNode( aNodeName, this );

        if( np )
            return np;
    }

    if( m_Coords )
    {
        np = m_Coords->FindNode( aNodeName, this );

        if( np )
            return np;
    }

    if( m_CoordIndices )
    {
        np = m_CoordIndices->FindNode( aNodeName, this );

        if( np )
            return np;
    }

    if( m_Normals )
    {
        np = m_Normals->FindNode( aNodeName, this );

        if( np )
            return np;
    }

    // query the parent if appropriate
    if( aCaller == m_Parent || NULL == m_Parent )
        return NULL;

    return m_Parent->FindNode( aNodeName, this );
}

GatherCoordIndices()

void SGFACESET::GatherCoordIndices

(

std::vector< int > &

aIndexList

)

Function GatherCoordIndices adds all internal coordinate indices to the given list in preparation for a normals calculation.

Definition at line 1111 of file sg_faceset.cpp.

References SGCOORDINDEX::GatherCoordIndices(), and m_CoordIndices.

Referenced by SGCOORDS::CalcNormals().

{
    if( m_CoordIndices )
        m_CoordIndices->GatherCoordIndices( aIndexList );

    return;
}

GetName()

const char * SGNODE::GetName ( void  )

inherited

Definition at line 150 of file sg_node.cpp.

References getNodeName(), SGNODE::m_Name, and SGNODE::m_SGtype.

Referenced by SGSHAPE::addNode(), addNode(), SCENEGRAPH::addNode(), SGNODE::DisassociateWrapper(), IFSG_NODE::GetName(), SGCOLORS::ReNameNodes(), SGNORMALS::ReNameNodes(), SGSHAPE::ReNameNodes(), SGCOORDS::ReNameNodes(), SGAPPEARANCE::ReNameNodes(), ReNameNodes(), SCENEGRAPH::ReNameNodes(), SGINDEX::ReNameNodes(), SGNORMALS::WriteCache(), SGCOLORS::WriteCache(), SGSHAPE::WriteCache(), SGCOORDS::WriteCache(), SGAPPEARANCE::WriteCache(), WriteCache(), SCENEGRAPH::WriteCache(), SGINDEX::WriteCache(), SGCOLORS::WriteVRML(), SGNORMALS::WriteVRML(), SGCOORDS::WriteVRML(), SGSHAPE::WriteVRML(), SGAPPEARANCE::WriteVRML(), WriteVRML(), and SCENEGRAPH::WriteVRML().

{
    if( m_Name.empty() )
        getNodeName( m_SGtype, m_Name );

    return m_Name.c_str();
}

GetNodeType()

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

inherited

Function GetNodeType returns the type of this node instance.

Definition at line 108 of file sg_node.cpp.

References SGNODE::m_SGtype.

Referenced by SGSHAPE::addNode(), addNode(), SCENEGRAPH::addNode(), IFSG_APPEARANCE::Attach(), IFSG_COORDINDEX::Attach(), IFSG_SHAPE::Attach(), IFSG_COORDS::Attach(), IFSG_FACESET::Attach(), IFSG_NORMALS::Attach(), IFSG_COLORS::Attach(), IFSG_TRANSFORM::Attach(), SGNODE::delNodeRef(), S3D::GetMatIndex(), S3D::GetModel(), IFSG_NODE::GetNodeType(), S3D::GetSGNodeType(), IFSG_APPEARANCE::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_COLORS::NewNode(), IFSG_TRANSFORM::NewNode(), SGSHAPE::ReadCache(), ReadCache(), SCENEGRAPH::ReadCache(), SCENEGRAPH::SCENEGRAPH(), SGCOLORS::SetParent(), SGNORMALS::SetParent(), SGCOORDS::SetParent(), SGAPPEARANCE::SetParent(), SGINDEX::SetParent(), SGSHAPE::SetParent(), SetParent(), SCENEGRAPH::SetParent(), SGAPPEARANCE::SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET(), SGINDEX::SGINDEX(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), SGNODE::SwapParent(), SCENEGRAPH::unlinkNode(), and S3D::WriteVRML().

{
    return m_SGtype;
}

GetNodeTypeName()

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

inherited

Definition at line 170 of file sg_node.cpp.

References node_names.

Referenced by IFSG_NODE::GetNodeTypeName(), IFSG_APPEARANCE::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_COORDS::NewNode(), IFSG_FACESET::NewNode(), IFSG_SHAPE::NewNode(), IFSG_NORMALS::NewNode(), IFSG_COLORS::NewNode(), and IFSG_TRANSFORM::NewNode().

{
    return node_names[aNodeType].c_str();
}

GetParent()

SGNODE * SGNODE::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 114 of file sg_node.cpp.

References SGNODE::m_Parent.

Referenced by IFSG_NODE::GetParent(), S3D::GetSGNodeParent(), IFSG_APPEARANCE::NewNode(), IFSG_COORDINDEX::NewNode(), IFSG_FACESET::NewNode(), IFSG_NORMALS::NewNode(), IFSG_SHAPE::NewNode(), IFSG_COORDS::NewNode(), IFSG_COLORS::NewNode(), IFSG_TRANSFORM::NewNode(), SGNORMALS::WriteCache(), SGCOLORS::WriteCache(), SGSHAPE::WriteCache(), SGCOORDS::WriteCache(), SGAPPEARANCE::WriteCache(), WriteCache(), SCENEGRAPH::WriteCache(), and SGINDEX::WriteCache().

{
    return m_Parent;
}

isWritten()

bool SGNODE::isWritten ( void  )

inlineinherited

Function IsWritten returns true if the object had already been written to a cache file or VRML file; for internal use only.

Definition at line 130 of file sg_node.h.

References SGNODE::m_written.

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

    {
        return m_written;
    }

ReadCache()

bool SGFACESET::ReadCache ( std::istream &  aFile, SGNODE *  parentNode  )

overridevirtual

Function ReadCache 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 673 of file sg_faceset.cpp.

References SGNODE::addNodeRef(), FindNode(), SGNODE::GetNodeType(), i, m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, name, NITEMS, SGCOLORS::ReadCache(), SGNORMALS::ReadCache(), SGCOORDS::ReadCache(), SGINDEX::ReadCache(), S3D::ReadTag(), SGNODE::SetName(), S3D::SGTYPE_COLORS, S3D::SGTYPE_COORDINDEX, S3D::SGTYPE_COORDS, and S3D::SGTYPE_NORMALS.

Referenced by SGSHAPE::ReadCache().

{
    if( m_Coords || m_RCoords || m_CoordIndices
        || m_Colors || m_RColors
        || m_Normals || m_RNormals )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] non-empty node";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

    #define NITEMS 7
    bool items[NITEMS];

    for( int i = 0; i < NITEMS; ++i )
        aFile.read( (char*)&items[i], sizeof(bool) );

    if( ( items[0] && items[1] ) || ( items[3] && items[4] )
        || ( items[5] && items[6] ) )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] corrupt data; multiple item definitions at position ";
        ostr << aFile.tellg();
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

    std::string name;

    if( items[0] )
    {
        if( S3D::SGTYPE_COORDS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad child coords tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_Coords = new SGCOORDS( this );
        m_Coords->SetName( name.c_str() );

        if( !m_Coords->ReadCache( aFile, this ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data while reading coords '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }
    }

    if( items[1] )
    {
        if( S3D::SGTYPE_COORDS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad ref coords tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        SGNODE* np = FindNode( name.c_str(), this );

        if( !np )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: cannot find ref coords '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        if( S3D::SGTYPE_COORDS != np->GetNodeType() )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: type is not SGCOORDS '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_RCoords = (SGCOORDS*)np;
        m_RCoords->addNodeRef( this );
    }

    if( items[2] )
    {
        if( S3D::SGTYPE_COORDINDEX != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad coord index tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_CoordIndices = new SGCOORDINDEX( this );
        m_CoordIndices->SetName( name.c_str() );

        if( !m_CoordIndices->ReadCache( aFile, this ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data while reading coord index '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }
    }

    if( items[3] )
    {
        if( S3D::SGTYPE_NORMALS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad child normals tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_Normals = new SGNORMALS( this );
        m_Normals->SetName( name.c_str() );

        if( !m_Normals->ReadCache( aFile, this ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data while reading normals '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }
    }

    if( items[4] )
    {
        if( S3D::SGTYPE_NORMALS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad ref normals tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        SGNODE* np = FindNode( name.c_str(), this );

        if( !np )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: cannot find ref normals '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        if( S3D::SGTYPE_NORMALS != np->GetNodeType() )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: type is not SGNORMALS '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_RNormals = (SGNORMALS*)np;
        m_RNormals->addNodeRef( this );
    }

    if( items[5] )
    {
        if( S3D::SGTYPE_COLORS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad child colors tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_Colors = new SGCOLORS( this );
        m_Colors->SetName( name.c_str() );

        if( !m_Colors->ReadCache( aFile, this ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data while reading colors '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }
    }

    if( items[6] )
    {
        if( S3D::SGTYPE_COLORS != S3D::ReadTag( aFile, name ) )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data; bad ref colors tag at position ";
            ostr << aFile.tellg();
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        SGNODE* np = FindNode( name.c_str(), this );

        if( !np )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: cannot find ref colors '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        if( S3D::SGTYPE_COLORS != np->GetNodeType() )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] corrupt data: type is not SGCOLORS '";
            ostr << name << "'";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        m_RColors = (SGCOLORS*)np;
        m_RColors->addNodeRef( this );
    }

    if( aFile.fail() )
        return false;

    return true;
}

ReNameNodes()

void SGFACESET::ReNameNodes ( void  )

overridevirtual

Function ReNameNodes renames a node and all its child nodes in preparation for Write() operations.

Implements SGNODE.

Definition at line 458 of file sg_faceset.cpp.

References SGNODE::GetName(), m_Colors, m_CoordIndices, m_Coords, SGNODE::m_Name, m_Normals, SGNODE::m_written, SGCOLORS::ReNameNodes(), SGNORMALS::ReNameNodes(), SGCOORDS::ReNameNodes(), and SGINDEX::ReNameNodes().

Referenced by SGSHAPE::ReNameNodes().

{
    m_written = false;

    // rename this node
    m_Name.clear();
    GetName();

    // rename all Colors and Indices
    if( m_Colors )
        m_Colors->ReNameNodes();

    // rename all Coordinates and Indices
    if( m_Coords )
        m_Coords->ReNameNodes();

    if( m_CoordIndices )
        m_CoordIndices->ReNameNodes();

    // rename all Normals and Indices
    if( m_Normals )
        m_Normals->ReNameNodes();

    return;
}

ResetNodeIndex()

void SGNODE::ResetNodeIndex ( void  )

inherited

Function ResetNodeIndex resets the global SG* node indices in preparation for Write() operations.

Definition at line 304 of file sg_node.cpp.

References i, node_counts, and S3D::SGTYPE_END.

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

{
    for( int i = 0; i < (int)S3D::SGTYPE_END; ++i )
        node_counts[i] = 1;

    return;
}

SetName()

void SGNODE::SetName ( const char *  aName )

inherited

Definition at line 159 of file sg_node.cpp.

References getNodeName(), SGNODE::m_Name, and SGNODE::m_SGtype.

Referenced by SGSHAPE::ReadCache(), ReadCache(), SCENEGRAPH::ReadCache(), and IFSG_NODE::SetName().

{
    if( NULL == aName || 0 == aName[0] )
        getNodeName( m_SGtype, m_Name );
    else
        m_Name = aName;

    return;
}

SetParent()

bool SGFACESET::SetParent ( SGNODE *  aParent, bool  notify = true  )

overridevirtual

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.

Implements SGNODE.

Definition at line 124 of file sg_faceset.cpp.

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

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

{
    if( NULL != m_Parent )
    {
        if( aParent == m_Parent )
            return true;

        // handle the change in parents
        if( notify )
            m_Parent->unlinkChildNode( this );

        m_Parent = NULL;

        if( NULL == aParent )
            return true;
    }

    // only a SGSHAPE may be parent to a SGFACESET
    if( NULL != aParent && S3D::SGTYPE_SHAPE != aParent->GetNodeType() )
        return false;

    m_Parent = aParent;

    if( m_Parent )
        m_Parent->AddChildNode( this );

    return true;
}

SwapParent()

bool SGNODE::SwapParent ( SGNODE *  aNewParent )

inherited

Function SwapParent swaps the ownership with the given parent.

This operation may be required when reordering nodes for optimization.

Parameters

aNewParent

[in] will become the new parent to the object; it must be the same type as the parent of this instance.

Definition at line 120 of file sg_node.cpp.

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

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

{
    if( aNewParent == m_Parent )
        return true;

    if( NULL == aNewParent )
        return false;

    if( NULL == m_Parent )
    {
        if( aNewParent->AddChildNode( this ) )
            return true;

        return false;
    }

    if( aNewParent->GetNodeType() != m_Parent->GetNodeType() )
        return false;

    SGNODE* oldParent = m_Parent;
    m_Parent->unlinkChildNode( this );
    m_Parent = NULL;
    aNewParent->unlinkRefNode( this );
    aNewParent->AddChildNode( this );
    oldParent->AddRefNode( this );

    return true;
}

unlinkChildNode()

void SGFACESET::unlinkChildNode ( const SGNODE *  aNode )

overridevirtual

Function unlinkChild removes 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

Implements SGNODE.

Definition at line 275 of file sg_faceset.cpp.

References unlinkNode().

{
    unlinkNode( aNode, true );
    return;
}

unlinkNode()

void SGFACESET::unlinkNode ( const SGNODE *  aNode, bool  isChild  )

private

Definition at line 204 of file sg_faceset.cpp.

References SGNODE::delNodeRef(), m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, valid, and validated.

Referenced by unlinkChildNode(), and unlinkRefNode().

{
    if( NULL == aNode )
        return;

    valid = false;
    validated = false;

    if( isChild )
    {
        if( aNode == m_Colors )
        {
            m_Colors = NULL;
            return;
        }

        if( aNode == m_Coords )
        {
            m_Coords = NULL;
            return;
        }

        if( aNode == m_Normals )
        {
            m_Normals = NULL;
            return;
        }

        if( aNode == m_CoordIndices )
        {
            m_CoordIndices = NULL;
            return;
        }
    }
    else
    {
        if( aNode == m_RColors )
        {
            delNodeRef( this );
            m_RColors = NULL;
            return;
        }

        if( aNode == m_RCoords )
        {
            delNodeRef( this );
            m_RCoords = NULL;
            return;
        }

        if( aNode == m_RNormals )
        {
            delNodeRef( this );
            m_RNormals = NULL;
            return;
        }
    }

    #ifdef DEBUG
    do {
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] unlinkNode() did not find its target";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
    } while( 0 );
    #endif

    return;
}

unlinkRefNode()

void SGFACESET::unlinkRefNode ( const SGNODE *  aNode )

overridevirtual

Function unlinkRef removes 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

Implements SGNODE.

Definition at line 282 of file sg_faceset.cpp.

References unlinkNode().

{
    unlinkNode( aNode, false );
    return;
}

validate()

bool SGFACESET::validate

(

void

)

Definition at line 987 of file sg_faceset.cpp.

References SGCOLORS::GetColorList(), SGCOORDS::GetCoordsList(), SGINDEX::GetIndices(), SGNORMALS::GetNormalList(), i, m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, valid, and validated.

Referenced by SGSHAPE::Prepare().

{
    // verify the integrity of this object's data
    if( validated )
        return valid;

    // ensure we have at least coordinates and their normals
    if( (NULL == m_Coords && NULL == m_RCoords)
        || (NULL == m_Normals && NULL == m_RNormals)
        || (NULL == m_CoordIndices) )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] bad model; no vertices, vertex indices, or normals";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        validated = true;
        valid = false;
        return false;
    }

    // check that there are >3 vertices
    SGCOORDS* coords = m_Coords;

    if( NULL == coords )
        coords = m_RCoords;

    size_t nCoords = 0;
    SGPOINT* lCoords = NULL;
    coords->GetCoordsList( nCoords, lCoords );

    if( nCoords < 3 )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] bad model; fewer than 3 vertices";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        validated = true;
        valid = false;
        return false;
    }

    // check that nVertices is divisible by 3 (facets are triangles)
    size_t nCIdx = 0;
    int* lCIdx = NULL;
    m_CoordIndices->GetIndices( nCIdx, lCIdx );

    if( nCIdx < 3 || ( nCIdx % 3 > 0 ) )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] bad model; no vertex indices or not multiple of 3";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        validated = true;
        valid = false;
        return false;
    }

    // check that vertex[n] >= 0 and < nVertices
    for( size_t i = 0; i < nCIdx; ++i )
    {
        if( lCIdx[i] < 0 || lCIdx[i] >= (int)nCoords )
        {
#ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [INFO] bad model; vertex index out of bounds";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
            validated = true;
            valid = false;
            return false;
        }
    }

    // check that there are as many normals as vertices
    size_t nNorms = 0;
    SGVECTOR* lNorms = NULL;
    SGNORMALS* pNorms = m_Normals;

    if( NULL == pNorms )
        pNorms = m_RNormals;

    pNorms->GetNormalList( nNorms, lNorms );

    if( nNorms != nCoords )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] bad model; number of normals (" << nNorms;
        ostr << ") does not match number of vertices (" << nCoords << ")";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        validated = true;
        valid = false;
        return false;
    }

    // if there are colors then ensure there are as many colors as vertices
    SGCOLORS* pColors = m_Colors;

    if( NULL == pColors )
        pColors = m_RColors;

    if( NULL != pColors )
    {
        // we must have at least as many colors as vertices
        size_t nColor = 0;
        SGCOLOR* pColor = NULL;
        pColors->GetColorList( nColor, pColor );
    }

    validated = true;
    valid = true;
    return true;
}

WriteCache()

bool SGFACESET::WriteCache ( std::ostream &  aFile, SGNODE *  parentNode  )

overridevirtual

Function WriteCache write's 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 541 of file sg_faceset.cpp.

References SGNODE::GetName(), SGNODE::GetParent(), i, SGNODE::isWritten(), m_Colors, m_CoordIndices, m_Coords, m_Normals, SGNODE::m_Parent, m_RColors, m_RCoords, m_RNormals, SGNODE::m_written, NITEMS, SGNODE::SwapParent(), SGNORMALS::WriteCache(), SGCOLORS::WriteCache(), SGCOORDS::WriteCache(), SGINDEX::WriteCache(), and SGNODE::WriteCache().

Referenced by SGSHAPE::WriteCache().

{
    if( NULL == parentNode )
    {
        if( NULL == m_Parent )
        {
            #ifdef DEBUG
            std::ostringstream ostr;
            ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
            ostr << " * [BUG] corrupt data; m_aParent is NULL";
            wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
            #endif

            return false;
        }

        SGNODE* np = m_Parent;

        while( NULL != np->GetParent() )
            np = np->GetParent();

        if( np->WriteCache( aFile, NULL ) )
        {
            m_written = true;
            return true;
        }

        return false;
    }

    if( parentNode != m_Parent )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] corrupt data; parentNode != m_aParent";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

    if( !aFile.good() )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [INFO] bad stream";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

    // check if any references are unwritten and swap parents if so
    if( NULL != m_RCoords && !m_RCoords->isWritten() )
        m_RCoords->SwapParent( this );

    if( NULL != m_RNormals && !m_RNormals->isWritten() )
        m_RNormals->SwapParent( this );

    if( NULL != m_RColors && !m_RColors->isWritten() )
        m_RColors->SwapParent( this );

    aFile << "[" << GetName() << "]";
    #define NITEMS 7
    bool items[NITEMS];
    int i;

    for( i = 0; i < NITEMS; ++i )
        items[i] = 0;

    i = 0;
    if( NULL != m_Coords )
        items[i] = true;

    ++i;
    if( NULL != m_RCoords )
        items[i] = true;

    ++i;
    if( NULL != m_CoordIndices )
        items[i] = true;

    ++i;
    if( NULL != m_Normals )
        items[i] = true;

    ++i;
    if( NULL != m_RNormals )
        items[i] = true;

    ++i;
    if( NULL != m_Colors )
        items[i] = true;

    ++i;
    if( NULL != m_RColors )
        items[i] = true;

    for( int jj = 0; jj < NITEMS; ++jj )
        aFile.write( (char*)&items[jj], sizeof(bool) );

    if( items[0] )
        m_Coords->WriteCache( aFile, this );

    if( items[1] )
        aFile << "[" << m_RCoords->GetName() << "]";

    if( items[2] )
        m_CoordIndices->WriteCache( aFile, this );

    if( items[3] )
        m_Normals->WriteCache( aFile, this );

    if( items[4] )
        aFile << "[" << m_RNormals->GetName() << "]";

    if( items[5] )
        m_Colors->WriteCache( aFile, this );

    if( items[6] )
        aFile << "[" << m_RColors->GetName() << "]";

    if( aFile.fail() )
        return false;

    m_written = true;
    return true;
}

WriteVRML()

bool SGFACESET::WriteVRML ( std::ostream &  aFile, bool  aReuseFlag  )

overridevirtual

Function WriteVRML writes this node's data to a VRML file; this includes all data of child and referenced nodes.

Implements SGNODE.

Definition at line 485 of file sg_faceset.cpp.

References SGNODE::GetName(), m_Colors, m_CoordIndices, m_Coords, m_Normals, m_RColors, m_RCoords, m_RNormals, SGNODE::m_written, SGNORMALS::WriteVRML(), SGCOLORS::WriteVRML(), SGCOORDS::WriteVRML(), and SGINDEX::WriteVRML().

Referenced by SGSHAPE::WriteVRML().

{
    if( ( NULL == m_Coords && NULL == m_RCoords )
        || ( NULL == m_CoordIndices ) )
    {
        return false;
    }

    if( aReuseFlag )
    {
        if( !m_written )
        {
            aFile << " geometry DEF " << GetName() << " IndexedFaceSet {\n";
            m_written = true;
        }
        else
        {
            aFile << "USE " << GetName() << "\n";
            return true;
        }
    }
    else
    {
        aFile << " geometry IndexedFaceSet {\n";
    }

    if( m_Coords )
        m_Coords->WriteVRML( aFile, aReuseFlag );

    if( m_RCoords )
        m_RCoords->WriteVRML( aFile, aReuseFlag );

    if( m_CoordIndices )
        m_CoordIndices->WriteVRML( aFile, aReuseFlag );

    if( m_Normals || m_RNormals )
        aFile << "  normalPerVertex TRUE\n";

    if( m_Normals )
        m_Normals->WriteVRML( aFile, aReuseFlag );

    if( m_RNormals )
        m_RNormals->WriteVRML( aFile, aReuseFlag );

    if( m_Colors )
        m_Colors->WriteVRML( aFile, aReuseFlag );

    if( m_RColors )
        m_RColors->WriteVRML( aFile, aReuseFlag );

    aFile << "}\n";

    return true;
}

Member Data Documentation

m_BackPointers

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

protectedinherited

Definition at line 82 of file sg_node.h.

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

m_Colors

SGCOLORS* SGFACESET::m_Colors

Definition at line 53 of file sg_faceset.h.

Referenced by addNode(), FindNode(), SGSHAPE::Prepare(), ReadCache(), ReNameNodes(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_CoordIndices

SGCOORDINDEX* SGFACESET::m_CoordIndices

Definition at line 55 of file sg_faceset.h.

Referenced by addNode(), FindNode(), GatherCoordIndices(), SGSHAPE::Prepare(), ReadCache(), ReNameNodes(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_Coords

SGCOORDS* SGFACESET::m_Coords

Definition at line 54 of file sg_faceset.h.

Referenced by addNode(), CalcNormals(), FindNode(), SGSHAPE::Prepare(), ReadCache(), ReNameNodes(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_Name

std::string SGNODE::m_Name

protectedinherited

Definition at line 85 of file sg_node.h.

Referenced by SGCOLORS::FindNode(), SGNORMALS::FindNode(), SGCOORDS::FindNode(), SGINDEX::FindNode(), SGSHAPE::FindNode(), SGAPPEARANCE::FindNode(), FindNode(), SCENEGRAPH::FindNode(), SGNODE::GetName(), SCENEGRAPH::ReadCache(), SGNORMALS::ReNameNodes(), SGCOLORS::ReNameNodes(), SGSHAPE::ReNameNodes(), SGCOORDS::ReNameNodes(), SGAPPEARANCE::ReNameNodes(), ReNameNodes(), SCENEGRAPH::ReNameNodes(), SGINDEX::ReNameNodes(), and SGNODE::SetName().

m_Normals

SGNORMALS* SGFACESET::m_Normals

Definition at line 56 of file sg_faceset.h.

Referenced by addNode(), SGCOORDS::CalcNormals(), CalcNormals(), FindNode(), SGSHAPE::Prepare(), ReadCache(), ReNameNodes(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_Parent

SGNODE* SGNODE::m_Parent

protectedinherited

Definition at line 83 of file sg_node.h.

Referenced by SGCOORDS::CalcNormals(), SGSHAPE::FindNode(), FindNode(), SCENEGRAPH::FindNode(), SGNODE::GetParent(), SCENEGRAPH::SCENEGRAPH(), SGNORMALS::SetParent(), SGCOLORS::SetParent(), SGCOORDS::SetParent(), SGAPPEARANCE::SetParent(), SGINDEX::SetParent(), SGSHAPE::SetParent(), SetParent(), SCENEGRAPH::SetParent(), SGAPPEARANCE::SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET(), SGINDEX::SGINDEX(), SGNODE::SGNODE(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), SGNODE::SwapParent(), SGNORMALS::WriteCache(), SGCOLORS::WriteCache(), SGSHAPE::WriteCache(), SGCOORDS::WriteCache(), SGAPPEARANCE::WriteCache(), WriteCache(), SCENEGRAPH::WriteCache(), SGINDEX::WriteCache(), and SGNODE::~SGNODE().

m_RColors

SGCOLORS* SGFACESET::m_RColors

Definition at line 59 of file sg_faceset.h.

Referenced by addNode(), SGSHAPE::Prepare(), ReadCache(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_RCoords

SGCOORDS* SGFACESET::m_RCoords

Definition at line 60 of file sg_faceset.h.

Referenced by addNode(), CalcNormals(), SGSHAPE::Prepare(), ReadCache(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_RNormals

SGNORMALS* SGFACESET::m_RNormals

Definition at line 61 of file sg_faceset.h.

Referenced by addNode(), CalcNormals(), SGSHAPE::Prepare(), ReadCache(), SGFACESET(), unlinkNode(), validate(), WriteCache(), WriteVRML(), and ~SGFACESET().

m_SGtype

S3D::SGTYPES SGNODE::m_SGtype

protectedinherited

Definition at line 84 of file sg_node.h.

Referenced by SGNODE::delNodeRef(), SGNODE::DisassociateWrapper(), SGNODE::GetName(), SGNODE::GetNodeType(), SCENEGRAPH::SCENEGRAPH(), SGNODE::SetName(), SGAPPEARANCE::SGAPPEARANCE(), SGCOLORS::SGCOLORS(), SGCOORDINDEX::SGCOORDINDEX(), SGCOORDS::SGCOORDS(), SGFACESET(), SGNODE::SGNODE(), SGNORMALS::SGNORMALS(), SGSHAPE::SGSHAPE(), and SGINDEX::WriteVRML().

m_written

bool SGNODE::m_written

protectedinherited

Definition at line 86 of file sg_node.h.

Referenced by SGNODE::isWritten(), SGCOLORS::ReNameNodes(), SGNORMALS::ReNameNodes(), SGCOORDS::ReNameNodes(), SGSHAPE::ReNameNodes(), SGAPPEARANCE::ReNameNodes(), ReNameNodes(), SCENEGRAPH::ReNameNodes(), SGINDEX::ReNameNodes(), SGNODE::SGNODE(), SGCOLORS::WriteCache(), SGNORMALS::WriteCache(), SGSHAPE::WriteCache(), SGCOORDS::WriteCache(), SGAPPEARANCE::WriteCache(), WriteCache(), SCENEGRAPH::WriteCache(), SGINDEX::WriteCache(), SGNORMALS::WriteVRML(), SGCOLORS::WriteVRML(), SGCOORDS::WriteVRML(), SGSHAPE::WriteVRML(), SGAPPEARANCE::WriteVRML(), WriteVRML(), and SCENEGRAPH::WriteVRML().

valid

bool SGFACESET::valid

private

Definition at line 46 of file sg_faceset.h.

Referenced by addNode(), SGFACESET(), unlinkNode(), and validate().

validated

bool SGFACESET::validated

private

Definition at line 47 of file sg_faceset.h.

Referenced by addNode(), SGFACESET(), unlinkNode(), and validate().

---

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

• sg_faceset.h
• sg_faceset.cpp