XCAFDoc_MaterialTool Class Reference

Provides tools to store and retrieve attributes (materials)
of TopoDS_Shape in and from TDocStd_Document
A Document is intended to hold different
attributes of ONE shape and it's sub-shapes

#include <XCAFDoc_MaterialTool.hxx>

Inheritance diagram for XCAFDoc_MaterialTool:

Public Member Functions
	XCAFDoc_MaterialTool ()
TDF_Label	BaseLabel () const
	returns the label under which colors are stored
const Handle_XCAFDoc_ShapeTool &	ShapeTool ()
	Returns internal XCAFDoc_ShapeTool tool
Standard_Boolean	IsMaterial (const TDF_Label &lab) const
	Returns True if label belongs to a material table and is a Material definition
void	GetMaterialLabels (TDF_LabelSequence &Labels) const
	Returns a sequence of materials currently stored in the material table
TDF_Label	AddMaterial (const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, const Standard_Real aDensity, const Handle< TCollection_HAsciiString > &aDensName, const Handle< TCollection_HAsciiString > &aDensValType) const
	Adds a Material definition to a table and returns its label
void	SetMaterial (const TDF_Label &L, const TDF_Label &MatL) const
	Sets a link with GUID
void	SetMaterial (const TDF_Label &L, const Handle< TCollection_HAsciiString > &aName, const Handle< TCollection_HAsciiString > &aDescription, const Standard_Real aDensity, const Handle< TCollection_HAsciiString > &aDensName, const Handle< TCollection_HAsciiString > &aDensValType) const
	Sets a link with GUID Adds a Material as necessary
Standard_Boolean	GetMaterial (const TDF_Label &MatL, Handle< TCollection_HAsciiString > &aName, Handle< TCollection_HAsciiString > &aDescription, Standard_Real &aDensity, Handle< TCollection_HAsciiString > &aDensName, Handle< TCollection_HAsciiString > &aDensValType) const
	Returns Material assigned to <MatL> Returns False if no such Material is assigned
const Standard_GUID &	ID () const
	Returns the ID of the attribute.
void	Restore (const Handle< TDF_Attribute > &with)
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
Handle_TDF_Attribute	NewEmpty () const
	Returns an new empty attribute from the good end type. It is used by the copy algorithm.
void	Paste (const Handle< TDF_Attribute > &into, const Handle< TDF_RelocationTable > &RT) const
	This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>. The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents! It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.
Static Public Member Functions
static Handle_XCAFDoc_MaterialTool	Set (const TDF_Label &L)
	Creates (if not exist) MaterialTool.
static const Standard_GUID &	GetID ()
static Standard_Real	GetDensityForShape (const TDF_Label &ShapeL)
	Find referred material and return density from it if no material --> return 0

---

Constructor & Destructor Documentation

XCAFDoc_MaterialTool::XCAFDoc_MaterialTool

(

)

---

Member Function Documentation

TDF_Label XCAFDoc_MaterialTool::AddMaterial	(	const Handle< TCollection_HAsciiString > &	aName,
		const Handle< TCollection_HAsciiString > &	aDescription,
		const Standard_Real	aDensity,
		const Handle< TCollection_HAsciiString > &	aDensName,
		const Handle< TCollection_HAsciiString > &	aDensValType
	)		const

TDF_Label XCAFDoc_MaterialTool::BaseLabel

(

)

const

static Standard_Real XCAFDoc_MaterialTool::GetDensityForShape

(

const TDF_Label &

ShapeL

)

[static]

static const Standard_GUID& XCAFDoc_MaterialTool::GetID

(

)

[static]

Standard_Boolean XCAFDoc_MaterialTool::GetMaterial	(	const TDF_Label &	MatL,
		Handle< TCollection_HAsciiString > &	aName,
		Handle< TCollection_HAsciiString > &	aDescription,
		Standard_Real &	aDensity,
		Handle< TCollection_HAsciiString > &	aDensName,
		Handle< TCollection_HAsciiString > &	aDensValType
	)		const

void XCAFDoc_MaterialTool::GetMaterialLabels

(

TDF_LabelSequence &

Labels

)

const

const Standard_GUID& XCAFDoc_MaterialTool::ID

(

)

const [virtual]

Implements TDF_Attribute.

Standard_Boolean XCAFDoc_MaterialTool::IsMaterial

(

const TDF_Label &

lab

)

const

Handle_TDF_Attribute XCAFDoc_MaterialTool::NewEmpty

(

)

const [virtual]

Implements TDF_Attribute.

void XCAFDoc_MaterialTool::Paste	(	const Handle< TDF_Attribute > &	intoAttribute,
		const Handle< TDF_RelocationTable > &	aRelocationTable
	)		const [virtual]

Implements TDF_Attribute.

void XCAFDoc_MaterialTool::Restore

(

const Handle< TDF_Attribute > &

anAttribute

)

[virtual]

Implements TDF_Attribute.

static Handle_XCAFDoc_MaterialTool XCAFDoc_MaterialTool::Set

(

const TDF_Label &

L

)

[static]

void XCAFDoc_MaterialTool::SetMaterial	(	const TDF_Label &	L,
		const TDF_Label &	MatL
	)		const

void XCAFDoc_MaterialTool::SetMaterial	(	const TDF_Label &	L,
		const Handle< TCollection_HAsciiString > &	aName,
		const Handle< TCollection_HAsciiString > &	aDescription,
		const Standard_Real	aDensity,
		const Handle< TCollection_HAsciiString > &	aDensName,
		const Handle< TCollection_HAsciiString > &	aDensValType
	)		const

const Handle_XCAFDoc_ShapeTool& XCAFDoc_MaterialTool::ShapeTool

(

)

---

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

• XCAFDoc_MaterialTool.hxx