XCAFDoc_Editor Class Reference

Tool for edit structure of document. More...

#include <XCAFDoc_Editor.hxx>

Static Public Member Functions
static Standard_Boolean	Expand (const TDF_Label &theDoc, const TDF_Label &theShape, const Standard_Boolean theRecursively=Standard_True)
	Converts shape (compound/compsolid/shell/wire) to assembly.
static Standard_Boolean	Expand (const TDF_Label &theDoc, const Standard_Boolean theRecursively=Standard_True)
	Converts all compounds shapes in the document to assembly.
static Standard_Boolean	Extract (const TDF_LabelSequence &theSrcLabels, const TDF_Label &theDstLabel, const Standard_Boolean theIsNoVisMat=Standard_False)
	Clones all labels to a new position, keeping the structure with all the attributes.
static Standard_Boolean	Extract (const TDF_Label &theSrcLabel, const TDF_Label &theDstLabel, const Standard_Boolean theIsNoVisMat=Standard_False)
	Clones the label to a new position, keeping the structure with all the attributes.
static TDF_Label	CloneShapeLabel (const TDF_Label &theSrcLabel, const Handle< XCAFDoc_ShapeTool > &theSrcShapeTool, const Handle< XCAFDoc_ShapeTool > &theDstShapeTool, TDF_LabelDataMap &theMap)
	Copies shapes label with keeping of shape structure (recursively)
static void	CloneMetaData (const TDF_Label &theSrcLabel, const TDF_Label &theDstLabel, NCollection_DataMap< Handle< XCAFDoc_VisMaterial >, Handle< XCAFDoc_VisMaterial > > *theVisMatMap, const Standard_Boolean theToCopyColor=Standard_True, const Standard_Boolean theToCopyLayer=Standard_True, const Standard_Boolean theToCopyMaterial=Standard_True, const Standard_Boolean theToCopyVisMaterial=Standard_True, const Standard_Boolean theToCopyAttributes=Standard_True)
	Copies metadata contains from the source label to the destination label. Protected against creating a new label for non-existent tools.
static Standard_Boolean	RescaleGeometry (const TDF_Label &theLabel, const Standard_Real theScaleFactor, const Standard_Boolean theForceIfNotRoot=Standard_False)
	Applies geometrical scaling to the following assembly components:

Detailed Description

Tool for edit structure of document.

Member Function Documentation

CloneMetaData()

static void XCAFDoc_Editor::CloneMetaData ( const TDF_Label &  theSrcLabel, const TDF_Label &  theDstLabel, NCollection_DataMap< Handle< XCAFDoc_VisMaterial >, Handle< XCAFDoc_VisMaterial > > *  theVisMatMap, const Standard_Boolean  theToCopyColor = Standard_True, const Standard_Boolean  theToCopyLayer = Standard_True, const Standard_Boolean  theToCopyMaterial = Standard_True, const Standard_Boolean  theToCopyVisMaterial = Standard_True, const Standard_Boolean  theToCopyAttributes = Standard_True  )

static

Copies metadata contains from the source label to the destination label. Protected against creating a new label for non-existent tools.

Parameters

[in]	theSrcLabel	original label to copy from
[in]	theDstLabel	destination shape label to set attributes
[in]	theVisMatMap	relating map of the original VisMaterial and created. Can be NULL for the same document
[in]	theToCopyColor	copying visible value and shape color (handled all color type)
[in]	theToCopyLayer	copying layer
[in]	theToCopyMaterial	copying material
[in]	theToCopyVisMaterial	copying visual material
[in]	theToCopyAttributes	copying of other node attributes, for example, a shape's property

CloneShapeLabel()

static TDF_Label XCAFDoc_Editor::CloneShapeLabel ( const TDF_Label &  theSrcLabel, const Handle< XCAFDoc_ShapeTool > &  theSrcShapeTool, const Handle< XCAFDoc_ShapeTool > &  theDstShapeTool, TDF_LabelDataMap &  theMap  )

static

Copies shapes label with keeping of shape structure (recursively)

Parameters

[in]	theSrcLabel	original label to copy from
[in]	theSrcShapeTool	shape tool to get
[in]	theDstShapeTool	shape tool to set
[out]	theMap	relating map of the original shapes label and labels created from them

Returns

result shape label

Expand() [1/2]

static Standard_Boolean XCAFDoc_Editor::Expand ( const TDF_Label &  theDoc, const Standard_Boolean  theRecursively = Standard_True  )

static

Converts all compounds shapes in the document to assembly.

Parameters

[in]	theDoc	input document
[in]	theRecursively	recursively expand a compound subshape

Returns

True if shape successfully expanded

Expand() [2/2]

static Standard_Boolean XCAFDoc_Editor::Expand ( const TDF_Label &  theDoc, const TDF_Label &  theShape, const Standard_Boolean  theRecursively = Standard_True  )

static

Converts shape (compound/compsolid/shell/wire) to assembly.

Parameters

[in]	theDoc	input document
[in]	theShape	input shape label
[in]	theRecursively	recursively expand a compound subshape

Returns

True if shape successfully expanded

Extract() [1/2]

static Standard_Boolean XCAFDoc_Editor::Extract ( const TDF_Label &  theSrcLabel, const TDF_Label &  theDstLabel, const Standard_Boolean  theIsNoVisMat = Standard_False  )

static

Clones the label to a new position, keeping the structure with all the attributes.

Parameters

[in]	theSrcLabel	original label to copy from
[in]	theDstLabel	label to set result as a component of or a main document's label to simply set new shape
[in]	theIsNoVisMat	get a VisMaterial attributes as is or convert to color

Returns

True if shape successfully extracted

Extract() [2/2]

static Standard_Boolean XCAFDoc_Editor::Extract ( const TDF_LabelSequence &  theSrcLabels, const TDF_Label &  theDstLabel, const Standard_Boolean  theIsNoVisMat = Standard_False  )

static

Clones all labels to a new position, keeping the structure with all the attributes.

Parameters

[in]	theSrcLabels	original labels to copy from
[in]	theDstLabel	label to set result as a component of or a main document's label to simply set new shape
[in]	theIsNoVisMat	get a VisMaterial attributes as is or convert to color

Returns

True if shape successfully extracted

RescaleGeometry()

static Standard_Boolean XCAFDoc_Editor::RescaleGeometry ( const TDF_Label &  theLabel, const Standard_Real  theScaleFactor, const Standard_Boolean  theForceIfNotRoot = Standard_False  )

static

Applies geometrical scaling to the following assembly components:

• part geometry
• sub-assembly/part occurrence location
• part's centroid, area and volume attributes
• PMIs (warnings and errors are reported if it is impossible to make changes) Normally, should start from a root sub-assembly, but if theForceIfNotRoot true scaling will be applied forcibly. If theLabel corresponds to the shape tool scaling is applied to the whole assembly.

  Parameters

  [in]	theLabel	starting label
  [in]	theScaleFactor	scale factor, should be positive
  [in]	theForceIfNotRoot	allows scaling of a non root assembly if true, otherwise - returns false

  Returns

  true in case of success, otherwise - false.

---

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

• XCAFDoc_Editor.hxx