WRL2SHAPE Class Reference

#include <vrml2_shape.h>

Inheritance diagram for WRL2SHAPE:

Public Member Functions
	WRL2SHAPE ()
	WRL2SHAPE (WRL2NODE *aParent)
virtual	~WRL2SHAPE ()
bool	Read (WRLPROC &proc, WRL2BASE *aTopNode) override
bool	AddRefNode (WRL2NODE *aNode) override
bool	AddChildNode (WRL2NODE *aNode) override
SGNODE *	TranslateToSG (SGNODE *aParent) override
	Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library. More...
bool	isDangling (void) override
	Determine whether an object should be moved to a different parent during the VRML to SG* translation. More...
WRL2NODES	GetNodeType (void) const
WRL2NODE *	GetParent (void) const
virtual bool	SetParent (WRL2NODE *aParent, bool doUnlink=true)
	Set the parent WRL2NODE of this object. More...
virtual std::string	GetName (void)
virtual bool	SetName (const std::string &aName)
const char *	GetNodeTypeName (WRL2NODES aNodeType) const
virtual WRL2NODE *	FindNode (const std::string &aNodeName, const WRL2NODE *aCaller)
	Search the tree of linked nodes and returns a reference to the first node found with the given name. More...
std::string	GetError (void)
WRL2NODES	getNodeTypeID (const std::string &aNodeName)
void	addNodeRef (WRL2NODE *aNode)
	Add a pointer to a node which references but does not own this node. More...
void	delNodeRef (WRL2NODE *aNode)
	Remove a pointer to a node which references but does not own this node. More...

Protected Attributes
WRL2NODE *	m_Parent
WRL2NODES	m_Type
std::string	m_Name
std::list< WRL2NODE * >	m_BackPointers
std::list< WRL2NODE * >	m_Children
std::list< WRL2NODE * >	m_Refs
std::string	m_error
SGNODE *	m_sgNode

Private Member Functions
bool	checkNodeType (WRL2NODES aType)
void	unlinkChildNode (const WRL2NODE *aNode) override
	Remove references to an owned child. More...
void	unlinkRefNode (const WRL2NODE *aNode) override
	Remove pointers to a referenced node. More...

Private Attributes
WRL2NODE *	appearance
WRL2NODE *	geometry

Detailed Description

Definition at line 38 of file vrml2_shape.h.

Constructor & Destructor Documentation

WRL2SHAPE() [1/2]

WRL2SHAPE::WRL2SHAPE

(

)

Definition at line 36 of file vrml2_shape.cpp.

 : WRL2NODE()
{
 appearance = nullptr;
 geometry = nullptr;
 m_Type = WRL2NODES::WRL2_SHAPE;
}

References appearance, geometry, WRL2NODE::m_Type, and WRL2_SHAPE.

WRL2SHAPE() [2/2]

WRL2SHAPE::WRL2SHAPE

(

WRL2NODE *

aParent

)

Definition at line 44 of file vrml2_shape.cpp.

 : WRL2NODE()
{
 appearance = nullptr;
 geometry = nullptr;
 m_Type = WRL2NODES::WRL2_SHAPE;
 m_Parent = aParent;
 
 if( nullptr != m_Parent )
 m_Parent->AddChildNode( this );
}

References WRL2NODE::AddChildNode(), appearance, geometry, WRL2NODE::m_Parent, WRL2NODE::m_Type, and WRL2_SHAPE.

~WRL2SHAPE()

WRL2SHAPE::~WRL2SHAPE ( )

virtual

Definition at line 56 of file vrml2_shape.cpp.

{
 wxLogTrace( traceVrmlPlugin,
 wxT( " * [INFO] Destroying Shape node with %zu children, %zu"
 "references, and %zu back pointers." ),
 m_Children.size(), m_Refs.size(), m_BackPointers.size() );
}

References WRL2NODE::m_BackPointers, WRL2NODE::m_Children, WRL2NODE::m_Refs, and traceVrmlPlugin.

Member Function Documentation

AddChildNode()

bool WRL2SHAPE::AddChildNode ( WRL2NODE *  aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 127 of file vrml2_shape.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "Invalid node." ) );
 
 WRL2NODES type = aNode->GetNodeType();
 
 if( !checkNodeType( type ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; unexpected child node '%s'." ),
 __FILE__, __FUNCTION__, __LINE__, aNode->GetNodeTypeName( type ) );
 
 return false;
 }
 
 if( WRL2NODES::WRL2_APPEARANCE == type )
 {
 if( nullptr != appearance )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; multiple appearance nodes." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 appearance = aNode;
 return WRL2NODE::AddChildNode( aNode );
 }
 
 if( nullptr != geometry )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; multiple geometry nodes." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 geometry = aNode;
 return WRL2NODE::AddChildNode( aNode );
}

References WRL2NODE::AddChildNode(), appearance, checkNodeType(), geometry, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), traceVrmlPlugin, and WRL2_APPEARANCE.

addNodeRef()

void WRL2NODE::addNodeRef ( WRL2NODE *  aNode )

inherited

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

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

Parameters

aNode

is the node holding a reference to this object.

Definition at line 171 of file vrml2_node.cpp.

{
 // the parent node must never be added as a backpointer
 if( aNode == m_Parent )
 return;
 
 std::list< WRL2NODE* >::iterator np =
 std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
 
 if( np != m_BackPointers.end() )
 return;
 
 m_BackPointers.push_back( aNode );
}

References WRL2NODE::m_BackPointers, and WRL2NODE::m_Parent.

Referenced by WRL2NODE::AddRefNode().

AddRefNode()

bool WRL2SHAPE::AddRefNode ( WRL2NODE *  aNode )

overridevirtual

Reimplemented from WRL2NODE.

Definition at line 80 of file vrml2_shape.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "Invalid node." ) );
 
 WRL2NODES type = aNode->GetNodeType();
 
 if( !checkNodeType( type ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; unexpected child node '%s'." ),
 __FILE__, __FUNCTION__, __LINE__, aNode->GetNodeTypeName( type ) );
 
 return false;
 }
 
 if( WRL2NODES::WRL2_APPEARANCE == type )
 {
 if( nullptr != appearance )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; multiple appearance nodes." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 appearance = aNode;
 return WRL2NODE::AddRefNode( aNode );
 }
 
 if( nullptr != geometry )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; multiple geometry nodes." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 geometry = aNode;
 return WRL2NODE::AddRefNode( aNode );
}

References WRL2NODE::AddRefNode(), appearance, checkNodeType(), geometry, WRL2NODE::GetNodeType(), WRL2NODE::GetNodeTypeName(), traceVrmlPlugin, and WRL2_APPEARANCE.

checkNodeType()

bool WRL2SHAPE::checkNodeType ( WRL2NODES  aType )

private

Returns

true if the node type is an appearance or geometry class.

Definition at line 174 of file vrml2_shape.cpp.

{
 switch( aType )
 {
 case WRL2NODES::WRL2_APPEARANCE:
 case WRL2NODES::WRL2_BOX:
 case WRL2NODES::WRL2_CONE:
 case WRL2NODES::WRL2_CYLINDER:
 case WRL2NODES::WRL2_ELEVATIONGRID:
 case WRL2NODES::WRL2_EXTRUSION:
 case WRL2NODES::WRL2_INDEXEDFACESET:
 case WRL2NODES::WRL2_INDEXEDLINESET:
 case WRL2NODES::WRL2_POINTSET:
 case WRL2NODES::WRL2_SPHERE:
 case WRL2NODES::WRL2_TEXT:
 break;
 
 default:
 return false;
 break;
 }
 
 return true;
}

References WRL2_APPEARANCE, WRL2_BOX, WRL2_CONE, WRL2_CYLINDER, WRL2_ELEVATIONGRID, WRL2_EXTRUSION, WRL2_INDEXEDFACESET, WRL2_INDEXEDLINESET, WRL2_POINTSET, WRL2_SPHERE, and WRL2_TEXT.

Referenced by AddChildNode(), and AddRefNode().

delNodeRef()

void WRL2NODE::delNodeRef ( WRL2NODE *  aNode )

inherited

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

Parameters

aNode

is the node holding a reference to this object

Definition at line 187 of file vrml2_node.cpp.

{
 std::list< WRL2NODE* >::iterator np =
 std::find( m_BackPointers.begin(), m_BackPointers.end(), aNode );
 
 if( np != m_BackPointers.end() )
 {
 m_BackPointers.erase( np );
 return;
 }
 
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
 " * [BUG] delNodeRef() did not find its target." ),
 __FILE__, __FUNCTION__, __LINE__ );
}

References WRL2NODE::m_BackPointers, and traceVrmlPlugin.

FindNode()

WRL2NODE * WRL2NODE::FindNode ( const std::string &  aNodeName, const WRL2NODE *  aCaller  )

virtualinherited

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

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

Parameters

aNodeName	is the name of the node to search for.
aCaller	is a pointer to the node invoking this function.

Returns

is a valid node pointer on success or NULL.

Definition at line 305 of file vrml2_node.cpp.

{
 if( aNodeName.empty() )
 return nullptr;
 
 if( !m_Name.compare( aNodeName ) )
 return this;
 
 std::list< WRL2NODE* >::iterator sLA = m_Children.begin();
 std::list< WRL2NODE* >::iterator eLA = m_Children.end();
 
 WRL2NODE* psg = nullptr;
 
 while( sLA != eLA )
 {
 if( *sLA != aCaller )
 {
 psg = (*sLA)->FindNode( aNodeName, this );
 
 if( nullptr != psg )
 return psg;
 
 }
 
 ++sLA;
 }
 
 if( nullptr != m_Parent && aCaller != m_Parent )
 return m_Parent->FindNode( aNodeName, this );
 
 return nullptr;
}

References WRL2NODE::FindNode(), WRL2NODE::m_Children, WRL2NODE::m_Name, and WRL2NODE::m_Parent.

Referenced by WRL2NODE::FindNode(), and WRL2BASE::implementUse().

GetError()

std::string WRL2NODE::GetError ( void  )

inherited

Definition at line 299 of file vrml2_node.cpp.

{
 return m_error;
}

References WRL2NODE::m_error.

GetName()

std::string WRL2NODE::GetName ( void  )

virtualinherited

Reimplemented in WRL2BASE.

Definition at line 216 of file vrml2_node.cpp.

{
 return m_Name;
}

References WRL2NODE::m_Name.

GetNodeType()

WRL2NODES WRL2NODE::GetNodeType ( void  ) const

inherited

Returns

the type of this node instance.

Definition at line 204 of file vrml2_node.cpp.

{
 return m_Type;
}

References WRL2NODE::m_Type.

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

getNodeTypeID()

WRL2NODES WRL2NODE::getNodeTypeID ( const std::string &  aNodeName )

inherited

Returns

The ID based on the given aNodeName or WRL2_INVALID (WRL2_END) if no such node name exists.

Definition at line 288 of file vrml2_node.cpp.

{
 NODEMAP::iterator it = nodenames.find( aNodeName );
 
 if( nodenames.end() != it )
 return it->second;
 
 return WRL2NODES::WRL2_INVALID;
}

References nodenames, and WRL2_INVALID.

Referenced by WRL2BASE::ReadNode().

GetNodeTypeName()

const char * WRL2NODE::GetNodeTypeName ( WRL2NODES  aNodeType ) const

inherited

Definition at line 273 of file vrml2_node.cpp.

{
 if( aNodeType < WRL2NODES::WRL2_BASE || aNodeType >= WRL2NODES::WRL2_END )
 return "*INVALID_TYPE*";
 
 if( aNodeType == WRL2NODES::WRL2_BASE )
 return "*VIRTUAL_BASE*";
 
 NODEMAP::iterator it = nodenames.begin();
 advance( it, (static_cast<int>( aNodeType ) - static_cast<int>( WRL2NODES::WRL2_BEGIN ) ) );
 
 return it->first.c_str();
}

References nodenames, WRL2_BASE, WRL2_BEGIN, and WRL2_END.

Referenced by WRL2APPEARANCE::AddChildNode(), WRL2FACESET::AddChildNode(), WRL2LINESET::AddChildNode(), WRL2POINTSET::AddChildNode(), AddChildNode(), WRL2APPEARANCE::AddRefNode(), WRL2FACESET::AddRefNode(), WRL2LINESET::AddRefNode(), WRL2POINTSET::AddRefNode(), and AddRefNode().

GetParent()

WRL2NODE * WRL2NODE::GetParent ( void  ) const

inherited

Returns

a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie. top level transform).

Definition at line 210 of file vrml2_node.cpp.

{
 return m_Parent;
}

References WRL2NODE::m_Parent.

Referenced by WRL2NODE::AddChildNode(), WRL2SWITCH::AddRefNode(), WRL2TRANSFORM::AddRefNode(), WRL2APPEARANCE::unlinkChildNode(), WRL2FACESET::unlinkChildNode(), WRL2LINESET::unlinkChildNode(), WRL2POINTSET::unlinkChildNode(), WRL2APPEARANCE::unlinkRefNode(), WRL2FACESET::unlinkRefNode(), WRL2LINESET::unlinkRefNode(), and WRL2POINTSET::unlinkRefNode().

isDangling()

bool WRL2SHAPE::isDangling ( void  )

overridevirtual

Determine whether an object should be moved to a different parent during the VRML to SG* translation.

Returns

true if the object does not have a parent which is a logical container for the object for example if a Shape has a parent which is a Base node.

Implements WRL2NODE.

Definition at line 65 of file vrml2_shape.cpp.

{
 // this node is dangling unless it has a parent of type:
 // WRL2_TRANSFORM
 // WRL2_SWITCH
 
 if( nullptr == m_Parent
 || ( m_Parent->GetNodeType() != WRL2NODES::WRL2_TRANSFORM
 && m_Parent->GetNodeType() != WRL2NODES::WRL2_SWITCH ) )
 return true;
 
 return false;
}

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

Read()

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

overridevirtual

Implements WRL2NODE.

Definition at line 200 of file vrml2_shape.cpp.

{
 wxCHECK_MSG( aTopNode, false, wxT( "Invalid top node." ) );
 
 char tok = proc.Peek();
 
 if( proc.eof() )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; unexpected eof %s." ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition() );
 
 return false;
 }
 
 if( '{' != tok )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] bad file format; expecting '{' but got '%s' %s." ),
 __FILE__, __FUNCTION__, __LINE__, tok, proc.GetFilePosition() );
 
 return false;
 }
 
 proc.Pop();
 std::string glob;
 
 while( true )
 {
 if( proc.Peek() == '}' )
 {
 proc.Pop();
 break;
 }
 
 if( !proc.ReadName( glob ) )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
 "%s" ),
 __FILE__, __FUNCTION__, __LINE__ , proc.GetError() );
 
 return false;
 }
 
 // expecting one of:
 // appearance
 // geometry
 if( !glob.compare( "appearance" ) )
 {
 if( !aTopNode->ReadNode( proc, this, nullptr ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] could not read appearance node information." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 }
 else if( !glob.compare( "geometry" ) )
 {
 if( !aTopNode->ReadNode( proc, this, nullptr ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] could not read geometry node information." ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 }
 else
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] invalid Shape %s.\n"
 " * [INFO] file: '%s'\n" ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition(),
 proc.GetFileName() );
 
 return false;
 }
 } // while( true ) -- reading contents of Shape{}
 
 return true;
}

References WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFileName(), WRLPROC::GetFilePosition(), WRLPROC::Peek(), WRLPROC::Pop(), WRLPROC::ReadName(), WRL2BASE::ReadNode(), and traceVrmlPlugin.

Referenced by WRL2BASE::readShape().

SetName()

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

virtualinherited

Reimplemented in WRL2BASE.

Definition at line 222 of file vrml2_node.cpp.

{
 if( aName.empty() )
 return false;
 
 std::set< std::string >::iterator item = badNames.find( aName );
 
 if( item != badNames.end() )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] invalid node name '%s' (matches restricted word)" ),
 __FILE__, __FUNCTION__, __LINE__, *item );
 
 return false;
 }
 
 
 if( isdigit( aName[0] ) )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n"
 " * [INFO] invalid node name '%s' (begins with digit)" ),
 __FILE__, __FUNCTION__, __LINE__, aName );
 
 return false;
 }
 
 // The characters '+' and '-' are not allowed in names as per the VRML2 specification;
 // however many parsers accept them and many bad generators use them so the rules
 // have been relaxed here.
 // #define BAD_CHARS1 "\"\'#+,-.\\[]{}\x00\x01\x02\x03\x04\x05\x06\x09\x0A\x0B\x0C\x0D\x0E\x0F"
 #define BAD_CHARS1 "\"\'#,.\\[]{}\x00\x01\x02\x03\x04\x05\x06\x09\x0A\x0B\x0C\x0D\x0E\x0F"
 #define BAD_CHARS2 "\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F"
 
 if( std::string::npos != aName.find_first_of( BAD_CHARS1 )
 || std::string::npos != aName.find_first_of( BAD_CHARS2 ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n"
 " * [INFO] invalid node name '%s' (contains invalid character)" ),
 __FILE__, __FUNCTION__, __LINE__, aName );
 
 return false;
 }
 
 m_Name = aName;
 
 return true;
}

References BAD_CHARS1, BAD_CHARS2, badNames, WRL2NODE::m_Name, and traceVrmlPlugin.

Referenced by WRL2BASE::implementDef().

SetParent()

bool WRL2NODE::SetParent ( WRL2NODE *  aParent, bool  doUnlink = true  )

virtualinherited

Set the parent WRL2NODE of this object.

Parameters

aParent	[in] is the desired parent node.
doUnlink	indicates that the child must be unlinked from the parent

Returns

true if the operation succeeds of false if the given node is not allowed to be a parent to the derived object.

Reimplemented in WRL2BASE.

Definition at line 339 of file vrml2_node.cpp.

{
 if( aParent == m_Parent )
 return true;
 
 if( nullptr != m_Parent && doUnlink )
 m_Parent->unlinkChildNode( this );
 
 m_Parent = aParent;
 
 if( nullptr != m_Parent )
 m_Parent->AddChildNode( this );
 
 return true;
}

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

Referenced by WRL2NODE::AddChildNode(), WRL2SWITCH::AddRefNode(), and WRL2TRANSFORM::AddRefNode().

TranslateToSG()

SGNODE * WRL2SHAPE::TranslateToSG ( SGNODE *  aParent )

overridevirtual

Produce a representation of the data using the intermediate scenegraph structures of the kicad_3dsg library.

Parameters

aParent

is a pointer to the parent SG node.

Returns

is non-NULL on success.

Implements WRL2NODE.

Definition at line 289 of file vrml2_shape.cpp.

{
 if( nullptr == geometry )
 return nullptr;
 
 WRL2NODES geomType = geometry->GetNodeType();
 
 switch( geomType )
 {
 case WRL2NODES::WRL2_INDEXEDLINESET:
 case WRL2NODES::WRL2_POINTSET:
 case WRL2NODES::WRL2_TEXT:
 return nullptr;
 break;
 
 default:
 break;
 }
 
 wxLogTrace( traceVrmlPlugin,
 wxT( " * [INFO] Translating Shape with %zu children, %zu references, and"
 "%zu back pointers." ),
 m_Children.size(), m_Refs.size(), m_BackPointers.size() );
 
 bool vcolors = false;
 
 if( WRL2NODES::WRL2_INDEXEDFACESET == geometry->GetNodeType() )
 vcolors = ((WRL2FACESET*)geometry)->HasColors();
 
 // if there is no appearance, make use of the per vertex colors if available
 if( nullptr == appearance )
 {
 if( WRL2NODES::WRL2_INDEXEDFACESET != geometry->GetNodeType() )
 return nullptr;
 
 if( !vcolors )
 return nullptr;
 }
 
 S3D::SGTYPES ptype = S3D::GetSGNodeType( aParent );
 
 wxCHECK_MSG( aParent && ( ptype == S3D::SGTYPE_TRANSFORM ), nullptr,
 wxString::Format( wxT( "Shape does not have a Transform parent (parent "
 "ID: %d)." ), ptype ) );
 
 if( m_sgNode )
 {
 if( nullptr != aParent )
 {
 if( nullptr == S3D::GetSGNodeParent( m_sgNode )
 && !S3D::AddSGNodeChild( aParent, m_sgNode ) )
 {
 return nullptr;
 }
 else if( aParent != S3D::GetSGNodeParent( m_sgNode )
 && !S3D::AddSGNodeRef( aParent, m_sgNode ) )
 {
 return nullptr;
 }
 }
 
 return m_sgNode;
 }
 
 IFSG_SHAPE shNode( aParent );
 
 SGNODE* pShape = shNode.GetRawPtr();
 SGNODE* pGeom = geometry->TranslateToSG( pShape );
 
 if( nullptr == pGeom )
 {
 // this can happen if a VRML file contains
 // empty point or index sets
 shNode.Destroy();
 return nullptr;
 }
 
 SGNODE* pApp = nullptr;
 
 if( nullptr != appearance )
 pApp = appearance->TranslateToSG( pShape );
 
 if( nullptr != appearance && nullptr == pApp )
 {
 IFSG_FACESET tmp( false );
 tmp.Attach( pGeom );
 tmp.Destroy();
 shNode.Destroy();
 return nullptr;
 }
 
 m_sgNode = shNode.GetRawPtr();
 
 return m_sgNode;
}

References S3D::AddSGNodeChild(), S3D::AddSGNodeRef(), appearance, IFSG_FACESET::Attach(), IFSG_NODE::Destroy(), Format(), geometry, WRL2NODE::GetNodeType(), IFSG_NODE::GetRawPtr(), S3D::GetSGNodeParent(), S3D::GetSGNodeType(), WRL2NODE::m_BackPointers, WRL2NODE::m_Children, WRL2NODE::m_Refs, WRL2NODE::m_sgNode, S3D::SGTYPE_TRANSFORM, traceVrmlPlugin, WRL2NODE::TranslateToSG(), WRL2_INDEXEDFACESET, WRL2_INDEXEDLINESET, WRL2_POINTSET, and WRL2_TEXT.

unlinkChildNode()

void WRL2SHAPE::unlinkChildNode ( const WRL2NODE *  aNode )

overrideprivatevirtual

Remove references to an owned child.

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

Parameters

aNode

is the child which is being deleted.

Reimplemented from WRL2NODE.

Definition at line 386 of file vrml2_shape.cpp.

{
 if( nullptr == aNode )
 return;
 
 if( aNode == appearance )
 appearance = nullptr;
 else if( aNode == geometry )
 geometry = nullptr;
 
 WRL2NODE::unlinkChildNode( aNode );
}

References appearance, geometry, and WRL2NODE::unlinkChildNode().

unlinkRefNode()

void WRL2SHAPE::unlinkRefNode ( const WRL2NODE *  aNode )

overrideprivatevirtual

Remove pointers to a referenced node.

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

Parameters

aNode

is the node which is being deleted.

Reimplemented from WRL2NODE.

Definition at line 400 of file vrml2_shape.cpp.

{
 if( nullptr == aNode )
 return;
 
 if( aNode == appearance )
 appearance = nullptr;
 else if( aNode == geometry )
 geometry = nullptr;
 
 WRL2NODE::unlinkRefNode( aNode );
}

References appearance, geometry, and WRL2NODE::unlinkRefNode().

Member Data Documentation

appearance

WRL2NODE* WRL2SHAPE::appearance

private

Definition at line 61 of file vrml2_shape.h.

Referenced by AddChildNode(), AddRefNode(), TranslateToSG(), unlinkChildNode(), unlinkRefNode(), and WRL2SHAPE().

geometry

WRL2NODE* WRL2SHAPE::geometry

private

Definition at line 62 of file vrml2_shape.h.

Referenced by AddChildNode(), AddRefNode(), TranslateToSG(), unlinkChildNode(), unlinkRefNode(), and WRL2SHAPE().

m_BackPointers

std::list< WRL2NODE* > WRL2NODE::m_BackPointers

protectedinherited

Definition at line 173 of file vrml2_node.h.

Referenced by WRL2NODE::addNodeRef(), WRL2NODE::delNodeRef(), WRL2APPEARANCE::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), ~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

m_Children

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

protectedinherited

Definition at line 174 of file vrml2_node.h.

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

m_error

std::string WRL2NODE::m_error

protectedinherited

Definition at line 176 of file vrml2_node.h.

Referenced by WRL2NODE::GetError().

m_Name

std::string WRL2NODE::m_Name

protectedinherited

Definition at line 171 of file vrml2_node.h.

Referenced by WRL2NODE::FindNode(), WRL2NODE::GetName(), and WRL2NODE::SetName().

m_Parent

WRL2NODE* WRL2NODE::m_Parent

protectedinherited

Definition at line 169 of file vrml2_node.h.

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

m_Refs

std::list< WRL2NODE* > WRL2NODE::m_Refs

protectedinherited

Definition at line 175 of file vrml2_node.h.

Referenced by WRL2NODE::AddRefNode(), WRL2APPEARANCE::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), WRL2NODE::unlinkRefNode(), WRL2APPEARANCE::~WRL2APPEARANCE(), WRL2FACESET::~WRL2FACESET(), WRL2LINESET::~WRL2LINESET(), WRL2NODE::~WRL2NODE(), WRL2POINTSET::~WRL2POINTSET(), ~WRL2SHAPE(), WRL2SWITCH::~WRL2SWITCH(), and WRL2TRANSFORM::~WRL2TRANSFORM().

m_sgNode

SGNODE* WRL2NODE::m_sgNode

protectedinherited

Definition at line 178 of file vrml2_node.h.

Referenced by WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), and WRL2NODE::WRL2NODE().

m_Type

WRL2NODES WRL2NODE::m_Type

protectedinherited

Definition at line 170 of file vrml2_node.h.

Referenced by WRL2NODE::GetNodeType(), WRL2APPEARANCE::WRL2APPEARANCE(), WRL2BASE::WRL2BASE(), WRL2BOX::WRL2BOX(), WRL2COLOR::WRL2COLOR(), WRL2COORDS::WRL2COORDS(), WRL2FACESET::WRL2FACESET(), WRL2INLINE::WRL2INLINE(), WRL2LINESET::WRL2LINESET(), WRL2MATERIAL::WRL2MATERIAL(), WRL2NODE::WRL2NODE(), WRL2NORMS::WRL2NORMS(), WRL2POINTSET::WRL2POINTSET(), WRL2SHAPE(), WRL2SWITCH::WRL2SWITCH(), and WRL2TRANSFORM::WRL2TRANSFORM().

---

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

• vrml2_shape.h
• vrml2_shape.cpp