OCC.Core.TDataXtd module¶

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

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class TDataXtd_Array1OfTrsf(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class TDataXtd_Axis(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataXtd_Axis self) → std::string¶

static GetID()¶

class methods ============= Returns the GUID for an axis.

rtype

Standard_GUID

static Set()¶

Finds or creates an axis attribute defined by the label. In the case of a creation of an axis, a compatible named shape should already be associated with label. Exceptions Standard_NullObject if no compatible named shape is associated with the label.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Axis>* Find, or create, an Axis attribute and set <P> as generated in the associated NamedShape. Axis methods ============

param label

type label

TDF_Label

param L

type L

gp_Lin

rtype

opencascade::handle<TDataXtd_Axis>

property thisown¶: The membership flag

class TDataXtd_Constraint(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

ClearGeometries()¶

Removes the geometries involved in the constraint or dimension from the array of topological attributes where they are stored.

rtype

None

static CollectChildConstraints()¶

collects constraints on Childs for label <aLabel>

param aLabel

type aLabel

TDF_Label

param TheList

type TheList

TDF_LabelList

rtype

void

static DownCast(t)¶

DumpToString(TDataXtd_Constraint self) → std::string¶

GetGeometry()¶

Returns the integer index Index used to access the array of the constraint or stored geometries of a dimension Index has a value between 1 and 4. methods to write constraint fields (use builder) ==================================

param Index

type Index

int

rtype

opencascade::handle<TNaming_NamedShape>

static GetID()¶

Returns the GUID for constraints.

rtype

Standard_GUID

GetPlane()¶

Returns the topological attribute of the plane used for planar - i.e., 2D - constraints. This plane is attached to another label. If the constraint is not planar, in other words, 3D, this function will return a null handle.

rtype

opencascade::handle<TNaming_NamedShape>

GetType()¶

Returns the type of constraint. This will be an element of the TDataXtd_ConstraintEnum enumeration.

rtype

TDataXtd_ConstraintEnum

GetValue()¶

Returns the value of a dimension. This value is a reference to a TDataStd_Real attribute. If the attribute is not a dimension, this value will be 0. Use IsDimension to test this condition.

rtype

opencascade::handle<TDataStd_Real>

Inverted()¶

Parameters

status –

type status: bool
rtype: None:rtype: bool

IsDimension()¶

Returns true if this constraint attribute is a dimension, and therefore has a value.

rtype

bool

IsPlanar()¶

Returns true if this constraint attribute is two-dimensional.

rtype

bool

NbGeometries()¶

Returns the number of geometry attributes in this constraint attribute. This number will be between 1 and 4.

rtype

int

Reversed()¶

Parameters

status –

type status: bool
rtype: None:rtype: bool

Set()¶

Finds or creates the 2D constraint attribute defined by the planar topological attribute plane and the label label. Constraint methods ==================

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Constraint>* Finds or creates the constraint attribute defined by the topological attribute G1 and the constraint type type.

param type

type type

TDataXtd_ConstraintEnum

param G1

type G1

TNaming_NamedShape

rtype

None* Finds or creates the constraint attribute defined by the topological attributes G1 and G2, and by the constraint type type.

param type

type type

TDataXtd_ConstraintEnum

param G1

type G1

TNaming_NamedShape

param G2

type G2

TNaming_NamedShape

rtype

None* Finds or creates the constraint attribute defined by the topological attributes G1, G2 and G3, and by the constraint type type.

param type

type type

TDataXtd_ConstraintEnum

param G1

type G1

TNaming_NamedShape

param G2

type G2

TNaming_NamedShape

param G3

type G3

TNaming_NamedShape

rtype

None* Finds or creates the constraint attribute defined by the topological attributes G1, G2, G3 and G4, and by the constraint type type. methods to read constraint fields =================================

param type

type type

TDataXtd_ConstraintEnum

param G1

type G1

TNaming_NamedShape

param G2

type G2

TNaming_NamedShape

param G3

type G3

TNaming_NamedShape

param G4

type G4

TNaming_NamedShape

rtype

None

SetGeometry()¶

Finds or creates the underlying geometry of the constraint defined by the topological attribute G and the integer index Index.

param Index

type Index

int

param G

type G

TNaming_NamedShape

rtype

None

SetPlane()¶

Finds or creates the plane of the 2D constraint attribute, defined by the planar topological attribute plane.

param plane

type plane

TNaming_NamedShape

rtype

None

SetType()¶

Finds or creates the type of constraint CTR.

param CTR

type CTR

TDataXtd_ConstraintEnum

rtype

None

SetValue()¶

Finds or creates the real number value V of the dimension constraint attribute.

param V

type V

TDataStd_Real

rtype

None

Verified()¶

Returns true if this constraint attribute is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true.

rtype

bool* Returns true if this constraint attribute defined by status is valid. By default, true is returned. When the value of a dimension is changed or when a geometry is moved, false is returned until the solver sets it back to true. If status is false, Verified is set to false.

param status

type status

bool

rtype

None

property thisown¶: The membership flag

class TDataXtd_Geometry(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

This and the next methods are used to retrieve underlying geometry of the NamedShape, even if noone Geometry Attribute is associated . if not found or not compliant geometry return False.

rtype

None

static Axis()¶

Returns the axis attribute defined by the label L and the axis G.

param L

type L

TDF_Label

param G

type G

gp_Ax1

rtype

bool* Returns the axis attribute defined by the topological attribute S and the axis G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Ax1

rtype

bool

static Circle()¶

Returns the circle attribute defined by the label L and the circle G.

param L

type L

TDF_Label

param G

type G

gp_Circ

rtype

bool* Returns the circle attribute defined by the topological attribute S and the circle G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Circ

rtype

bool

static Cylinder()¶

Returns the cylinder attribute defined by the label L and the cylinder G.

param L

type L

TDF_Label

param G

type G

gp_Cylinder

rtype

bool* Returns the cylinder attribute defined by the topological attribute S and the cylinder G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Cylinder

rtype

bool

static DownCast(t)¶

DumpToString(TDataXtd_Geometry self) → std::string¶

static Ellipse()¶

Returns the ellipse attribute defined by the label L and the ellipse G.

param L

type L

TDF_Label

param G

type G

gp_Elips

rtype

bool* Returns the ellipse attribute defined by the topological attribute S and the ellipse G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Elips

rtype

bool

static GetID()¶

Returns the GUID for geometry attributes.

rtype

Standard_GUID

GetType()¶

Returns the type of geometric construction.

rtype

TDataXtd_GeometryEnum

static Line()¶

Returns the line attribute defined by the label L and the line G.

param L

type L

TDF_Label

param G

type G

gp_Lin

rtype

bool* Returns the line attribute defined by the topological attribute S and the line G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Lin

rtype

bool

static Plane()¶

Returns the plane attribute defined by the label L and the plane G.

param L

type L

TDF_Label

param G

type G

gp_Pln

rtype

bool* Returns the plane attribute defined by the topological attribute S and the plane G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Pln

rtype

bool

static Point()¶

Returns the point attribute defined by the label L and the point G.

param L

type L

TDF_Label

param G

type G

gp_Pnt

rtype

bool* Returns the point attribute defined by the topological attribute S and the point G.

param S

type S

TNaming_NamedShape

param G

type G

gp_Pnt

rtype

bool

static Set()¶

API class methods ================= Finds, or creates, a Geometry attribute defined by the label label. The default type of geometry is the value ANY_GEOM of the enumeration TDataXtd_GeometryEnum. To specify another value of this enumeration, use the function SetType.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Geometry>

SetType()¶

Returns the type of geometric construction T of this attribute. T will be a value of the enumeration TDataXtd_GeometryEnum.

param T

type T

TDataXtd_GeometryEnum

rtype

None

static Type()¶

Returns the label L used to define the type of geometric construction for the geometry attribute.

param L

type L

TDF_Label

rtype

TDataXtd_GeometryEnum* Returns the topological attribute S used to define the type of geometric construction for the geometry attribute.

param S

type S

TNaming_NamedShape

rtype

TDataXtd_GeometryEnum

property thisown¶: The membership flag

class TDataXtd_HArray1OfTrsf(*args)¶

Bases: OCC.Core.TDataXtd.TDataXtd_Array1OfTrsf, OCC.Core.Standard.Standard_Transient

Empty constructor

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

Array1()¶

ChangeArray1()¶

static DownCast(t)¶

property thisown¶: The membership flag

class TDataXtd_Pattern(*args, **kwargs)¶

Bases: OCC.Core.TDF.TDF_Attribute

Empty constructor

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

ComputeTrsfs()¶

Give the transformations

param Trsfs

type Trsfs

TDataXtd_Array1OfTrsf

rtype

void

static DownCast(t)¶

static GetID()¶

Return type: Standard_GUID

NbTrsfs()¶

Give the number of transformation

rtype

int

PatternID()¶

Returns the ID of the attribute.

rtype

Standard_GUID

property thisown¶: The membership flag

class TDataXtd_PatternStd(*args)¶

Bases: OCC.Core.TDataXtd.TDataXtd_Pattern

Return type: None

Axis1()¶

Parameters

Axis1 –

type Axis1: TNaming_NamedShape
rtype: None:rtype: opencascade::handle<TNaming_NamedShape>

Axis1Reversed()¶

Parameters

Axis1Reversed –

type Axis1Reversed: bool
rtype: None:rtype: bool

Axis2()¶

Parameters

Axis2 –

type Axis2: TNaming_NamedShape
rtype: None:rtype: opencascade::handle<TNaming_NamedShape>

Axis2Reversed()¶

Parameters

Axis2Reversed –

type Axis2Reversed: bool
rtype: None:rtype: bool

static DownCast(t)¶

DumpToString(TDataXtd_PatternStd self) → std::string¶

static GetPatternID()¶

Return type: Standard_GUID

Mirror()¶

Parameters

plane –

type plane: TNaming_NamedShape
rtype: None:rtype: opencascade::handle<TNaming_NamedShape>

NbInstances1()¶

Parameters

NbInstances1 –

type NbInstances1: TDataStd_Integer
rtype: None:rtype: opencascade::handle<TDataStd_Integer>

NbInstances2()¶

Parameters

NbInstances2 –

type NbInstances2: TDataStd_Integer
rtype: None:rtype: opencascade::handle<TDataStd_Integer>

static Set()¶

Find, or create, a PatternStd attribute

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_PatternStd>

Signature()¶

Parameters

signature –

type signature: int
rtype: None:rtype: int

Value1()¶

Parameters

value –

type value: TDataStd_Real
rtype: None:rtype: opencascade::handle<TDataStd_Real>

Value2()¶

Parameters

value –

type value: TDataStd_Real
rtype: None:rtype: opencascade::handle<TDataStd_Real>

property thisown¶: The membership flag

class TDataXtd_Placement(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataXtd_Placement self) → std::string¶

static GetID()¶

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

rtype

Standard_GUID

static Set()¶

Find, or create, an Placement attribute. the Placement attribute is returned. Placement methods =================

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Placement>

property thisown¶: The membership flag

class TDataXtd_Plane(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataXtd_Plane self) → std::string¶

static GetID()¶

class methods ============= //! Returns the GUID for plane attributes.

rtype

Standard_GUID

static Set()¶

Finds or creates the plane attribute defined by the label label. Warning If you are creating the attribute with this syntax, a planar face should already be associated with label.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Plane>* Finds, or creates, a Plane attribute and sets <P> as generated the associated NamedShape. Plane methods =============

param label

type label

TDF_Label

param P

type P

gp_Pln

rtype

opencascade::handle<TDataXtd_Plane>

property thisown¶: The membership flag

class TDataXtd_Point(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataXtd_Point self) → std::string¶

static GetID()¶

class methods ============= //! Returns the GUID for point attributes.

rtype

Standard_GUID

static Set()¶

Sets the label Label as a point attribute. If no object is found, a point attribute is created.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Point>* Sets the label Label as a point attribute containing the point P. If no object is found, a point attribute is created. Point methods =============

param label

type label

TDF_Label

param P

type P

gp_Pnt

rtype

opencascade::handle<TDataXtd_Point>

property thisown¶: The membership flag

class TDataXtd_Position(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

static Get()¶

Search label <aLabel) for the TDataXtd_Position attribute and get its position if found returns True

param aLabel

type aLabel

TDF_Label

param aPos

type aPos

gp_Pnt

rtype

bool

static GetID()¶

Returns the ID of the attribute.

rtype

Standard_GUID

GetPosition()¶

Return type: gp_Pnt

static Set()¶

Create if not found the TDataXtd_Position attribute set its position to <aPos>

param aLabel

type aLabel

TDF_Label

param aPos

type aPos

gp_Pnt

rtype

void* Find an existing, or create an empty, Position. the Position attribute is returned.

param aLabel

type aLabel

TDF_Label

rtype

opencascade::handle<TDataXtd_Position>

SetPosition()¶

Parameters

aPos –

type aPos: gp_Pnt
rtype: None

property thisown¶: The membership flag

class TDataXtd_Presentation(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

//!@name Attribute mechanics Empty constructor

rtype

None

AddSelectionMode()¶

Parameters

theSelectionMode –

type theSelectionMode: int
param theTransaction: default value is Standard_True
type theTransaction: bool
rtype: None

Color()¶

Return type: Quantity_NameOfColor

static DownCast(t)¶

GetDriverGUID()¶

//!@name Access to data Returns the GUID of the driver managing display of associated AIS object

rtype

Standard_GUID

static GetID()¶

Returns the ID of the attribute.

rtype

Standard_GUID

GetNbSelectionModes()¶

Returns the number of selection modes of the attribute. It starts with 1 .. GetNbSelectionModes().

rtype

int

HasOwnColor()¶

Return type: bool

HasOwnMaterial()¶

Return type: bool

HasOwnMode()¶

Return type: bool

HasOwnSelectionMode()¶

Return type: bool

HasOwnTransparency()¶

Return type: bool

HasOwnWidth()¶

Return type: bool

IsDisplayed()¶

Return type: bool

MaterialIndex()¶

Return type: int

Mode()¶

Return type: int

SelectionMode()¶

Parameters: index – default value is 1 :type index: int :rtype: int

static Set()¶

Create if not found the TDataXtd_Presentation attribute and set its driver GUID

param theLabel

type theLabel

TDF_Label

param theDriverId

type theDriverId

Standard_GUID

rtype

opencascade::handle<TDataXtd_Presentation>

SetColor()¶

Parameters

theColor –

type theColor: Quantity_NameOfColor
rtype: None

SetDisplayed()¶

Parameters

theIsDisplayed –

type theIsDisplayed: bool
rtype: None

SetDriverGUID()¶

Sets the GUID of the driver managing display of associated AIS object

param theGUID

type theGUID

Standard_GUID

rtype

None

SetMaterialIndex()¶

Parameters

theMaterialIndex –

type theMaterialIndex: int
rtype: None

SetMode()¶

Parameters

theMode –

type theMode: int
rtype: None

SetSelectionMode()¶

Sets selection mode. If ‘theTransaction’ flag is OFF, modification of the attribute doesn’t influence the transaction mechanism (the attribute doesn’t participate in undo/redo because of this modification). Certainly, if any other data of the attribute is modified (display mode, color, …), the attribute will be included into undo/redo.

param theSelectionMode

type theSelectionMode

int

param theTransaction

default value is Standard_True

type theTransaction

bool

rtype

None

SetTransparency()¶

Parameters

theValue –

type theValue: float
rtype: None

SetWidth()¶

Parameters

theWidth –

type theWidth: float
rtype: None

Transparency()¶

Return type: float

static Unset()¶

Remove attribute of this type from the label

param theLabel

type theLabel

TDF_Label

rtype

void

UnsetColor()¶

Return type: None

UnsetMaterial()¶

Return type: None

UnsetMode()¶

Return type: None

UnsetSelectionMode()¶

Return type: None

UnsetTransparency()¶

Return type: None

UnsetWidth()¶

Return type: None

Width()¶

Return type: float

property thisown¶: The membership flag

class TDataXtd_Shape(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataXtd_Shape self) → std::string¶

static Find()¶

class methods ============= try to retrieve a Shape attribute at <current> label or in fathers label of <current>. Returns True if found and set <S>.

param current

type current

TDF_Label

param S

type S

TDataXtd_Shape

rtype

bool

static Get()¶

the Shape from associated NamedShape attribute is returned.

param label

type label

TDF_Label

rtype

TopoDS_Shape

static GetID()¶

Shape methods ============

rtype

Standard_GUID

static New()¶

Find, or create, a Shape attribute. the Shape attribute is returned. Raises if <label> has attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataXtd_Shape>

static Set()¶

Create or update associated NamedShape attribute. the Shape attribute is returned.

param label

type label

TDF_Label

param shape

type shape

TopoDS_Shape

rtype

opencascade::handle<TDataXtd_Shape>

property thisown¶: The membership flag

class TDataXtd_Triangulation(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Object methods A constructor. Don’t use it directly, use please the static method Set(), which returns the attribute attached to a label.

rtype

None

Deflection()¶

Poly_Triangulation methods The methods are ‘covered’ by this attribute to prevent direct modification of the mesh. There is no performance problem to call Poly_Triangulation method through this attribute. The most of the methods are considered as ‘inline’ by the compiler in release mode. Returns the deflection of this triangulation.

rtype

float* Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D

param theDeflection

type theDeflection

float

rtype

None

static DownCast(t)¶

DumpToString(TDataXtd_Triangulation self) → std::string¶

Get()¶

Returns the underlying triangulation.

rtype

opencascade::handle<Poly_Triangulation>

static GetID()¶

Static methods Returns the ID of the triangulation attribute.

rtype

Standard_GUID

HasNormals()¶

Returns Standard_True if nodal normals are defined.

rtype

bool

HasUVNodes()¶

returns Standard_True if 2D nodes are associated with 3D nodes for this triangulation.

rtype

bool

NbNodes()¶

returns the number of nodes for this triangulation.

rtype

int

NbTriangles()¶

returns the number of triangles for this triangulation.

rtype

int

Node()¶

returns node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

param theIndex

type theIndex

int

rtype

gp_Pnt

Normal()¶

returns normal at the given index. Raises Standard_OutOfRange exception.

param theIndex

type theIndex

int

rtype

gp_Dir

RemoveUVNodes()¶

Deallocates the UV nodes.

rtype

None

Set()¶

Finds or creates a triangulation attribute.

param theLabel

type theLabel

TDF_Label

rtype

opencascade::handle<TDataXtd_Triangulation>* Finds or creates a triangulation attribute. Initializes the attribute by a Poly_Triangulation object.

param theLabel

type theLabel

TDF_Label

param theTriangulation

type theTriangulation

Poly_Triangulation

rtype

opencascade::handle<TDataXtd_Triangulation>* Sets the triangulation.

param theTriangulation

type theTriangulation

Poly_Triangulation

rtype

None

SetNode()¶

The method differs from Poly_Triangulation! Sets a node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

param theIndex

type theIndex

int

param theNode

type theNode

gp_Pnt

rtype

None

SetNormal()¶

Changes normal at the given index. Raises Standard_OutOfRange exception.

param theIndex

type theIndex

int

param theNormal

type theNormal

gp_Dir

rtype

None

SetNormals()¶

Sets the table of node normals. Raises exception if length of theNormals != 3 * NbNodes

param theNormals

type theNormals

TShort_HArray1OfShortReal

rtype

None

SetTriangle()¶

The method differs from Poly_Triangulation! Sets a triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

param theIndex

type theIndex

int

param theTriangle

type theTriangle

Poly_Triangle

rtype

None

SetUVNode()¶

The method differs from Poly_Triangulation! Sets a UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

param theIndex

type theIndex

int

param theUVNode

type theUVNode

gp_Pnt2d

rtype

None

Triangle()¶

returns triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

param theIndex

type theIndex

int

rtype

Poly_Triangle

UVNode()¶

returns UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

param theIndex

type theIndex

int

rtype

gp_Pnt2d

property thisown¶: The membership flag

class tdataxtd¶

Bases: object

static IDList()¶

Appends to <anIDList> the list of the attributes IDs of this package. CAUTION: <anIDList> is NOT cleared before use. Print of TDataExt enumeration =============================

param anIDList

type anIDList

TDF_IDList

rtype

void

static Print()¶

Prints the name of the geometry dimension <GEO> as a String on the Stream <S> and returns <S>.

param GEO

type GEO

TDataXtd_GeometryEnum

param S

type S

Standard_OStream

rtype

Standard_OStream* Prints the name of the constraint <CTR> as a String on the Stream <S> and returns <S>.

param CTR

type CTR

TDataXtd_ConstraintEnum

param S

type S

Standard_OStream

rtype

Standard_OStream

property thisown¶: The membership flag