# OCC.XCAFDoc module

class `Handle_XCAFDoc_Area`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Centroid`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Color`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_ColorTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_DataMapNodeOfDataMapOfShapeLabel`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_MapNode`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Datum`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_DimTol`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_DimTolTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_DocumentTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_GraphNode`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_LayerTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Location`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Material`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_MaterialTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_SequenceNodeOfGraphNodeSequence`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_SeqNode`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_ShapeMapTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_ShapeTool`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XCAFDoc_Volume`(*args)

  Bases: `OCC.TDF.Handle_TDF_Attribute`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `SwigPyIterator`(*args, **kwargs)

  Bases: `object`

  `advance`()
  `copy`()
  `decr`()
  `distance`()
  `equal`()
  `incr`()
  `next`()
  `previous`()
  `thisown`

    The membership flag

  `value`()

class `XCAFDoc_Area`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - class methods =============

  Return type: | None

  `DumpToString`()

    XCAFDoc_Area_DumpToString(XCAFDoc_Area self) -> std::string

  static `Get`(*args)

    Return type: | float

    - Returns volume of area as argument and succes status returns false if no such attribute at the <label>

    Parameters: | label (TDF_Label &) – area (float &) –
    Return type: | bool

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  static `Set`(*args)
    - Sets a value of volume

    Parameters: | vol (float) –
    Return type: | None

    - Find, or create, an Area attribute and set its value

    Parameters: | label (TDF_Label &) – area (float) –
    Return type: | Handle_XCAFDoc_Area

  `thisown`

    The membership flag

`XCAFDoc_Area_Get`(*args)

  Return type: | float

  - Returns volume of area as argument and succes status returns false if no such attribute at the <label>

  Parameters: | label (TDF_Label &) – area (float &) –
  Return type: | bool

`XCAFDoc_Area_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_Area_Set`(*args)
  - Sets a value of volume

  Parameters: | vol (float) –
  Return type: | None

  - Find, or create, an Area attribute and set its value

  Parameters: | label (TDF_Label &) – area (float) –
  Return type: | Handle_XCAFDoc_Area

class `XCAFDoc_Centroid`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - class methods =============

  Return type: | None

  `DumpToString`()

    XCAFDoc_Centroid_DumpToString(XCAFDoc_Centroid self) -> std::string

  static `Get`(*args)

    Return type: | gp_Pnt

    - Returns point as argument returns false if no such attribute at the <label>

    Parameters: | label (TDF_Label &) – pnt (gp_Pnt) –
    Return type: | bool

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `Set`()
    - Find, or create, a Location attribute and set it’s value the Location attribute is returned. Location methods ===============

    Parameters: | label (TDF_Label &) – pnt (gp_Pnt) – pnt –
    Return type: | Handle_XCAFDoc_Centroid
    Return type: | None

  `thisown`

    The membership flag

`XCAFDoc_Centroid_Get`(*args)

  Return type: | gp_Pnt

  - Returns point as argument returns false if no such attribute at the <label>

  Parameters: | label (TDF_Label &) – pnt (gp_Pnt) –
  Return type: | bool

`XCAFDoc_Centroid_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_Color`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `GetColor`()

    Return type: | Quantity_Color

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetNOC`()

    Return type: | Quantity_NameOfColor

  `GetRGB`()
    - Returns True if there is a reference on the same label

    Parameters: | R (float &) – G (float &) – B (float &) –
    Return type: | None

  `Set`()

    Parameters: | label (TDF_Label &) – C (Quantity_NameOfColor) – label – C –
    Return type: | Handle_XCAFDoc_Color
    Return type: | Handle_XCAFDoc_Color

    - Find, or create, a Color attribute and set it’s value the Color attribute is returned.

    Parameters: | label (TDF_Label &) – R (float) – G (float) – B (float) – C (Quantity_NameOfColor) – C – R – G – B –
    Return type: | Handle_XCAFDoc_Color
    Return type: | None
    Return type: | None
    Return type: | None

  `thisown`

    The membership flag

class `XCAFDoc_ColorTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `AddColor`()
    - Adds a color definition to a colortable and returns its label (returns existing label if the same color is already defined)

    Parameters: | col (Quantity_Color &) –
    Return type: | TDF_Label

  `BaseLabel`()
    - returns the label under which colors are stored

    Return type: | TDF_Label

  `FindColor`()
    - Finds a color definition in a colortable and returns its label if found Returns False if color is not found in colortable

    Parameters: | col (Quantity_Color &) – lab (TDF_Label &) –
    Return type: | bool

    - Finds a color definition in a colortable and returns its label if found (or Null label else)

    Parameters: | col (Quantity_Color &) –
    Return type: | TDF_Label

  `GetColor`()
    - Returns color defined by label lab Returns False if the label is not in colortable or does not define a color

    Parameters: | lab (TDF_Label &) – col (Quantity_Color &) –
    Return type: | bool

    - Returns label with color assigned to <L> as <type> Returns False if no such color is assigned

    Parameters: | L (TDF_Label &) – type (XCAFDoc_ColorType) – colorL (TDF_Label &) –
    Return type: | bool

    - Returns color assigned to <L> as <type> Returns False if no such color is assigned

    Parameters: | L (TDF_Label &) – type (XCAFDoc_ColorType) – color (Quantity_Color &) –
    Return type: | bool

    - Returns label with color assigned to <L> as <type> Returns False if no such color is assigned

    Parameters: | S (TopoDS_Shape &) – type (XCAFDoc_ColorType) – colorL (TDF_Label &) –
    Return type: | bool

    - Returns color assigned to <L> as <type> Returns False if no such color is assigned

    Parameters: | S (TopoDS_Shape &) – type (XCAFDoc_ColorType) – color (Quantity_Color &) –
    Return type: | bool

  `GetColors`()
    - Returns a sequence of colors currently stored in the colortable

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetInstanceColor`()
    - Gets the color of component that styled with SHUO structure Returns False if no sush component or color type

    Parameters: | theShape (TopoDS_Shape &) – type (XCAFDoc_ColorType) – color (Quantity_Color &) –
    Return type: | bool

  `IsColor`()
    - Returns True if label belongs to a colortable and is a color definition

    Parameters: | lab (TDF_Label &) –
    Return type: | bool

  `IsInstanceVisible`()
    - Gets the visibility status of component that styled with SHUO structure Returns False if no sush component

    Parameters: | theShape (TopoDS_Shape &) –
    Return type: | bool

  `IsSet`()
    - Returns True if label <L> has a color assignment of the type <type>

    Parameters: | L (TDF_Label &) – type (XCAFDoc_ColorType) –
    Return type: | bool

    - Returns True if label <L> has a color assignment of the type <type>

    Parameters: | S (TopoDS_Shape &) – type (XCAFDoc_ColorType) –
    Return type: | bool

  `IsVisible`()
    - Return True if object on this label is visible, False if invisible.

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  `RemoveColor`()
    - Removes color from the colortable

    Parameters: | lab (TDF_Label &) –
    Return type: | None

  `ReverseChainsOfTreeNodes`()
    - Reverses order in chains of TreeNodes (from Last to First) under each Color Label since we became to use function ::Prepend() instead of ::Append() in method SetColor() for acceleration

    Return type: | bool

  static `Set`(*args)
    - Creates (if not exist) ColorTool.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_ColorTool

  `SetColor`()
    - Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color defined by <colorL>. Color of shape is defined following way in dependance with type of color. If type of color is XCAFDoc_ColorGen - then this color defines default color for surfaces and curves. If for shape color with types XCAFDoc_ColorSurf or XCAFDoc_ColorCurv is specified then such color overrides generic color.

    Parameters: | L (TDF_Label &) – colorL (TDF_Label &) – type (XCAFDoc_ColorType) –
    Return type: | None

    - Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary

    Parameters: | L (TDF_Label &) – Color (Quantity_Color &) – type (XCAFDoc_ColorType) –
    Return type: | None

    - Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color defined by <colorL> Returns False if cannot find a label for shape S

    Parameters: | S (TopoDS_Shape &) – colorL (TDF_Label &) – type (XCAFDoc_ColorType) –
    Return type: | bool

    - Sets a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color <Color> in the colortable Adds a color as necessary Returns False if cannot find a label for shape S

    Parameters: | S (TopoDS_Shape &) – Color (Quantity_Color &) – type (XCAFDoc_ColorType) –
    Return type: | bool

  `SetInstanceColor`()
    - Sets the color of component that styled with SHUO structure Returns False if no sush component found NOTE: create SHUO structeure if it is necessary and if <isCreateSHUO>

    Parameters: | theShape (TopoDS_Shape &) – type (XCAFDoc_ColorType) – color (Quantity_Color &) – isCreateSHUO (bool) – default value is Standard_True
    Return type: | bool

  `SetVisibility`()
    - Set the visibility of object on label. Do nothing if there no any object. Set UAttribute with corresponding GUID.

    Parameters: | shapeLabel (TDF_Label &) – isvisible (bool) – default value is Standard_True
    Return type: | None

  `ShapeTool`()
    - Returns internal XCAFDoc_ShapeTool tool

    Return type: | Handle_XCAFDoc_ShapeTool

  `UnSetColor`()
    - Removes a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color

    Parameters: | L (TDF_Label &) – type (XCAFDoc_ColorType) –
    Return type: | None

    - Removes a link with GUID defined by <type> (see XCAFDoc::ColorRefGUID()) from label <L> to color Returns True if such link existed

    Parameters: | S (TopoDS_Shape &) – type (XCAFDoc_ColorType) –
    Return type: | bool

  `thisown`

    The membership flag

`XCAFDoc_ColorTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_ColorTool_Set`(*args)
  - Creates (if not exist) ColorTool.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_ColorTool

`XCAFDoc_Color_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_DataMapIteratorOfDataMapOfShapeLabel`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMapIterator`

  Return type: | None
  Parameters: | aMap (XCAFDoc_DataMapOfShapeLabel &) –
  Return type: | None

  `Initialize`()

    Parameters: | aMap (XCAFDoc_DataMapOfShapeLabel &) –
    Return type: | None

  `Key`()

    Return type: | TopoDS_Shape

  `Value`()

    Return type: | TDF_Label

  `thisown`

    The membership flag

class `XCAFDoc_DataMapNodeOfDataMapOfShapeLabel`(*args)

  Bases: `OCC.TCollection.TCollection_MapNode`

  Parameters: | K (TopoDS_Shape &) – I (TDF_Label &) – n (TCollection_MapNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Key`()

    Return type: | TopoDS_Shape

  `Value`()

    Return type: | TDF_Label

  `thisown`

    The membership flag

class `XCAFDoc_DataMapOfShapeLabel`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMap`

  Parameters: | NbBuckets (int) – default value is 1
  Return type: | None

  `Assign`()

    Parameters: | Other (XCAFDoc_DataMapOfShapeLabel &) –
    Return type: | XCAFDoc_DataMapOfShapeLabel

  `Bind`()

    Parameters: | K (TopoDS_Shape &) – I (TDF_Label &) –
    Return type: | bool

  `ChangeFind`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | TDF_Label

  `ChangeFind1`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `Clear`()

    Return type: | None

  `Find`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | TDF_Label

  `Find1`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `IsBound`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | bool

  `ReSize`()

    Parameters: | NbBuckets (int) –
    Return type: | None

  `Set`()

    Parameters: | Other (XCAFDoc_DataMapOfShapeLabel &) –
    Return type: | XCAFDoc_DataMapOfShapeLabel

  `UnBind`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | bool

  `thisown`

    The membership flag

class `XCAFDoc_Datum`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `GetDescription`()

    Return type: | Handle_TCollection_HAsciiString

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetIdentification`()

    Return type: | Handle_TCollection_HAsciiString

  `GetName`()

    Return type: | Handle_TCollection_HAsciiString

  `Set`()

    Parameters: | label (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – anIdentification (Handle_TCollection_HAsciiString &) – aName – aDescription – anIdentification –
    Return type: | Handle_XCAFDoc_Datum
    Return type: | None

  `thisown`

    The membership flag

`XCAFDoc_Datum_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_DimTol`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `GetDescription`()

    Return type: | Handle_TCollection_HAsciiString

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetKind`()

    Return type: | int

  `GetName`()

    Return type: | Handle_TCollection_HAsciiString

  `GetVal`()

    Return type: | Handle_TColStd_HArray1OfReal

  `Set`()

    Parameters: | label (TDF_Label &) – kind (int) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – kind – aVal – aName – aDescription –
    Return type: | Handle_XCAFDoc_DimTol
    Return type: | None

  `thisown`

    The membership flag

class `XCAFDoc_DimTolTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `AddDatum`()
    - Adds a datum definition to a DGTtable and returns its label

    Parameters: | aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – anIdentification (Handle_TCollection_HAsciiString &) –
    Return type: | TDF_Label

  `AddDimTol`()
    - Adds a dimtol definition to a DGTtable and returns its label

    Parameters: | kind (int) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) –
    Return type: | TDF_Label

  `BaseLabel`()
    - returns the label under which colors are stored

    Return type: | TDF_Label

  `FindDatum`()
    - Finds a datum and returns its label if found

    Parameters: | aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – anIdentification (Handle_TCollection_HAsciiString &) – lab (TDF_Label &) –
    Return type: | bool

  `FindDimTol`()
    - Finds a dimtol definition in a DGTtable and returns its label if found Returns False if dimtol is not found in DGTtable

    Parameters: | kind (int) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – lab (TDF_Label &) –
    Return type: | bool

    - Finds a dimtol definition in a DGTtable and returns its label if found (or Null label else)

    Parameters: | kind (int) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) –
    Return type: | TDF_Label

  `GetDatum`()
    - Returns datum assigned to <DatumL> Returns False if no such datum is assigned

    Parameters: | DatumL (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – anIdentification (Handle_TCollection_HAsciiString &) –
    Return type: | bool

  `GetDatumLabels`()
    - Returns a sequence of Datumss currently stored in the DGTtable

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  `GetDatumTolerLabels`()
    - Returns all Datum labels defined for label DimTolL

    Parameters: | DimTolL (TDF_Label &) – Datums (TDF_LabelSequence &) –
    Return type: | bool

  `GetDimTol`()
    - Returns dimtol assigned to <DimTolL> Returns False if no such dimtol is assigned

    Parameters: | DimTolL (TDF_Label &) – kind (int &) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) –
    Return type: | bool

  `GetDimTolLabels`()
    - Returns a sequence of D&GTs currently stored in the DGTtable

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetRefDGTLabels`()
    - Returns all DimTol labels defined for label ShapeL

    Parameters: | ShapeL (TDF_Label &) – DimTols (TDF_LabelSequence &) –
    Return type: | bool

  `GetRefShapeLabel`()
    - Returns ShapeL defined for label DimTolL Returns False if the DimTolL is not in DGTtable

    Parameters: | DimTolL (TDF_Label &) – ShapeL (TDF_Label &) –
    Return type: | bool

  `IsDatum`()
    - Returns True if label belongs to a dimtoltable and is a Datum definition

    Parameters: | lab (TDF_Label &) –
    Return type: | bool

  `IsDimTol`()
    - Returns True if label belongs to a dimtoltable and is a DimTol definition

    Parameters: | lab (TDF_Label &) –
    Return type: | bool

  static `Set`(*args)
    - Creates (if not exist) DimTolTool.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_DimTolTool

  `SetDatum`()
    - Sets a link with GUID

    Parameters: | L (TDF_Label &) – DatumL (TDF_Label &) –
    Return type: | None

    - Sets a link with GUID for Datum Adds a Datum as necessary Sets connection between Datum and Tolerance

    Parameters: | L (TDF_Label &) – TolerL (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – anIdentification (Handle_TCollection_HAsciiString &) –
    Return type: | None

  `SetDimTol`()
    - Sets a link with GUID

    Parameters: | L (TDF_Label &) – DimTolL (TDF_Label &) –
    Return type: | None

    - Sets a link with GUID Adds a DimTol as necessary

    Parameters: | L (TDF_Label &) – kind (int) – aVal (Handle_TColStd_HArray1OfReal &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) –
    Return type: | TDF_Label

  `ShapeTool`()
    - Returns internal XCAFDoc_ShapeTool tool

    Return type: | Handle_XCAFDoc_ShapeTool

  `thisown`

    The membership flag

`XCAFDoc_DimTolTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_DimTolTool_Set`(*args)
  - Creates (if not exist) DimTolTool.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_DimTolTool

`XCAFDoc_DimTol_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_DocumentTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  static `ColorTool`(*args)
    - Creates (if it does not exist) ColorTool attribute on ColorsLabel().

    Parameters: | acces (TDF_Label &) –
    Return type: | Handle_XCAFDoc_ColorTool

  static `ColorsLabel`(*args)
    - Returns sub-label of DocLabel() with tag 2.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  static `DGTsLabel`(*args)
    - Returns sub-label of DocLabel() with tag 4.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  `Destroy`()
    - Unregisters the document holding this attribute from an internal global map of XDE documents.

    Return type: | void

  static `DimTolTool`(*args)
    - Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

    Parameters: | acces (TDF_Label &) –
    Return type: | Handle_XCAFDoc_DimTolTool

  static `DocLabel`(*args)
    - Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `Init`()
    - to be called when reading this attribute from file

    Return type: | None

  static `IsXCAFDocument`(*args)

    Parameters: | Doc (Handle_TDocStd_Document &) –
    Return type: | bool

  static `LayerTool`(*args)
    - Creates (if it does not exist) LayerTool attribute on LayersLabel().

    Parameters: | acces (TDF_Label &) –
    Return type: | Handle_XCAFDoc_LayerTool

  static `LayersLabel`(*args)
    - Returns sub-label of DocLabel() with tag 3.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  static `MaterialTool`(*args)
    - Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

    Parameters: | acces (TDF_Label &) –
    Return type: | Handle_XCAFDoc_MaterialTool

  static `MaterialsLabel`(*args)
    - Returns sub-label of DocLabel() with tag 5.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  static `Set`(*args)
    - 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.

    Parameters: | L (TDF_Label &) – IsAcces (bool) – default value is Standard_True
    Return type: | Handle_XCAFDoc_DocumentTool

  static `ShapeTool`(*args)
    - Creates (if it does not exist) ShapeTool attribute on ShapesLabel().

    Parameters: | acces (TDF_Label &) –
    Return type: | Handle_XCAFDoc_ShapeTool

  static `ShapesLabel`(*args)
    - Returns sub-label of DocLabel() with tag 1.

    Parameters: | acces (TDF_Label &) –
    Return type: | TDF_Label

  `thisown`

    The membership flag

`XCAFDoc_DocumentTool_ColorTool`(*args)
  - Creates (if it does not exist) ColorTool attribute on ColorsLabel().

  Parameters: | acces (TDF_Label &) –
  Return type: | Handle_XCAFDoc_ColorTool

`XCAFDoc_DocumentTool_ColorsLabel`(*args)
  - Returns sub-label of DocLabel() with tag 2.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

`XCAFDoc_DocumentTool_DGTsLabel`(*args)
  - Returns sub-label of DocLabel() with tag 4.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

`XCAFDoc_DocumentTool_DimTolTool`(*args)
  - Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

  Parameters: | acces (TDF_Label &) –
  Return type: | Handle_XCAFDoc_DimTolTool

`XCAFDoc_DocumentTool_DocLabel`(*args)
  - Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

`XCAFDoc_DocumentTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_DocumentTool_IsXCAFDocument`(*args)

  Parameters: | Doc (Handle_TDocStd_Document &) –
  Return type: | bool

`XCAFDoc_DocumentTool_LayerTool`(*args)
  - Creates (if it does not exist) LayerTool attribute on LayersLabel().

  Parameters: | acces (TDF_Label &) –
  Return type: | Handle_XCAFDoc_LayerTool

`XCAFDoc_DocumentTool_LayersLabel`(*args)
  - Returns sub-label of DocLabel() with tag 3.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

`XCAFDoc_DocumentTool_MaterialTool`(*args)
  - Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

  Parameters: | acces (TDF_Label &) –
  Return type: | Handle_XCAFDoc_MaterialTool

`XCAFDoc_DocumentTool_MaterialsLabel`(*args)
  - Returns sub-label of DocLabel() with tag 5.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

`XCAFDoc_DocumentTool_Set`(*args)
  - 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.

  Parameters: | L (TDF_Label &) – IsAcces (bool) – default value is Standard_True
  Return type: | Handle_XCAFDoc_DocumentTool

`XCAFDoc_DocumentTool_ShapeTool`(*args)
  - Creates (if it does not exist) ShapeTool attribute on ShapesLabel().

  Parameters: | acces (TDF_Label &) –
  Return type: | Handle_XCAFDoc_ShapeTool

`XCAFDoc_DocumentTool_ShapesLabel`(*args)
  - Returns sub-label of DocLabel() with tag 1.

  Parameters: | acces (TDF_Label &) –
  Return type: | TDF_Label

class `XCAFDoc_GraphNode`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `ChildIndex`()
    - Return index of <Ch>, or zero if there is no such Graphnode.

    Parameters: | Ch (Handle_XCAFDoc_GraphNode &) –
    Return type: | int

  `DumpToString`()

    XCAFDoc_GraphNode_DumpToString(XCAFDoc_GraphNode self) -> std::string

  `FatherIndex`()
    - Return index of <F>, or zero if there is no such Graphnode.

    Parameters: | F (Handle_XCAFDoc_GraphNode &) –
    Return type: | int

  static `Find`(*args)
    - class methods working on the node =================================== Shortcut to search a Graph node attribute with default GraphID. Returns true if found.

    Parameters: | L (TDF_Label &) – G (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `GetChild`()
    - Return GraphNode by index from GraphNodeSequence.

    Parameters: | Chindex (int) –
    Return type: | Handle_XCAFDoc_GraphNode

  static `GetDefaultGraphID`(*args)
    - returns a default Graph ID. this ID is used by the <Set> method without explicit tree ID. Instance methods: ================

    Return type: | Standard_GUID

  `GetFather`()
    - Return GraphNode by index from GraphNodeSequence.

    Parameters: | Findex (int) –
    Return type: | Handle_XCAFDoc_GraphNode

  `GetHandle`()
  `IsChild`()
    - returns True if <self> is child of <F>.

    Parameters: | F (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `IsFather`()
    - returns True if <self> is father of <Ch>.

    Parameters: | Ch (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `NbChildren`()
    - return Number of Childrens GraphNodes. Implementation of Attribute methods: ===================================

    Return type: | int

  `NbFathers`()
    - return Number of Fathers GraphNodes.

    Return type: | int

  static `Set`(*args)
    - Finds or Creates a GraphNode attribute on the label <L> with the default Graph ID, returned by the method <GetDefaultGraphID>. Returns the created/found GraphNode attribute.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_GraphNode

    - Finds or Creates a GraphNode attribute on the label <L>, with an explicit tree ID. <ExplicitGraphID> is the ID returned by <TDF_Attribute::ID> method. Returns the found/created GraphNode attribute.

    Parameters: | L (TDF_Label &) – ExplicitGraphID (Standard_GUID &) –
    Return type: | Handle_XCAFDoc_GraphNode

  `SetChild`()
    - Set GraphNode <Ch> as child of me and returns index of <Ch> in Sequence that containing Children GraphNodes. return index of <Ch> from GraphNodeSequnece

    Parameters: | Ch (Handle_XCAFDoc_GraphNode &) –
    Return type: | int

  `SetFather`()
    - Set GraphNode <F> as father of me and returns index of <F> in Sequence that containing Fathers GraphNodes. return index of <F> from GraphNodeSequnece

    Parameters: | F (Handle_XCAFDoc_GraphNode &) –
    Return type: | int

  `SetGraphID`()

    Parameters: | explicitID (Standard_GUID &) –
    Return type: | None

  `UnSetChild`()
    - Remove <Ch> from GraphNodeSequence. and remove link between father and child.

    Parameters: | Ch (Handle_XCAFDoc_GraphNode &) –
    Return type: | None

    - Remove Child GraphNode by index from Children GraphNodeSequence. and remove link between father and child.

    Parameters: | Chindex (int) –
    Return type: | None

  `UnSetFather`()
    - Remove <F> from Fathers GraphNodeSequence. and remove link between father and child.

    Parameters: | F (Handle_XCAFDoc_GraphNode &) –
    Return type: | None

    - Remove Father GraphNode by index from Fathers GraphNodeSequence. and remove link between father and child.

    Parameters: | Findex (int) –
    Return type: | None

  `thisown`

    The membership flag

class `XCAFDoc_GraphNodeSequence`(*args)

  Bases: `OCC.TCollection.TCollection_BaseSequence`

  Return type: | None
  Parameters: | Other (XCAFDoc_GraphNodeSequence &) –
  Return type: | None

  `Append`()

    Parameters: | T (Handle_XCAFDoc_GraphNode &) – S (XCAFDoc_GraphNodeSequence &) –
    Return type: | None
    Return type: | None

  `Assign`()

    Parameters: | Other (XCAFDoc_GraphNodeSequence &) –
    Return type: | XCAFDoc_GraphNodeSequence

  `ChangeValue`()

    Parameters: | Index (int) –
    Return type: | Handle_XCAFDoc_GraphNode

  `Clear`()

    Return type: | None

  `First`()

    Return type: | Handle_XCAFDoc_GraphNode

  `InsertAfter`()

    Parameters: | Index (int) – T (Handle_XCAFDoc_GraphNode &) – Index – S (XCAFDoc_GraphNodeSequence &) –
    Return type: | None
    Return type: | None

  `InsertBefore`()

    Parameters: | Index (int) – T (Handle_XCAFDoc_GraphNode &) – Index – S (XCAFDoc_GraphNodeSequence &) –
    Return type: | None
    Return type: | None

  `Last`()

    Return type: | Handle_XCAFDoc_GraphNode

  `Prepend`()

    Parameters: | T (Handle_XCAFDoc_GraphNode &) – S (XCAFDoc_GraphNodeSequence &) –
    Return type: | None
    Return type: | None

  `Remove`()

    Parameters: | Index (int) – FromIndex (int) – ToIndex (int) –
    Return type: | None
    Return type: | None

  `Set`()

    Parameters: | Other (XCAFDoc_GraphNodeSequence &) –
    Return type: | XCAFDoc_GraphNodeSequence

  `SetValue`()

    Parameters: | Index (int) – I (Handle_XCAFDoc_GraphNode &) –
    Return type: | None

  `Split`()

    Parameters: | Index (int) – Sub (XCAFDoc_GraphNodeSequence &) –
    Return type: | None

  `Value`()

    Parameters: | Index (int) –
    Return type: | Handle_XCAFDoc_GraphNode

  `thisown`

    The membership flag

`XCAFDoc_GraphNode_Find`(*args)
  - class methods working on the node =================================== Shortcut to search a Graph node attribute with default GraphID. Returns true if found.

  Parameters: | L (TDF_Label &) – G (Handle_XCAFDoc_GraphNode &) –
  Return type: | bool

`XCAFDoc_GraphNode_GetDefaultGraphID`(*args)
  - returns a default Graph ID. this ID is used by the <Set> method without explicit tree ID. Instance methods: ================

  Return type: | Standard_GUID

`XCAFDoc_GraphNode_Set`(*args)
  - Finds or Creates a GraphNode attribute on the label <L> with the default Graph ID, returned by the method <GetDefaultGraphID>. Returns the created/found GraphNode attribute.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_GraphNode

  - Finds or Creates a GraphNode attribute on the label <L>, with an explicit tree ID. <ExplicitGraphID> is the ID returned by <TDF_Attribute::ID> method. Returns the found/created GraphNode attribute.

  Parameters: | L (TDF_Label &) – ExplicitGraphID (Standard_GUID &) –
  Return type: | Handle_XCAFDoc_GraphNode

class `XCAFDoc_LayerTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `AddLayer`()
    - Adds a Layer definition to a Layertable and returns its label (returns existing label if the same Layer is already defined)

    Parameters: | aLayer (TCollection_ExtendedString &) –
    Return type: | TDF_Label

  `BaseLabel`()
    - returns the label under which Layers are stored

    Return type: | TDF_Label

  `FindLayer`()
    - Finds a Layer definition in a Layertable and returns its label if found Returns False if Layer is not found in Layertable

    Parameters: | aLayer (TCollection_ExtendedString &) – lab (TDF_Label &) –
    Return type: | bool

    - Finds a Layer definition in a Layertable and returns its label if found (or Null label else)

    Parameters: | aLayer (TCollection_ExtendedString &) –
    Return type: | TDF_Label

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetLayer`()
    - Returns Layer defined by label lab Returns False if the label is not in Layertable or does not define a Layer

    Parameters: | lab (TDF_Label &) – aLayer (TCollection_ExtendedString &) –
    Return type: | bool

  `GetLayerLabels`()
    - Returns a sequence of Layers currently stored in the Layertable

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  `GetLayers`()
    - Return sequence of strings <aLayerS> that assosiated with label <L>.

    Parameters: | L (TDF_Label &) – aLayerS (Handle_TColStd_HSequenceOfExtendedString &) –
    Return type: | bool

    - Return sequence of labels <aLayerSL> that assosiated with label <L>.

    Parameters: | L (TDF_Label &) – aLayerLS (TDF_LabelSequence &) –
    Return type: | bool

    - Return sequence of strings that assosiated with label <L>.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_TColStd_HSequenceOfExtendedString

    - Return sequence of strings <aLayerS> that assosiated with shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) – aLayerS (Handle_TColStd_HSequenceOfExtendedString &) –
    Return type: | bool

    - Return sequence of labels <aLayerLS> that assosiated with shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) – aLayerLS (TDF_LabelSequence &) –
    Return type: | bool

    - Return sequence of strings that assosiated with shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) –
    Return type: | Handle_TColStd_HSequenceOfExtendedString

  `GetShapesOfLayer`()
    - Return sequanese of shape labels that assigned with layers to <ShLabels>.

    Parameters: | layerL (TDF_Label &) – ShLabels (TDF_LabelSequence &) –
    Return type: | None

  `IsLayer`()
    - Returns True if label belongs to a Layertable and is a Layer definition

    Parameters: | lab (TDF_Label &) –
    Return type: | bool

  `IsSet`()
    - Returns True if label <L> has a Layer assosiated with the <aLayer>.

    Parameters: | L (TDF_Label &) – aLayer (TCollection_ExtendedString &) –
    Return type: | bool

    - Returns True if label <L> has a Layer assosiated with the <aLayerL> label.

    Parameters: | L (TDF_Label &) – aLayerL (TDF_Label &) –
    Return type: | bool

    - Returns True if shape <Sh> has a Layer assosiated with the <aLayer>.

    Parameters: | Sh (TopoDS_Shape &) – aLayer (TCollection_ExtendedString &) –
    Return type: | bool

    - Returns True if shape <Sh> has a Layer assosiated with the <aLayerL>.

    Parameters: | Sh (TopoDS_Shape &) – aLayerL (TDF_Label &) –
    Return type: | bool

  `IsVisible`()
    - Return True if layer is visible, False if invisible.

    Parameters: | layerL (TDF_Label &) –
    Return type: | bool

  `RemoveLayer`()
    - Removes Layer from the Layertable

    Parameters: | lab (TDF_Label &) –
    Return type: | None

  static `Set`(*args)
    - Creates (if not exist) LayerTool.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_LayerTool

  `SetLayer`()
    - Sets a link from label <L> to Layer defined by <LayerL> optional parametr <shapeInOneLayer> show could shape be in number of layers or only in one.

    Parameters: | L (TDF_Label &) – LayerL (TDF_Label &) – shapeInOneLayer (bool) – default value is Standard_False
    Return type: | None

    - Sets a link from label <L> to Layer <aLayer> in the Layertable Adds a Layer as necessary optional parametr <shapeInOneLayer> show could shape be in number of layers or only in one.

    Parameters: | L (TDF_Label &) – aLayer (TCollection_ExtendedString &) – shapeInOneLayer (bool) – default value is Standard_False
    Return type: | None

    - Sets a link from label that containig shape <Sh> with layer that situated at label <LayerL>. optional parametr <shapeInOneLayer> show could shape be in number of layers or only in one. return False if no such shape <Sh> or label <LayerL>

    Parameters: | Sh (TopoDS_Shape &) – LayerL (TDF_Label &) – shapeInOneLayer (bool) – default value is Standard_False
    Return type: | bool

    - Sets a link from label that containig shape <Sh> with layer <aLayer>. Add <aLayer> to LayerTable if nessesery. optional parametr <shapeInOneLayer> show could shape be in number of layers or only in one. return False if no such shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) – aLayer (TCollection_ExtendedString &) – shapeInOneLayer (bool) – default value is Standard_False
    Return type: | bool

  `SetVisibility`()
    - Set the visibility of layer. If layer is invisible when on it’s layer will set UAttribute with corresponding GUID.

    Parameters: | layerL (TDF_Label &) – isvisible (bool) – default value is Standard_True
    Return type: | None

  `ShapeTool`()
    - Returns internal XCAFDoc_ShapeTool tool

    Return type: | Handle_XCAFDoc_ShapeTool

  `UnSetLayers`()
    - Removes a link from label <L> to all layers

    Parameters: | L (TDF_Label &) –
    Return type: | None

    - Remove link between shape <Sh> and all Layers at LayerTable. return False if no such shape <Sh> in XCAF Document.

    Parameters: | Sh (TopoDS_Shape &) –
    Return type: | bool

  `UnSetOneLayer`()
    - Remove link from label <L> and Layer <aLayer>. returns False if no such layer.

    Parameters: | L (TDF_Label &) – aLayer (TCollection_ExtendedString &) –
    Return type: | bool

    - Remove link from label <L> and Layer <aLayerL>. returns False if <aLayerL> is not a layer label.

    Parameters: | L (TDF_Label &) – aLayerL (TDF_Label &) –
    Return type: | bool

    - Remove link between shape <Sh> and layer <aLayer>. returns False if no such layer <aLayer> or shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) – aLayer (TCollection_ExtendedString &) –
    Return type: | bool

    - Remove link between shape <Sh> and layer <aLayerL>. returns False if no such layer <aLayerL> or shape <Sh>.

    Parameters: | Sh (TopoDS_Shape &) – aLayerL (TDF_Label &) –
    Return type: | bool

  `thisown`

    The membership flag

`XCAFDoc_LayerTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_LayerTool_Set`(*args)
  - Creates (if not exist) LayerTool.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_LayerTool

class `XCAFDoc_Location`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - class methods =============

  Return type: | None

  `Get`()
    - Returns True if there is a reference on the same label

    Return type: | TopLoc_Location

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `Set`()
    - Find, or create, a Location attribute and set it’s value the Location attribute is returned. Location methods ===============

    Parameters: | label (TDF_Label &) – Loc (TopLoc_Location &) – Loc –
    Return type: | Handle_XCAFDoc_Location
    Return type: | None

  `thisown`

    The membership flag

`XCAFDoc_Location_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_Material`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `GetDensName`()

    Return type: | Handle_TCollection_HAsciiString

  `GetDensValType`()

    Return type: | Handle_TCollection_HAsciiString

  `GetDensity`()

    Return type: | float

  `GetDescription`()

    Return type: | Handle_TCollection_HAsciiString

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetName`()

    Return type: | Handle_TCollection_HAsciiString

  `Set`()

    Parameters: | label (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – aDensity (float) – aDensName (Handle_TCollection_HAsciiString &) – aDensValType (Handle_TCollection_HAsciiString &) – aName – aDescription – aDensity – aDensName – aDensValType –
    Return type: | Handle_XCAFDoc_Material
    Return type: | None

  `thisown`

    The membership flag

class `XCAFDoc_MaterialTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  Return type: | None

  `AddMaterial`()
    - Adds a Material definition to a table and returns its label

    Parameters: | aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – aDensity (float) – aDensName (Handle_TCollection_HAsciiString &) – aDensValType (Handle_TCollection_HAsciiString &) –
    Return type: | TDF_Label

  `BaseLabel`()
    - returns the label under which colors are stored

    Return type: | TDF_Label

  static `GetDensityForShape`(*args)
    - Find referred material and return density from it if no material –> return 0

    Parameters: | ShapeL (TDF_Label &) –
    Return type: | float

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetMaterial`()
    - Returns Material assigned to <MatL> Returns False if no such Material is assigned

    Parameters: | MatL (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – aDensity (float &) – aDensName (Handle_TCollection_HAsciiString &) – aDensValType (Handle_TCollection_HAsciiString &) –
    Return type: | bool

  `GetMaterialLabels`()
    - Returns a sequence of materials currently stored in the material table

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  `IsMaterial`()
    - Returns True if label belongs to a material table and is a Material definition

    Parameters: | lab (TDF_Label &) –
    Return type: | bool

  static `Set`(*args)
    - Creates (if not exist) MaterialTool.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_MaterialTool

  `SetMaterial`()
    - Sets a link with GUID

    Parameters: | L (TDF_Label &) – MatL (TDF_Label &) –
    Return type: | None

    - Sets a link with GUID Adds a Material as necessary

    Parameters: | L (TDF_Label &) – aName (Handle_TCollection_HAsciiString &) – aDescription (Handle_TCollection_HAsciiString &) – aDensity (float) – aDensName (Handle_TCollection_HAsciiString &) – aDensValType (Handle_TCollection_HAsciiString &) –
    Return type: | None

  `ShapeTool`()
    - Returns internal XCAFDoc_ShapeTool tool

    Return type: | Handle_XCAFDoc_ShapeTool

  `thisown`

    The membership flag

`XCAFDoc_MaterialTool_GetDensityForShape`(*args)
  - Find referred material and return density from it if no material –> return 0

  Parameters: | ShapeL (TDF_Label &) –
  Return type: | float

`XCAFDoc_MaterialTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_MaterialTool_Set`(*args)
  - Creates (if not exist) MaterialTool.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_MaterialTool

`XCAFDoc_Material_GetID`(*args)

  Return type: | Standard_GUID

class `XCAFDoc_SequenceNodeOfGraphNodeSequence`(*args)

  Bases: `OCC.TCollection.TCollection_SeqNode`

  Parameters: | I (Handle_XCAFDoc_GraphNode &) – n (TCollection_SeqNodePtr &) – p (TCollection_SeqNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Value`()

    Return type: | Handle_XCAFDoc_GraphNode

  `thisown`

    The membership flag

class `XCAFDoc_ShapeMapTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - Creates an empty tool

  Return type: | None

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  `GetMap`()

    Return type: | TopTools_IndexedMapOfShape

  `IsSubShape`()
    - Checks whether shape <sub> is subshape of shape stored on label shapeL

    Parameters: | sub (TopoDS_Shape &) –
    Return type: | bool

  static `Set`(*args)
    - Create (if not exist) ShapeTool from XCAFDoc on <L>.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_ShapeMapTool

  `SetShape`()
    - Sets representation (TopoDS_Shape) for top-level shape

    Parameters: | S (TopoDS_Shape &) –
    Return type: | None

  `thisown`

    The membership flag

`XCAFDoc_ShapeMapTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_ShapeMapTool_Set`(*args)
  - Create (if not exist) ShapeTool from XCAFDoc on <L>.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_ShapeMapTool

class `XCAFDoc_ShapeTool`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - Creates an empty tool Creates a tool to work with a document <Doc> Attaches to label XCAFDoc::LabelShapes()

  Return type: | None

  `AddComponent`()
    - Adds a component given by its label and location to the assembly Note: assembly must be IsAssembly() or IsSimpleShape()

    Parameters: | assembly (TDF_Label &) – comp (TDF_Label &) – Loc (TopLoc_Location &) –
    Return type: | TDF_Label

    - 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()

    Parameters: | assembly (TDF_Label &) – comp (TopoDS_Shape &) – expand (bool) – default value is Standard_False
    Return type: | TDF_Label

  `AddShape`()
    - 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 assmebly by located components to avoid some problems. If AutoNaming() is True then automatically attaches names.

    Parameters: | S (TopoDS_Shape &) – makeAssembly (bool) – default value is Standard_True makePrepare (bool) – default value is Standard_True
    Return type: | TDF_Label

  `AddSubShape`()
    - Adds a label for subshape <sub> of shape stored on label shapeL Returns Null label if it is not subshape

    Parameters: | shapeL (TDF_Label &) – sub (TopoDS_Shape &) –
    Return type: | TDF_Label

  static `AutoNaming`(*args)
    - Returns current auto-naming mode. See SetAutoNaming() for description.

    Return type: | bool

  `BaseLabel`()
    - returns the label under which shapes are stored

    Return type: | TDF_Label

  `ComputeShapes`()
    - recursive

    Parameters: | L (TDF_Label &) –
    Return type: | None

  `ComputeSimpleShapes`()
    - Compute a sequence of simple shapes

    Return type: | None

  `Dump`()

    Parameters: | theDumpLog (Standard_OStream &) – deep (bool) – default value is Standard_False
    Return type: | None

  static `DumpShape`(*args)
    - Print to 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

    Parameters: | theDumpLog (Standard_OStream &) – L (TDF_Label &) – level (int) – default value is 0 deep (bool) – default value is Standard_False
    Return type: | void

  `FindComponent`()
    - Serach 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

    Parameters: | theShape (TopoDS_Shape &) – Labels (TDF_LabelSequence &) –
    Return type: | bool

  `FindMainShape`()
    - Performs a search among top-level shapes to find the shape containing <sub> as subshape Checks only simple shapes, and returns the first found label (which should be the only one for valid model)

    Parameters: | sub (TopoDS_Shape &) –
    Return type: | TDF_Label

  `FindMainShapeUsingMap`()

    Parameters: | sub (TopoDS_Shape &) –
    Return type: | TDF_Label

  static `FindSHUO`(*args)
    - Searchs the SHUO by labels of components from upper_usage componet to next_usage Returns null attribute if no SHUO found

    Parameters: | Labels (TDF_LabelSequence &) – theSHUOAttr (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `FindShape`()
    - Returns the label corresponding to shape S (searches among top-level shapes, not including subcomponents of assemblies) If findInstance is False (default), searches for the non-located shape (i.e. among original shapes) If findInstance is True, searches for the shape with the same location, including shape instances Return True if <S> is found.

    Parameters: | S (TopoDS_Shape &) – L (TDF_Label &) – findInstance (bool) – default value is Standard_False
    Return type: | bool

    - Does the same as previous method Returns Null label if not found

    Parameters: | S (TopoDS_Shape &) – findInstance (bool) – default value is Standard_False
    Return type: | TDF_Label

  `FindSubShape`()
    - Finds a label for subshape <sub> of shape stored on label shapeL Returns Null label if it is not found

    Parameters: | shapeL (TDF_Label &) – sub (TopoDS_Shape &) – L (TDF_Label &) –
    Return type: | bool

  static `GetAllComponentSHUO`(*args)
    - Returns founded SHUO GraphNodes of indicated component Returns false in other case

    Parameters: | CompLabel (TDF_Label &) – SHUOAttrs (TDF_AttributeSequence &) –
    Return type: | bool

  `GetAllSHUOInstances`()
    - Seaching for component shapes that styled by shuo Returns empty sequence of shape if no any shape is found.

    Parameters: | theSHUO (Handle_XCAFDoc_GraphNode &) – theSHUOShapeSeq (TopTools_SequenceOfShape &) –
    Return type: | bool

  static `GetComponents`(*args)
    - Returns list of components of assembly Returns False if label is not assembly

    Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) – getsubchilds (bool) – default value is Standard_False
    Return type: | bool

  static `GetExternRefs`(*args)
    - Gets the names of references on the no-step files

    Parameters: | L (TDF_Label &) – SHAS (TColStd_SequenceOfHAsciiString &) –
    Return type: | void

  `GetFreeShapes`()
    - Returns a sequence of all top-level shapes which are free (i.e. not referred by any other)

    Parameters: | FreeLabels (TDF_LabelSequence &) –
    Return type: | None

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  static `GetLocation`(*args)
    - Returns location of instance

    Parameters: | L (TDF_Label &) –
    Return type: | TopLoc_Location

  static `GetReferredShape`(*args)
    - Returns label which corresponds to a shape referred by L Returns False if label is not reference

    Parameters: | L (TDF_Label &) – Label (TDF_Label &) –
    Return type: | bool

  static `GetSHUO`(*args)
    - Returns founded SHUO GraphNode attribute <aSHUOAttr> Returns false in other case

    Parameters: | SHUOLabel (TDF_Label &) – aSHUOAttr (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `GetSHUOInstance`()
    - Search for the component shape that styled by shuo Returns null shape if no any shape is found.

    Parameters: | theSHUO (Handle_XCAFDoc_GraphNode &) –
    Return type: | TopoDS_Shape

  static `GetSHUONextUsage`(*args)
    - 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

    Parameters: | UpperUsageL (TDF_Label &) – Labels (TDF_LabelSequence &) –
    Return type: | bool

  static `GetSHUOUpperUsage`(*args)
    - 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

    Parameters: | NextUsageL (TDF_Label &) – Labels (TDF_LabelSequence &) –
    Return type: | bool

  static `GetShape`(*args)
    - To get TopoDS_Shape from shape’s label For component, returns new shape with correct location Returns False if label does not contain shape

    Parameters: | L (TDF_Label &) – S (TopoDS_Shape &) –
    Return type: | bool

    - 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

    Parameters: | L (TDF_Label &) –
    Return type: | TopoDS_Shape

  `GetShapes`()
    - Returns a sequence of all top-level shapes

    Parameters: | Labels (TDF_LabelSequence &) –
    Return type: | None

  static `GetSubShapes`(*args)
    - Returns list of labels identifying subshapes of the given shape Returns False if no subshapes are placed on that label

    Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) –
    Return type: | bool

  static `GetUsers`(*args)
    - Returns list of labels which refer shape L as component Returns number of users (0 if shape is free)

    Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) – getsubchilds (bool) – default value is Standard_False
    Return type: | int

  `Init`()
    - set hasComponents into false

    Return type: | None

  static `IsAssembly`(*args)
    - 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

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsComponent`(*args)
    - Return true if <L> is reference serving as component of assembly

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsCompound`(*args)
    - Returns True if the label is a label of compound, i.e. contains some sublabels This is relevant only if IsShape() is True

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsExternRef`(*args)
    - 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

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsFree`(*args)
    - 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>)

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsReference`(*args)
    - Return true if <L> is a located instance of other shape i.e. reference

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsShape`(*args)
    - Returns True if the label represents a shape (simple shape, assembly or reference)

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `IsSimpleShape`(*args)
    - Returns True if the label is a label of simple shape

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  `IsSubShape`()
    - Return true if <L> is subshape of the top-level shape

    Parameters: | L (TDF_Label &) –
    Return type: | bool

    - Checks whether shape <sub> is subshape of shape stored on label shapeL

    Parameters: | shapeL (TDF_Label &) – sub (TopoDS_Shape &) –
    Return type: | bool

  `IsTopLevel`()
    - Returns True if the label is a label of top-level shape, as opposed to component of assembly or subshape

    Parameters: | L (TDF_Label &) –
    Return type: | bool

  static `NbComponents`(*args)
    - Returns number of Assembles components

    Parameters: | L (TDF_Label &) – getsubchilds (bool) – default value is Standard_False
    Return type: | int

  `NewShape`()
    - Creates new (empty) top-level shape. Initially it holds empty TopoDS_Compound

    Return type: | TDF_Label

  `RemoveComponent`()
    - Removes a component from its assembly

    Parameters: | comp (TDF_Label &) –
    Return type: | None

  `RemoveSHUO`()
    - 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.

    Parameters: | SHUOLabel (TDF_Label &) –
    Return type: | bool

  `RemoveShape`()
    - 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

    Parameters: | L (TDF_Label &) – removeCompletely (bool) – default value is Standard_True
    Return type: | bool

  `Search`()
    - General tool to find a (sub) shape in the document * If findInstance is True, and S has a non-null location, first tries to find the shape among the top-level shapes with this location * If not found, and findComponent is True, tries to find the shape among the components of assemblies * If not found, tries to find the shape without location among top-level shapes * If not found and findSubshape is True, tries to find a shape as a subshape of top-level simple shapes Returns False if nothing is found

    Parameters: | S (TopoDS_Shape &) – L (TDF_Label &) – findInstance (bool) – default value is Standard_True findComponent (bool) – default value is Standard_True findSubshape (bool) – default value is Standard_True
    Return type: | bool

  `SearchUsingMap`()

    Parameters: | S (TopoDS_Shape &) – L (TDF_Label &) – findWithoutLoc (bool) – findSubshape (bool) –
    Return type: | bool

  static `Set`(*args)
    - Create (if not exist) ShapeTool from XCAFDoc on <L>.

    Parameters: | L (TDF_Label &) –
    Return type: | Handle_XCAFDoc_ShapeTool

  static `SetAutoNaming`(*args)
    - 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().

    Parameters: | V (bool) –
    Return type: | void

  `SetExternRefs`()
    - Sets the names of references on the no-step files

    Parameters: | SHAS (TColStd_SequenceOfHAsciiString &) –
    Return type: | TDF_Label

    - Sets the names of references on the no-step files

    Parameters: | L (TDF_Label &) – SHAS (TColStd_SequenceOfHAsciiString &) –
    Return type: | None

  `SetInstanceSHUO`()
    - 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.

    Parameters: | theShape (TopoDS_Shape &) –
    Return type: | Handle_XCAFDoc_GraphNode

  `SetSHUO`()
    - 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

    Parameters: | Labels (TDF_LabelSequence &) – MainSHUOAttr (Handle_XCAFDoc_GraphNode &) –
    Return type: | bool

  `SetShape`()
    - Sets representation (TopoDS_Shape) for top-level shape

    Parameters: | L (TDF_Label &) – S (TopoDS_Shape &) –
    Return type: | None

  `UpdateAssembly`()
    - Update an assembly at label <L>

    Parameters: | L (TDF_Label &) –
    Return type: | None

  `thisown`

    The membership flag

`XCAFDoc_ShapeTool_AutoNaming`(*args)
  - Returns current auto-naming mode. See SetAutoNaming() for description.

  Return type: | bool

`XCAFDoc_ShapeTool_DumpShape`(*args)
  - Print to 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

  Parameters: | theDumpLog (Standard_OStream &) – L (TDF_Label &) – level (int) – default value is 0 deep (bool) – default value is Standard_False
  Return type: | void

`XCAFDoc_ShapeTool_FindSHUO`(*args)
  - Searchs the SHUO by labels of components from upper_usage componet to next_usage Returns null attribute if no SHUO found

  Parameters: | Labels (TDF_LabelSequence &) – theSHUOAttr (Handle_XCAFDoc_GraphNode &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetAllComponentSHUO`(*args)
  - Returns founded SHUO GraphNodes of indicated component Returns false in other case

  Parameters: | CompLabel (TDF_Label &) – SHUOAttrs (TDF_AttributeSequence &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetComponents`(*args)
  - Returns list of components of assembly Returns False if label is not assembly

  Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) – getsubchilds (bool) – default value is Standard_False
  Return type: | bool

`XCAFDoc_ShapeTool_GetExternRefs`(*args)
  - Gets the names of references on the no-step files

  Parameters: | L (TDF_Label &) – SHAS (TColStd_SequenceOfHAsciiString &) –
  Return type: | void

`XCAFDoc_ShapeTool_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_ShapeTool_GetLocation`(*args)
  - Returns location of instance

  Parameters: | L (TDF_Label &) –
  Return type: | TopLoc_Location

`XCAFDoc_ShapeTool_GetReferredShape`(*args)
  - Returns label which corresponds to a shape referred by L Returns False if label is not reference

  Parameters: | L (TDF_Label &) – Label (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetSHUO`(*args)
  - Returns founded SHUO GraphNode attribute <aSHUOAttr> Returns false in other case

  Parameters: | SHUOLabel (TDF_Label &) – aSHUOAttr (Handle_XCAFDoc_GraphNode &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetSHUONextUsage`(*args)
  - 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

  Parameters: | UpperUsageL (TDF_Label &) – Labels (TDF_LabelSequence &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetSHUOUpperUsage`(*args)
  - 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

  Parameters: | NextUsageL (TDF_Label &) – Labels (TDF_LabelSequence &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetShape`(*args)
  - To get TopoDS_Shape from shape’s label For component, returns new shape with correct location Returns False if label does not contain shape

  Parameters: | L (TDF_Label &) – S (TopoDS_Shape &) –
  Return type: | bool

  - 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

  Parameters: | L (TDF_Label &) –
  Return type: | TopoDS_Shape

`XCAFDoc_ShapeTool_GetSubShapes`(*args)
  - Returns list of labels identifying subshapes of the given shape Returns False if no subshapes are placed on that label

  Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) –
  Return type: | bool

`XCAFDoc_ShapeTool_GetUsers`(*args)
  - Returns list of labels which refer shape L as component Returns number of users (0 if shape is free)

  Parameters: | L (TDF_Label &) – Labels (TDF_LabelSequence &) – getsubchilds (bool) – default value is Standard_False
  Return type: | int

`XCAFDoc_ShapeTool_IsAssembly`(*args)
  - 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

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsComponent`(*args)
  - Return true if <L> is reference serving as component of assembly

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsCompound`(*args)
  - Returns True if the label is a label of compound, i.e. contains some sublabels This is relevant only if IsShape() is True

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsExternRef`(*args)
  - 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

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsFree`(*args)
  - 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>)

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsReference`(*args)
  - Return true if <L> is a located instance of other shape i.e. reference

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsShape`(*args)
  - Returns True if the label represents a shape (simple shape, assembly or reference)

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_IsSimpleShape`(*args)
  - Returns True if the label is a label of simple shape

  Parameters: | L (TDF_Label &) –
  Return type: | bool

`XCAFDoc_ShapeTool_NbComponents`(*args)
  - Returns number of Assembles components

  Parameters: | L (TDF_Label &) – getsubchilds (bool) – default value is Standard_False
  Return type: | int

`XCAFDoc_ShapeTool_Set`(*args)
  - Create (if not exist) ShapeTool from XCAFDoc on <L>.

  Parameters: | L (TDF_Label &) –
  Return type: | Handle_XCAFDoc_ShapeTool

`XCAFDoc_ShapeTool_SetAutoNaming`(*args)
  - 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().

  Parameters: | V (bool) –
  Return type: | void

class `XCAFDoc_Volume`(*args)

  Bases: `OCC.TDF.TDF_Attribute`

  - class methods =============

  Return type: | None

  `DumpToString`()

    XCAFDoc_Volume_DumpToString(XCAFDoc_Volume self) -> std::string

  static `Get`(*args)

    Return type: | float

    - Returns volume as argument returns false if no such attribute at the <label>

    Parameters: | label (TDF_Label &) – vol (float &) –
    Return type: | bool

  `GetHandle`()
  static `GetID`(*args)

    Return type: | Standard_GUID

  static `Set`(*args)
    - Sets a value of volume

    Parameters: | vol (float) –
    Return type: | None

    - Find, or create, an Volume attribute and set its value

    Parameters: | label (TDF_Label &) – vol (float) –
    Return type: | Handle_XCAFDoc_Volume

  `thisown`

    The membership flag

`XCAFDoc_Volume_Get`(*args)

  Return type: | float

  - Returns volume as argument returns false if no such attribute at the <label>

  Parameters: | label (TDF_Label &) – vol (float &) –
  Return type: | bool

`XCAFDoc_Volume_GetID`(*args)

  Return type: | Standard_GUID

`XCAFDoc_Volume_Set`(*args)
  - Sets a value of volume

  Parameters: | vol (float) –
  Return type: | None

  - Find, or create, an Volume attribute and set its value

  Parameters: | label (TDF_Label &) – vol (float) –
  Return type: | Handle_XCAFDoc_Volume

`register_handle`(handle, base_object)

  Inserts the handle into the base object to prevent memory corruption in certain cases

class `xcafdoc`

  Bases: `object`

  static `AssemblyGUID`(*args)
    - Returns GUID for UAttribute identifying assembly

    Return type: | Standard_GUID

  static `ColorRefGUID`(*args)
    - Return GUIDs for TreeNode representing specified types of colors

    Parameters: | type (XCAFDoc_ColorType) –
    Return type: | Standard_GUID

  static `DatumRefGUID`(*args)
    - Return GUIDs for TreeNode representing specified types of datum

    Return type: | Standard_GUID

  static `DatumTolRefGUID`(*args)
    - Return GUIDs for TreeNode representing connections Datum-Toler

    Return type: | Standard_GUID

  static `DimTolRefGUID`(*args)
    - Return GUIDs for TreeNode representing specified types of DGT

    Return type: | Standard_GUID

  static `ExternRefGUID`(*args)
    - Returns GUID for UAttribute identifying external reference on no-step file

    Return type: | Standard_GUID

  static `InvisibleGUID`(*args)

    Return type: | Standard_GUID

  static `LayerRefGUID`(*args)

    Return type: | Standard_GUID

  static `MaterialRefGUID`(*args)

    Return type: | Standard_GUID

  static `SHUORefGUID`(*args)
    - Returns GUID for UAttribute identifying specified higher usage occurrence

    Return type: | Standard_GUID

  static `ShapeRefGUID`(*args)
    - Returns GUID for TreeNode representing assembly link

    Return type: | Standard_GUID

  `thisown`

    The membership flag

`xcafdoc_AssemblyGUID`(*args)
  - Returns GUID for UAttribute identifying assembly

  Return type: | Standard_GUID

`xcafdoc_ColorRefGUID`(*args)
  - Return GUIDs for TreeNode representing specified types of colors

  Parameters: | type (XCAFDoc_ColorType) –
  Return type: | Standard_GUID

`xcafdoc_DatumRefGUID`(*args)
  - Return GUIDs for TreeNode representing specified types of datum

  Return type: | Standard_GUID

`xcafdoc_DatumTolRefGUID`(*args)
  - Return GUIDs for TreeNode representing connections Datum-Toler

  Return type: | Standard_GUID

`xcafdoc_DimTolRefGUID`(*args)
  - Return GUIDs for TreeNode representing specified types of DGT

  Return type: | Standard_GUID

`xcafdoc_ExternRefGUID`(*args)
  - Returns GUID for UAttribute identifying external reference on no-step file

  Return type: | Standard_GUID

`xcafdoc_InvisibleGUID`(*args)

  Return type: | Standard_GUID

`xcafdoc_LayerRefGUID`(*args)

  Return type: | Standard_GUID

`xcafdoc_MaterialRefGUID`(*args)

  Return type: | Standard_GUID

`xcafdoc_SHUORefGUID`(*args)
  - Returns GUID for UAttribute identifying specified higher usage occurrence

  Return type: | Standard_GUID

`xcafdoc_ShapeRefGUID`(*args)
  - Returns GUID for TreeNode representing assembly link

  Return type: | Standard_GUID