XCAFDoc_DocumentTool Class Reference

Defines sections structure of an XDE document.

#include <XCAFDoc_DocumentTool.hxx>

Inheritance diagram for XCAFDoc_DocumentTool:

Public Member Functions
	XCAFDoc_DocumentTool ()
void	Init () const
	to be called when reading this attribute from file
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 const Standard_GUID &	GetID ()
static Handle_XCAFDoc_DocumentTool	Set (const TDF_Label &L, const Standard_Boolean IsAcces=Standard_True)
	Create (if not exist) DocumentTool attribute on 0.1 label if <IsAcces> is true, else on <L> label. This label will be returned by DocLabel(); If the attribute is already set it won't be reset on <L> even if <IsAcces> is false. ColorTool and ShapeTool attributes are also set by this method.
static Standard_Boolean	IsXCAFDocument (const Handle< TDocStd_Document > &Doc)
static TDF_Label	DocLabel (const TDF_Label &acces)
	Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set.
static TDF_Label	ShapesLabel (const TDF_Label &acces)
	Returns sub-label of DocLabel() with tag 1.
static TDF_Label	ColorsLabel (const TDF_Label &acces)
	Returns sub-label of DocLabel() with tag 2.
static TDF_Label	LayersLabel (const TDF_Label &acces)
	Returns sub-label of DocLabel() with tag 3.
static TDF_Label	DGTsLabel (const TDF_Label &acces)
	Returns sub-label of DocLabel() with tag 4.
static TDF_Label	MaterialsLabel (const TDF_Label &acces)
	Returns sub-label of DocLabel() with tag 5.
static Handle_XCAFDoc_ShapeTool	ShapeTool (const TDF_Label &acces)
	Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
static Handle_XCAFDoc_ColorTool	ColorTool (const TDF_Label &acces)
	Creates (if it does not exist) ColorTool attribute on ColorsLabel().
static Handle_XCAFDoc_LayerTool	LayerTool (const TDF_Label &acces)
	Creates (if it does not exist) LayerTool attribute on LayersLabel().
static Handle_XCAFDoc_DimTolTool	DimTolTool (const TDF_Label &acces)
	Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
static Handle_XCAFDoc_MaterialTool	MaterialTool (const TDF_Label &acces)
	Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

---

Constructor & Destructor Documentation

XCAFDoc_DocumentTool::XCAFDoc_DocumentTool

(

)

---

Member Function Documentation

static TDF_Label XCAFDoc_DocumentTool::ColorsLabel

(

const TDF_Label &

acces

)

[static]

static Handle_XCAFDoc_ColorTool XCAFDoc_DocumentTool::ColorTool

(

const TDF_Label &

acces

)

[static]

static TDF_Label XCAFDoc_DocumentTool::DGTsLabel

(

const TDF_Label &

acces

)

[static]

static Handle_XCAFDoc_DimTolTool XCAFDoc_DocumentTool::DimTolTool

(

const TDF_Label &

acces

)

[static]

static TDF_Label XCAFDoc_DocumentTool::DocLabel

(

const TDF_Label &

acces

)

[static]

static const Standard_GUID& XCAFDoc_DocumentTool::GetID

(

)

[static]

const Standard_GUID& XCAFDoc_DocumentTool::ID

(

)

const [virtual]

Implements TDF_Attribute.

void XCAFDoc_DocumentTool::Init

(

)

const

static Standard_Boolean XCAFDoc_DocumentTool::IsXCAFDocument

(

const Handle< TDocStd_Document > &

Doc

)

[static]

static TDF_Label XCAFDoc_DocumentTool::LayersLabel

(

const TDF_Label &

acces

)

[static]

static Handle_XCAFDoc_LayerTool XCAFDoc_DocumentTool::LayerTool

(

const TDF_Label &

acces

)

[static]

static TDF_Label XCAFDoc_DocumentTool::MaterialsLabel

(

const TDF_Label &

acces

)

[static]

static Handle_XCAFDoc_MaterialTool XCAFDoc_DocumentTool::MaterialTool

(

const TDF_Label &

acces

)

[static]

Handle_TDF_Attribute XCAFDoc_DocumentTool::NewEmpty

(

)

const [virtual]

Implements TDF_Attribute.

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

Implements TDF_Attribute.

void XCAFDoc_DocumentTool::Restore

(

const Handle< TDF_Attribute > &

anAttribute

)

[virtual]

Implements TDF_Attribute.

static Handle_XCAFDoc_DocumentTool XCAFDoc_DocumentTool::Set	(	const TDF_Label &	L,
		const Standard_Boolean	IsAcces = Standard_True
	)		[static]

static TDF_Label XCAFDoc_DocumentTool::ShapesLabel

(

const TDF_Label &

acces

)

[static]

static Handle_XCAFDoc_ShapeTool XCAFDoc_DocumentTool::ShapeTool

(

const TDF_Label &

acces

)

[static]

---

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

• XCAFDoc_DocumentTool.hxx