S3D Namespace Reference

Classes
struct	MATLIST

Enumerations
enum	SGTYPES {   SGTYPE_TRANSFORM = 0 , SGTYPE_APPEARANCE , SGTYPE_COLORS , SGTYPE_COLORINDEX ,   SGTYPE_FACESET , SGTYPE_COORDS , SGTYPE_COORDINDEX , SGTYPE_NORMALS ,   SGTYPE_SHAPE , SGTYPE_END }

Functions
bool	degenerate (glm::dvec3 *pts) noexcept
bool	CalcTriangleNormals (std::vector< SGPOINT > coords, std::vector< int > &index, std::vector< SGVECTOR > &norms)
void	FormatFloat (std::string &result, double value)
void	FormatOrientation (std::string &result, const SGVECTOR &axis, double rotation)
void	FormatPoint (std::string &result, const SGPOINT &point)
void	FormatVector (std::string &result, const SGVECTOR &aVector)
void	FormatColor (std::string &result, const SGCOLOR &aColor)
bool	WritePoint (std::ostream &aFile, const SGPOINT &aPoint)
bool	WriteVector (std::ostream &aFile, const SGVECTOR &aVector)
bool	WriteColor (std::ostream &aFile, const SGCOLOR &aColor)
S3D::SGTYPES	ReadTag (std::istream &aFile, std::string &aName)
	Read the text tag of a binary cache file which is the NodeTag and unique ID number combined. More...
bool	ReadPoint (std::istream &aFile, SGPOINT &aPoint)
bool	ReadVector (std::istream &aFile, SGVECTOR &aVector)
bool	ReadColor (std::istream &aFile, SGCOLOR &aColor)
char const *	GetNodeTypeName (S3D::SGTYPES aType) noexcept
	Return the name of the given type of node. More...
bool	GetMatIndex (MATLIST &aList, SGNODE *aNode, int &aIndex)
void	INIT_SMATERIAL (SMATERIAL &aMaterial)
void	INIT_SMESH (SMESH &aMesh) noexcept
void	INIT_S3DMODEL (S3DMODEL &aModel) noexcept
void	FREE_SMESH (SMESH &aMesh) noexcept
void	FREE_S3DMODEL (S3DMODEL &aModel)
bool	Select3DModel (wxWindow *aParent, S3D_CACHE *aCache, wxString &prevModelSelectDir, int &prevModelWildcard, FP_3DMODEL *aModel)
bool	Configure3DPaths (wxWindow *aParent, FILENAME_RESOLVER *aResolver)
SGLIB_API void	GetLibVersion (unsigned char *Major, unsigned char *Minor, unsigned char *Patch, unsigned char *Revision) noexcept
	Function GetLibVersion retrieves version information of the kicad_3dsg library. More...
SGLIB_API S3D::SGTYPES	GetSGNodeType (SGNODE *aNode)
SGLIB_API SGNODE *	GetSGNodeParent (SGNODE *aNode)
SGLIB_API bool	AddSGNodeRef (SGNODE *aParent, SGNODE *aChild)
SGLIB_API bool	AddSGNodeChild (SGNODE *aParent, SGNODE *aChild)
SGLIB_API void	AssociateSGNodeWrapper (SGNODE *aObject, SGNODE **aRefPtr)
SGLIB_API SGVECTOR	CalcTriNorm (const SGPOINT &p1, const SGPOINT &p2, const SGPOINT &p3)
	Function CalcTriNorm returns the normal vector of a triangle described by vertices p1, p2, p3. More...
SGLIB_API bool	WriteCache (const char *aFileName, bool overwrite, SGNODE *aNode, const char *aPluginInfo)
	Function WriteCache writes the SGNODE tree to a binary cache file. More...
SGLIB_API SGNODE *	ReadCache (const char *aFileName, void *aPluginMgr, bool(*aTagCheck)(const char *, void *))
	Function ReadCache reads a binary cache file and creates an SGNODE tree. More...
SGLIB_API bool	WriteVRML (const char *filename, bool overwrite, SGNODE *aTopNode, bool reuse, bool renameNodes)
	Function WriteVRML writes out the given node and its subnodes to a VRML2 file. More...
SGLIB_API void	ResetNodeIndex (SGNODE *aNode)
	Function ResetNodeIndex resets the global SG* class indices. More...
SGLIB_API void	RenameNodes (SGNODE *aNode)
	Function RenameNodes renames a node and all children nodes based on the current values of the global SG* class indices. More...
SGLIB_API void	DestroyNode (SGNODE *aNode) noexcept
	Function DestroyNode deletes the given SG* class node. More...
SGLIB_API S3DMODEL *	GetModel (SCENEGRAPH *aNode)
	Function GetModel creates an S3DMODEL representation of aNode (raw data, no transforms) More...
SGLIB_API void	Destroy3DModel (S3DMODEL **aModel)
	Function Destroy3DModel frees memory used by an S3DMODEL structure and sets the pointer to the structure to NULL. More...
SGLIB_API void	Free3DModel (S3DMODEL &aModel)
	Function Free3DModel frees memory used internally by an S3DMODEL structure. More...
SGLIB_API void	Free3DMesh (SMESH &aMesh)
	Function Free3DMesh frees memory used internally by an SMESH structure. More...
SGLIB_API S3DMODEL *	New3DModel (void)
	Function New3DModel creates and initializes an S3DMODEL struct. More...
SGLIB_API void	Init3DMaterial (SMATERIAL &aMat)
	Function Init3DMaterial initializes an SMATERIAL struct. More...
SGLIB_API void	Init3DMesh (SMESH &aMesh)
	Function Init3DMesh creates and initializes an SMESH struct. More...

Enumeration Type Documentation

SGTYPES

enum S3D::SGTYPES

Enumerator
SGTYPE_TRANSFORM
SGTYPE_APPEARANCE
SGTYPE_COLORS
SGTYPE_COLORINDEX
SGTYPE_FACESET
SGTYPE_COORDS
SGTYPE_COORDINDEX
SGTYPE_NORMALS
SGTYPE_SHAPE
SGTYPE_END

Definition at line 34 of file sg_types.h.

 {
 SGTYPE_TRANSFORM = 0,
 SGTYPE_APPEARANCE,
 SGTYPE_COLORS,
 SGTYPE_COLORINDEX,
 SGTYPE_FACESET,
 SGTYPE_COORDS,
 SGTYPE_COORDINDEX,
 SGTYPE_NORMALS,
 SGTYPE_SHAPE,
 SGTYPE_END
 };

Function Documentation

AddSGNodeChild()

bool S3D::AddSGNodeChild	(	SGNODE *	aParent,
		SGNODE *	aChild
	)

Definition at line 512 of file ifsg_api.cpp.

{
 if( nullptr == aParent || nullptr == aChild )
 return false;
 
 return aParent->AddChildNode( aChild );
}

References SGNODE::AddChildNode().

Referenced by addItems(), processFace(), WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2INLINE::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), and X3DTRANSFORM::TranslateToSG().

AddSGNodeRef()

bool S3D::AddSGNodeRef	(	SGNODE *	aParent,
		SGNODE *	aChild
	)

Definition at line 503 of file ifsg_api.cpp.

{
 if( nullptr == aParent || nullptr == aChild )
 return false;
 
 return aParent->AddRefNode( aChild );
}

References SGNODE::AddRefNode().

Referenced by addItems(), processFace(), WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2INLINE::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), and X3DTRANSFORM::TranslateToSG().

AssociateSGNodeWrapper()

void S3D::AssociateSGNodeWrapper	(	SGNODE *	aObject,
		SGNODE **	aRefPtr
	)

Definition at line 521 of file ifsg_api.cpp.

{
 if( nullptr == aObject || nullptr == aRefPtr || aObject != *aRefPtr )
 return;
 
 aObject->AssociateWrapper( aRefPtr );
}

References SGNODE::AssociateWrapper().

CalcTriangleNormals()

bool S3D::CalcTriangleNormals	(	std::vector< SGPOINT >	coords,
		std::vector< int > &	index,
		std::vector< SGVECTOR > &	norms
	)

Definition at line 353 of file sg_helpers.cpp.

{
 size_t vsize = coords.size();
 
 if( vsize < 3 )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] invalid vertex set (fewer than 3 "
 "vertices)" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 size_t isize = index.size();
 
 if( 0 != isize % 3 || index.empty() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] invalid index set (not multiple of 3)" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 if( !norms.empty() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] normals set is not empty" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 std::map< int, std::list< glm::dvec3 > >vmap;
 
 int p1, p2, p3;
 
 // create the map of indices to facet sets
 for( size_t i = 0; i < isize; )
 {
 p1 = index[i++];
 p2 = index[i++];
 p3 = index[i++];
 
 if( p1 < 0 || p1 >= (int)vsize || p2 < 0 || p2 >= (int)vsize || p3 < 0 || p3 >= (int)vsize )
 {
#ifdef DEBUG
 std::ostringstream ostr;
 ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
 ostr << " * [INFO] invalid index set; index out of bounds";
 wxLogTrace( MASK_3D_SG, wxT( "%s\n" ), ostr.str().c_str() );
#endif
 
 return false;
 }
 
 glm::dvec3 tri;
 glm::dvec3 trip[3];
 trip[0] = glm::dvec3( coords[p1].x, coords[p1].y, coords[p1].z );
 trip[1] = glm::dvec3( coords[p2].x, coords[p2].y, coords[p2].z );
 trip[2] = glm::dvec3( coords[p3].x, coords[p3].y, coords[p3].z );
 calcTriad( trip, tri );
 
 std::map< int, std::list< glm::dvec3 > >::iterator ip = vmap.find( p1 );
 
 if( ip != vmap.end() )
 {
 ip->second.push_back( tri );
 }
 else
 {
 vmap.emplace( p1, std::list < glm::dvec3 >( 1, tri ) );
 }
 
 ip = vmap.find( p2 );
 
 if( ip != vmap.end() )
 {
 ip->second.push_back( tri );
 }
 else
 {
 vmap.emplace( p2, std::list < glm::dvec3 >( 1, tri ) );
 }
 
 ip = vmap.find( p3 );
 
 if( ip != vmap.end() )
 {
 ip->second.push_back( tri );
 }
 else
 {
 vmap.emplace( p3, std::list < glm::dvec3 >( 1, tri ) );
 }
 }
 
 std::map< int, std::list< glm::dvec3 > >::iterator sM = vmap.begin();
 std::map< int, std::list< glm::dvec3 > >::iterator eM = vmap.end();
 size_t idx = 0;
 
 while( sM != eM )
 {
 size_t item = sM->first;
 
 // assign any skipped coordinates a normal of (0,0,1)
 while( item > idx )
 {
 norms.emplace_back( 0, 0, 1 );
 ++idx;
 }
 
 std::list< glm::dvec3 >::iterator sT = sM->second.begin();
 std::list< glm::dvec3 >::iterator eT = sM->second.end();
 glm::dvec3 norm( 0.0, 0.0, 0.0 );
 
 while( sT != eT )
 {
 norm += *sT;
 ++sT;
 }
 
 norms.emplace_back( norm.x, norm.y, norm.z );
 
 ++idx;
 ++sM;
 }
 
 if( norms.size() != coords.size() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] number of normals does not equal number "
 "of vertices" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return false;
 }
 
 return true;
}

References calcTriad().

Referenced by SGCOORDS::CalcNormals().

CalcTriNorm()

SGVECTOR S3D::CalcTriNorm	(	const SGPOINT &	p1,
		const SGPOINT &	p2,
		const SGPOINT &	p3
	)

Function CalcTriNorm returns the normal vector of a triangle described by vertices p1, p2, p3.

Definition at line 464 of file ifsg_api.cpp.

{
 glm::dvec3 tri = glm::dvec3( 0.0, 0.0, 0.0 );
 glm::dvec3 pts[3];
 
 pts[0] = glm::dvec3( p1.x, p1.y, p1.z );
 pts[1] = glm::dvec3( p2.x, p2.y, p2.z );
 pts[2] = glm::dvec3( p3.x, p3.y, p3.z );
 
 // degenerate points are given a default 0, 0, 1 normal
 if( S3D::degenerate( pts ) )
 return SGVECTOR( 0.0, 0.0, 1.0 );
 
 // normal
 tri = glm::cross( pts[1] - pts[0], pts[2] - pts[0] );
 glm::normalize( tri );
 
 return SGVECTOR( tri.x, tri.y, tri.z );
}

References degenerate(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by EXPORTER_PCB_VRML::create_vrml_shell(), and vrmlToSG().

Configure3DPaths()

bool S3D::Configure3DPaths	(	wxWindow *	aParent,
		FILENAME_RESOLVER *	aResolver
	)

Definition at line 46 of file 3d_cache_dialogs.cpp.

{
 DIALOG_CONFIGURE_PATHS dlg( aParent );
 
 // Use QuasiModal so that HTML help window will work
 return( dlg.ShowQuasiModal() == wxID_OK );
}

References DIALOG_SHIM::ShowQuasiModal().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), and DIALOG_SELECT_3DMODEL::Cfg3DPaths().

degenerate()

bool S3D::degenerate ( glm::dvec3 *  pts )

noexcept

Definition at line 310 of file sg_helpers.cpp.

{
 double dx, dy, dz;
 
 dx = pts[1].x - pts[0].x;
 dy = pts[1].y - pts[0].y;
 dz = pts[1].z - pts[0].z;
 
 if( ( dx*dx + dy*dy + dz*dz ) < 1e-15 )
 return true;
 
 dx = pts[2].x - pts[0].x;
 dy = pts[2].y - pts[0].y;
 dz = pts[2].z - pts[0].z;
 
 if( ( dx*dx + dy*dy + dz*dz ) < 1e-15 )
 return true;
 
 dx = pts[2].x - pts[1].x;
 dy = pts[2].y - pts[1].y;
 dz = pts[2].z - pts[1].z;
 
 if( ( dx*dx + dy*dy + dz*dz ) < 1e-15 )
 return true;
 
 return false;
}

Referenced by calcTriad(), and CalcTriNorm().

Destroy3DModel()

void S3D::Destroy3DModel

(

S3DMODEL **

aModel

)

Function Destroy3DModel frees memory used by an S3DMODEL structure and sets the pointer to the structure to NULL.

Definition at line 403 of file ifsg_api.cpp.

{
 if( nullptr == aModel || nullptr == *aModel )
 return;
 
 S3DMODEL* m = *aModel;
 S3D::FREE_S3DMODEL( *m );
 delete m;
 *aModel = nullptr;
}

References FREE_S3DMODEL().

Referenced by S3D_CACHE::load(), and S3D_CACHE_ENTRY::~S3D_CACHE_ENTRY().

DestroyNode()

void S3D::DestroyNode ( SGNODE *  aNode )

noexcept

Function DestroyNode deletes the given SG* class node.

This function makes it possible to safely delete an SG* node without associating the node with its corresponding IFSG* wrapper.

Definition at line 149 of file ifsg_api.cpp.

{
 wxCHECK( aNode, /* void */ );
 
 delete aNode;
}

Referenced by S3D_CACHE::load(), S3D_CACHE::loadCacheData(), WRL1MATERIAL::Reclaim(), DATA::~DATA(), EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML(), WRL1MATERIAL::~WRL1MATERIAL(), and WRL2BASE::~WRL2BASE().

FormatColor()

void S3D::FormatColor	(	std::string &	result,
		const SGCOLOR &	aColor
	)

Definition at line 135 of file sg_helpers.cpp.

{
 float R, G, B;
 aColor.GetColor( R, G, B );
 FormatFloat( result, R );
 
 std::string tmp;
 FormatFloat( tmp, G );
 result.append( " " );
 result.append( tmp );
 
 FormatFloat( tmp, B );
 result.append( " " );
 result.append( tmp );
}

References FormatFloat(), G, and SGCOLOR::GetColor().

Referenced by SGCOLORS::WriteVRML().

FormatFloat()

void S3D::FormatFloat	(	std::string &	result,
		double	value
	)

Definition at line 37 of file sg_helpers.cpp.

{
 if( value < 1e-8 && value > -1e-8 )
 {
 result = "0";
 return;
 }
 
 // note: many VRML implementations use float so we use the max.
 // precision here of 8 digits.
 std::ostringstream out;
 out << std::setprecision( 8 ) << value;
 
 result = out.str();
 
 size_t p = result.find( '.' );
 
 // trim trailing 0 if appropriate
 if( std::string::npos == p )
 return;
 
 p = result.find_first_of( "eE" );
 
 if( std::string::npos == p )
 {
 while( '0' == *( result.rbegin() ) )
 result.erase( result.size() - 1 );
 
 return;
 }
 
 if( '0' != result.at( p - 1 ) )
 return;
 
 // trim all 0 to the left of 'p'
 std::string tmp = result.substr( p );
 result = result.substr( 0, p );
 
 while( '0' == *( result.rbegin() ) )
 result.erase( result.size() - 1 );
 
 result.append( tmp );
}

Referenced by FormatColor(), FormatOrientation(), FormatPoint(), FormatVector(), and SGAPPEARANCE::WriteVRML().

FormatOrientation()

void S3D::FormatOrientation	(	std::string &	result,
		const SGVECTOR &	axis,
		double	rotation
	)

Definition at line 82 of file sg_helpers.cpp.

{
 double aX;
 double aY;
 double aZ;
 
 axis.GetVector( aX, aY, aZ );
 FormatFloat( result, aX );
 std::string tmp;
 FormatFloat( tmp, aY );
 result.append( " " );
 result.append( tmp );
 FormatFloat( tmp, aZ );
 result.append( " " );
 result.append( tmp );
 FormatFloat( tmp, rotation );
 result.append( " " );
 result.append( tmp );
}

References FormatFloat(), and SGVECTOR::GetVector().

Referenced by SCENEGRAPH::WriteVRML().

FormatPoint()

void S3D::FormatPoint	(	std::string &	result,
		const SGPOINT &	point
	)

Definition at line 103 of file sg_helpers.cpp.

{
 FormatFloat( result, point.x );
 
 std::string tmp;
 FormatFloat( tmp, point.y );
 result.append( " " );
 result.append( tmp );
 
 FormatFloat( tmp, point.z );
 result.append( " " );
 result.append( tmp );
}

References FormatFloat(), SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by SCENEGRAPH::WriteVRML(), and SGCOORDS::WriteVRML().

FormatVector()

void S3D::FormatVector	(	std::string &	result,
		const SGVECTOR &	aVector
	)

Definition at line 118 of file sg_helpers.cpp.

{
 double X, Y, Z;
 aVector.GetVector( X, Y, Z );
 FormatFloat( result, X );
 
 std::string tmp;
 FormatFloat( tmp, Y );
 result.append( " " );
 result.append( tmp );
 
 FormatFloat( tmp, Z );
 result.append( " " );
 result.append( tmp );
}

References FormatFloat(), SGVECTOR::GetVector(), and X.

Referenced by SGNORMALS::WriteVRML().

Free3DMesh()

void S3D::Free3DMesh

(

SMESH &

aMesh

)

Function Free3DMesh frees memory used internally by an SMESH structure.

Definition at line 421 of file ifsg_api.cpp.

{
 S3D::FREE_SMESH( aMesh );
}

References FREE_SMESH().

Referenced by GetModel().

Free3DModel()

SGLIB_API void S3D::Free3DModel

(

S3DMODEL &

aModel

)

Function Free3DModel frees memory used internally by an S3DMODEL structure.

FREE_S3DMODEL()

void S3D::FREE_S3DMODEL

(

S3DMODEL &

aModel

)

Definition at line 326 of file sg_node.cpp.

{
 if( nullptr != aModel.m_Materials )
 {
 delete [] aModel.m_Materials;
 aModel.m_Materials = nullptr;
 }
 
 aModel.m_MaterialsSize = 0;
 
 if( nullptr != aModel.m_Meshes )
 {
 for( unsigned int i = 0; i < aModel.m_MeshesSize; ++i )
 FREE_SMESH( aModel.m_Meshes[i] );
 
 delete [] aModel.m_Meshes;
 aModel.m_Meshes = nullptr;
 }
 
 aModel.m_MeshesSize = 0;
}

References FREE_SMESH(), S3DMODEL::m_Materials, S3DMODEL::m_MaterialsSize, S3DMODEL::m_Meshes, and S3DMODEL::m_MeshesSize.

Referenced by Destroy3DModel(), and Free3DModel().

FREE_SMESH()

void S3D::FREE_SMESH ( SMESH &  aMesh )

noexcept

Definition at line 288 of file sg_node.cpp.

{
 if( nullptr != aMesh.m_Positions )
 {
 delete [] aMesh.m_Positions;
 aMesh.m_Positions = nullptr;
 }
 
 if( nullptr != aMesh.m_Normals )
 {
 delete [] aMesh.m_Normals;
 aMesh.m_Normals = nullptr;
 }
 
 if( nullptr != aMesh.m_Texcoords )
 {
 delete [] aMesh.m_Texcoords;
 aMesh.m_Texcoords = nullptr;
 }
 
 if( nullptr != aMesh.m_Color )
 {
 delete [] aMesh.m_Color;
 aMesh.m_Color = nullptr;
 }
 
 if( nullptr != aMesh.m_FaceIdx )
 {
 delete [] aMesh.m_FaceIdx;
 aMesh.m_FaceIdx = nullptr;
 }
 
 aMesh.m_VertexSize = 0;
 aMesh.m_FaceIdxSize = 0;
 aMesh.m_MaterialIdx = 0;
}

Referenced by Free3DMesh(), and FREE_S3DMODEL().

GetLibVersion()

void S3D::GetLibVersion ( unsigned char *  Major, unsigned char *  Minor, unsigned char *  Patch, unsigned char *  Revision  )

noexcept

Function GetLibVersion retrieves version information of the kicad_3dsg library.

Definition at line 447 of file ifsg_api.cpp.

{
 if( Major )
 *Major = KICADSG_VERSION_MAJOR;
 
 if( Minor )
 *Minor = KICADSG_VERSION_MINOR;
 
 if( Revision )
 *Revision = KICADSG_VERSION_REVISION;
 
 if( Patch )
 *Patch = KICADSG_VERSION_PATCH;
}

References KICADSG_VERSION_MAJOR, KICADSG_VERSION_MINOR, KICADSG_VERSION_PATCH, and KICADSG_VERSION_REVISION.

GetMatIndex()

bool S3D::GetMatIndex	(	MATLIST &	aList,
		SGNODE *	aNode,
		int &	aIndex
	)

Definition at line 245 of file sg_node.cpp.

{
 aIndex = 0;
 
 wxCHECK( aNode && S3D::SGTYPE_APPEARANCE == aNode->GetNodeType(), false );
 
 SGAPPEARANCE* node = (SGAPPEARANCE*)aNode;
 
 std::map< SGAPPEARANCE const*, int >::iterator it = aList.matmap.find( node );
 
 if( it != aList.matmap.end() )
 {
 aIndex = it->second;
 return true;
 }
 
 int idx = (int)aList.matorder.size();
 aList.matorder.push_back( node );
 aList.matmap.emplace( node, idx );
 aIndex = idx;
 
 return true;
}

References SGNODE::GetNodeType(), S3D::MATLIST::matmap, S3D::MATLIST::matorder, and SGTYPE_APPEARANCE.

Referenced by SGSHAPE::Prepare().

GetModel()

S3DMODEL * S3D::GetModel

(

SCENEGRAPH *

aNode

)

Function GetModel creates an S3DMODEL representation of aNode (raw data, no transforms)

Parameters

aNode

is the node to be transcribed into an S3DMODEL representation

Returns

an S3DMODEL representation of aNode on success, otherwise NULL

Definition at line 338 of file ifsg_api.cpp.

{
 if( nullptr == aNode )
 return nullptr;
 
 if( aNode->GetNodeType() != S3D::SGTYPE_TRANSFORM )
 return nullptr;
 
 S3D::MATLIST materials;
 std::vector< SMESH > meshes;
 
 // the materials list shall have a default color; although the VRML
 // default is an opaque black, the default used here shall be a median
 // gray in hopes that it may help highlight faulty models; this color is
 // also typical of MCAD applications. When a model has no associated
 // material color it shall be assigned the index 0.
 SGAPPEARANCE app( nullptr );
 app.ambient = SGCOLOR( 0.6f, 0.6f, 0.6f );
 app.diffuse = SGCOLOR( 0.6f, 0.6f, 0.6f );
 app.specular = app.diffuse;
 app.shininess = 0.05f;
 app.transparency = 0.0f;
 
 materials.matorder.push_back( &app );
 materials.matmap.emplace( &app, 0 );
 
 if( aNode->Prepare( nullptr, materials, meshes ) )
 {
 if( meshes.empty() )
 return nullptr;
 
 S3DMODEL* model = S3D::New3DModel();
 
 // add all the materials
 size_t j = materials.matorder.size();
 SMATERIAL* lmat = new SMATERIAL[j];
 
 for( size_t i = 0; i < j; ++i )
 formatMaterial( lmat[i], materials.matorder[i] );
 
 model->m_Materials = lmat;
 model->m_MaterialsSize = j;
 
 // add all the meshes
 j = meshes.size();
 SMESH* lmesh = new SMESH[j];
 
 for( size_t i = 0; i < j; ++i )
 lmesh[i] = meshes[i];
 
 model->m_Meshes = lmesh;
 model->m_MeshesSize = j;
 
 return model;
 }
 
 size_t j = meshes.size();
 
 for( size_t i = 0; i < j; ++i )
 S3D::Free3DMesh( meshes[i] );
 
 return nullptr;
}

References SGAPPEARANCE::ambient, SGAPPEARANCE::diffuse, formatMaterial(), Free3DMesh(), SGNODE::GetNodeType(), S3DMODEL::m_Materials, S3DMODEL::m_MaterialsSize, S3DMODEL::m_Meshes, S3DMODEL::m_MeshesSize, S3D::MATLIST::matmap, S3D::MATLIST::matorder, New3DModel(), SCENEGRAPH::Prepare(), SGTYPE_TRANSFORM, SGAPPEARANCE::shininess, SGAPPEARANCE::specular, and SGAPPEARANCE::transparency.

Referenced by S3D_CACHE::GetModel(), PCB_CONTROL::GridSetOrigin(), and PCB_VIEWER_TOOLS::MeasureTool().

GetNodeTypeName()

char const * S3D::GetNodeTypeName ( S3D::SGTYPES  aType )

noexcept

Return the name of the given type of node.

Definition at line 53 of file sg_node.cpp.

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

References node_names.

Referenced by ReadTag().

GetSGNodeParent()

SGNODE * S3D::GetSGNodeParent

(

SGNODE *

aNode

)

Definition at line 494 of file ifsg_api.cpp.

{
 if( nullptr == aNode )
 return nullptr;
 
 return aNode->GetParent();
}

References SGNODE::GetParent().

Referenced by addItems(), SHAPE::CalcShape(), EXPORTER_PCB_VRML::create_vrml_plane(), EXPORTER_PCB_VRML::create_vrml_shell(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), processFace(), WRL1MATERIAL::Reclaim(), WRL2APPEARANCE::TranslateToSG(), WRL2BASE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2INLINE::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), DATA::~DATA(), EXPORTER_PCB_VRML::~EXPORTER_PCB_VRML(), WRL1MATERIAL::~WRL1MATERIAL(), and WRL2BASE::~WRL2BASE().

GetSGNodeType()

S3D::SGTYPES S3D::GetSGNodeType

(

SGNODE *

aNode

)

Definition at line 485 of file ifsg_api.cpp.

{
 if( nullptr == aNode )
 return SGTYPE_END;
 
 return aNode->GetNodeType();
}

References SGNODE::GetNodeType(), and SGTYPE_END.

Referenced by WRL2APPEARANCE::TranslateToSG(), WRL2BOX::TranslateToSG(), WRL2FACESET::TranslateToSG(), WRL2INLINE::TranslateToSG(), WRL2MATERIAL::TranslateToSG(), WRL2SHAPE::TranslateToSG(), WRL2SWITCH::TranslateToSG(), WRL2TRANSFORM::TranslateToSG(), X3DAPP::TranslateToSG(), X3DIFACESET::TranslateToSG(), X3DSHAPE::TranslateToSG(), X3DTRANSFORM::TranslateToSG(), WRL1GROUP::TranslateToSG(), and WRL1SEPARATOR::TranslateToSG().

Init3DMaterial()

void S3D::Init3DMaterial

(

SMATERIAL &

aMat

)

Function Init3DMaterial initializes an SMATERIAL struct.

Definition at line 435 of file ifsg_api.cpp.

{
 S3D::INIT_SMATERIAL( aMat );
}

References INIT_SMATERIAL().

Init3DMesh()

void S3D::Init3DMesh

(

SMESH &

aMesh

)

Function Init3DMesh creates and initializes an SMESH struct.

Definition at line 441 of file ifsg_api.cpp.

{
 S3D::INIT_SMESH( aMesh );
}

References INIT_SMESH().

INIT_S3DMODEL()

void S3D::INIT_S3DMODEL ( S3DMODEL &  aModel )

noexcept

Definition at line 282 of file sg_node.cpp.

{
 aModel = {};
}

Referenced by New3DModel().

INIT_SMATERIAL()

void S3D::INIT_SMATERIAL

(

SMATERIAL &

aMaterial

)

Definition at line 270 of file sg_node.cpp.

{
 aMaterial = {};
}

Referenced by Init3DMaterial().

INIT_SMESH()

void S3D::INIT_SMESH ( SMESH &  aMesh )

noexcept

Definition at line 276 of file sg_node.cpp.

{
 aMesh = {};
}

Referenced by Init3DMesh(), and SGSHAPE::Prepare().

New3DModel()

S3DMODEL * S3D::New3DModel

(

void

)

Function New3DModel creates and initializes an S3DMODEL struct.

Definition at line 427 of file ifsg_api.cpp.

{
 S3DMODEL* mp = new S3DMODEL;
 S3D::INIT_S3DMODEL( *mp );
 return mp;
}

References INIT_S3DMODEL().

Referenced by GetModel().

ReadCache()

SGNODE * S3D::ReadCache	(	const char *	aFileName,
		void *	aPluginMgr,
		bool(*)(const char *, void *)	aTagCheck
	)

Function ReadCache reads a binary cache file and creates an SGNODE tree.

Parameters

aFileName

is the name of the binary cache file to be read

Returns

NULL on failure, on success a pointer to the top level SCENEGRAPH node; if desired this node can be associated with an IFSG_TRANSFORM wrapper via the IFSG_TRANSFORM::Attach() function.

Definition at line 221 of file ifsg_api.cpp.

{
 if( nullptr == aFileName || aFileName[0] == 0 )
 return nullptr;
 
 wxString ofile = wxString::FromUTF8Unchecked( aFileName );
 
 if( !wxFileName::FileExists( aFileName ) )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] no such file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 return nullptr;
 }
 
 std::unique_ptr<SGNODE> np = std::make_unique<SCENEGRAPH>( nullptr );
 
 OPEN_ISTREAM( file, aFileName );
 
 if( file.fail() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] failed to open file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 return nullptr;
 }
 
 // from SG_VERSION_TAG 1, read the version tag; if it's not the expected tag
 // then we fail to read the cache file
 do
 {
 std::string name;
 char schar;
 file.get( schar );
 
 if( '(' != schar )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; missing left parenthesis"
 " at position '%d'" ),
 __FILE__, __FUNCTION__, __LINE__,
 static_cast<int>( file.tellg() ) );
 
 CLOSE_STREAM( file );
 return nullptr;
 }
 
 file.get( schar );
 
 while( ')' != schar && file.good() )
 {
 name.push_back( schar );
 file.get( schar );
 }
 
 if( name.compare( SG_VERSION_TAG ) )
 {
 CLOSE_STREAM( file );
 return nullptr;
 }
 
 } while( 0 );
 
 // from SG_VERSION_TAG 2, read the PluginInfo string and check that it matches
 // version tag; if it's not the expected tag then we fail to read the file
 do
 {
 std::string name;
 char schar;
 file.get( schar );
 
 if( '(' != schar )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; missing left parenthesis"
 " at position '%d'" ),
 __FILE__, __FUNCTION__, __LINE__,
 static_cast<int>( file.tellg() ) );
 
 CLOSE_STREAM( file );
 return nullptr;
 }
 
 file.get( schar );
 
 while( ')' != schar && file.good() )
 {
 name.push_back( schar );
 file.get( schar );
 }
 
 // check the plugin tag
 if( nullptr != aTagCheck && nullptr != aPluginMgr
 && !aTagCheck( name.c_str(), aPluginMgr ) )
 {
 CLOSE_STREAM( file );
 return nullptr;
 }
 
 } while( 0 );
 
 bool rval = np->ReadCache( file, nullptr );
 CLOSE_STREAM( file );
 
 if( !rval )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] problems encountered reading cache file "
 "'%s'" ),
 __FILE__, __FUNCTION__, __LINE__,
 aFileName );
 
 return nullptr;
 }
 
 return np.release();
}

References CLOSE_STREAM, name, OPEN_ISTREAM, and SG_VERSION_TAG.

Referenced by S3D_CACHE::loadCacheData().

ReadColor()

bool S3D::ReadColor	(	std::istream &	aFile,
		SGCOLOR &	aColor
	)

Definition at line 295 of file sg_helpers.cpp.

{
 float r, g, b;
 aFile.read( (char*) &r, sizeof( float ) );
 aFile.read( (char*) &g, sizeof( float ) );
 aFile.read( (char*) &b, sizeof( float ) );
 aColor.SetColor( r, g, b );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGCOLOR::SetColor().

Referenced by SGAPPEARANCE::ReadCache(), and SGCOLORS::ReadCache().

ReadPoint()

bool S3D::ReadPoint	(	std::istream &	aFile,
		SGPOINT &	aPoint
	)

Definition at line 267 of file sg_helpers.cpp.

{
 aFile.read( (char*) &aPoint.x, sizeof( aPoint.x ) );
 aFile.read( (char*) &aPoint.y, sizeof( aPoint.y ) );
 aFile.read( (char*) &aPoint.z, sizeof( aPoint.z ) );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGPOINT::x, SGPOINT::y, and SGPOINT::z.

Referenced by SCENEGRAPH::ReadCache(), and SGCOORDS::ReadCache().

ReadTag()

S3D::SGTYPES S3D::ReadTag	(	std::istream &	aFile,
		std::string &	aName
	)

Read the text tag of a binary cache file which is the NodeTag and unique ID number combined.

Parameters

aFile	is a binary file open for reading.
aName	will hold the tag name on successful return.

Returns

will be the NodeType which the tag represents or S3D::SGTYPES::SGTYPE_END on failure.

Definition at line 195 of file sg_helpers.cpp.

{
 char schar;
 aFile.get( schar );
 
 if( '[' != schar )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; missing left bracket at "
 "position %d" ),
 __FILE__, __FUNCTION__, __LINE__,
 static_cast<int>( aFile.tellg() ) );
 
 return S3D::SGTYPE_END;
 }
 
 std::string name;
 aFile.get( schar );
 
 while( ']' != schar && aFile.good() )
 {
 name.push_back( schar );
 aFile.get( schar );
 }
 
 if( schar != ']' )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; could not find right "
 "bracket" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 return S3D::SGTYPE_END;
 }
 
 aName = name;
 size_t upos = name.find( '_' );
 
 if( std::string::npos == upos )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; no underscore in name '%s'" ),
 __FILE__, __FUNCTION__, __LINE__,
 name );
 
 return S3D::SGTYPE_END;
 }
 
 name = name.substr( 0, upos );
 S3D::SGTYPES types[S3D::SGTYPE_END] = {
 SGTYPE_TRANSFORM,
 SGTYPE_APPEARANCE,
 SGTYPE_COLORS,
 SGTYPE_COLORINDEX,
 SGTYPE_FACESET,
 SGTYPE_COORDS,
 SGTYPE_COORDINDEX,
 SGTYPE_NORMALS,
 SGTYPE_SHAPE
 };
 
 for( int i = 0; i < S3D::SGTYPE_END; ++i )
 {
 if( !name.compare( S3D::GetNodeTypeName( types[i] ) ) )
 return types[i];
 }
 
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] corrupt data; no node type matching '%s'" ),
 __FILE__, __FUNCTION__, __LINE__,
 name );
 
 return S3D::SGTYPE_END;
}

References GetNodeTypeName(), name, SGTYPE_APPEARANCE, SGTYPE_COLORINDEX, SGTYPE_COLORS, SGTYPE_COORDINDEX, SGTYPE_COORDS, SGTYPE_END, SGTYPE_FACESET, SGTYPE_NORMALS, SGTYPE_SHAPE, and SGTYPE_TRANSFORM.

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

ReadVector()

bool S3D::ReadVector	(	std::istream &	aFile,
		SGVECTOR &	aVector
	)

Definition at line 280 of file sg_helpers.cpp.

{
 double x, y, z;
 aFile.read( (char*) &x, sizeof( double ) );
  aFile.read( (char*) &y, sizeof( double ) );
 aFile.read( (char*) &z, sizeof( double ) );
 aVector.SetVector( x, y, z );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGVECTOR::SetVector().

Referenced by SCENEGRAPH::ReadCache(), and SGNORMALS::ReadCache().

RenameNodes()

void S3D::RenameNodes

(

SGNODE *

aNode

)

Function RenameNodes renames a node and all children nodes based on the current values of the global SG* class indices.

Parameters

aNode

is a top level node

Definition at line 141 of file ifsg_api.cpp.

{
 wxCHECK( aNode, /* void */ );
 
 aNode->ReNameNodes();
}

References SGNODE::ReNameNodes().

ResetNodeIndex()

void S3D::ResetNodeIndex

(

SGNODE *

aNode

)

Function ResetNodeIndex resets the global SG* class indices.

Parameters

aNode

may be any valid SGNODE

Definition at line 133 of file ifsg_api.cpp.

{
 wxCHECK( aNode, /* void */ );
 
 aNode->ResetNodeIndex();
}

References SGNODE::ResetNodeIndex().

Select3DModel()

bool S3D::Select3DModel	(	wxWindow *	aParent,
		S3D_CACHE *	aCache,
		wxString &	prevModelSelectDir,
		int &	prevModelWildcard,
		FP_3DMODEL *	aModel
	)

Definition at line 33 of file 3d_cache_dialogs.cpp.

{
 if( nullptr == aModel )
 return false;
 
 DIALOG_SELECT_3DMODEL dm( aParent, aCache, aModel, prevModelSelectDir, prevModelWildcard );
 
 // Use QuasiModal so that Configure3DPaths (and its help window) will work
 return dm.ShowQuasiModal() == wxID_OK;
}

References DIALOG_SHIM::ShowQuasiModal().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel().

WriteCache()

bool S3D::WriteCache	(	const char *	aFileName,
		bool	overwrite,
		SGNODE *	aNode,
		const char *	aPluginInfo
	)

Function WriteCache writes the SGNODE tree to a binary cache file.

Parameters

aFileName	is the name of the file to write
overwrite	must be set to true to overwrite an existing file
aNode	is any node within the node tree which is to be written

Returns

true on success

Definition at line 157 of file ifsg_api.cpp.

{
 if( nullptr == aFileName || aFileName[0] == 0 )
 return false;
 
 wxString ofile = wxString::FromUTF8Unchecked( aFileName );
 
 wxCHECK( aNode, false );
 
 if( wxFileName::Exists( ofile ) )
 {
 if( !overwrite )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] file exists not overwriting '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 return false;
 }
 
 // make sure we make no attempt to write a directory
 if( !wxFileName::FileExists( aFileName ) )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] specified path is a directory '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 return false;
 }
 }
 
 OPEN_OSTREAM( output, aFileName );
 
 if( output.fail() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] failed to open file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 return false;
 }
 
 output << "(" << SG_VERSION_TAG << ")";
 
 if( nullptr != aPluginInfo && aPluginInfo[0] != 0 )
 output << "(" << aPluginInfo << ")";
 else
 output << "(INTERNAL:0.0.0.0)";
 
 bool rval = aNode->WriteCache( output, nullptr );
 CLOSE_STREAM( output );
 
 if( !rval )
 {
 wxLogTrace( MASK_3D_SG,
 wxT( "%s:%s:%d * [INFO] problems encountered writing cache file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, aFileName );
 
 // delete the defective file
 wxRemoveFile( ofile );
 }
 
 return rval;
}

References CLOSE_STREAM, OPEN_OSTREAM, SG_VERSION_TAG, and SGNODE::WriteCache().

Referenced by S3D_CACHE::saveCacheData().

WriteColor()

bool S3D::WriteColor	(	std::ostream &	aFile,
		const SGCOLOR &	aColor
	)

Definition at line 180 of file sg_helpers.cpp.

{
 float r, g, b;
 aColor.GetColor( r, g, b );
 aFile.write( (char*) &r, sizeof( float ) );
 aFile.write( (char*) &g, sizeof( float ) );
 aFile.write( (char*) &b, sizeof( float ) );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGCOLOR::GetColor().

Referenced by SGAPPEARANCE::WriteCache(), and SGCOLORS::WriteCache().

WritePoint()

bool S3D::WritePoint	(	std::ostream &	aFile,
		const SGPOINT &	aPoint
	)

Definition at line 152 of file sg_helpers.cpp.

{
 aFile.write( (char*) &aPoint.x, sizeof( aPoint.x ) );
 aFile.write( (char*) &aPoint.y, sizeof( aPoint.y ) );
 aFile.write( (char*) &aPoint.z, sizeof( aPoint.z ) );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGPOINT::x, SGPOINT::y, and SGPOINT::z.

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

WriteVector()

bool S3D::WriteVector	(	std::ostream &	aFile,
		const SGVECTOR &	aVector
	)

Definition at line 165 of file sg_helpers.cpp.

{
 double x, y, z;
 aVector.GetVector( x, y, z );
 aFile.write( (char*) &x, sizeof( double ) );
 aFile.write( (char*) &y, sizeof( double ) );
 aFile.write( (char*) &z, sizeof( double ) );
 
 if( aFile.fail() )
 return false;
 
 return true;
}

References SGVECTOR::GetVector().

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

WriteVRML()

bool S3D::WriteVRML	(	const char *	filename,
		bool	overwrite,
		SGNODE *	aTopNode,
		bool	reuse,
		bool	renameNodes
	)

Function WriteVRML writes out the given node and its subnodes to a VRML2 file.

Parameters

filename	is the name of the output file
overwrite	should be set to true to overwrite an existing VRML file
aTopNode	is a pointer to a SCENEGRAPH object representing the VRML scene
reuse	should be set to true to make use of VRML DEF/USE features

Returns

true on success

Definition at line 77 of file ifsg_api.cpp.

{
 if( nullptr == filename || filename[0] == 0 )
 return false;
 
 wxString ofile = wxString::FromUTF8Unchecked( filename );
 
 if( wxFileName::Exists( ofile ) )
 {
 if( !overwrite )
 return false;
 
 // make sure we make no attempt to write a directory
 if( !wxFileName::FileExists( ofile ) )
 return false;
 }
 
 wxCHECK( aTopNode && aTopNode->GetNodeType() == S3D::SGTYPE_TRANSFORM, false );
 
 OPEN_OSTREAM( op, filename );
 
 if( op.fail() )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] failed to open file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, filename );
 
 return false;
 }
 
 op.imbue( std::locale::classic() );
 op << "#VRML V2.0 utf8\n";
 
 if( renameNodes )
 {
 aTopNode->ResetNodeIndex();
 aTopNode->ReNameNodes();
 }
 
 aTopNode->WriteVRML( op, reuse );
 
 if( !op.fail() )
 {
 CLOSE_STREAM( op );
 return true;
 }
 
 CLOSE_STREAM( op );
 
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [INFO] problems encountered writing file '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, filename );
 
 return false;
}

References CLOSE_STREAM, SGNODE::GetNodeType(), OPEN_OSTREAM, SGNODE::ReNameNodes(), SGNODE::ResetNodeIndex(), SGTYPE_TRANSFORM, and SGNODE::WriteVRML().

Referenced by EXPORTER_PCB_VRML::ExportVrmlFootprint(), Load(), LoadModel(), LoadVRML(), and EXPORTER_PCB_VRML::writeLayers().