XCAFDoc_Editor Class Reference

Tool for edit structure of document. More...

#include <XCAFDoc_Editor.hxx>

Static Public Member Functions
static bool	Expand (const TDF_Label &theDoc, const TDF_Label &theShape, const bool theRecursively=true)
	Converts shape (compound/compsolid/shell/wire) to assembly.
static bool	Expand (const TDF_Label &theDoc, const bool theRecursively=true)
	Converts all compounds shapes in the document to assembly.
static bool	Extract (const NCollection_Sequence< TDF_Label > &theSrcLabels, const TDF_Label &theDstLabel, const bool theIsNoVisMat=false)
	Clones all labels to a new position, keeping the structure with all the attributes.
static bool	Extract (const TDF_Label &theSrcLabel, const TDF_Label &theDstLabel, const bool theIsNoVisMat=false)
	Clones the label to a new position, keeping the structure with all the attributes.
static TDF_Label	CloneShapeLabel (const TDF_Label &theSrcLabel, const occ::handle< XCAFDoc_ShapeTool > &theSrcShapeTool, const occ::handle< XCAFDoc_ShapeTool > &theDstShapeTool, NCollection_DataMap< TDF_Label, TDF_Label > &theMap)
	Copies shapes label with keeping of shape structure (recursively)
static void	CloneMetaData (const TDF_Label &theSrcLabel, const TDF_Label &theDstLabel, NCollection_DataMap< occ::handle< XCAFDoc_VisMaterial >, occ::handle< XCAFDoc_VisMaterial > > *theVisMatMap, const bool theToCopyColor=true, const bool theToCopyLayer=true, const bool theToCopyMaterial=true, const bool theToCopyVisMaterial=true, const bool theToCopyAttributes=true)
	Copies metadata contains from the source label to the destination label. Protected against creating a new label for non-existent tools.
static void	GetParentShapeLabels (const TDF_Label &theLabel, NCollection_Map< TDF_Label > &theRelatedLabels)
	Gets shape labels that has down relation with the input label.
static void	GetChildShapeLabels (const TDF_Label &theLabel, NCollection_Map< TDF_Label > &theRelatedLabels)
	Gets shape labels that has up relation with the input label.
static bool	FilterShapeTree (const occ::handle< XCAFDoc_ShapeTool > &theShapeTool, const NCollection_Map< TDF_Label > &theLabelsToKeep)
	Filters original shape tree with keeping structure. The result will include the full label hierarchy lower then input labels. Any higher hierarchy labels will be filtered to keep only necessary labels. All not related shape labels with input will be cleared (all attributes will be removed).
static bool	RescaleGeometry (const TDF_Label &theLabel, const double theScaleFactor, const bool theForceIfNotRoot=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< occ::handle< XCAFDoc_VisMaterial >, occ::handle< XCAFDoc_VisMaterial > > * theVisMatMap, const bool theToCopyColor = true, const bool theToCopyLayer = true, const bool theToCopyMaterial = true, const bool theToCopyVisMaterial = true, const bool theToCopyAttributes = 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 occ::handle< XCAFDoc_ShapeTool > & theSrcShapeTool, const occ::handle< XCAFDoc_ShapeTool > & theDstShapeTool, NCollection_DataMap< TDF_Label, TDF_Label > & 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 bool XCAFDoc_Editor::Expand ( const TDF_Label & theDoc, const bool theRecursively = 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 bool XCAFDoc_Editor::Expand ( const TDF_Label & theDoc, const TDF_Label & theShape, const bool theRecursively = 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 bool XCAFDoc_Editor::Extract ( const NCollection_Sequence< TDF_Label > & theSrcLabels, const TDF_Label & theDstLabel, const bool theIsNoVisMat = 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

Extract() [2/2]

static bool XCAFDoc_Editor::Extract ( const TDF_Label & theSrcLabel, const TDF_Label & theDstLabel, const bool theIsNoVisMat = 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

FilterShapeTree()

static bool XCAFDoc_Editor::FilterShapeTree ( const occ::handle< XCAFDoc_ShapeTool > & theShapeTool, const NCollection_Map< TDF_Label > & theLabelsToKeep )

static

Filters original shape tree with keeping structure. The result will include the full label hierarchy lower then input labels. Any higher hierarchy labels will be filtered to keep only necessary labels. All not related shape labels with input will be cleared (all attributes will be removed).

The result impact directly into original document and existed shape labels. Attributes related to removed shape can became invalide. For example, GDT with relation on removed shape label(s) and without attachment point(s) became invalid for visualization.

Parameters

[in]	theShapeTool	shape tool to extract from
[in]	theLabelsToKeep	labels to keep

Returns

true if the tree was filtered successfully.

GetChildShapeLabels()

static void XCAFDoc_Editor::GetChildShapeLabels ( const TDF_Label & theLabel, NCollection_Map< TDF_Label > & theRelatedLabels )

static

Gets shape labels that has up relation with the input label.

Parameters

[in]	theLabel	input label
[out]	theRelatedLabels	output labels

GetParentShapeLabels()

static void XCAFDoc_Editor::GetParentShapeLabels ( const TDF_Label & theLabel, NCollection_Map< TDF_Label > & theRelatedLabels )

static

Gets shape labels that has down relation with the input label.

Parameters

[in]	theLabel	input label
[out]	theRelatedLabels	output labels

RescaleGeometry()

static bool XCAFDoc_Editor::RescaleGeometry ( const TDF_Label & theLabel, const double theScaleFactor, const bool theForceIfNotRoot = 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