Represent the top node of a VRML1 model. More...

#include <vrml1_base.h>

Inheritance diagram for WRL1BASE:

Public Member Functions
	WRL1BASE ()

virtual	~WRL1BASE ()

bool	Read (WRLPROC &proc)

bool	ReadNode (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

virtual std::string	GetName (void) override

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

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

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

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

void	cancelDict (void)

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

virtual void	unlinkChildNode (const WRL1NODE *aNode)
	Remove references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references. More...

virtual void	unlinkRefNode (const WRL1NODE *aNode)
	Remove pointers to a referenced node; it is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references. More...

void	addNodeRef (WRL1NODE *aNode)
	Add a pointer to a node which references, but does not own, this node. More...

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

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

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

const char *	GetNodeTypeName (WRL1NODES aNodeType) const

size_t	GetNItems (void) const

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

virtual bool	AddChildNode (WRL1NODE *aNode)

virtual bool	AddRefNode (WRL1NODE *aNode)

std::string	GetError (void)

Protected Attributes
WRL1NODE *	m_Parent

WRL1NODES	m_Type

std::string	m_Name

std::list< WRL1NODE * >	m_BackPointers

std::list< WRL1NODE * >	m_Children

std::list< WRL1NODE * >	m_Refs

std::list< WRL1NODE * >	m_Items

std::string	m_error

WRL1STATUS	m_current

SGNODE *	m_sgNode

NAMEREGISTER *	m_dictionary

Private Member Functions
bool	implementUse (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	implementDef (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readGroup (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readSeparator (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readSwitch (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readMaterial (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readMatBinding (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readCoords (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readFaceSet (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readTransform (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

bool	readShapeHints (WRLPROC &proc, WRL1NODE aParent, WRL1NODE *aNode)

void	addItem (WRL1NODE *aNode)

void	delItem (const WRL1NODE *aNode)

Detailed Description

Represent the top node of a VRML1 model.

Definition at line 45 of file vrml1_base.h.

Constructor & Destructor Documentation

◆ WRL1BASE()

WRL1BASE::WRL1BASE ( )

Definition at line 42 of file vrml1_base.cpp.

 : WRL1NODE( nullptr )
{
 m_Type = WRL1NODES::WRL1_BASE;
 m_dictionary = new NAMEREGISTER;
 return;
}

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

◆ ~WRL1BASE()

WRL1BASE::~WRL1BASE ( )

virtual

Definition at line 50 of file vrml1_base.cpp.

{
 wxLogTrace( traceVrmlPlugin, wxT( " * [INFO] Destroying virtual base node." ) );
 
 cancelDict();
}

References WRL1NODE::cancelDict(), and traceVrmlPlugin.

Member Function Documentation

◆ AddChildNode()

bool WRL1NODE::AddChildNode ( WRL1NODE * aNode )

virtualinherited

Reimplemented in WRL1COORDS, WRL1FACESET, WRL1MATBINDING, WRL1MATERIAL, WRL1SHAPEHINTS, and WRL1TRANSFORM.

Definition at line 376 of file vrml1_node.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "Invalid node pointer." ) );
 wxCHECK_MSG( aNode->GetNodeType() != WRL1NODES::WRL1_BASE, false,
 wxT( "Attempting to add a base node to another node." ) );
 
 std::list< WRL1NODE* >::iterator sC = m_Children.begin();
 std::list< WRL1NODE* >::iterator eC = m_Children.end();
 
 while( sC != eC )
 {
 if( *sC == aNode )
 return false;
 
 ++sC;
 }
 
 m_Children.push_back( aNode );
 addItem( aNode );
 
 if( aNode->GetParent() != this )
 aNode->SetParent( this );
 
 return true;
}

References WRL1NODE::addItem(), WRL1NODE::GetNodeType(), WRL1NODE::GetParent(), WRL1NODE::m_Children, WRL1NODE::SetParent(), and WRL1_BASE.

Referenced by WRL1NODE::SetParent(), WRL1COORDS::WRL1COORDS(), WRL1FACESET::WRL1FACESET(), WRL1GROUP::WRL1GROUP(), WRL1MATBINDING::WRL1MATBINDING(), WRL1MATERIAL::WRL1MATERIAL(), WRL1SEPARATOR::WRL1SEPARATOR(), WRL1SHAPEHINTS::WRL1SHAPEHINTS(), WRL1SWITCH::WRL1SWITCH(), and WRL1TRANSFORM::WRL1TRANSFORM().

◆ addItem()

void WRL1NODE::addItem ( WRL1NODE * aNode )

privateinherited

Definition at line 458 of file vrml1_node.cpp.

{
 m_Items.push_back( aNode );
}

References WRL1NODE::m_Items.

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

◆ addNodeRef()

void WRL1NODE::addNodeRef ( WRL1NODE * aNode )

inherited

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

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

Parameters

aNode is the node holding a reference to this object.

Definition at line 216 of file vrml1_node.cpp.

{
 // the parent node must never be added as a backpointer
 if( aNode == m_Parent )
 return;
 
 std::list< WRL1NODE* >::iterator sR = m_BackPointers.begin();
 std::list< WRL1NODE* >::iterator eR = m_BackPointers.end();
 
 while( sR != eR )
 {
 if( *sR == aNode )
 return;
 
 ++sR;
 }
 
 m_BackPointers.push_back( aNode );
}

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

Referenced by WRL1NODE::AddRefNode().

◆ AddRefNode()

bool WRL1NODE::AddRefNode ( WRL1NODE * aNode )

virtualinherited

Reimplemented in WRL1COORDS, WRL1FACESET, WRL1MATBINDING, WRL1MATERIAL, WRL1SHAPEHINTS, and WRL1TRANSFORM.

Definition at line 403 of file vrml1_node.cpp.

{
 wxCHECK_MSG( aNode, false, wxT( "Invalid node pointer." ) );
 wxCHECK_MSG( aNode->GetNodeType() != WRL1NODES::WRL1_BASE, false,
 wxT( "Attempt to add a base node reference to another base node" ) );
 
 // note: the VRML1 spec does not prevent the reuse of a node at
 // the same level; for example a Coordinate3 node can be recalled
 // at any time to set the current coordinate set.
 m_Refs.push_back( aNode );
 aNode->addNodeRef( this );
 addItem( aNode );
 
 return true;
}

References WRL1NODE::addItem(), WRL1NODE::addNodeRef(), WRL1NODE::GetNodeType(), WRL1NODE::m_Refs, and WRL1_BASE.

Referenced by implementUse().

◆ cancelDict()

void WRL1NODE::cancelDict ( void )

inherited

Definition at line 198 of file vrml1_node.cpp.

{
 std::list< WRL1NODE* >::iterator sC = m_Children.begin();
 std::list< WRL1NODE* >::iterator eC = m_Children.end();
 
 while( sC != eC )
 {
 (*sC)->cancelDict();
 ++sC;
 }
 
 if( m_Type == WRL1NODES::WRL1_BASE && nullptr != m_dictionary )
 delete m_dictionary;
 
 m_dictionary = nullptr;
}

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

Referenced by ~WRL1BASE().

◆ delItem()

void WRL1NODE::delItem ( const WRL1NODE * aNode )

privateinherited

Definition at line 464 of file vrml1_node.cpp.

{
 std::list< WRL1NODE* >::iterator sL = m_Items.begin();
 std::list< WRL1NODE* >::iterator eL = m_Items.end();
 
 while( sL != eL )
 {
 if( *sL == aNode )
 {
 m_Items.erase( sL );
 return;
 }
 
 ++sL;
 }
}

References WRL1NODE::m_Items.

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

◆ delNodeRef()

void WRL1NODE::delNodeRef ( WRL1NODE * aNode )

inherited

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

Parameters

aNode is the node holding a reference to this object.

Definition at line 237 of file vrml1_node.cpp.

{
 std::list< WRL1NODE* >::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 WRL1NODE::m_BackPointers, and traceVrmlPlugin.

◆ FindNode()

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

virtualinherited

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

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

Parameters

aNodeName is the name of the node to search for.

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

Definition at line 350 of file vrml1_node.cpp.

{
 if( nullptr == m_dictionary )
 return nullptr;
 
 return m_dictionary->FindName( aNodeName );
}

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

Referenced by implementUse().

◆ GetError()

std::string WRL1NODE::GetError ( void )

inherited

Definition at line 344 of file vrml1_node.cpp.

{
 return m_error;
}

References WRL1NODE::m_error.

◆ GetName()

std::string WRL1BASE::GetName ( void )

overridevirtual

Reimplemented from WRL1NODE.

Definition at line 64 of file vrml1_base.cpp.

{
 wxCHECK_MSG( false, std::string( "" ),
 wxT( "Attempt to extract name from virtual base node." ) );
}

◆ GetNItems()

size_t WRL1NODE::GetNItems ( void ) const

inherited

Definition at line 338 of file vrml1_node.cpp.

{
 return m_Items.size();
}

References WRL1NODE::m_Items.

◆ GetNodeType()

WRL1NODES WRL1NODE::GetNodeType ( void ) const

inherited

Return the type of this node instance.

Definition at line 254 of file vrml1_node.cpp.

{
 return m_Type;
}

References WRL1NODE::m_Type.

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

◆ getNodeTypeID()

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

inherited

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

Definition at line 327 of file vrml1_node.cpp.

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

References nodenames, and WRL1_INVALID.

Referenced by ReadNode().

◆ GetNodeTypeName()

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

inherited

Definition at line 312 of file vrml1_node.cpp.

{
 if( aNodeType < WRL1NODES::WRL1_BASE || aNodeType >= WRL1NODES::WRL1_END )
 return "*INVALID_TYPE*";
 
 if( aNodeType == WRL1NODES::WRL1_BASE )
 return "*VIRTUAL_BASE*";
 
 NODEMAP::iterator it = nodenames.begin();
 advance( it, ( static_cast<int>( aNodeType ) - static_cast<int>( WRL1NODES::WRL1_BEGIN ) ) );
 
 return it->first.c_str();
}

References nodenames, WRL1_BASE, WRL1_BEGIN, and WRL1_END.

Referenced by implementUse().

◆ GetParent()

WRL1NODE * WRL1NODE::GetParent ( void ) const

inherited

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

top level transform).

Definition at line 260 of file vrml1_node.cpp.

{
 return m_Parent;
}

References WRL1NODE::m_Parent.

Referenced by WRL1NODE::AddChildNode().

◆ implementDef()

bool WRL1BASE::implementDef	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 156 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 wxCHECK_MSG( nullptr != aParent, false, wxT( "Invalid parent pointer." ) );
 
 std::string glob;
 WRL1NODE* lnode = nullptr;
 
 if( !proc.ReadName( glob ) )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n%s" ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetError() );
 
 return false;
 }
 
 if( ReadNode( proc, aParent, &lnode ) )
 {
 if( nullptr != aNode )
 *aNode = lnode;
 
 if( lnode && !lnode->SetName( glob ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n * [INFO] bad formatting (invalid name) %s." ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition() );
 
 return false;
 }
 
 if( !m_dictionary )
 return false;
 
 m_dictionary->AddName( glob, lnode );
 
 return true;
 }
 
 return false;
}

References NAMEREGISTER::AddName(), WRLPROC::GetError(), WRLPROC::GetFilePosition(), WRL1NODE::m_dictionary, WRLPROC::ReadName(), ReadNode(), WRL1NODE::SetName(), and traceVrmlPlugin.

Referenced by ReadNode().

◆ implementUse()

bool WRL1BASE::implementUse	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 111 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 wxCHECK_MSG( aParent, false, wxT( "Invoked with invalid parent." ) );
 
 std::string glob;
 
 if( !proc.ReadName( glob ) )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s" ), proc.GetError() );
 
 return false;
 }
 
 WRL1NODE* ref = aParent->FindNode( glob );
 
 // return 'true' - the file may be defective but it may still be somewhat OK
 if( nullptr == ref )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n * [INFO] node '%s' not found." ),
 __FILE__, __FUNCTION__, __LINE__, glob );
 
 return true;
 }
 
 if( !aParent->AddRefNode( ref ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n * [INFO] failed to add node '%s' (%s) to parent of type %s." ),
 __FILE__, __FUNCTION__, __LINE__, glob,
 ref->GetNodeTypeName( ref->GetNodeType() ),
 aParent->GetNodeTypeName( aParent->GetNodeType() ) );
 
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = ref;
 
 return true;
}

References WRL1NODE::AddRefNode(), WRL1NODE::FindNode(), WRLPROC::GetError(), WRL1NODE::GetNodeType(), WRL1NODE::GetNodeTypeName(), WRLPROC::ReadName(), and traceVrmlPlugin.

Referenced by ReadNode().

◆ Read() [1/2]

bool WRL1BASE::Read ( WRLPROC & proc )

Definition at line 77 of file vrml1_base.cpp.

{
 wxCHECK_MSG( proc.GetVRMLType() == WRLVERSION::VRML_V1, false,
 wxT( "No open file or file is not a VRML1 file" ) );
 
 // Note: according to the VRML1 specification, a file may contain
 // only one grouping node at the top level. The following code
 // supports non-conformant VRML1 files by processing all top level
 // nodes as if the vrml1_base were the equivalent of a vrml1_separator
 
 while( proc.Peek() )
 {
 if( !ReadNode( proc, this, nullptr ) )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n * [INFO] bad file format; unexpected eof %s" ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition() );
 
 return false;
 }
 }
 
 if( !proc.eof() )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n%s" ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetError() );
 
 return false;
 }
 
 return true;
}

References WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFilePosition(), WRLPROC::GetVRMLType(), WRLPROC::Peek(), ReadNode(), traceVrmlPlugin, and VRML_V1.

Referenced by LoadVRML().

◆ Read() [2/2]

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

overridevirtual

Implements WRL1NODE.

Definition at line 346 of file vrml1_base.cpp.

{
 wxCHECK_MSG( false, false, wxT( "This method must never be invoked on a WRL1BASE object" ) );
}

◆ readCoords()

bool WRL1BASE::readCoords	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 449 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1COORDS* np = new WRL1COORDS( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1COORDS::Read().

Referenced by ReadNode().

◆ readFaceSet()

bool WRL1BASE::readFaceSet	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 469 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1FACESET* np = new WRL1FACESET( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1FACESET::Read().

Referenced by ReadNode().

◆ readGroup()

bool WRL1BASE::readGroup	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 352 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1GROUP* np = new WRL1GROUP( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1GROUP::Read().

Referenced by ReadNode().

◆ readMatBinding()

bool WRL1BASE::readMatBinding	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 429 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1MATBINDING* np = new WRL1MATBINDING( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1MATBINDING::Read().

Referenced by ReadNode().

◆ readMaterial()

bool WRL1BASE::readMaterial	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 409 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1MATERIAL* np = new WRL1MATERIAL( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1MATERIAL::Read().

Referenced by ReadNode().

◆ ReadNode()

bool WRL1BASE::ReadNode	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

Definition at line 200 of file vrml1_base.cpp.

{
 // This function reads a node and stores a pointer to it in aNode.
 // A value 'true' is returned if a node is successfully read or,
 // if the node is not supported, successfully discarded. Callers
 // must always check the value of aNode when the function returns
 // 'true' since it will be NULL if the node type is not supported.
 
 if( nullptr != aNode )
 *aNode = nullptr;
 
 wxCHECK_MSG( aParent, false, wxT( "Invalid parent pointer." ) );
 
 std::string glob;
 WRL1NODES ntype;
 
 if( !proc.ReadName( glob ) )
 {
 if( !proc.eof() )
 {
 wxLogTrace( traceVrmlPlugin, wxT( "%s:%s:%d\n%s" ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetError() );
 }
 
 return false;
 }
 
 // Process node name:
 // the names encountered at this point should be one of the
 // built-in node names or one of:
 // DEF, USE
 if( !glob.compare( "USE" ) )
 {
 if( !implementUse( proc, aParent, aNode ) )
 return false;
 
 return true;
 }
 
 if( !glob.compare( "DEF" ) )
 {
 if( !implementDef( proc, aParent, aNode ) )
 return false;
 
 return true;
 }
 
 ntype = getNodeTypeID( glob );
 
 wxLogTrace( traceVrmlPlugin, wxT( " * [INFO] Processing node '%s' ID: %d." ), glob, ntype );
 
 switch( ntype )
 {
 case WRL1NODES::WRL1_GROUP:
 
 if( !readGroup( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_SEPARATOR:
 
 if( !readSeparator( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_SWITCH:
 
 if( !readSwitch( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_MATERIAL:
 
 if( !readMaterial( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_MATERIALBINDING:
 
 if( !readMatBinding( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_COORDINATE3:
 
 if( !readCoords( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_INDEXEDFACESET:
 
 if( !readFaceSet( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_TRANSFORM:
 case WRL1NODES::WRL1_TRANSLATION:
 case WRL1NODES::WRL1_ROTATION:
 case WRL1NODES::WRL1_SCALE:
 
 if( !readTransform( proc, aParent, aNode ) )
 return false;
 
 break;
 
 case WRL1NODES::WRL1_SHAPEHINTS:
 
 if( !readShapeHints( proc, aParent, aNode ) )
 return false;
 
 break;
 
 //
 // items not implemented or for optional future implementation:
 //
 default:
 
 if( !proc.DiscardNode() )
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( "%s:%s:%d\n * [INFO] could not discard node %s." ),
 __FILE__, __FUNCTION__, __LINE__, proc.GetFilePosition() );
 
 return false;
 }
 else
 {
 wxLogTrace( traceVrmlPlugin,
 wxT( " * [INFO] discarded node '%s' %s (currently unsupported)." ),
 glob, proc.GetFilePosition() );
 }
 
 break;
 }
 
 return true;
}

References WRLPROC::DiscardNode(), WRLPROC::eof(), WRLPROC::GetError(), WRLPROC::GetFilePosition(), WRL1NODE::getNodeTypeID(), implementDef(), implementUse(), readCoords(), readFaceSet(), readGroup(), readMatBinding(), readMaterial(), WRLPROC::ReadName(), readSeparator(), readShapeHints(), readSwitch(), readTransform(), traceVrmlPlugin, WRL1_COORDINATE3, WRL1_GROUP, WRL1_INDEXEDFACESET, WRL1_MATERIAL, WRL1_MATERIALBINDING, WRL1_ROTATION, WRL1_SCALE, WRL1_SEPARATOR, WRL1_SHAPEHINTS, WRL1_SWITCH, WRL1_TRANSFORM, and WRL1_TRANSLATION.

Referenced by implementDef(), Read(), WRL1GROUP::Read(), WRL1SEPARATOR::Read(), and WRL1SWITCH::Read().

◆ readSeparator()

bool WRL1BASE::readSeparator	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 372 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1SEPARATOR* np = new WRL1SEPARATOR( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1SEPARATOR::Read().

Referenced by ReadNode().

◆ readShapeHints()

bool WRL1BASE::readShapeHints	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 509 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1SHAPEHINTS* np = new WRL1SHAPEHINTS( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
  *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1SHAPEHINTS::Read().

Referenced by ReadNode().

◆ readSwitch()

bool WRL1BASE::readSwitch	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 392 of file vrml1_base.cpp.

{
 WRL1SWITCH* np = new WRL1SWITCH( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1SWITCH::Read().

Referenced by ReadNode().

◆ readTransform()

bool WRL1BASE::readTransform	(	WRLPROC &	proc,
		WRL1NODE *	aParent,
		WRL1NODE **	aNode
	)

private

Definition at line 489 of file vrml1_base.cpp.

{
 if( nullptr != aNode )
 *aNode = nullptr;
 
 WRL1TRANSFORM* np = new WRL1TRANSFORM( m_dictionary, aParent );
 
 if( !np->Read( proc, this ) )
 {
 delete np;
 return false;
 }
 
 if( nullptr != aNode )
 *aNode = (WRL1NODE*) np;
 
 return true;
}

References WRL1NODE::m_dictionary, and WRL1TRANSFORM::Read().

Referenced by ReadNode().

◆ SetName()

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

overridevirtual

Reimplemented from WRL1NODE.

Definition at line 71 of file vrml1_base.cpp.

{
 wxCHECK_MSG( false, false, wxT( "Attempt to set name on virtual base node." ) );
}

◆ SetParent()

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

overridevirtual

Set the parent WRL1NODE of this object.

Parameters

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

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

Reimplemented from WRL1NODE.

Definition at line 58 of file vrml1_base.cpp.

{
 wxCHECK_MSG( false, false, wxT( "Attempt to set parent on WRL1BASE node." ) );
}

◆ TranslateToSG()

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

overridevirtual

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

Parameters

aParent is a pointer to the parent SG node.

Returns: is non-NULL on success.

Implements WRL1NODE.

Definition at line 529 of file vrml1_base.cpp.

{
 wxLogTrace( traceVrmlPlugin, wxT( " * [INFO] Translating VRML1 Base with %zu items." ),
 m_Items.size() );
 
 if( m_Items.empty() )
 return nullptr;
 
 if( m_Items.size() == 1 )
 return ( *m_Items.begin() )->TranslateToSG( nullptr, nullptr );
 
 // Note: according to the VRML1 specification, a file may contain
 // only one grouping node at the top level. The following code
 // supports non-conformant VRML1 files.
 
 m_current.Init();
 
 IFSG_TRANSFORM txNode( true );
 bool hasContent = false;
 
 std::list< WRL1NODE* >::iterator sI = m_Items.begin();
 std::list< WRL1NODE* >::iterator eI = m_Items.end();
 
 SGNODE* node = txNode.GetRawPtr();
 
 while( sI != eI )
 {
 if( nullptr != (*sI)->TranslateToSG( node, &m_current ) )
 hasContent = true;
 
 ++sI;
 }
 
 if( !hasContent )
 {
 txNode.Destroy();
 return nullptr;
 }
 
 return node;
}

References IFSG_NODE::Destroy(), IFSG_NODE::GetRawPtr(), WRL1STATUS::Init(), WRL1NODE::m_current, WRL1NODE::m_Items, and traceVrmlPlugin.

Referenced by LoadVRML().

◆ unlinkChildNode()

void WRL1NODE::unlinkChildNode ( const WRL1NODE * aNode )

virtualinherited

Remove references to an owned child; it is invoked by the child upon destruction to ensure that the parent has no invalid references.

Parameters

aNode is the child which is being deleted.

Definition at line 420 of file vrml1_node.cpp.

{
 std::list< WRL1NODE* >::iterator sL = m_Children.begin();
 std::list< WRL1NODE* >::iterator eL = m_Children.end();
 
 while( sL != eL )
 {
 if( *sL == aNode )
 {
 m_Children.erase( sL );
 delItem( aNode );
 return;
 }
 
 ++sL;
 }
}

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

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

◆ unlinkRefNode()

void WRL1NODE::unlinkRefNode ( const WRL1NODE * aNode )

virtualinherited

Remove pointers to a referenced node; it is invoked by the referenced node upon destruction to ensure that the referring node has no invalid references.

Parameters

aNode is the node which is being deleted.

Definition at line 439 of file vrml1_node.cpp.

{
 std::list< WRL1NODE* >::iterator sL = m_Refs.begin();
 std::list< WRL1NODE* >::iterator eL = m_Refs.end();
 
 while( sL != eL )
 {
 if( *sL == aNode )
 {
 m_Refs.erase( sL );
 delItem( aNode );
 return;
 }
 
 ++sL;
 }
}

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

Member Data Documentation

◆ m_BackPointers

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

protectedinherited

Definition at line 230 of file vrml1_node.h.

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

◆ m_Children

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

protectedinherited

Definition at line 231 of file vrml1_node.h.

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

◆ m_current

WRL1STATUS WRL1NODE::m_current

protectedinherited

Definition at line 236 of file vrml1_node.h.

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

◆ m_dictionary

NAMEREGISTER* WRL1NODE::m_dictionary

protectedinherited

Definition at line 246 of file vrml1_node.h.

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

◆ m_error

std::string WRL1NODE::m_error

protectedinherited

Definition at line 234 of file vrml1_node.h.

Referenced by WRL1NODE::GetError().

◆ m_Items

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

protectedinherited

Definition at line 233 of file vrml1_node.h.

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

◆ m_Name

std::string WRL1NODE::m_Name

protectedinherited

Definition at line 228 of file vrml1_node.h.

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

◆ m_Parent

WRL1NODE* WRL1NODE::m_Parent

protectedinherited

◆ m_Refs

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

protectedinherited

Definition at line 232 of file vrml1_node.h.

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

◆ m_sgNode

SGNODE* WRL1NODE::m_sgNode

protectedinherited

Definition at line 237 of file vrml1_node.h.

Referenced by WRL1NODE::WRL1NODE().

◆ m_Type

WRL1NODES WRL1NODE::m_Type

protectedinherited

Definition at line 227 of file vrml1_node.h.

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WRL1BASE()

◆ ~WRL1BASE()

Member Function Documentation

◆ AddChildNode()

◆ addItem()

◆ addNodeRef()

◆ AddRefNode()

◆ cancelDict()

◆ delItem()

◆ delNodeRef()

◆ FindNode()

◆ GetError()

◆ GetName()

◆ GetNItems()

◆ GetNodeType()

◆ getNodeTypeID()

◆ GetNodeTypeName()

◆ GetParent()

◆ implementDef()

◆ implementUse()

◆ Read() [1/2]

◆ Read() [2/2]

◆ readCoords()

◆ readFaceSet()

◆ readGroup()

◆ readMatBinding()

◆ readMaterial()

◆ ReadNode()

◆ readSeparator()

◆ readShapeHints()

◆ readSwitch()

◆ readTransform()

◆ SetName()

◆ SetParent()

◆ TranslateToSG()

◆ unlinkChildNode()

◆ unlinkRefNode()

Member Data Documentation

◆ m_BackPointers

◆ m_Children

◆ m_current

◆ m_dictionary

◆ m_error

◆ m_Items

◆ m_Name

◆ m_Parent

◆ m_Refs

◆ m_sgNode

◆ m_Type