A tool to store shapes in an XDE document in the form of assembly structure, and to maintain this structure. Attribute containing Shapes section of DECAF document. Provide tools for management of Shapes section. The API provided by this class allows to work with this structure regardless of its low-level implementation. All the shapes are stored on child labels of a main label which is XCAFDoc_DocumentTool::LabelShapes(). The label for assembly also has sub-labels, each of which represents the instance of another shape in that assembly (component). Such sub-label stores reference to the label of the original shape in the form of TDataStd_TreeNode with GUID XCAFDoc::ShapeRefGUID(), and its location encapsulated into the NamedShape. For correct work with an XDE document, it is necessary to use methods for analysis and methods for working with shapes. For example: if ( STool->IsAssembly(aLabel) ) { Standard_Boolean subchilds = Standard_False; (default) Standard_Integer nbc = STool->NbComponents (aLabel[,subchilds]); } If subchilds is True, commands also consider sub-levels. By default, only level one is checked. In this example, number of children from the first level of assembly will be returned. Methods for creation and initialization: Constructor: XCAFDoc_ShapeTool::XCAFDoc_ShapeTool() Getting a guid: Standard_GUID GetID (); Creation (if does not exist) of ShapeTool on label L: Handle(XCAFDoc_ShapeTool) XCAFDoc_ShapeTool::Set(const TDF_Label& L) Analyze whether shape is a simple shape or an instance or a component of an assembly or it is an assembly ( methods of analysis). For example: STool->IsShape(aLabel) ; Analyze that the label represents a shape (simple shape, assembly or reference) or STool->IsTopLevel(aLabel); Analyze that the label is a label of a top-level shape. Work with simple shapes, assemblies and instances ( methods for work with shapes). For example: Add shape: Standard_Boolean makeAssembly; // True to interpret a Compound as an Assembly, False to take it as a whole aLabel = STool->AddShape(aShape, makeAssembly); Get shape: TDF_Label aLabel... // A label must be present if (aLabel.IsNull()) { ... no such label : abandon .. } TopoDS_Shape aShape; aShape = STool->GetShape(aLabel); if (aShape.IsNull()) { ... this label is not for a Shape ... } To get a label from shape. Standard_Boolean findInstance = Standard_False; (this is default value) aLabel = STool->FindShape(aShape [,findInstance]); if (aLabel.IsNull()) { ... no label found for this shape ... }.
More...
|
| | XCAFDoc_ShapeTool () |
| | Creates an empty tool Creates a tool to work with a document <Doc> Attaches to label XCAFDoc::LabelShapes()
|
| |
| Standard_Boolean | IsTopLevel (const TDF_Label &L) const |
| | Returns True if the label is a label of top-level shape, as opposed to component of assembly or subshape.
|
| |
| Standard_Boolean | IsSubShape (const TDF_Label &shapeL, const TopoDS_Shape &sub) const |
| | Checks whether shape is subshape of shape stored on label shapeL.
|
| |
| Standard_Boolean | SearchUsingMap (const TopoDS_Shape &S, TDF_Label &L, const Standard_Boolean findWithoutLoc, const Standard_Boolean findSubshape) const |
| |
| Standard_Boolean | Search (const TopoDS_Shape &S, TDF_Label &L, const Standard_Boolean findInstance=Standard_True, const Standard_Boolean findComponent=Standard_True, const Standard_Boolean findSubshape=Standard_True) const |
| | General tool to find a (sub) shape in the document.
|
| |
| Standard_Boolean | FindShape (const TopoDS_Shape &S, TDF_Label &L, const Standard_Boolean findInstance=Standard_False) const |
| | Returns the label corresponding to shape S (searches among top-level shapes, not including subcomponents of assemblies and subshapes) If findInstance is False (default), search for the input shape without location If findInstance is True, searches for the input shape as is. Return True if is found.
|
| |
| TDF_Label | FindShape (const TopoDS_Shape &S, const Standard_Boolean findInstance=Standard_False) const |
| | Does the same as previous method Returns Null label if not found.
|
| |
| TopoDS_Shape | GetOneShape () const |
| | Gets shape from a sequence of all top-level shapes which are free.
|
| |
| TDF_Label | NewShape () const |
| | Creates new (empty) top-level shape. Initially it holds empty TopoDS_Compound.
|
| |
| void | SetShape (const TDF_Label &L, const TopoDS_Shape &S) |
| | Sets representation (TopoDS_Shape) for top-level shape.
|
| |
| TDF_Label | AddShape (const TopoDS_Shape &S, const Standard_Boolean makeAssembly=Standard_True, const Standard_Boolean makePrepare=Standard_True) |
| | Adds a new top-level (creates and returns a new label) If makeAssembly is True, treats TopAbs_COMPOUND shapes as assemblies (creates assembly structure). NOTE: <makePrepare> replace components without location in assembly by located components to avoid some problems. If AutoNaming() is True then automatically attaches names.
|
| |
| Standard_Boolean | RemoveShape (const TDF_Label &L, const Standard_Boolean removeCompletely=Standard_True) const |
| | Removes shape (whole label and all its sublabels) If removeCompletely is true, removes complete shape If removeCompletely is false, removes instance(location) only Returns False (and does nothing) if shape is not free or is not top-level shape.
|
| |
| void | Init () |
| | set hasComponents into false
|
| |
| void | ComputeShapes (const TDF_Label &L) |
| | recursive
|
| |
| void | ComputeSimpleShapes () |
| | Compute a sequence of simple shapes.
|
| |
| void | GetShapes (TDF_LabelSequence &Labels) const |
| | Returns a sequence of all top-level shapes.
|
| |
| void | GetFreeShapes (TDF_LabelSequence &FreeLabels) const |
| | Returns a sequence of all top-level shapes which are free (i.e. not referred by any other)
|
| |
| TDF_Label | AddComponent (const TDF_Label &assembly, const TDF_Label &comp, const TopLoc_Location &Loc) |
| | Adds a component given by its label and location to the assembly Note: assembly must be IsAssembly() or IsSimpleShape()
|
| |
| TDF_Label | AddComponent (const TDF_Label &assembly, const TopoDS_Shape &comp, const Standard_Boolean expand=Standard_False) |
| | Adds a shape (located) as a component to the assembly If necessary, creates an additional top-level shape for component and return the Label of component. If expand is True and component is Compound, it will be created as assembly also Note: assembly must be IsAssembly() or IsSimpleShape()
|
| |
| void | RemoveComponent (const TDF_Label &comp) const |
| | Removes a component from its assembly.
|
| |
| void | UpdateAssemblies () |
| | Top-down update for all assembly compounds stored in the document.
|
| |
| Standard_Boolean | FindSubShape (const TDF_Label &shapeL, const TopoDS_Shape &sub, TDF_Label &L) const |
| | Finds a label for subshape of shape stored on label shapeL Returns Null label if it is not found.
|
| |
| TDF_Label | AddSubShape (const TDF_Label &shapeL, const TopoDS_Shape &sub) const |
| | Adds a label for subshape of shape stored on label shapeL Returns Null label if it is not subshape.
|
| |
| Standard_Boolean | AddSubShape (const TDF_Label &shapeL, const TopoDS_Shape &sub, TDF_Label &addedSubShapeL) const |
| | Adds (of finds already existed) a label for subshape of shape stored on label shapeL. Label addedSubShapeL returns added (found) label or empty in case of wrong subshape. Returns True, if new shape was added, False in case of already existed subshape/wrong subshape.
|
| |
| TDF_Label | FindMainShapeUsingMap (const TopoDS_Shape &sub) const |
| |
| TDF_Label | FindMainShape (const TopoDS_Shape &sub) const |
| | Performs a search among top-level shapes to find the shape containing as subshape Checks only simple shapes, and returns the first found label (which should be the only one for valid model)
|
| |
| TDF_Label | BaseLabel () const |
| | returns the label under which shapes are stored
|
| |
| Standard_OStream & | Dump (Standard_OStream &theDumpLog, const Standard_Boolean deep) const |
| |
| virtual Standard_OStream & | Dump (Standard_OStream &theDumpLog) const override |
| | Dumps the minimum information about <me> on <aStream>.
|
| |
| const Standard_GUID & | ID () const override |
| | Returns the ID of the attribute.
|
| |
| TDF_Label | SetExternRefs (const TColStd_SequenceOfHAsciiString &SHAS) const |
| | Sets the names of references on the no-step files.
|
| |
| void | SetExternRefs (const TDF_Label &L, const TColStd_SequenceOfHAsciiString &SHAS) const |
| | Sets the names of references on the no-step files.
|
| |
| Standard_Boolean | SetSHUO (const TDF_LabelSequence &Labels, Handle< XCAFDoc_GraphNode > &MainSHUOAttr) const |
| | Sets the SHUO structure between upper_usage and next_usage create multy-level (if number of labels > 2) SHUO from first to last Initialise out <MainSHUOAttr> by main upper_usage SHUO attribute. Returns FALSE if some of labels in not component label.
|
| |
| Standard_Boolean | RemoveSHUO (const TDF_Label &SHUOLabel) const |
| | Remove SHUO from component sublabel, remove all dependencies on other SHUO. Returns FALSE if cannot remove SHUO dependencies. NOTE: remove any styles that associated with this SHUO.
|
| |
| Standard_Boolean | FindComponent (const TopoDS_Shape &theShape, TDF_LabelSequence &Labels) const |
| | Search the path of labels in the document, that corresponds the component from any assembly Try to search the sequence of labels with location that produce this shape as component of any assembly NOTE: Clear sequence of labels before filling.
|
| |
| TopoDS_Shape | GetSHUOInstance (const Handle< XCAFDoc_GraphNode > &theSHUO) const |
| | Search for the component shape that styled by shuo Returns null shape if no any shape is found.
|
| |
| Handle< XCAFDoc_GraphNode > | SetInstanceSHUO (const TopoDS_Shape &theShape) const |
| | Search for the component shape by labelks path and set SHUO structure for founded label structure Returns null attribute if no component in any assembly found.
|
| |
| Standard_Boolean | GetAllSHUOInstances (const Handle< XCAFDoc_GraphNode > &theSHUO, TopTools_SequenceOfShape &theSHUOShapeSeq) const |
| | Searching for component shapes that styled by shuo Returns empty sequence of shape if no any shape is found.
|
| |
| Standard_Boolean | SetLocation (const TDF_Label &theShapeLabel, const TopLoc_Location &theLoc, TDF_Label &theRefLabel) |
| | Sets location to the shape label If label is reference -> changes location attribute If label is free shape -> creates reference with location to it.
|
| |
| Standard_Boolean | Expand (const TDF_Label &Shape) |
| | Convert Shape (compound/compsolid/shell/wire) to assembly.
|
| |
| Handle< TDataStd_NamedData > | GetNamedProperties (const TDF_Label &theLabel, const Standard_Boolean theToCreate=Standard_False) const |
| | Method to get NamedData attribute assigned to the given shape label.
|
| |
| Handle< TDataStd_NamedData > | GetNamedProperties (const TopoDS_Shape &theShape, const Standard_Boolean theToCreate=Standard_False) const |
| | Method to get NamedData attribute assigned to a label of the given shape.
|
| |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| | Dumps the content of me into the stream.
|
| |
| void | Restore (const Handle< TDF_Attribute > &) override |
| | Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
|
| |
| void | Paste (const Handle< TDF_Attribute > &, const Handle< TDF_RelocationTable > &) const override |
| | 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>.
|
| |
| virtual void | SetID (const Standard_GUID &) |
| | Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
|
| |
| virtual void | SetID () |
| | Sets default ID defined in nested class (to be used for attributes having User ID feature).
|
| |
| const TDF_Label | Label () const |
| | Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
|
| |
| Standard_Integer | Transaction () const |
| | Returns the transaction index in which the attribute has been created or modified.
|
| |
| Standard_Integer | UntilTransaction () const |
| | Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
|
| |
| Standard_Boolean | IsValid () const |
| | Returns true if the attribute is valid; i.e. not a backuped or removed one.
|
| |
| Standard_Boolean | IsNew () const |
| | Returns true if the attribute has no backup.
|
| |
| Standard_Boolean | IsForgotten () const |
| | Returns true if the attribute forgotten status is set.
|
| |
| Standard_Boolean | IsAttribute (const Standard_GUID &anID) const |
| | Returns true if it exists an associated attribute of <me> with <anID> as ID.
|
| |
| Standard_Boolean | FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const |
| | Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
|
| |
| template<class T > |
| Standard_Boolean | FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const |
| | Safe variant for arbitrary type of argument.
|
| |
| void | AddAttribute (const Handle< TDF_Attribute > &other) const |
| | Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
|
| |
| Standard_Boolean | ForgetAttribute (const Standard_GUID &aguid) const |
| | Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
|
| |
| void | ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const |
| | Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call.
|
| |
| virtual void | AfterAddition () |
| | Something to do after adding an Attribute to a label.
|
| |
| virtual void | BeforeRemoval () |
| | Something to do before removing an Attribute from a label.
|
| |
| virtual void | BeforeForget () |
| | Something to do before forgetting an Attribute to a label.
|
| |
| virtual void | AfterResume () |
| | Something to do after resuming an Attribute from a label.
|
| |
| virtual Standard_Boolean | AfterRetrieval (const Standard_Boolean forceIt=Standard_False) |
| | Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual Standard_Boolean | BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) |
| | Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual Standard_Boolean | AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False) |
| | Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
|
| |
| virtual void | BeforeCommitTransaction () |
| | A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
|
| |
| void | Backup () |
| | Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
|
| |
| Standard_Boolean | IsBackuped () const |
| | Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
|
| |
| virtual Handle< TDF_Attribute > | BackupCopy () const |
| | Copies the attribute contents into a new other attribute. It is used by Backup().
|
| |
| virtual Handle< TDF_DeltaOnAddition > | DeltaOnAddition () const |
| | Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
|
| |
| virtual Handle< TDF_DeltaOnForget > | DeltaOnForget () const |
| | Makes an AttributeDelta because <me> has been forgotten.
|
| |
| virtual Handle< TDF_DeltaOnResume > | DeltaOnResume () const |
| | Makes an AttributeDelta because <me> has been resumed.
|
| |
| virtual Handle< TDF_DeltaOnModification > | DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const |
| | Makes a DeltaOnModification between <me> and.
|
| |
| virtual void | DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta) |
| | Applies a DeltaOnModification to <me>.
|
| |
| virtual Handle< TDF_DeltaOnRemoval > | DeltaOnRemoval () const |
| | Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
|
| |
| virtual Handle< TDF_Attribute > | NewEmpty () const =0 |
| | Returns an new empty attribute from the good end type. It is used by the copy algorithm.
|
| |
| virtual void | References (const Handle< TDF_DataSet > &aDataSet) const |
| | Adds the first level referenced attributes and labels to <aDataSet>.
|
| |
| Standard_OStream & | operator<< (Standard_OStream &anOS) const |
| |
| virtual void | ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const |
| | Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
|
| |
| void | Forget (const Standard_Integer aTransaction) |
| | Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
|
| |
 Public Member Functions inherited from Standard_Transient |
| | Standard_Transient () |
| | Empty constructor.
|
| |
| | Standard_Transient (const Standard_Transient &) |
| | Copy constructor – does nothing.
|
| |
| Standard_Transient & | operator= (const Standard_Transient &) |
| | Assignment operator, needed to avoid copying reference counter.
|
| |
| virtual | ~Standard_Transient () |
| | Destructor must be virtual.
|
| |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| | Returns a type descriptor about this object.
|
| |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| | Returns a true value if this is an instance of Type.
|
| |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| | Returns a true value if this is an instance of TypeName.
|
| |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| | Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| | Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Transient * | This () const |
| | Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
|
| |
| Standard_Integer | GetRefCount () const noexcept |
| | Get the reference counter of this object.
|
| |
| void | IncrementRefCounter () noexcept |
| | Increments the reference counter of this object.
|
| |
| Standard_Integer | DecrementRefCounter () noexcept |
| | Decrements the reference counter of this object; returns the decremented value.
|
| |
| virtual void | Delete () const |
| | Memory deallocator for transient classes.
|
| |
|
| static const Standard_GUID & | GetID () |
| |
| static Handle< XCAFDoc_ShapeTool > | Set (const TDF_Label &L) |
| | Create (if not exist) ShapeTool from XCAFDoc on <L>.
|
| |
| static Standard_Boolean | IsFree (const TDF_Label &L) |
| | Returns True if the label is not used by any assembly, i.e. contains sublabels which are assembly components This is relevant only if IsShape() is True (There is no Father TreeNode on this <L>)
|
| |
| static Standard_Boolean | IsShape (const TDF_Label &L) |
| | Returns True if the label represents a shape (simple shape, assembly or reference)
|
| |
| static Standard_Boolean | IsSimpleShape (const TDF_Label &L) |
| | Returns True if the label is a label of simple shape.
|
| |
| static Standard_Boolean | IsReference (const TDF_Label &L) |
| | Return true if <L> is a located instance of other shape i.e. reference.
|
| |
| static Standard_Boolean | IsAssembly (const TDF_Label &L) |
| | Returns True if the label is a label of assembly, i.e. contains sublabels which are assembly components This is relevant only if IsShape() is True.
|
| |
| static Standard_Boolean | IsComponent (const TDF_Label &L) |
| | Return true if <L> is reference serving as component of assembly.
|
| |
| static Standard_Boolean | IsCompound (const TDF_Label &L) |
| | Returns True if the label is a label of compound, i.e. contains some sublabels This is relevant only if IsShape() is True.
|
| |
| static Standard_Boolean | IsSubShape (const TDF_Label &L) |
| | Return true if <L> is subshape of the top-level shape.
|
| |
| static Standard_Boolean | GetShape (const TDF_Label &L, TopoDS_Shape &S) |
| | To get TopoDS_Shape from shape's label For component, returns new shape with correct location Returns False if label does not contain shape.
|
| |
| static TopoDS_Shape | GetShape (const TDF_Label &L) |
| | To get TopoDS_Shape from shape's label For component, returns new shape with correct location Returns Null shape if label does not contain shape.
|
| |
| static TopoDS_Shape | GetOneShape (const TDF_LabelSequence &theLabels) |
| | Gets shape from a sequence of shape's labels.
|
| |
| static void | SetAutoNaming (const Standard_Boolean V) |
| | Sets auto-naming mode to <V>. If True then for added shapes, links, assemblies and SHUO's, the TDataStd_Name attribute is automatically added. For shapes it contains a shape type (e.g. "SOLID", "SHELL", etc); for links it has a form "=>[0:1:1:2]" (where a tag is a label containing a shape without a location); for assemblies it is "ASSEMBLY", and "SHUO" for SHUO's. This setting is global; it cannot be made a member function as it is used by static methods as well. By default, auto-naming is enabled. See also AutoNaming().
|
| |
| static Standard_Boolean | AutoNaming () |
| | Returns current auto-naming mode. See SetAutoNaming() for description.
|
| |
| static Standard_Integer | GetUsers (const TDF_Label &L, TDF_LabelSequence &Labels, const Standard_Boolean getsubchilds=Standard_False) |
| | Returns list of labels which refer shape L as component Returns number of users (0 if shape is free)
|
| |
| static TopLoc_Location | GetLocation (const TDF_Label &L) |
| | Returns location of instance.
|
| |
| static Standard_Boolean | GetReferredShape (const TDF_Label &L, TDF_Label &Label) |
| | Returns label which corresponds to a shape referred by L Returns False if label is not reference.
|
| |
| static Standard_Integer | NbComponents (const TDF_Label &L, const Standard_Boolean getsubchilds=Standard_False) |
| | Returns number of Assembles components.
|
| |
| static Standard_Boolean | GetComponents (const TDF_Label &L, TDF_LabelSequence &Labels, const Standard_Boolean getsubchilds=Standard_False) |
| | Returns list of components of assembly Returns False if label is not assembly.
|
| |
| static Standard_Boolean | GetSubShapes (const TDF_Label &L, TDF_LabelSequence &Labels) |
| | Returns list of labels identifying subshapes of the given shape Returns False if no subshapes are placed on that label.
|
| |
| static void | DumpShape (Standard_OStream &theDumpLog, const TDF_Label &L, const Standard_Integer level=0, const Standard_Boolean deep=Standard_False) |
| | Print to std::ostream <theDumpLog> type of shape found on <L> label and the entry of <L>, with <level> tabs before. If <deep>, print also TShape and Location addresses.
|
| |
| static Standard_Boolean | IsExternRef (const TDF_Label &L) |
| | Returns True if the label is a label of external references, i.e. there are some reference on the no-step files, which are described in document only their names.
|
| |
| static void | GetExternRefs (const TDF_Label &L, TColStd_SequenceOfHAsciiString &SHAS) |
| | Gets the names of references on the no-step files.
|
| |
| static Standard_Boolean | GetSHUO (const TDF_Label &SHUOLabel, Handle< XCAFDoc_GraphNode > &aSHUOAttr) |
| | Returns founded SHUO GraphNode attribute <aSHUOAttr> Returns false in other case.
|
| |
| static Standard_Boolean | GetAllComponentSHUO (const TDF_Label &CompLabel, TDF_AttributeSequence &SHUOAttrs) |
| | Returns founded SHUO GraphNodes of indicated component Returns false in other case.
|
| |
| static Standard_Boolean | GetSHUOUpperUsage (const TDF_Label &NextUsageL, TDF_LabelSequence &Labels) |
| | Returns the sequence of labels of SHUO attributes, which is upper_usage for this next_usage SHUO attribute (that indicated by label) NOTE: returns upper_usages only on one level (not recurse) NOTE: do not clear the sequence before filling.
|
| |
| static Standard_Boolean | GetSHUONextUsage (const TDF_Label &UpperUsageL, TDF_LabelSequence &Labels) |
| | Returns the sequence of labels of SHUO attributes, which is next_usage for this upper_usage SHUO attribute (that indicated by label) NOTE: returns next_usages only on one level (not recurse) NOTE: do not clear the sequence before filling.
|
| |
| static Standard_Boolean | FindSHUO (const TDF_LabelSequence &Labels, Handle< XCAFDoc_GraphNode > &theSHUOAttr) |
| | Searches the SHUO by labels of components from upper_usage component to next_usage Returns null attribute if no SHUO found.
|
| |
| Static Public Member Functions inherited from Standard_Transient |
| static constexpr const char * | get_type_name () |
| | Returns a type descriptor about this object.
|
| |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| | Returns type descriptor of Standard_Transient class.
|
| |
A tool to store shapes in an XDE document in the form of assembly structure, and to maintain this structure. Attribute containing Shapes section of DECAF document. Provide tools for management of Shapes section. The API provided by this class allows to work with this structure regardless of its low-level implementation. All the shapes are stored on child labels of a main label which is XCAFDoc_DocumentTool::LabelShapes(). The label for assembly also has sub-labels, each of which represents the instance of another shape in that assembly (component). Such sub-label stores reference to the label of the original shape in the form of TDataStd_TreeNode with GUID XCAFDoc::ShapeRefGUID(), and its location encapsulated into the NamedShape. For correct work with an XDE document, it is necessary to use methods for analysis and methods for working with shapes. For example: if ( STool->IsAssembly(aLabel) ) { Standard_Boolean subchilds = Standard_False; (default) Standard_Integer nbc = STool->NbComponents (aLabel[,subchilds]); } If subchilds is True, commands also consider sub-levels. By default, only level one is checked. In this example, number of children from the first level of assembly will be returned. Methods for creation and initialization: Constructor: XCAFDoc_ShapeTool::XCAFDoc_ShapeTool() Getting a guid: Standard_GUID GetID (); Creation (if does not exist) of ShapeTool on label L: Handle(XCAFDoc_ShapeTool) XCAFDoc_ShapeTool::Set(const TDF_Label& L) Analyze whether shape is a simple shape or an instance or a component of an assembly or it is an assembly ( methods of analysis). For example: STool->IsShape(aLabel) ; Analyze that the label represents a shape (simple shape, assembly or reference) or STool->IsTopLevel(aLabel); Analyze that the label is a label of a top-level shape. Work with simple shapes, assemblies and instances ( methods for work with shapes). For example: Add shape: Standard_Boolean makeAssembly; // True to interpret a Compound as an Assembly, False to take it as a whole aLabel = STool->AddShape(aShape, makeAssembly); Get shape: TDF_Label aLabel... // A label must be present if (aLabel.IsNull()) { ... no such label : abandon .. } TopoDS_Shape aShape; aShape = STool->GetShape(aLabel); if (aShape.IsNull()) { ... this label is not for a Shape ... } To get a label from shape. Standard_Boolean findInstance = Standard_False; (this is default value) aLabel = STool->FindShape(aShape [,findInstance]); if (aLabel.IsNull()) { ... no label found for this shape ... }.
