KICAD3D_INFO Class Reference

This is an internal KiCad use attribute to add additional markup to a opencascade document for internal processing. More...

#include <kicad3d_info.h>

Inheritance diagram for KICAD3D_INFO:

Public Member Functions
	KICAD3D_INFO ()
KICAD3D_MODEL_TYPE	GetModelType () const
void	SetModelType (const KICAD3D_MODEL_TYPE &aModelType)
const std::string &	GetDisplayName () const
void	SetDisplayName (const std::string &aName)
const Standard_GUID &	ID () const override
void	Restore (const Handle(TDF_Attribute) &aAttribute) override
	Handle (TDF_Attribute) NewEmpty() const override
void	Paste (const Handle(TDF_Attribute) &aAttribute, const Handle(TDF_RelocationTable) &aRelocationTable) const override
Standard_OStream &	Dump (Standard_OStream &aOS) const override

Static Public Member Functions
static const Standard_GUID &	GetID ()
	Get the GUID of this attribute.
static	Handle (KICAD3D_INFO) Set(const TDF_Label &aLabel
	Finds or creates the attribute attached to <theLabel>.

Public Attributes
static KICAD3D_MODEL_TYPE	aModelType
static KICAD3D_MODEL_TYPE std::string	aDisplayName = "" )

Private Attributes
KICAD3D_MODEL_TYPE	m_modelType
std::string	m_displayName

Detailed Description

This is an internal KiCad use attribute to add additional markup to a opencascade document for internal processing.

Definition at line 44 of file kicad3d_info.h.

Constructor & Destructor Documentation

KICAD3D_INFO()

KICAD3D_INFO::KICAD3D_INFO

(

)

Referenced by Handle(), Handle(), Handle(), and Restore().

Member Function Documentation

Dump()

Standard_OStream & KICAD3D_INFO::Dump ( Standard_OStream & aOS ) const

override

GetDisplayName()

const std::string & KICAD3D_INFO::GetDisplayName ( ) const

inline

Definition at line 66 of file kicad3d_info.h.

References m_displayName.

GetID()

const Standard_GUID & KICAD3D_INFO::GetID ( )

static

Get the GUID of this attribute.

Definition at line 27 of file kicad3d_info.cpp.

References ID().

Referenced by U3D::WRITER::generateMeshesByAssembly(), U3D::WRITER::getMeshName(), Handle(), ID(), and isLabelABoardMesh().

GetModelType()

KICAD3D_MODEL_TYPE KICAD3D_INFO::GetModelType ( ) const

inline

Definition at line 63 of file kicad3d_info.h.

References m_modelType.

Handle() [1/2]

static KICAD3D_INFO::Handle ( KICAD3D_INFO ) const &

static

Finds or creates the attribute attached to <theLabel>.

The found or created attribute is returned

References KICAD3D_INFO().

Referenced by Handle(), and Restore().

Handle() [2/2]

KICAD3D_INFO::Handle ( TDF_Attribute ) const

override

ID()

const Standard_GUID & KICAD3D_INFO::ID ( ) const

override

Definition at line 50 of file kicad3d_info.cpp.

References GetID().

Referenced by GetID().

Paste()

void KICAD3D_INFO::Paste ( const Handle(TDF_Attribute) & aAttribute, const Handle(TDF_RelocationTable) & aRelocationTable ) const

override

Restore()

void KICAD3D_INFO::Restore ( const Handle(TDF_Attribute) & aAttribute )

override

Definition at line 56 of file kicad3d_info.cpp.

References Handle(), KICAD3D_INFO(), m_displayName, and m_modelType.

SetDisplayName()

void KICAD3D_INFO::SetDisplayName ( const std::string & aName )

inline

Definition at line 67 of file kicad3d_info.h.

References m_displayName.

SetModelType()

void KICAD3D_INFO::SetModelType ( const KICAD3D_MODEL_TYPE & aModelType )

inline

Definition at line 64 of file kicad3d_info.h.

References aModelType, and m_modelType.

Member Data Documentation

aDisplayName

KICAD3D_MODEL_TYPE std::string KICAD3D_INFO::aDisplayName = "" )

Definition at line 58 of file kicad3d_info.h.

Referenced by Handle().

aModelType

KICAD3D_MODEL_TYPE KICAD3D_INFO::aModelType

Definition at line 57 of file kicad3d_info.h.

Referenced by Handle(), and SetModelType().

m_displayName

std::string KICAD3D_INFO::m_displayName

private

Definition at line 79 of file kicad3d_info.h.

Referenced by GetDisplayName(), Restore(), and SetDisplayName().

m_modelType

KICAD3D_MODEL_TYPE KICAD3D_INFO::m_modelType

private

Definition at line 78 of file kicad3d_info.h.

Referenced by GetModelType(), Restore(), and SetModelType().

---

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

• kicad3d_info.h
• kicad3d_info.cpp