OCC.Core.XCAFDoc module¶

XCAFDoc module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_xcafdoc.html

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class XCAFDoc_Area(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

class methods =============

rtype

None

static DownCast(t)¶

DumpToString(XCAFDoc_Area self) → std::string¶

static Get()¶

Return type: float* Returns volume of area as argument and succes status returns false if no such attribute at the <label> :param label: :type label: TDF_Label :param area: :type area: float :rtype: bool

static GetID()¶

Return type: Standard_GUID

static Set()¶

Sets a value of volume

param vol

type vol

float

rtype

None* Find, or create, an Area attribute and set its value

param label

type label

TDF_Label

param area

type area

float

rtype

opencascade::handle<XCAFDoc_Area>

property thisown¶: The membership flag

class XCAFDoc_AssemblyItemId(*args)¶

Bases: object

Constructs an empty item ID.

rtype

None* Constructs an item ID from a list of strings, where every string is a label entry. param [in] thePath - list of label entries.

param thePath

type thePath

TColStd_ListOfAsciiString

rtype

None* Constructs an item ID from a formatted path, where label entries are separated by ‘/’ symbol. param [in] theString - formatted full path.

param theString

type theString

TCollection_AsciiString

rtype

None

GetPath()¶

Returns the full path as a list of label entries.

rtype

TColStd_ListOfAsciiString

Init()¶

Initializes the item ID from a list of strings, where every string is a label entry. param [in] thePath - list of label entries.

param thePath

type thePath

TColStd_ListOfAsciiString

rtype

None* Initializes the item ID from a formatted path, where label entries are separated by ‘/’ symbol. param [in] theString - formatted full path.

param theString

type theString

TCollection_AsciiString

rtype

None

IsChild()¶

Checks if this item is a child of the given item. param [in] theOther - potentially ancestor item. eturn true if the item is a child of theOther item, otherwise - false.

param theOther

type theOther

XCAFDoc_AssemblyItemId

rtype

bool

IsDirectChild()¶

Checks if this item is a direct child of the given item. param [in] theOther - potentially parent item. eturn true if the item is a direct child of theOther item, otherwise - false.

param theOther

type theOther

XCAFDoc_AssemblyItemId

rtype

bool

IsEqual()¶

Checks for item IDs equality. param [in] theOther - the item ID to check equality with. eturn true if this ID is equal to theOther, otherwise - false.

param theOther

type theOther

XCAFDoc_AssemblyItemId

rtype

bool

IsNull()¶

Returns true if the full path is empty, otherwise - false.

rtype

bool

Nullify()¶

Clears the full path.

rtype

None

ToString()¶

Returns the full pass as a formatted string.

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class XCAFDoc_AssemblyItemRef(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

@} Creates an empty reference attribute.

rtype

None

ClearExtraRef()¶

@} Reverts the reference to empty state.

rtype

None

static DownCast(t)¶

DumpToString(XCAFDoc_AssemblyItemRef self) → std::string¶

static Get()¶

Finds a reference attribute on the given label and returns it, if it is found

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>

GetGUID()¶

Returns the assembly item’s attribute that the reference points to. If the reference doesn’t point to an attribute, returns an empty GUID.

rtype

Standard_GUID

static GetID()¶

Return type: Standard_GUID

GetItem()¶

@} Returns the assembly item ID that the reference points to.

rtype

XCAFDoc_AssemblyItemId

GetSubshapeIndex()¶

Returns the assembly item’s subshape that the reference points to. If the reference doesn’t point to a subshape, returns 0.

rtype

int

HasExtraRef()¶

@name Extra reference functions. @{ Checks if the reference points on an item’s shapeindex or attribute.

rtype

bool

IsGUID()¶

Checks is the reference points to an item’s attribute.

rtype

bool

IsOrphan()¶

Checks if the reference points to a really existing item in XDE document.

rtype

bool

IsSubshapeIndex()¶

Checks is the reference points to an item’s subshape.

rtype

bool

static Set()¶

@name Set reference attribute functions. @{ Create (if not exist) a reference to an assembly item. param [in] theLabel - label to add the attribute. param [in] theItemId - assembly item ID. eturn A handle to the attribute instance.

param theLabel

type theLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>* Create (if not exist) a reference to an assembly item’s label attribute. param [in] theLabel - label to add the attribute. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s label attribute ID. eturn A handle to the attribute instance.

param theLabel

type theLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>* Create (if not exist) a reference to an assembly item’s subshape. param [in] theLabel - label to add the attribute. param [in] theItemId - assembly item ID. param [in] theShapeIndex - assembly item’s subshape index. eturn A handle to the attribute instance.

param theLabel

type theLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theShapeIndex

type theShapeIndex

int

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>

SetGUID()¶

Sets the assembly item’s label attribute that the reference points to. The base assembly item will not change.

param theAttrGUID

type theAttrGUID

Standard_GUID

rtype

None

SetItem()¶

@name Set reference data functions. @{ Sets the assembly item ID that the reference points to. Extra reference data (if any) will be cleared.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

rtype

None* Sets the assembly item ID from a list of label entries that the reference points to. Extra reference data (if any) will be cleared.

param thePath

type thePath

TColStd_ListOfAsciiString

rtype

None* Sets the assembly item ID from a formatted path that the reference points to. Extra reference data (if any) will be cleared.

param theString

type theString

TCollection_AsciiString

rtype

None

SetSubshapeIndex()¶

Sets the assembly item’s subshape that the reference points to. The base assembly item will not change.

param theShapeIndex

type theShapeIndex

int

rtype

None

property thisown¶: The membership flag

class XCAFDoc_Centroid(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

class methods =============

rtype

None

static DownCast(t)¶

DumpToString(XCAFDoc_Centroid self) → std::string¶

static Get()¶

Return type: gp_Pnt* Returns point as argument returns false if no such attribute at the <label> :param label: :type label: TDF_Label :param pnt: :type pnt: gp_Pnt :rtype: bool

static GetID()¶

Return type: Standard_GUID

Set()¶

Find, or create, a Location attribute and set it’s value the Location attribute is returned. Location methods ===============

param label

type label

TDF_Label

param pnt

type pnt

gp_Pnt

rtype

opencascade::handle<XCAFDoc_Centroid>:param pnt:

type pnt

gp_Pnt

rtype

None

property thisown¶: The membership flag

class XCAFDoc_ClippingPlaneTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

AddClippingPlane()¶

Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_ExtendedString

param theCapping

type theCapping

bool

rtype

TDF_Label* Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_HAsciiString

param theCapping

type theCapping

bool

rtype

TDF_Label* Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_ExtendedString

rtype

TDF_Label* Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_HAsciiString

rtype

TDF_Label

BaseLabel()¶

returns the label under which ClippingPlanes are stored

rtype

TDF_Label

static DownCast(t)¶

GetCapping()¶

Get capping value for given clipping plane label Return capping value

param theClippingPlaneL

type theClippingPlaneL

TDF_Label

rtype

bool* Get capping value for given clipping plane label Return true if Label is valid abd capping is exist.

param theClippingPlaneL

type theClippingPlaneL

TDF_Label

param theCapping

type theCapping

bool

rtype

bool

GetClippingPlane()¶

Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane

param theLabel

type theLabel

TDF_Label

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_ExtendedString

param theCapping

type theCapping

bool

rtype

bool* Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane

param theLabel

type theLabel

TDF_Label

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_HAsciiString

param theCapping

type theCapping

bool

rtype

bool

GetClippingPlanes()¶

Returns a sequence of clipping planes currently stored in the ClippingPlane table

param Labels

type Labels

TDF_LabelSequence

rtype

None

static GetID()¶

Return type: Standard_GUID

IsClippingPlane()¶

Returns True if label belongs to a ClippingPlane table and is a ClippingPlane definition

param theLabel

type theLabel

TDF_Label

rtype

bool

RemoveClippingPlane()¶

Removes clipping plane from the ClippingPlane table Return false and do nothing if clipping plane is referenced in at least one View

param theLabel

type theLabel

TDF_Label

rtype

bool

static Set()¶

Creates (if not exist) ClippingPlaneTool.

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_ClippingPlaneTool>

SetCapping()¶

Set new value of capping for given clipping plane label

param theClippingPlaneL

type theClippingPlaneL

TDF_Label

param theCapping

type theCapping

bool

rtype

None

UpdateClippingPlane()¶

Sets new value of plane and name to the given clipping plane label or do nothing, if the given label is not a clipping plane label

param theLabelL

type theLabelL

TDF_Label

param thePlane

type thePlane

gp_Pln

param theName

type theName

TCollection_ExtendedString

rtype

None

property thisown¶: The membership flag

class XCAFDoc_Color(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

GetAlpha()¶

Return type: Standard_ShortReal

GetColor()¶

Return type: Quantity_Color

GetColorRGBA()¶

Return type: Quantity_ColorRGBA

static GetID()¶

Return type: Standard_GUID

GetNOC()¶

Return type: Quantity_NameOfColor

GetRGB()¶

Parameters

R –

type R: float
param G
type G: float
param B
type B: float
rtype: None

Set()¶

Parameters

label –

type label: TDF_Label
param C
type C: Quantity_Color
rtype: opencascade::handle<XCAFDoc_Color>:param label:
type label: TDF_Label
param C
type C: Quantity_ColorRGBA
rtype: opencascade::handle<XCAFDoc_Color>:param label:
type label: TDF_Label
param C
type C: Quantity_NameOfColor
rtype: opencascade::handle<XCAFDoc_Color>* Find, or create, a Color attribute and set it’s value the Color attribute is returned.
param label
type label: TDF_Label
param R
type R: float
param G
type G: float
param B
type B: float
param alpha: default value is 1.0
type alpha: float
rtype: opencascade::handle<XCAFDoc_Color>:param C:
type C: Quantity_Color
rtype: None:param C:
type C: Quantity_ColorRGBA
rtype: None:param C:
type C: Quantity_NameOfColor
rtype: None:param R:
type R: float
param G
type G: float
param B
type B: float
param alpha: default value is 1.0
type alpha: float
rtype: None

property thisown¶: The membership flag

class XCAFDoc_ColorTool(*args)¶

Bases: OCC.Core.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)

param col

type col

Quantity_Color

rtype

TDF_Label* Adds a color definition to a colortable and returns its label (returns existing label if the same color is already defined)

param col

type col

Quantity_ColorRGBA

rtype

TDF_Label

BaseLabel()¶

returns the label under which colors are stored

rtype

TDF_Label

static DownCast(t)¶

FindColor()¶

Finds a color definition in a colortable and returns its label if found Returns False if color is not found in colortable

param col

type col

Quantity_Color

param lab

type lab

TDF_Label

rtype

bool* Finds a color definition in a colortable and returns its label if found Returns False if color is not found in colortable

param col

type col

Quantity_ColorRGBA

param lab

type lab

TDF_Label

rtype

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

param col

type col

Quantity_Color

rtype

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

param col

type col

Quantity_ColorRGBA

rtype

TDF_Label

GetColor()¶

Returns color defined by label lab Returns False if the label is not in colortable or does not define a color

param lab

type lab

TDF_Label

param col

type col

Quantity_Color

rtype

bool* Returns color defined by label lab Returns False if the label is not in colortable or does not define a color

param lab

type lab

TDF_Label

param col

type col

Quantity_ColorRGBA

rtype

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

param L

type L

TDF_Label

param type

type type

XCAFDoc_ColorType

param colorL

type colorL

TDF_Label

rtype

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

param L

type L

TDF_Label

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_Color

rtype

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

param L

type L

TDF_Label

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_ColorRGBA

rtype

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

param S

type S

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param colorL

type colorL

TDF_Label

rtype

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

param S

type S

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_Color

rtype

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

param S

type S

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_ColorRGBA

rtype

bool

GetColors()¶

Returns a sequence of colors currently stored in the colortable

param Labels

type Labels

TDF_LabelSequence

rtype

None

static GetID()¶

Return type: Standard_GUID

GetInstanceColor()¶

Gets the color of component that styled with SHUO structure Returns False if no sush component or color type

param theShape

type theShape

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_Color

rtype

bool* Gets the color of component that styled with SHUO structure Returns False if no sush component or color type

param theShape

type theShape

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_ColorRGBA

rtype

bool

IsColor()¶

Returns True if label belongs to a colortable and is a color definition

param lab

type lab

TDF_Label

rtype

bool

IsColorByLayer()¶

Return True if object color defined by its Layer, False if not.

param L

type L

TDF_Label

rtype

bool

IsInstanceVisible()¶

Gets the visibility status of component that styled with SHUO structure Returns False if no sush component

param theShape

type theShape

TopoDS_Shape

rtype

bool

IsSet()¶

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

param L

type L

TDF_Label

param type

type type

XCAFDoc_ColorType

rtype

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

param S

type S

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

rtype

bool

IsVisible()¶

Return True if object on this label is visible, False if invisible.

param L

type L

TDF_Label

rtype

bool

RemoveColor()¶

Removes color from the colortable

param lab

type lab

TDF_Label

rtype

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

rtype

bool

static Set()¶

Creates (if not exist) ColorTool.

param L

type L

TDF_Label

rtype

opencascade::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.

param L

type L

TDF_Label

param colorL

type colorL

TDF_Label

param type

type type

XCAFDoc_ColorType

rtype

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

param L

type L

TDF_Label

param Color

type Color

Quantity_Color

param type

type type

XCAFDoc_ColorType

rtype

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

param L

type L

TDF_Label

param Color

type Color

Quantity_ColorRGBA

param type

type type

XCAFDoc_ColorType

rtype

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

param S

type S

TopoDS_Shape

param colorL

type colorL

TDF_Label

param type

type type

XCAFDoc_ColorType

rtype

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

param S

type S

TopoDS_Shape

param Color

type Color

Quantity_Color

param type

type type

XCAFDoc_ColorType

rtype

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

param S

type S

TopoDS_Shape

param Color

type Color

Quantity_ColorRGBA

param type

type type

XCAFDoc_ColorType

rtype

bool

SetColorByLayer()¶

Set the Color defined by Layer flag on label. Do nothing if there no any object. Set UAttribute with corresponding GUID.

param shapeLabel

type shapeLabel

TDF_Label

param isColorByLayer

default value is Standard_False

type isColorByLayer

bool

rtype

None

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>

param theShape

type theShape

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_Color

param isCreateSHUO

default value is Standard_True

type isCreateSHUO

bool

rtype

bool* 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>

param theShape

type theShape

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

param color

type color

Quantity_ColorRGBA

param isCreateSHUO

default value is Standard_True

type isCreateSHUO

bool

rtype

bool

SetVisibility()¶

Set the visibility of object on label. Do nothing if there no any object. Set UAttribute with corresponding GUID.

param shapeLabel

type shapeLabel

TDF_Label

param isvisible

default value is Standard_True

type isvisible

bool

rtype

None

ShapeTool()¶

Returns internal XCAFDoc_ShapeTool tool

rtype

opencascade::handle<XCAFDoc_ShapeTool>

UnSetColor()¶

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

param L

type L

TDF_Label

param type

type type

XCAFDoc_ColorType

rtype

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

param S

type S

TopoDS_Shape

param type

type type

XCAFDoc_ColorType

rtype

bool

property thisown¶: The membership flag

class XCAFDoc_DataMapOfShapeLabel(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class XCAFDoc_Datum(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

GetDescription()¶

Return type: opencascade::handle<TCollection_HAsciiString>

static GetID()¶

Return type: Standard_GUID

GetIdentification()¶

Return type: opencascade::handle<TCollection_HAsciiString>

GetName()¶

Return type: opencascade::handle<TCollection_HAsciiString>

GetObject()¶

Returns dimension object data taken from the paren’s label and its sub-labels.

rtype

opencascade::handle<XCAFDimTolObjects_DatumObject>

Set()¶

Parameters

label –

type label: TDF_Label
param aName
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
param anIdentification
type anIdentification: TCollection_HAsciiString
rtype: opencascade::handle<XCAFDoc_Datum>:param theLabel:
type theLabel: TDF_Label
rtype: opencascade::handle<XCAFDoc_Datum>:param aName:
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
param anIdentification
type anIdentification: TCollection_HAsciiString
rtype: None

SetObject()¶

Updates parent’s label and its sub-labels with data taken from theDatumObject. Old data associated with the label will be lost.

param theDatumObject

type theDatumObject

XCAFDimTolObjects_DatumObject

rtype

None

property thisown¶: The membership flag

class XCAFDoc_DimTol(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

GetDescription()¶

Return type: opencascade::handle<TCollection_HAsciiString>

static GetID()¶

Return type: Standard_GUID

GetKind()¶

Return type: int

GetName()¶

Return type: opencascade::handle<TCollection_HAsciiString>

GetVal()¶

Return type: opencascade::handle<TColStd_HArray1OfReal>

Set()¶

Parameters

label –

type label: TDF_Label
param kind
type kind: int
param aVal
type aVal: TColStd_HArray1OfReal
param aName
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
rtype: opencascade::handle<XCAFDoc_DimTol>:param kind:
type kind: int
param aVal
type aVal: TColStd_HArray1OfReal
param aName
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
rtype: None

property thisown¶: The membership flag

class XCAFDoc_Dimension(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

GetObject()¶

Returns dimension object data taken from the paren’s label and its sub-labels.

rtype

opencascade::handle<XCAFDimTolObjects_DimensionObject>

static Set()¶

Parameters

theLabel –

type theLabel: TDF_Label
rtype: opencascade::handle<XCAFDoc_Dimension>

SetObject()¶

Updates parent’s label and its sub-labels with data taken from theDimensionObject. Old data associated with the label will be lost.

param theDimensionObject

type theDimensionObject

XCAFDimTolObjects_DimensionObject

rtype

None

property thisown¶: The membership flag

class XCAFDoc_DocumentTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static ClippingPlaneTool()¶

Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_ClippingPlaneTool>

static ClippingPlanesLabel()¶

Returns sub-label of DocLabel() with tag 8.

param acces

type acces

TDF_Label

rtype

TDF_Label

static ColorTool()¶

Creates (if it does not exist) ColorTool attribute on ColorsLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_ColorTool>

static ColorsLabel()¶

Returns sub-label of DocLabel() with tag 2.

param acces

type acces

TDF_Label

rtype

TDF_Label

static DGTsLabel()¶

Returns sub-label of DocLabel() with tag 4.

param acces

type acces

TDF_Label

rtype

TDF_Label

static DimTolTool()¶

Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_DimTolTool>

static DocLabel()¶

Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set.

param acces

type acces

TDF_Label

rtype

TDF_Label

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

Init()¶

to be called when reading this attribute from file

rtype

None

static IsXCAFDocument()¶

Parameters

Doc –

type Doc: TDocStd_Document
rtype: bool

static LayerTool()¶

Creates (if it does not exist) LayerTool attribute on LayersLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_LayerTool>

static LayersLabel()¶

Returns sub-label of DocLabel() with tag 3.

param acces

type acces

TDF_Label

rtype

TDF_Label

static MaterialTool()¶

Creates (if it does not exist) DimTolTool attribute on DGTsLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_MaterialTool>

static MaterialsLabel()¶

Returns sub-label of DocLabel() with tag 5.

param acces

type acces

TDF_Label

rtype

TDF_Label

static NotesLabel()¶

Returns sub-label of DocLabel() with tag 9.

param acces

type acces

TDF_Label

rtype

TDF_Label

static NotesTool()¶

Creates (if it does not exist) NotesTool attribute on NotesLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_NotesTool>

static Set()¶

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.

param L

type L

TDF_Label

param IsAcces

default value is Standard_True

type IsAcces

bool

rtype

opencascade::handle<XCAFDoc_DocumentTool>

static ShapeTool()¶

Creates (if it does not exist) ShapeTool attribute on ShapesLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_ShapeTool>

static ShapesLabel()¶

Returns sub-label of DocLabel() with tag 1.

param acces

type acces

TDF_Label

rtype

TDF_Label

static ViewTool()¶

Creates (if it does not exist) ViewTool attribute on ViewsLabel().

param acces

type acces

TDF_Label

rtype

opencascade::handle<XCAFDoc_ViewTool>

static ViewsLabel()¶

Returns sub-label of DocLabel() with tag 7.

param acces

type acces

TDF_Label

rtype

TDF_Label

property thisown¶: The membership flag

class XCAFDoc_Editor¶

Bases: object

static Expand()¶

Convert Shape (compound/compsolid/shell/wire) to assembly. Only compounds expanded recursively

param Doc

type Doc

TDF_Label

param Shape

type Shape

TDF_Label

param recursively

default value is Standard_True

type recursively

bool

rtype

bool* Convert all compounds in Doc to assembly

param Doc

type Doc

TDF_Label

param recursively

default value is Standard_True

type recursively

bool

rtype

bool

property thisown¶: The membership flag

class XCAFDoc_GraphNode(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

ChildIndex()¶

Return index of <Ch>, or zero if there is no such Graphnode.

param Ch

type Ch

XCAFDoc_GraphNode

rtype

int

static DownCast(t)¶

DumpToString(XCAFDoc_GraphNode self) → std::string¶

FatherIndex()¶

Return index of <F>, or zero if there is no such Graphnode.

param F

type F

XCAFDoc_GraphNode

rtype

int

static Find()¶

class methods working on the node =================================== Shortcut to search a Graph node attribute with default GraphID. Returns true if found.

param L

type L

TDF_Label

param G

type G

XCAFDoc_GraphNode

rtype

bool

GetChild()¶

Return GraphNode by index from GraphNodeSequence.

param Chindex

type Chindex

int

rtype

opencascade::handle<XCAFDoc_GraphNode>

static GetDefaultGraphID()¶

returns a default Graph ID. this ID is used by the <Set> method without explicit tree ID. Instance methods: ================

rtype

Standard_GUID

GetFather()¶

Return GraphNode by index from GraphNodeSequence.

param Findex

type Findex

int

rtype

opencascade::handle<XCAFDoc_GraphNode>

IsChild()¶

returns True if <self> is child of <F>.

param F

type F

XCAFDoc_GraphNode

rtype

bool

IsFather()¶

returns True if <self> is father of <Ch>.

param Ch

type Ch

XCAFDoc_GraphNode

rtype

bool

NbChildren()¶

return Number of Childrens GraphNodes. Implementation of Attribute methods: ===================================

rtype

int

NbFathers()¶

return Number of Fathers GraphNodes.

rtype

int

static Set()¶

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.

param L

type L

TDF_Label

rtype

opencascade::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.

param L

type L

TDF_Label

param ExplicitGraphID

type ExplicitGraphID

Standard_GUID

rtype

opencascade::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

param Ch

type Ch

XCAFDoc_GraphNode

rtype

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

param F

type F

XCAFDoc_GraphNode

rtype

int

SetGraphID()¶

Parameters

explicitID –

type explicitID: Standard_GUID
rtype: None

UnSetChild()¶

Remove <Ch> from GraphNodeSequence. and remove link between father and child.

param Ch

type Ch

XCAFDoc_GraphNode

rtype

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

param Chindex

type Chindex

int

rtype

None

UnSetFather()¶

Remove <F> from Fathers GraphNodeSequence. and remove link between father and child.

param F

type F

XCAFDoc_GraphNode

rtype

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

param Findex

type Findex

int

rtype

None

property thisown¶: The membership flag

class XCAFDoc_GraphNodeSequence(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class XCAFDoc_LayerTool(*args)¶

Bases: OCC.Core.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)

param aLayer

type aLayer

TCollection_ExtendedString

rtype

TDF_Label

BaseLabel()¶

returns the label under which Layers are stored

rtype

TDF_Label

static DownCast(t)¶

FindLayer()¶

Finds a Layer definition in a Layertable and returns its label if found Returns False if Layer is not found in Layertable

param aLayer

type aLayer

TCollection_ExtendedString

param lab

type lab

TDF_Label

rtype

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

param aLayer

type aLayer

TCollection_ExtendedString

rtype

TDF_Label

static GetID()¶

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

param lab

type lab

TDF_Label

param aLayer

type aLayer

TCollection_ExtendedString

rtype

bool

GetLayerLabels()¶

Returns a sequence of Layers currently stored in the Layertable

param Labels

type Labels

TDF_LabelSequence

rtype

None

GetLayers()¶

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

param L

type L

TDF_Label

param aLayerS

type aLayerS

TColStd_HSequenceOfExtendedString

rtype

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

param L

type L

TDF_Label

param aLayerLS

type aLayerLS

TDF_LabelSequence

rtype

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

param L

type L

TDF_Label

rtype

opencascade::handle<TColStd_HSequenceOfExtendedString>* Return sequence of strings <aLayerS> that assosiated with shape <Sh>.

param Sh

type Sh

TopoDS_Shape

param aLayerS

type aLayerS

TColStd_HSequenceOfExtendedString

rtype

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

param Sh

type Sh

TopoDS_Shape

param aLayerLS

type aLayerLS

TDF_LabelSequence

rtype

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

param Sh

type Sh

TopoDS_Shape

rtype

opencascade::handle<TColStd_HSequenceOfExtendedString>

GetShapesOfLayer()¶

Return sequanese of shape labels that assigned with layers to <ShLabels>.

param layerL

type layerL

TDF_Label

param ShLabels

type ShLabels

TDF_LabelSequence

rtype

None

IsLayer()¶

Returns True if label belongs to a Layertable and is a Layer definition

param lab

type lab

TDF_Label

rtype

bool

IsSet()¶

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

param L

type L

TDF_Label

param aLayer

type aLayer

TCollection_ExtendedString

rtype

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

param L

type L

TDF_Label

param aLayerL

type aLayerL

TDF_Label

rtype

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

param Sh

type Sh

TopoDS_Shape

param aLayer

type aLayer

TCollection_ExtendedString

rtype

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

param Sh

type Sh

TopoDS_Shape

param aLayerL

type aLayerL

TDF_Label

rtype

bool

IsVisible()¶

Return True if layer is visible, False if invisible.

param layerL

type layerL

TDF_Label

rtype

bool

RemoveLayer()¶

Removes Layer from the Layertable

param lab

type lab

TDF_Label

rtype

None

static Set()¶

Creates (if not exist) LayerTool.

param L

type L

TDF_Label

rtype

opencascade::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.

param L

type L

TDF_Label

param LayerL

type LayerL

TDF_Label

param shapeInOneLayer

default value is Standard_False

type shapeInOneLayer

bool

rtype

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.

param L

type L

TDF_Label

param aLayer

type aLayer

TCollection_ExtendedString

param shapeInOneLayer

default value is Standard_False

type shapeInOneLayer

bool

rtype

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>

param Sh

type Sh

TopoDS_Shape

param LayerL

type LayerL

TDF_Label

param shapeInOneLayer

default value is Standard_False

type shapeInOneLayer

bool

rtype

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>.

param Sh

type Sh

TopoDS_Shape

param aLayer

type aLayer

TCollection_ExtendedString

param shapeInOneLayer

default value is Standard_False

type shapeInOneLayer

bool

rtype

bool

SetVisibility()¶

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

param layerL

type layerL

TDF_Label

param isvisible

default value is Standard_True

type isvisible

bool

rtype

None

ShapeTool()¶

Returns internal XCAFDoc_ShapeTool tool

rtype

opencascade::handle<XCAFDoc_ShapeTool>

UnSetLayers()¶

Removes a link from label <L> to all layers

param L

type L

TDF_Label

rtype

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

param Sh

type Sh

TopoDS_Shape

rtype

bool

UnSetOneLayer()¶

Remove link from label <L> and Layer <aLayer>. returns False if no such layer.

param L

type L

TDF_Label

param aLayer

type aLayer

TCollection_ExtendedString

rtype

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

param L

type L

TDF_Label

param aLayerL

type aLayerL

TDF_Label

rtype

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

param Sh

type Sh

TopoDS_Shape

param aLayer

type aLayer

TCollection_ExtendedString

rtype

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

param Sh

type Sh

TopoDS_Shape

param aLayerL

type aLayerL

TDF_Label

rtype

bool

property thisown¶: The membership flag

class XCAFDoc_Location(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

class methods =============

rtype

None

static DownCast(t)¶

Get()¶

Returns True if there is a reference on the same label

rtype

TopLoc_Location

static GetID()¶

Return type: Standard_GUID

Set()¶

Find, or create, a Location attribute and set it’s value the Location attribute is returned. Location methods ===============

param label

type label

TDF_Label

param Loc

type Loc

TopLoc_Location

rtype

opencascade::handle<XCAFDoc_Location>:param Loc:

type Loc

TopLoc_Location

rtype

None

property thisown¶: The membership flag

class XCAFDoc_Material(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

GetDensName()¶

Return type: opencascade::handle<TCollection_HAsciiString>

GetDensValType()¶

Return type: opencascade::handle<TCollection_HAsciiString>

GetDensity()¶

Return type: float

GetDescription()¶

Return type: opencascade::handle<TCollection_HAsciiString>

static GetID()¶

Return type: Standard_GUID

GetName()¶

Return type: opencascade::handle<TCollection_HAsciiString>

Set()¶

Parameters

label –

type label: TDF_Label
param aName
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
param aDensity
type aDensity: float
param aDensName
type aDensName: TCollection_HAsciiString
param aDensValType
type aDensValType: TCollection_HAsciiString
rtype: opencascade::handle<XCAFDoc_Material>:param aName:
type aName: TCollection_HAsciiString
param aDescription
type aDescription: TCollection_HAsciiString
param aDensity
type aDensity: float
param aDensName
type aDensName: TCollection_HAsciiString
param aDensValType
type aDensValType: TCollection_HAsciiString
rtype: None

property thisown¶: The membership flag

class XCAFDoc_MaterialTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

AddMaterial()¶

Adds a Material definition to a table and returns its label

param aName

type aName

TCollection_HAsciiString

param aDescription

type aDescription

TCollection_HAsciiString

param aDensity

type aDensity

float

param aDensName

type aDensName

TCollection_HAsciiString

param aDensValType

type aDensValType

TCollection_HAsciiString

rtype

TDF_Label

BaseLabel()¶

returns the label under which colors are stored

rtype

TDF_Label

static DownCast(t)¶

static GetDensityForShape()¶

Find referred material and return density from it if no material –> return 0

param ShapeL

type ShapeL

TDF_Label

rtype

float

static GetID()¶

Return type: Standard_GUID

GetMaterial()¶

Returns Material assigned to <MatL> Returns False if no such Material is assigned

param MatL

type MatL

TDF_Label

param aName

type aName

TCollection_HAsciiString

param aDescription

type aDescription

TCollection_HAsciiString

param aDensity

type aDensity

float

param aDensName

type aDensName

TCollection_HAsciiString

param aDensValType

type aDensValType

TCollection_HAsciiString

rtype

bool

GetMaterialLabels()¶

Returns a sequence of materials currently stored in the material table

param Labels

type Labels

TDF_LabelSequence

rtype

None

IsMaterial()¶

Returns True if label belongs to a material table and is a Material definition

param lab

type lab

TDF_Label

rtype

bool

static Set()¶

Creates (if not exist) MaterialTool.

param L

type L

TDF_Label

rtype

opencascade::handle<XCAFDoc_MaterialTool>

SetMaterial()¶

Sets a link with GUID

param L

type L

TDF_Label

param MatL

type MatL

TDF_Label

rtype

None* Sets a link with GUID Adds a Material as necessary

param L

type L

TDF_Label

param aName

type aName

TCollection_HAsciiString

param aDescription

type aDescription

TCollection_HAsciiString

param aDensity

type aDensity

float

param aDensName

type aDensName

TCollection_HAsciiString

param aDensValType

type aDensValType

TCollection_HAsciiString

rtype

None

ShapeTool()¶

Returns internal XCAFDoc_ShapeTool tool

rtype

opencascade::handle<XCAFDoc_ShapeTool>

property thisown¶: The membership flag

class XCAFDoc_Note(*args, **kwargs)¶

Bases: OCC.Core.TDF.TDF_Attribute

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

DumpToString(XCAFDoc_Note self) → std::string¶

static Get()¶

Finds a reference attribute on the given label and returns it, if it is found

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_Note>

GetObject()¶

Returns auxiliary data object

rtype

opencascade::handle<XCAFNoteObjects_NoteObject>

static IsMine()¶

Checks if the given label represents a note.

param theLabel

type theLabel

TDF_Label

rtype

bool

IsOrphan()¶

Checks if the note isn’t linked to annotated items.

rtype

bool

Set()¶

Sets the user name and the timestamp of the note. param [in] theUserName - the user associated with the note. param [in] theTimeStamp - timestamp of the note. eturn A handle to the attribute instance.

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

rtype

None

SetObject()¶

Updates auxiliary data

param theObject

type theObject

XCAFNoteObjects_NoteObject

rtype

None

TimeStamp()¶

Returns the timestamp of the note.

rtype

TCollection_ExtendedString

UserName()¶

Returns the user name, who created the note.

rtype

TCollection_ExtendedString

property thisown¶: The membership flag

class XCAFDoc_NoteBalloon(*args)¶

Bases: OCC.Core.XCAFDoc.XCAFDoc_NoteComment

Creates an empty comment note.

rtype

None

static DownCast(t)¶

static Get()¶

Finds a reference attribute on the given label and returns it, if it is found

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_NoteBalloon>

static GetID()¶

Returns default attribute GUID

rtype

Standard_GUID

static Set()¶

Create (if not exist) a comment note on the given label. param [in] theLabel - note label. param [in] theUserName - the name of the user, who created the note. param [in] theTimeStamp - creation timestamp of the note. param [in] theComment - comment text.

param theLabel

type theLabel

TDF_Label

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theComment

type theComment

TCollection_ExtendedString

rtype

opencascade::handle<XCAFDoc_NoteBalloon>

property thisown¶: The membership flag

class XCAFDoc_NoteBinData(*args)¶

Bases: OCC.Core.XCAFDoc.XCAFDoc_Note

@} Creates an empty binary data note.

rtype

None

Data()¶

Returns byte data array.

rtype

opencascade::handle<TColStd_HArray1OfByte>

static DownCast(t)¶

DumpToString(XCAFDoc_NoteBinData self) → std::string¶

static Get()¶

Finds a binary data attribute on the given label and returns it, if it is found

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_NoteBinData>

static GetID()¶

Returns default attribute GUID

rtype

Standard_GUID

MIMEtype()¶

Returns data MIME type.

rtype

TCollection_AsciiString

Set()¶

@name Set attribute functions. @{ Create (if not exist) a binary note with data loaded from a binary file. param [in] theLabel - label to add the attribute. param [in] theUserName - the name of the user, who created the note. param [in] theTimeStamp - creation timestamp of the note. param [in] theTitle - file title. param [in] theMIMEtype - MIME type of the file. param [in] theFile - input binary file. eturn A handle to the attribute instance.

param theLabel

type theLabel

TDF_Label

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theFile

type theFile

OSD_File

rtype

opencascade::handle<XCAFDoc_NoteBinData>* Create (if not exist) a binary note byte data array. param [in] theLabel - label to add the attribute. param [in] theUserName - the name of the user, who created the note. param [in] theTimeStamp - creation timestamp of the note. param [in] theTitle - data title. param [in] theMIMEtype - MIME type of data. param [in] theData - byte data array. eturn A handle to the attribute instance.

param theLabel

type theLabel

TDF_Label

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theData

type theData

TColStd_HArray1OfByte

rtype

opencascade::handle<XCAFDoc_NoteBinData>* @name Set attribute data functions. @{ Sets title, MIME type and data from a binary file. param [in] theTitle - file title. param [in] theMIMEtype - MIME type of the file. param [in] theFile - input binary file.

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theFile

type theFile

OSD_File

rtype

bool* Sets title, MIME type and data from a byte array. param [in] theTitle - data title. param [in] theMIMEtype - MIME type of data. param [in] theData - byte data array.

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theData

type theData

TColStd_HArray1OfByte

rtype

None

Size()¶

Size of data in bytes.

rtype

int

Title()¶

@} Returns the note title.

rtype

TCollection_ExtendedString

property thisown¶: The membership flag

class XCAFDoc_NoteComment(*args)¶

Bases: OCC.Core.XCAFDoc.XCAFDoc_Note

Creates an empty comment note.

rtype

None

Comment()¶

Returns the comment text.

rtype

TCollection_ExtendedString

static DownCast(t)¶

DumpToString(XCAFDoc_NoteComment self) → std::string¶

static Get()¶

Finds a reference attribute on the given label and returns it, if it is found

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_NoteComment>

static GetID()¶

Returns default attribute GUID

rtype

Standard_GUID

Set()¶

Create (if not exist) a comment note on the given label. param [in] theLabel - note label. param [in] theUserName - the name of the user, who created the note. param [in] theTimeStamp - creation timestamp of the note. param [in] theComment - comment text.

param theLabel

type theLabel

TDF_Label

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theComment

type theComment

TCollection_ExtendedString

rtype

opencascade::handle<XCAFDoc_NoteComment>* Sets the comment text.

param theComment

type theComment

TCollection_ExtendedString

rtype

None

property thisown¶: The membership flag

class XCAFDoc_NotesTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Creates an empty notes tool.

rtype

None

AddNote()¶

@} @name Annotation functions @{ Adds the given note to the assembly item. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>* Adds the given note to the labeled item. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>

AddNoteToAttr()¶

Adds the given note to the assembly item’s attribute. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s attribute GUID. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>* Adds the given note to the labeled item’s attribute. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. param [in] theGUID - assembly item’s attribute GUID. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

param theGUID

type theGUID

Standard_GUID

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>

AddNoteToSubshape()¶

Adds the given note to the assembly item’s subshape. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. param [in] theSubshapeIndex - assembly item’s subshape index. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theSubshapeIndex

type theSubshapeIndex

int

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>* Adds the given note to the labeled item’s subshape. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. param [in] theSubshapeIndex - assembly item’s subshape index. eturn a handle to the assembly reference attribute.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

param theSubshapeIndex

type theSubshapeIndex

int

rtype

opencascade::handle<XCAFDoc_AssemblyItemRef>

CreateBalloon()¶

Create a new ‘balloon’ note. Creates a new label under the notes hive and attaches ef XCAFDoc_NoteBalloon attribute (derived ftom ef XCAFDoc_Note). param [in] theUserName - the user associated with the note. param [in] theTimeStamp - timestamp of the note. param [in] theComment - textual comment. eturn a handle to the base note attribute.

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theComment

type theComment

TCollection_ExtendedString

rtype

opencascade::handle<XCAFDoc_Note>

CreateBinData()¶

Create a new note with data loaded from a binary file. Creates a new label under the notes hive and attaches ef XCAFDoc_NoteComment attribute (derived ftom ef XCAFDoc_Note). param [in] theUserName - the user associated with the note. param [in] theTimeStamp - timestamp of the note. param [in] theTitle - file title. param [in] theMIMEtype - MIME type of the file. param [in] theFile - input binary file. eturn a handle to the base note attribute.

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theFile

type theFile

OSD_File

rtype

opencascade::handle<XCAFDoc_Note>* Create a new note with data loaded from a byte data array. Creates a new label under the notes hive and attaches ef XCAFDoc_NoteComment attribute (derived ftom ef XCAFDoc_Note). param [in] theUserName - the user associated with the note. param [in] theTimeStamp - timestamp of the note. param [in] theTitle - data title. param [in] theMIMEtype - MIME type of the file. param [in] theData - byte data array. eturn a handle to the base note attribute.

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theTitle

type theTitle

TCollection_ExtendedString

param theMIMEtype

type theMIMEtype

TCollection_AsciiString

param theData

type theData

TColStd_HArray1OfByte

rtype

opencascade::handle<XCAFDoc_Note>

CreateComment()¶

@} @name Note creation functions @{ Create a new comment note. Creates a new label under the notes hive and attaches ef XCAFDoc_NoteComment attribute (derived ftom ef XCAFDoc_Note). param [in] theUserName - the user associated with the note. param [in] theTimeStamp - timestamp of the note. param [in] theComment - textual comment. eturn a handle to the base note attribute.

param theUserName

type theUserName

TCollection_ExtendedString

param theTimeStamp

type theTimeStamp

TCollection_ExtendedString

param theComment

type theComment

TCollection_ExtendedString

rtype

opencascade::handle<XCAFDoc_Note>

DeleteAllNotes()¶

Deletes all notes. Clears all annotations. eturn number of deleted notes.

rtype

int

DeleteNote()¶

@} @name Delete note functions @{ Deletes the given note. Removes all links with items annotated by the note. param [in] theNoteLabel - note label. eturn true if the note is deleted, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

rtype

bool

DeleteNotes()¶

Deletes the given notes. Removes all links with items annotated by the notes. param [in] theNoteLabels - note label sequence. eturn number of deleted notes.

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int

DeleteOrphanNotes()¶

Deletes all notes that aren’t linked to annotated items. eturn number of deleted notes.

rtype

int

static DownCast(t)¶

DumpToString(XCAFDoc_NotesTool self) → std::string¶

FindAnnotatedItem()¶

@name Find annotated item functions @{ Finds a label of the given assembly item ID in the annotated items hive. param [in] theItemId - assembly item ID. eturn annotated item label if it is found, otherwise - null label.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

rtype

TDF_Label* Finds a label of the given labeled item in the annotated items hive. param [in] theItemLabel - item label. eturn annotated item label if it is found, otherwise - null label.

param theItemLabel

type theItemLabel

TDF_Label

rtype

TDF_Label

FindAnnotatedItemAttr()¶

Finds a label of the given assembly item’s attribute in the annotated items hive. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s attribute GUID. eturn annotated item label if it is found, otherwise - null label.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

rtype

TDF_Label* Finds a label of the given labeled item’s attribute in the annotated items hive. param [in] theItemLabel - item label. param [in] theGUID - item’s attribute GUID. eturn annotated item label if it is found, otherwise - null label.

param theItemLabel

type theItemLabel

TDF_Label

param theGUID

type theGUID

Standard_GUID

rtype

TDF_Label

FindAnnotatedItemSubshape()¶

Finds a label of the given assembly item’s subshape in the annotated items hive. param [in] theItemId - assembly item ID. param [in] theSubshapeIndex - assembly item’s subshape index. eturn annotated item label if it is found, otherwise - null label.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theSubshapeIndex

type theSubshapeIndex

int

rtype

TDF_Label* Finds a label of the given labeled item’s subshape in the annotated items hive. param [in] theItemLabel - item label. param [in] theSubshapeIndex - labeled item’s subshape index. eturn annotated item label if it is found, otherwise - null label.

param theItemLabel

type theItemLabel

TDF_Label

param theSubshapeIndex

type theSubshapeIndex

int

rtype

TDF_Label

GetAnnotatedItems()¶

Returns all labels from the annotated items hive. The label sequence isn’t cleared beforehand. param [out] theNoteLabels - sequence of labels.

param theLabels

type theLabels

TDF_LabelSequence

rtype

None

GetAnnotatedItemsLabel()¶

Returns the label of the annotated items hive.

rtype

TDF_Label

GetAttrNotes()¶

Gets all note labels of the assembly item’s attribute. Notes linked to the item itself or to item’s subshapes aren’t taken into account. The label sequence isn’t cleared beforehand. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s attribute GUID. param [out] theNoteLabels - sequence of labels. eturn number of added labels.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int* Gets all note labels of the labeled item’s attribute. Notes linked to the item itself or to item’s subshapes aren’t taken into account. The label sequence isn’t cleared beforehand. param [in] theItemLabel - item label. param [in] theGUID - item’s attribute GUID. param [out] theNoteLabels - sequence of labels. eturn number of added labels.

param theItemLabel

type theItemLabel

TDF_Label

param theGUID

type theGUID

Standard_GUID

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int

static GetID()¶

Returns default attribute GUID

rtype

Standard_GUID

GetNotes()¶

Returns all labels from the notes hive. The label sequence isn’t cleared beforehand. param [out] theNoteLabels - sequence of labels.

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

None* @} @name Get notes from annotated items functions @{ Gets all note labels of the assembly item. Notes linked to item’s subshapes or attributes aren’t taken into account. The label sequence isn’t cleared beforehand. param [in] theItemId - assembly item ID. param [out] theNoteLabels - sequence of labels. eturn number of added labels.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int* Gets all note labels of the labeled item. Notes linked to item’s attributes aren’t taken into account. The label sequence isn’t cleared beforehand. param [in] theItemLabel - item label. param [out] theNoteLabels - sequence of labels. eturn number of added labels.

param theItemLabel

type theItemLabel

TDF_Label

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int

GetNotesLabel()¶

Returns the label of the notes hive.

rtype

TDF_Label

GetOrphanNotes()¶

Returns note labels that aren’t linked to annotated items. The label sequence isn’t cleared beforehand. param [out] theNoteLabels - sequence of labels.

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

None

GetSubshapeNotes()¶

Gets all note labels of the annotated item. Notes linked to the item itself or to item’s attributes taken into account. The label sequence isn’t cleared beforehand. param [in] theItemId - assembly item ID. param [in] theSubshapeIndex - assembly item’s subshape index. param [out] theNoteLabels - sequence of labels. eturn number of added labels.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theSubshapeIndex

type theSubshapeIndex

int

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

int

IsAnnotatedItem()¶

Checks if the given assembly item is annotated. param [in] theItemId - assembly item ID. eturn true if the item is annotated, otherwise - false.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

rtype

bool* Checks if the given labeled item is annotated. param [in] theItemLabel - item label. eturn true if the item is annotated, otherwise - false.

param theItemLabel

type theItemLabel

TDF_Label

rtype

bool

NbAnnotatedItems()¶

Returns the number of labels in the annotated items hive.

rtype

int

NbNotes()¶

Returns the number of labels in the notes hive.

rtype

int

NbOrphanNotes()¶

@} @name Orphan annotated items functions @{ Returns number of notes that aren’t linked to annotated items.

rtype

int

RemoveAllAttrNotes()¶

Removes all notes from the assembly item’s attribute. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s attribute GUID. param [in] theDelIfOrphan - deletes removed notes from the notes hive if there are no more annotated items linked with the notes. eturn true if the notes are removed, otherwise - false.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool* Removes all notes from the labeled item’s attribute. param [in] theItemLabel - item label. param [in] theGUID - labeled item’s attribute GUID. param [in] theDelIfOrphan - deletes removed notes from the notes hive if there are no more annotated items linked with the notes. eturn true if the notes are removed, otherwise - false.

param theItemLabel

type theItemLabel

TDF_Label

param theGUID

type theGUID

Standard_GUID

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

RemoveAllNotes()¶

Removes all notes from the assembly item. param [in] theItemId - assembly item ID. param [in] theDelIfOrphan - deletes removed notes from the notes hive if there are no more annotated items linked with the notes. eturn true if the notes are removed, otherwise - false.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool* Removes all notes from the labeled item. param [in] theItemLabel - item label. param [in] theDelIfOrphan - deletes removed notes from the notes hive if there are no more annotated items linked with the notes. eturn true if the notes are removed, otherwise - false.

param theItemLabel

type theItemLabel

TDF_Label

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

RemoveAllSubshapeNotes()¶

Removes all notes from the assembly item’s subshape. param [in] theItemId - assembly item ID. param [in] theSubshapeIndex - assembly item’s subshape index. param [in] theDelIfOrphan - deletes removed notes from the notes hive if there are no more annotated items linked with the notes. eturn true if the notes are removed, otherwise - false.

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theSubshapeIndex

type theSubshapeIndex

int

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

RemoveAttrNote()¶

Removes a note from the assembly item’s attribute. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. param [in] theGUID - assembly item’s attribute GUID. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more assembly item’s attribute linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theGUID

type theGUID

Standard_GUID

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool* Removes a note from the labeled item’s attribute. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. param [in] theGUID - labeled item’s attribute GUID. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more assembly item’s attribute linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

param theGUID

type theGUID

Standard_GUID

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

RemoveNote()¶

@} @name Remove annotation functions @{ Removes the given note from the assembly item. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more assembly items linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool* Removes the given note from the labeled item. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more labeled items linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

RemoveSubshapeNote()¶

Removes the given note from the assembly item’s subshape. param [in] theNoteLabel - note label. param [in] theItemId - assembly item ID. param [in] theSubshapeIndex - assembly item’s subshape index. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more assembly item’s subshape linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemId

type theItemId

XCAFDoc_AssemblyItemId

param theSubshapeIndex

type theSubshapeIndex

int

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool* Removes the given note from the labeled item’s subshape. param [in] theNoteLabel - note label. param [in] theItemLabel - item label. param [in] theSubshapeIndex - labeled item’s subshape index. param [in] theDelIfOrphan - deletes the note from the notes hive if there are no more assembly item’s subshape linked with the note. eturn true if the note is removed, otherwise - false.

param theNoteLabel

type theNoteLabel

TDF_Label

param theItemLabel

type theItemLabel

TDF_Label

param theSubshapeIndex

type theSubshapeIndex

int

param theDelIfOrphan

default value is Standard_False

type theDelIfOrphan

bool

rtype

bool

static Set()¶

Create (if not exist) a notes tool from XCAFDoc on theLabel.

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<XCAFDoc_NotesTool>

property thisown¶: The membership flag

class XCAFDoc_ShapeMapTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Creates an empty tool

rtype

None

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

GetMap()¶

Return type: TopTools_IndexedMapOfShape

IsSubShape()¶

Checks whether shape is subshape of shape stored on label shapeL

param sub

type sub

TopoDS_Shape

rtype

bool

static Set()¶

Create (if not exist) ShapeTool from XCAFDoc on <L>.

param L

type L

TDF_Label

rtype

opencascade::handle<XCAFDoc_ShapeMapTool>

SetShape()¶

Sets representation (TopoDS_Shape) for top-level shape

param S

type S

TopoDS_Shape

rtype

None

property thisown¶: The membership flag

class XCAFDoc_ShapeTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

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

rtype

None

AddComponent()¶

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

param assembly

type assembly

TDF_Label

param comp

type comp

TDF_Label

param Loc

type Loc

TopLoc_Location

rtype

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

param assembly

type assembly

TDF_Label

param comp

type comp

TopoDS_Shape

param expand

default value is Standard_False

type expand

bool

rtype

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.

param S

type S

TopoDS_Shape

param makeAssembly

default value is Standard_True

type makeAssembly

bool

param makePrepare

default value is Standard_True

type makePrepare

bool

rtype

TDF_Label

AddSubShape()¶

Adds a label for subshape of shape stored on label shapeL Returns Null label if it is not subshape

param shapeL

type shapeL

TDF_Label

param sub

type sub

TopoDS_Shape

rtype

TDF_Label* 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

param shapeL

type shapeL

TDF_Label

param sub

type sub

TopoDS_Shape

param addedSubShapeL

type addedSubShapeL

TDF_Label

rtype

bool

static AutoNaming()¶

Returns current auto-naming mode. See SetAutoNaming() for description.

rtype

bool

BaseLabel()¶

returns the label under which shapes are stored

rtype

TDF_Label

ComputeShapes()¶

recursive

param L

type L

TDF_Label

rtype

None

ComputeSimpleShapes()¶

Compute a sequence of simple shapes

rtype

None

static DownCast(t)¶

Dump()¶

Parameters

theDumpLog –

type theDumpLog: Standard_OStream
param deep
type deep: bool
rtype: Standard_OStream

static DumpShape()¶

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

param theDumpLog

type theDumpLog

Standard_OStream

param L

type L

TDF_Label

param level

default value is 0

type level

int

param deep

default value is Standard_False

type deep

bool

rtype

void

DumpToString(XCAFDoc_ShapeTool self) → std::string¶

Expand()¶

Convert Shape (compound/compsolid/shell/wire) to assembly

param Shape

type Shape

TDF_Label

rtype

bool

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

param theShape

type theShape

TopoDS_Shape

param Labels

type Labels

TDF_LabelSequence

rtype

bool

FindMainShape()¶

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)

param sub

type sub

TopoDS_Shape

rtype

TDF_Label

FindMainShapeUsingMap()¶

Parameters

sub –

type sub: TopoDS_Shape
rtype: TDF_Label

static FindSHUO()¶

Searchs the SHUO by labels of components from upper_usage componet to next_usage Returns null attribute if no SHUO found

param Labels

type Labels

TDF_LabelSequence

param theSHUOAttr

type theSHUOAttr

XCAFDoc_GraphNode

rtype

bool

FindShape()¶

Returns the label corresponding to shape S (searches among top-level shapes, not including subcomponents of assemblies and subshapes) If findInstance is False (default), seach for the input shape without location If findInstance is True, searches for the input shape as is. Return True if <S> is found.

param S

type S

TopoDS_Shape

param L

type L

TDF_Label

param findInstance

default value is Standard_False

type findInstance

bool

rtype

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

param S

type S

TopoDS_Shape

param findInstance

default value is Standard_False

type findInstance

bool

rtype

TDF_Label

FindSubShape()¶

Finds a label for subshape of shape stored on label shapeL Returns Null label if it is not found

param shapeL

type shapeL

TDF_Label

param sub

type sub

TopoDS_Shape

param L

type L

TDF_Label

rtype

bool

static GetAllComponentSHUO()¶

Returns founded SHUO GraphNodes of indicated component Returns false in other case

param CompLabel

type CompLabel

TDF_Label

param SHUOAttrs

type SHUOAttrs

TDF_AttributeSequence

rtype

bool

GetAllSHUOInstances()¶

Seaching for component shapes that styled by shuo Returns empty sequence of shape if no any shape is found.

param theSHUO

type theSHUO

XCAFDoc_GraphNode

param theSHUOShapeSeq

type theSHUOShapeSeq

TopTools_SequenceOfShape

rtype

bool

static GetComponents()¶

Returns list of components of assembly Returns False if label is not assembly

param L

type L

TDF_Label

param Labels

type Labels

TDF_LabelSequence

param getsubchilds

default value is Standard_False

type getsubchilds

bool

rtype

bool

static GetExternRefs()¶

Gets the names of references on the no-step files

param L

type L

TDF_Label

param SHAS

type SHAS

TColStd_SequenceOfHAsciiString

rtype

void

GetFreeShapes()¶

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

param FreeLabels

type FreeLabels

TDF_LabelSequence

rtype

None

static GetID()¶

Return type: Standard_GUID

static GetLocation()¶

Returns location of instance

param L

type L

TDF_Label

rtype

TopLoc_Location

GetNamedProperties()¶

Method to get NamedData attribute assigned to the given shape label. @param theLabel [in] the shape Label @param theToCreate [in] create and assign attribute if it doesn’t exist returns Handle to the NamedData attribute or Null if there is none

param theLabel

type theLabel

TDF_Label

param theToCreate

default value is Standard_False

type theToCreate

bool

rtype

opencascade::handle<TDataStd_NamedData>* Method to get NamedData attribute assigned to a label of the given shape. @param theShape [in] input shape @param theToCreate [in] create and assign attribute if it doesn’t exist returns Handle to the NamedData attribute or Null if there is none

param theShape

type theShape

TopoDS_Shape

param theToCreate

default value is Standard_False

type theToCreate

bool

rtype

opencascade::handle<TDataStd_NamedData>

static GetReferredShape()¶

Returns label which corresponds to a shape referred by L Returns False if label is not reference

param L

type L

TDF_Label

param Label

type Label

TDF_Label

rtype

bool

static GetSHUO()¶

Returns founded SHUO GraphNode attribute <aSHUOAttr> Returns false in other case

param SHUOLabel

type SHUOLabel

TDF_Label

param aSHUOAttr

type aSHUOAttr

XCAFDoc_GraphNode

rtype

bool

GetSHUOInstance()¶

Search for the component shape that styled by shuo Returns null shape if no any shape is found.

param theSHUO

type theSHUO

XCAFDoc_GraphNode

rtype

TopoDS_Shape

static GetSHUONextUsage()¶

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

param UpperUsageL

type UpperUsageL

TDF_Label

param Labels

type Labels

TDF_LabelSequence

rtype

bool

static GetSHUOUpperUsage()¶

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

param NextUsageL

type NextUsageL

TDF_Label

param Labels

type Labels

TDF_LabelSequence

rtype

bool

static GetShape()¶

To get TopoDS_Shape from shape’s label For component, returns new shape with correct location Returns False if label does not contain shape

param L

type L

TDF_Label

param S

type S

TopoDS_Shape

rtype

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

param L

type L

TDF_Label

rtype

TopoDS_Shape

GetShapes()¶

Returns a sequence of all top-level shapes

param Labels

type Labels

TDF_LabelSequence

rtype

None

static GetSubShapes()¶

Returns list of labels identifying subshapes of the given shape Returns False if no subshapes are placed on that label

param L

type L

TDF_Label

param Labels

type Labels

TDF_LabelSequence

rtype

bool

static GetUsers()¶

Returns list of labels which refer shape L as component Returns number of users (0 if shape is free)

param L

type L

TDF_Label

param Labels

type Labels

TDF_LabelSequence

param getsubchilds

default value is Standard_False

type getsubchilds

bool

rtype

int

Init()¶

set hasComponents into false

rtype

None

static IsAssembly()¶

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

param L

type L

TDF_Label

rtype

bool

static IsComponent()¶

Return true if <L> is reference serving as component of assembly

param L

type L

TDF_Label

rtype

bool

static IsCompound()¶

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

param L

type L

TDF_Label

rtype

bool

static IsExternRef()¶

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

param L

type L

TDF_Label

rtype

bool

static IsFree()¶

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

param L

type L

TDF_Label

rtype

bool

static IsReference()¶

Return true if <L> is a located instance of other shape i.e. reference

param L

type L

TDF_Label

rtype

bool

static IsShape()¶

Returns True if the label represents a shape (simple shape, assembly or reference)

param L

type L

TDF_Label

rtype

bool

static IsSimpleShape()¶

Returns True if the label is a label of simple shape

param L

type L

TDF_Label

rtype

bool

IsSubShape()¶

Return true if <L> is subshape of the top-level shape

param L

type L

TDF_Label

rtype

bool* Checks whether shape is subshape of shape stored on label shapeL

param shapeL

type shapeL

TDF_Label

param sub

type sub

TopoDS_Shape

rtype

bool

IsTopLevel()¶

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

param L

type L

TDF_Label

rtype

bool

static NbComponents()¶

Returns number of Assembles components

param L

type L

TDF_Label

param getsubchilds

default value is Standard_False

type getsubchilds

bool

rtype

int

NewShape()¶

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

rtype

TDF_Label

RemoveComponent()¶

Removes a component from its assembly

param comp

type comp

TDF_Label

rtype

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.

param SHUOLabel

type SHUOLabel

TDF_Label

rtype

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

param L

type L

TDF_Label

param removeCompletely

default value is Standard_True

type removeCompletely

bool

rtype

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

param S

type S

TopoDS_Shape

param L

type L

TDF_Label

param findInstance

default value is Standard_True

type findInstance

bool

param findComponent

default value is Standard_True

type findComponent

bool

param findSubshape

default value is Standard_True

type findSubshape

bool

rtype

bool

SearchUsingMap()¶

Parameters

S –

type S: TopoDS_Shape
param L
type L: TDF_Label
param findWithoutLoc
type findWithoutLoc: bool
param findSubshape
type findSubshape: bool
rtype: bool

static Set()¶

Create (if not exist) ShapeTool from XCAFDoc on <L>.

param L

type L

TDF_Label

rtype

opencascade::handle<XCAFDoc_ShapeTool>

static SetAutoNaming()¶

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

param V

type V

bool

rtype

void

SetExternRefs()¶

Sets the names of references on the no-step files

param SHAS

type SHAS

TColStd_SequenceOfHAsciiString

rtype

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

param L

type L

TDF_Label

param SHAS

type SHAS

TColStd_SequenceOfHAsciiString

rtype

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.

param theShape

type theShape

TopoDS_Shape

rtype

opencascade::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

param Labels

type Labels

TDF_LabelSequence

param MainSHUOAttr

type MainSHUOAttr

XCAFDoc_GraphNode

rtype

bool

SetShape()¶

Sets representation (TopoDS_Shape) for top-level shape.

param L

type L

TDF_Label

param S

type S

TopoDS_Shape

rtype

None

UpdateAssemblies()¶

Top-down update for all assembly compounds stored in the document.

rtype

None

property thisown¶: The membership flag

class XCAFDoc_View(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

GetObject()¶

Returns view object data taken from the paren’s label and its sub-labels.

rtype

opencascade::handle<XCAFView_Object>

static Set()¶

Parameters

theLabel –

type theLabel: TDF_Label
rtype: opencascade::handle<XCAFDoc_View>

SetObject()¶

Updates parent’s label and its sub-labels with data taken from theViewObject. Old data associated with the label will be lost.

param theViewObject

type theViewObject

XCAFView_Object

rtype

None

property thisown¶: The membership flag

class XCAFDoc_ViewTool(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

AddView()¶

Adds a view definition to a View table and returns its label

rtype

TDF_Label

BaseLabel()¶

Returns the label under which Views are stored

rtype

TDF_Label

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

GetRefAnnotationLabel()¶

Returns Annotation labels defined for label theViewL Returns False if the theViewL is not in View table

param theViewL

type theViewL

TDF_Label

param theAnnotationLabels

type theAnnotationLabels

TDF_LabelSequence

rtype

bool

GetRefClippingPlaneLabel()¶

Returns ClippingPlane labels defined for label theViewL Returns False if the theViewL is not in View table

param theViewL

type theViewL

TDF_Label

param theClippingPlaneLabels

type theClippingPlaneLabels

TDF_LabelSequence

rtype

bool

GetRefGDTLabel()¶

Returns GDT labels defined for label theViewL Returns False if the theViewL is not in View table

param theViewL

type theViewL

TDF_Label

param theGDTLabels

type theGDTLabels

TDF_LabelSequence

rtype

bool

GetRefNoteLabel()¶

Returns Notes labels defined for label theViewL Returns False if the theViewL is not in View table

param theViewL

type theViewL

TDF_Label

param theNoteLabels

type theNoteLabels

TDF_LabelSequence

rtype

bool

GetRefShapeLabel()¶

Returns shape labels defined for label theViewL Returns False if the theViewL is not in View table

param theViewL

type theViewL

TDF_Label

param theShapeLabels

type theShapeLabels

TDF_LabelSequence

rtype

bool

GetViewLabels()¶

Returns a sequence of View labels currently stored in the View table

param theLabels

type theLabels

TDF_LabelSequence

rtype

None

GetViewLabelsForAnnotation()¶

Returns all View labels defined for label AnnotationL

param theAnnotationL

type theAnnotationL

TDF_Label

param theViews

type theViews

TDF_LabelSequence

rtype

bool

GetViewLabelsForClippingPlane()¶

Returns all View labels defined for label ClippingPlaneL

param theClippingPlaneL

type theClippingPlaneL

TDF_Label

param theViews

type theViews

TDF_LabelSequence

rtype

bool

GetViewLabelsForGDT()¶

Returns all View labels defined for label GDTL

param theGDTL

type theGDTL

TDF_Label

param theViews

type theViews

TDF_LabelSequence

rtype

bool

GetViewLabelsForNote()¶

Returns all View labels defined for label NoteL

param theNoteL

type theNoteL

TDF_Label

param theViews

type theViews

TDF_LabelSequence

rtype

bool

GetViewLabelsForShape()¶

Returns all View labels defined for label ShapeL

param theShapeL

type theShapeL

TDF_Label

param theViews

type theViews

TDF_LabelSequence

rtype

bool

IsLocked()¶

Returns true if the given View is marked as locked

param theViewL

type theViewL

TDF_Label

rtype

bool

IsView()¶

Returns True if label belongs to a View table and is a View definition

param theLabel

type theLabel

TDF_Label

rtype

bool

Lock()¶

Mark the given View as locked

param theViewL

type theViewL

TDF_Label

rtype

None

RemoveView()¶

Remove View

param theViewL

type theViewL

TDF_Label

rtype

None

static Set()¶

Creates (if not exist) ViewTool.

param L

type L

TDF_Label

rtype

opencascade::handle<XCAFDoc_ViewTool>

SetClippingPlanes()¶

Set Clipping planes to given View

param theClippingPlaneLabels

type theClippingPlaneLabels

TDF_LabelSequence

param theViewL

type theViewL

TDF_Label

rtype

None

SetView()¶

Sets a link with GUID

param theShapes

type theShapes

TDF_LabelSequence

param theGDTs

type theGDTs

TDF_LabelSequence

param theClippingPlanes

type theClippingPlanes

TDF_LabelSequence

param theNotes

type theNotes

TDF_LabelSequence

param theAnnotations

type theAnnotations

TDF_LabelSequence

param theViewL

type theViewL

TDF_Label

rtype

None* Sets a link with GUID

param theShapes

type theShapes

TDF_LabelSequence

param theGDTs

type theGDTs

TDF_LabelSequence

param theClippingPlanes

type theClippingPlanes

TDF_LabelSequence

param theViewL

type theViewL

TDF_Label

rtype

None* Sets a link with GUID

param theShapes

type theShapes

TDF_LabelSequence

param theGDTs

type theGDTs

TDF_LabelSequence

param theViewL

type theViewL

TDF_Label

rtype

None

Unlock()¶

Unlock the given View

param theViewL

type theViewL

TDF_Label

rtype

None

property thisown¶: The membership flag

class XCAFDoc_Volume(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

class methods =============

rtype

None

static DownCast(t)¶

DumpToString(XCAFDoc_Volume self) → std::string¶

static Get()¶

Return type: float* Returns volume as argument returns false if no such attribute at the <label> :param label: :type label: TDF_Label :param vol: :type vol: float :rtype: bool

static GetID()¶

Return type: Standard_GUID

static Set()¶

Sets a value of volume

param vol

type vol

float

rtype

None* Find, or create, an Volume attribute and set its value

param label

type label

TDF_Label

param vol

type vol

float

rtype

opencascade::handle<XCAFDoc_Volume>

property thisown¶: The membership flag

class xcafdoc¶

Bases: object

static AssemblyGUID()¶

class for containing GraphNodes. Returns GUID for UAttribute identifying assembly

rtype

Standard_GUID

static ColorByLayerGUID()¶

Return type: Standard_GUID

static ColorRefGUID()¶

Return GUIDs for TreeNode representing specified types of colors

param type

type type

XCAFDoc_ColorType

rtype

Standard_GUID

static DatumRefGUID()¶

Return GUIDs for TreeNode representing specified types of datum

rtype

Standard_GUID

static DatumTolRefGUID()¶

Return GUIDs for TreeNode representing connections Datum-Toler

rtype

Standard_GUID

static DimTolRefGUID()¶

Return GUIDs for TreeNode representing specified types of DGT

rtype

Standard_GUID

static DimensionRefFirstGUID()¶

Return GUIDs for TreeNode representing specified types of Dimension

rtype

Standard_GUID

static DimensionRefSecondGUID()¶

Return GUIDs for TreeNode representing specified types of Dimension

rtype

Standard_GUID

static ExternRefGUID()¶

Returns GUID for UAttribute identifying external reference on no-step file

rtype

Standard_GUID

static GeomToleranceRefGUID()¶

Return GUIDs for TreeNode representing specified types of GeomTolerance

rtype

Standard_GUID

static InvisibleGUID()¶

Return type: Standard_GUID

static LayerRefGUID()¶

Return type: Standard_GUID

static LockGUID()¶

Returns GUID for UAttribute identifying lock flag

rtype

Standard_GUID

static MaterialRefGUID()¶

Return type: Standard_GUID

static NoteRefGUID()¶

Return GUIDs for representing notes

rtype

Standard_GUID

static SHUORefGUID()¶

Returns GUID for UAttribute identifying specified higher usage occurrence

rtype

Standard_GUID

static ShapeRefGUID()¶

Returns GUID for TreeNode representing assembly link

rtype

Standard_GUID

static ViewRefAnnotationGUID()¶

Return type: Standard_GUID

static ViewRefGDTGUID()¶

Return GUIDs for TreeNode representing specified types of View

rtype

Standard_GUID

static ViewRefGUID()¶

Return GUIDs for TreeNode representing specified types of View

rtype

Standard_GUID

static ViewRefNoteGUID()¶

Return GUIDs for GraphNode representing specified types of View

rtype

Standard_GUID

static ViewRefPlaneGUID()¶

Return GUIDs for TreeNode representing specified types of View

rtype

Standard_GUID

static ViewRefShapeGUID()¶

Return GUIDs for TreeNode representing specified types of View

rtype

Standard_GUID

property thisown¶: The membership flag