OCC.Core.Prs3d module¶

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

class Prs3d_Arrow¶

Bases: OCC.Core.Prs3d.Prs3d_Root

static Draw()¶

Defines the representation of the arrow. Note that this method does NOT assign any presentation aspects to the primitives group! @param theGroup presentation group to add primitives @param theLocation location of the arrow tip @param theDirection direction of the arrow @param theAngle angle of opening of the arrow head @param theLength length of the arrow (from the tip)

param theGroup

type theGroup

Graphic3d_Group

param theLocation

type theLocation

gp_Pnt

param theDirection

type theDirection

gp_Dir

param theAngle

type theAngle

float

param theLength

type theLength

float

rtype

void* Alias to another method Draw() for backward compatibility.

param thePrs

type thePrs

Prs3d_Presentation

param theLocation

type theLocation

gp_Pnt

param theDirection

type theDirection

gp_Dir

param theAngle

type theAngle

float

param theLength

type theLength

float

rtype

None

static DrawSegments()¶

Defines the representation of the arrow as a container of segments. @param theLocation location of the arrow tip @param theDir direction of the arrow @param theAngle angle of opening of the arrow head @param theLength length of the arrow (from the tip) @param theNbSegments count of points on polyline where location is connected

param theLocation

type theLocation

gp_Pnt

param theDir

type theDir

gp_Dir

param theAngle

type theAngle

float

param theLength

type theLength

float

param theNbSegments

type theNbSegments

int

rtype

opencascade::handle<Graphic3d_ArrayOfSegments>

static DrawShaded()¶

Defines the representation of the arrow as shaded triangulation. @param theAxis axis definition (arrow origin and direction) @param theTubeRadius tube (cylinder) radius @param theAxisLength overall arrow length (cylinder + cone) @param theConeRadius cone radius (arrow tip) @param theConeLength cone length (arrow tip) @param theNbFacettes tessellation quality for each part

param theAxis

type theAxis

gp_Ax1

param theTubeRadius

type theTubeRadius

float

param theAxisLength

type theAxisLength

float

param theConeRadius

type theConeRadius

float

param theConeLength

type theConeLength

float

param theNbFacettes

type theNbFacettes

int

rtype

opencascade::handle<Graphic3d_ArrayOfTriangles>

property thisown¶: The membership flag

class Prs3d_ArrowAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs an empty framework for displaying arrows in representations of lengths. The lengths displayed are either on their own or in chamfers, fillets, diameters and radii.

rtype

None* Constructs a framework to display an arrow with a shaft of the length aLength and having a head with sides at the angle anAngle from each other.

param anAngle

type anAngle

float

param aLength

type aLength

float

rtype

None:param theAspect:

type theAspect

Graphic3d_AspectLine3d

rtype

None

Angle()¶

returns the current value of the angle used when drawing an arrow.

rtype

float

Aspect()¶

Return type: opencascade::handle<Graphic3d_AspectLine3d>

static DownCast(t)¶

DumpJsonToString(Prs3d_ArrowAspect self, int depth=-1) → std::string¶

Length()¶

Returns the current value of the length used when drawing an arrow.

rtype

float

SetAngle()¶

defines the angle of the arrows.

param anAngle

type anAngle

float

rtype

None

SetAspect()¶

Parameters

theAspect –

type theAspect: Graphic3d_AspectLine3d
rtype: None

SetColor()¶

Parameters

theColor –

type theColor: Quantity_Color
rtype: None

SetLength()¶

Defines the length of the arrows.

param theLength

type theLength

float

rtype

None

property thisown¶: The membership flag

class Prs3d_BasicAspect(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

static DownCast(t)¶

property thisown¶: The membership flag

class Prs3d_DatumAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

An empty framework to define the display of datums.

rtype

None

ArrowAspect()¶

Returns the arrow aspect of presentation

rtype

opencascade::handle<Prs3d_ArrowAspect>

ArrowPartForAxis()¶

Returns type of arrow for a type of axis

param thePart

type thePart

Prs3d_DatumParts

rtype

Prs3d_DatumParts

Attribute()¶

Returns the attribute of the datum type

param theType

type theType

Prs3d_DatumAttribute

rtype

float

AxisLength()¶

Returns the length of the displayed first axis.

param thePart

type thePart

Prs3d_DatumParts

rtype

float

DatumAxes()¶

Returns axes used in the datum aspect

rtype

Prs3d_DatumAxes

static DownCast(t)¶

DrawDatumPart()¶

Returns true if the given part is used in axes of aspect

param thePart

type thePart

Prs3d_DatumParts

rtype

bool

DrawFirstAndSecondAxis()¶

Returns true if the first and second axes can be drawn.

rtype

bool

DrawThirdAxis()¶

Returns true if the third axis can be drawn.

rtype

bool

DumpJsonToString(Prs3d_DatumAspect self, int depth=-1) → std::string¶

FirstAxisAspect()¶

Returns the attributes for display of the first axis.

rtype

opencascade::handle<Prs3d_LineAspect>

FirstAxisLength()¶

Returns the length of the displayed first axis.

rtype

float

LineAspect()¶

Returns the right-handed coordinate system set in SetComponent.

param thePart

type thePart

Prs3d_DatumParts

rtype

opencascade::handle<Prs3d_LineAspect>

PointAspect()¶

Returns the point aspect of origin wireframe presentation

rtype

opencascade::handle<Prs3d_PointAspect>

SecondAxisAspect()¶

Returns the attributes for display of the second axis.

rtype

opencascade::handle<Prs3d_LineAspect>

SecondAxisLength()¶

Returns the length of the displayed second axis.

rtype

float

SetArrowAspect()¶

Sets the arrow aspect of presentation

param theAspect

type theAspect

Prs3d_ArrowAspect

rtype

None

SetAttribute()¶

Sets the attribute of the datum type

param theType

type theType

Prs3d_DatumAttribute

param theValue

type theValue

float

rtype

None

SetAxisLength()¶

Sets the lengths of the three axes.

param theL1

type theL1

float

param theL2

type theL2

float

param theL3

type theL3

float

rtype

None

SetDrawArrows()¶

Sets option to draw or not arrows for axes

param theToDraw

type theToDraw

bool

rtype

None

SetDrawDatumAxes()¶

Sets the axes used in the datum aspect

param theType

type theType

Prs3d_DatumAxes

rtype

None

SetDrawFirstAndSecondAxis()¶

Sets the DrawFirstAndSecondAxis attributes to active.

param theToDraw

type theToDraw

bool

rtype

None

SetDrawLabels()¶

Sets option to draw or not to draw text labels for axes

param theToDraw

type theToDraw

bool

rtype

None

SetDrawThirdAxis()¶

Sets the DrawThirdAxis attributes to active.

param theToDraw

type theToDraw

bool

rtype

None

SetPointAspect()¶

Returns the point aspect of origin wireframe presentation

param theAspect

type theAspect

Prs3d_PointAspect

rtype

None

SetTextAspect()¶

Sets text attributes for rendering labels.

param theTextAspect

type theTextAspect

Prs3d_TextAspect

rtype

None

SetToDrawLabels()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

ShadingAspect()¶

Returns the right-handed coordinate system set in SetComponent.

param thePart

type thePart

Prs3d_DatumParts

rtype

opencascade::handle<Prs3d_ShadingAspect>

TextAspect()¶

Returns the text attributes for rendering labels.

rtype

opencascade::handle<Prs3d_TextAspect>

ThirdAxisAspect()¶

Returns the attributes for display of the third axis.

rtype

opencascade::handle<Prs3d_LineAspect>

ThirdAxisLength()¶

Returns the length of the displayed third axis.

rtype

float

ToDrawArrows()¶

returns true if axes arrows are drawn; True by default.

rtype

bool

ToDrawLabels()¶

returns true if axes labels are drawn; True by default.

rtype

bool

property thisown¶: The membership flag

class Prs3d_DimensionAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs an empty framework to define the display of dimensions.

rtype

None

ArrowAspect()¶

Returns the settings for displaying arrows.

rtype

opencascade::handle<Prs3d_ArrowAspect>

ArrowOrientation()¶

Gets orientation of arrows (external or internal).

rtype

Prs3d_DimensionArrowOrientation

ArrowTailSize()¶

Returns arrow tail size.

rtype

float

static DownCast(t)¶

DumpJsonToString(Prs3d_DimensionAspect self, int depth=-1) → std::string¶

ExtensionSize()¶

Returns extension size.

rtype

float

IsArrows3d()¶

Gets type of arrows.

rtype

bool

IsText3d()¶

Check if text for dimension label is 3d.

rtype

bool

IsTextShaded()¶

Check if 3d text for dimension label is shaded.

rtype

bool

IsUnitsDisplayed()¶

Shows if Units are to be displayed along with dimension value.

rtype

bool

LineAspect()¶

Returns the settings for the display of lines used in presentation of dimensions.

rtype

opencascade::handle<Prs3d_LineAspect>

MakeArrows3d()¶

Sets type of arrows.

param theIsArrows3d

type theIsArrows3d

bool

rtype

None

MakeText3d()¶

Sets type of text.

param isText3d

type isText3d

bool

rtype

None

MakeTextShaded()¶

Turns on/off text shading for 3d text.

param theIsTextShaded

type theIsTextShaded

bool

rtype

None

MakeUnitsDisplayed()¶

Specifies whether the units string should be displayed along with value label or not.

param theIsDisplayed

type theIsDisplayed

bool

rtype

None

SetArrowAspect()¶

Sets the display attributes of arrows used in presentation of dimensions.

param theAspect

type theAspect

Prs3d_ArrowAspect

rtype

None

SetArrowOrientation()¶

Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size.

param theArrowOrient

type theArrowOrient

Prs3d_DimensionArrowOrientation

rtype

None

SetArrowTailSize()¶

Set size for arrow tail (extension without text).

param theSize

type theSize

float

rtype

None

SetCommonColor()¶

Sets the same color for all parts of dimension: lines, arrows and text.

param theColor

type theColor

Quantity_Color

rtype

None

SetExtensionSize()¶

Sets extension size.

param theSize

type theSize

float

rtype

None

SetLineAspect()¶

Sets the display attributes of lines used in presentation of dimensions.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetTextAspect()¶

Sets the display attributes of text used in presentation of dimensions.

param theAspect

type theAspect

Prs3d_TextAspect

rtype

None

SetTextHorizontalPosition()¶

Sets horizontal text alignment for text label.

param thePosition

type thePosition

Prs3d_DimensionTextHorizontalPosition

rtype

None

SetTextVerticalPosition()¶

Sets vertical text alignment for text label.

param thePosition

type thePosition

Prs3d_DimensionTextVerticalPosition

rtype

None

SetValueStringFormat()¶

Sets ‘sprintf’-syntax format for formatting dimension value labels.

param theFormat

type theFormat

TCollection_AsciiString

rtype

None

TextAspect()¶

Returns the settings for the display of text used in presentation of dimensions.

rtype

opencascade::handle<Prs3d_TextAspect>

TextHorizontalPosition()¶

Gets horizontal text alignment for text label.

rtype

Prs3d_DimensionTextHorizontalPosition

TextVerticalPosition()¶

Gets vertical text alignment for text label.

rtype

Prs3d_DimensionTextVerticalPosition

ValueStringFormat()¶

Returns format.

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class Prs3d_DimensionUnits(*args)¶

Bases: object

Default constructor. Sets meters as default length units and radians as default angle units.

rtype

None:param theUnits:

type theUnits

Prs3d_DimensionUnits

rtype

None

GetAngleUnits()¶

returns angle units

rtype

TCollection_AsciiString

GetLengthUnits()¶

returns length units

rtype

TCollection_AsciiString

SetAngleUnits()¶

Sets angle units

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

SetLengthUnits()¶

Sets length units

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

property thisown¶: The membership flag

class Prs3d_Drawer(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_PresentationAttributes

Default constructor.

rtype

None

ArrowAspect()¶

Returns the attributes for display of arrows.

rtype

opencascade::handle<Prs3d_ArrowAspect>

ClearLocalAttributes()¶

Removes local attributes.

rtype

None

DatumAspect()¶

Returns settings for the appearance of datums. These settings can be edited. The default values for the three axes are: Color: Quantity_NOC_PEACHPUFF Type of line: Aspect_TOL_SOLID Width: 1.0

rtype

opencascade::handle<Prs3d_DatumAspect>

DeviationAngle()¶

Returns the value for deviation angle.

rtype

float

DeviationCoefficient()¶

Returns the deviation coefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.

rtype

float

DimAngleDisplayUnits()¶

Returns angle units in which dimension presentation is displayed.

rtype

TCollection_AsciiString

DimAngleModelUnits()¶

Returns angle model units for the dimension presentation.

rtype

TCollection_AsciiString

DimLengthDisplayUnits()¶

Returns length units in which dimension presentation is displayed.

rtype

TCollection_AsciiString

DimLengthModelUnits()¶

Returns length model units for the dimension presentation.

rtype

TCollection_AsciiString

DimensionAspect()¶

Returns settings for the appearance of dimensions.

rtype

opencascade::handle<Prs3d_DimensionAspect>

DisableDrawHiddenLine()¶

Disables the DrawHiddenLine function.

rtype

None

Discretisation()¶

Returns the discretisation setting.

rtype

int

static DownCast(t)¶

DrawHiddenLine()¶

Returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.

rtype

bool

DumpJsonToString(Prs3d_Drawer self, int depth=-1) → std::string¶

EnableDrawHiddenLine()¶

Enables the DrawHiddenLine function.

rtype

None

FaceBoundaryAspect()¶

Returns line aspect of face boundaries.

rtype

opencascade::handle<Prs3d_LineAspect>

FaceBoundaryDraw()¶

Checks whether the face boundary drawing is enabled or not.

rtype

bool

FaceBoundaryUpperContinuity()¶

Get the most edge continuity class; GeomAbs_CN by default (all edges).

rtype

GeomAbs_Shape

FreeBoundaryAspect()¶

Returns the values for presentation of free boundaries, in other words, boundaries which are not shared. The LineAspect for the free boundaries can be edited. The default values are: Color: Quantity_NOC_GREEN Type of line: Aspect_TOL_SOLID Width: 1.0 These attributes are used by the algorithm Prs3d_WFShape

rtype

opencascade::handle<Prs3d_LineAspect>

FreeBoundaryDraw()¶

Returns True if the drawing of the free boundaries is enabled True is the default setting.

rtype

bool

HLRAngle()¶

Returns the real number value of the deviation angle in hidden line removal views. The default value is 20 * M_PI / 180.

rtype

float

HLRDeviationCoefficient()¶

Returns the real number value of the hidden line removal deviation coefficient in this framework, if the flag hasOwnHLRDeviationCoefficient is true or there is no Link. Else the shape’s HLR deviation coefficient is used. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient give the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. To find the hidden lines, hidden line display mode entails recalculation of the view at each different projector perspective. Since hidden lines entail calculations of more than usual complexity to decompose them into these triangles, a deviation coefficient allowing greater tolerance is used. This increases efficiency in calculation. The Default value is 0.02.

rtype

float

HasLink()¶

Returns true if the current object has a link on the other drawer.

rtype

bool

HasOwnArrowAspect()¶

Returns true if the drawer has its own attribute for arrow aspect that overrides the one in the link.

rtype

bool

HasOwnDatumAspect()¶

Returns true if the drawer has its own attribute for datum aspect that overrides the one in the link.

rtype

bool

HasOwnDeviationAngle()¶

Returns true if the there is a local setting for deviation angle in this framework for a specific interactive object.

rtype

bool

HasOwnDeviationCoefficient()¶

Returns true if there is a local setting for deviation coefficient in this framework for a specific interactive object.

rtype

bool

HasOwnDimAngleDisplayUnits()¶

Returns true if the drawer has its own attribute for angle units in which dimension presentation is displayed that overrides the one in the link.

rtype

bool

HasOwnDimAngleModelUnits()¶

Returns true if the drawer has its own attribute for dimension angle model units that overrides the one in the link.

rtype

bool

HasOwnDimLengthDisplayUnits()¶

Returns true if the drawer has its own attribute for length units in which dimension presentation is displayed that overrides the one in the link.

rtype

bool

HasOwnDimLengthModelUnits()¶

Returns true if the drawer has its own attribute for dimension length model units that overrides the one in the link.

rtype

bool

HasOwnDimensionAspect()¶

Returns true if the drawer has its own attribute for the appearance of dimensions that overrides the one in the link.

rtype

bool

HasOwnDiscretisation()¶

Returns true if the drawer has discretisation setting active.

rtype

bool

HasOwnDrawHiddenLine()¶

Returns true if the drawer has its own attribute for ‘draw hidden lines’ flag that overrides the one in the link.

rtype

bool

HasOwnFaceBoundaryAspect()¶

Returns true if the drawer has its own attribute for face boundaries aspect that overrides the one in the link.

rtype

bool

HasOwnFaceBoundaryDraw()¶

Returns true if the drawer has its own attribute for ‘draw face boundaries’ flag that overrides the one in the link.

rtype

bool

HasOwnFaceBoundaryUpperContinuity()¶

Returns true if the drawer has its own attribute for face boundaries upper edge continuity class that overrides the one in the link.

rtype

bool

HasOwnFreeBoundaryAspect()¶

Returns true if the drawer has its own attribute for free boundaries aspect that overrides the one in the link.

rtype

bool

HasOwnFreeBoundaryDraw()¶

Returns true if the drawer has its own attribute for ‘draw free boundaries’ flag that overrides the one in the link.

rtype

bool

HasOwnHLRDeviationAngle()¶

Returns true if the there is a setting for HLR deviation angle in this framework for a specific interactive object.

rtype

bool

HasOwnHLRDeviationCoefficient()¶

Returns true if the there is a setting for HLR deviation coefficient in this framework for a specific interactive object.

rtype

bool

HasOwnHiddenLineAspect()¶

Returns true if the drawer has its own attribute for hidden lines aspect that overrides the one in the link.

rtype

bool

HasOwnIsAutoTriangulation()¶

Returns true if the drawer has IsoOnPlane setting active.

rtype

bool

HasOwnIsoOnPlane()¶

Returns true if the drawer has IsoOnPlane setting active.

rtype

bool

HasOwnIsoOnTriangulation()¶

Returns true if the drawer has IsoOnTriangulation setting active.

rtype

bool

HasOwnLineArrowDraw()¶

Returns true if the drawer has its own attribute for ‘draw arrow’ flag that overrides the one in the link.

rtype

bool

HasOwnLineAspect()¶

Returns true if the drawer has its own attribute for line aspect that overrides the one in the link.

rtype

bool

HasOwnMaximalChordialDeviation()¶

Returns true if the drawer has a maximal chordial deviation setting active.

rtype

bool

HasOwnMaximalParameterValue()¶

Returns true if the drawer has a maximum value allowed for the first and last parameters of an infinite curve setting active.

rtype

bool

HasOwnPlaneAspect()¶

Returns true if the drawer has its own attribute for plane aspect that overrides the one in the link.

rtype

bool

HasOwnPointAspect()¶

Returns true if the drawer has its own attribute for point aspect that overrides the one in the link.

rtype

bool

HasOwnSectionAspect()¶

Returns true if the drawer has its own attribute for section aspect that overrides the one in the link.

rtype

bool

HasOwnSeenLineAspect()¶

Returns true if the drawer has its own attribute for seen line aspect that overrides the one in the link.

rtype

bool

HasOwnShadingAspect()¶

Returns true if the drawer has its own attribute for shading aspect that overrides the one in the link.

rtype

bool

HasOwnTextAspect()¶

Returns true if the drawer has its own attribute for text aspect that overrides the one in the link.

rtype

bool

HasOwnTypeOfDeflection()¶

Returns true if the drawer has a type of deflection setting active.

rtype

bool

HasOwnTypeOfHLR()¶

Returns true if the type of HLR is not equal to Prs3d_TOH_NotSet.

rtype

bool

HasOwnUIsoAspect()¶

Returns true if the drawer has its own attribute for UIso aspect that overrides the one in the link.

rtype

bool

HasOwnUnFreeBoundaryAspect()¶

Returns true if the drawer has its own attribute for unfree boundaries aspect that overrides the one in the link.

rtype

bool

HasOwnUnFreeBoundaryDraw()¶

Returns true if the drawer has its own attribute for ‘draw shared boundaries’ flag that overrides the one in the link.

rtype

bool

HasOwnVIsoAspect()¶

Returns true if the drawer has its own attribute for VIso aspect that overrides the one in the link.

rtype

bool

HasOwnVectorAspect()¶

Returns true if the drawer has its own attribute for vector aspect that overrides the one in the link.

rtype

bool

HasOwnVertexDrawMode()¶

Returns true if the vertex draw mode is not equal to Prs3d_VDM_Inherited. This means that individual vertex draw mode value (i.e. not inherited from the global drawer) is used for a specific interactive object.

rtype

bool

HasOwnWireAspect()¶

Returns true if the drawer has its own attribute for wire aspect that overrides the one in the link.

rtype

bool

HasOwnWireDraw()¶

Returns true if the drawer has its own attribute for ‘draw wires’ flag that overrides the one in the link.

rtype

bool

HiddenLineAspect()¶

Returns settings for hidden line aspects. These settings can be edited. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1.0

rtype

opencascade::handle<Prs3d_LineAspect>

IsAutoTriangulation()¶

Returns True if automatic triangulation is enabled.

rtype

bool

IsoOnPlane()¶

Returns True if the drawing of isos on planes is enabled.

rtype

bool

IsoOnTriangulation()¶

Returns True if the drawing of isos on triangulation is enabled.

rtype

bool

LineArrowDraw()¶

Returns True if drawing an arrow at the end of each edge is enabled and False otherwise (the default).

rtype

bool

LineAspect()¶

Returns settings for line aspects. These settings can be edited. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_SOLID Width: 1.0 These attributes are used by the following algorithms: Prs3d_Curve Prs3d_Line Prs3d_HLRShape

rtype

opencascade::handle<Prs3d_LineAspect>

Link()¶

Returns the drawer to which the current object references.

rtype

opencascade::handle<Prs3d_Drawer>* Sets theDrawer as a link to which the current object references.

param theDrawer

type theDrawer

Prs3d_Drawer

rtype

None

MaximalChordialDeviation()¶

Returns the maximal chordal deviation. The default value is 0.1. Drawings of curves or patches are made with respect to an absolute maximal chordal deviation.

rtype

float

MaximalParameterValue()¶

Sets the maximum value allowed for the first and last parameters of an infinite curve. By default, this value is 500000.

rtype

float

PlaneAspect()¶

Returns settings for the appearance of planes.

rtype

opencascade::handle<Prs3d_PlaneAspect>

PointAspect()¶

Returns the point aspect setting. The default values are Color: Quantity_NOC_YELLOW Type of marker: Aspect_TOM_PLUS Scale: 1.0 These attributes are used by the algorithms Prs3d_Point.

rtype

opencascade::handle<Prs3d_PointAspect>

PreviousDeviationAngle()¶

Returns the previous deviation angle

rtype

float

PreviousDeviationCoefficient()¶

Saves the previous value used for the chordal deviation coefficient.

rtype

float

PreviousHLRDeviationAngle()¶

Returns the previous value of the HLR deviation angle.

rtype

float

PreviousHLRDeviationCoefficient()¶

Returns the previous value of the hidden line removal deviation coefficient.

rtype

float

SectionAspect()¶

The LineAspect for the wire can be edited. The default values are: Color: Quantity_NOC_ORANGE Type of line: Aspect_TOL_SOLID Width: 1.0 These attributes are used by the algorithm Prs3d_WFShape.

rtype

opencascade::handle<Prs3d_LineAspect>

SeenLineAspect()¶

Returns settings for seen line aspects. These settings can be edited. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_SOLID Width: 1.0

rtype

opencascade::handle<Prs3d_LineAspect>

SetArrowAspect()¶

Sets the parameter theAspect for display attributes of arrows.

param theAspect

type theAspect

Prs3d_ArrowAspect

rtype

None

SetAutoTriangulation()¶

Sets IsAutoTriangulated on or off by setting the parameter theIsEnabled to true or false. If this flag is True automatic re-triangulation with deflection-check logic will be applied. Else this feature will be disable and triangulation is expected to be computed by application itself and no shading presentation at all if unavailable.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetDatumAspect()¶

Sets the modality theAspect for the display of datums.

param theAspect

type theAspect

Prs3d_DatumAspect

rtype

None

SetDeviationAngle()¶

Sets the deviation angle theAngle. Also sets the hasOwnDeviationAngle flag to Standard_True, and myPreviousDeviationAngle.

param theAngle

type theAngle

float

rtype

None* Sets the hasOwnDeviationAngle flag to Standard_False

rtype

None

SetDeviationCoefficient()¶

Sets the deviation coefficient theCoefficient. Also sets the hasOwnDeviationCoefficient flag to Standard_True and myPreviousDeviationCoefficient

param theCoefficient

type theCoefficient

float

rtype

None* Sets the hasOwnDeviationCoefficient flag to Standard_False

rtype

None

SetDimAngleDisplayUnits()¶

Sets angle units in which value for dimension presentation is displayed. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

SetDimAngleModelUnits()¶

Sets dimension angle model units for computing of dimension presentation. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

SetDimLengthDisplayUnits()¶

Sets length units in which value for dimension presentation is displayed. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

SetDimLengthModelUnits()¶

Sets dimension length model units for computing of dimension presentation. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.

param theUnits

type theUnits

TCollection_AsciiString

rtype

None

SetDimensionAspect()¶

Sets the settings for the appearance of dimensions. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.

param theAspect

type theAspect

Prs3d_DimensionAspect

rtype

None

SetDiscretisation()¶

Sets the discretisation parameter theValue.

param theValue

type theValue

int

rtype

None

SetFaceBoundaryAspect()¶

Sets line aspect for face boundaries. The method sets line aspect owned by the drawer that will be used during visualization instead of the one set in link. theAspect is the line aspect that determines the look of the face boundaries.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetFaceBoundaryDraw()¶

Enables or disables face boundary drawing for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the face boundaries should be drawn or not.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetFaceBoundaryUpperContinuity()¶

Set the most edge continuity class for face boundaries.

param theMostAllowedEdgeClass

type theMostAllowedEdgeClass

GeomAbs_Shape

rtype

None

SetFreeBoundaryAspect()¶

Sets the parameter theAspect for the display of free boundaries. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetFreeBoundaryDraw()¶

Enables or disables drawing of free boundaries for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the free boundaries should be drawn or not.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetHLRAngle()¶

Sets anAngle, the angle of maximum chordal deviation for removal of hidden lines created by different viewpoints in different presentations. The default value is 20 * M_PI / 180. Also sets the hasOwnHLRDeviationAngle flag to Standard_True and myPreviousHLRDeviationAngle.

param theAngle

type theAngle

float

rtype

None* Sets the hasOwnHLRDeviationAngle flag to Standard_False

rtype

None

SetHLRDeviationCoefficient()¶

Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02. Also sets the hasOwnHLRDeviationCoefficient flag to Standard_True and myPreviousHLRDeviationCoefficient

param theCoefficient

type theCoefficient

float

rtype

None* Sets the hasOwnHLRDeviationCoefficient flag to Standard_False

rtype

None

SetHiddenLineAspect()¶

Sets the parameter theAspect for the display of hidden lines in hidden line removal mode.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetIsoOnPlane()¶

Sets IsoOnPlane on or off by setting the parameter theIsEnabled to true or false.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetIsoOnTriangulation()¶

Enables or disables isolines on triangulation by setting the parameter theIsEnabled to true or false.

param theToEnable

type theToEnable

bool

rtype

None

SetLineArrowDraw()¶

Enables the drawing of an arrow at the end of each line. By default the arrows are not drawn.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetLineAspect()¶

Sets the parameter theAspect for display attributes of lines.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetLink()¶

Sets theDrawer as a link to which the current object references.

param theDrawer

type theDrawer

Prs3d_Drawer

rtype

None

SetMaximalChordialDeviation()¶

Defines the maximal chordial deviation when drawing any curve. Even if the type of deviation is set to TOD_Relative, this value is used by: Prs3d_DeflectionCurve Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace

param theChordialDeviation

type theChordialDeviation

float

rtype

None

SetMaximalParameterValue()¶

Defines the maximum value allowed for the first and last parameters of an infinite curve.

param theValue

type theValue

float

rtype

None

SetOwnDatumAspects()¶

Sets own line aspects for datums. Returns False if own line for datums are already set.

param theDefaults

default value is opencascade::handle<Prs3d_Drawer>()

type theDefaults

Prs3d_Drawer

rtype

bool

SetOwnLineAspects()¶

Sets own line aspects. Returns False if own line aspect are already set.

param theDefaults

default value is opencascade::handle<Prs3d_Drawer>()

type theDefaults

Prs3d_Drawer

rtype

bool

SetPlaneAspect()¶

Sets the parameter theAspect for the display of planes.

param theAspect

type theAspect

Prs3d_PlaneAspect

rtype

None

SetPointAspect()¶

Sets the parameter theAspect for display attributes of points

param theAspect

type theAspect

Prs3d_PointAspect

rtype

None

SetSectionAspect()¶

Sets the parameter theAspect for display attributes of sections.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetSeenLineAspect()¶

Sets the parameter theAspect for the display of seen lines in hidden line removal mode.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetShaderProgram()¶

Assign shader program for specified type of primitives. @param theProgram new program to set (might be NULL) @param theAspect the type of primitives @param theToOverrideDefaults if true then non-overridden attributes using defaults will be allocated and copied from the Link; otherwise, only already customized attributes will be changed returns True if presentation should be recomputed after creating aspects not previously customized (if theToOverrideDefaults is also True)

param theProgram

type theProgram

Graphic3d_ShaderProgram

param theAspect

type theAspect

Graphic3d_GroupAspect

param theToOverrideDefaults

default value is false

type theToOverrideDefaults

bool

rtype

bool

SetShadingAspect()¶

Sets the parameter theAspect for display attributes of shading.

param theAspect

type theAspect

Prs3d_ShadingAspect

rtype

None

SetShadingModel()¶

Sets Shading Model type for the shading aspect.

param theModel

type theModel

Graphic3d_TypeOfShadingModel

param theToOverrideDefaults

default value is false

type theToOverrideDefaults

bool

rtype

bool

SetTextAspect()¶

Sets the parameter theAspect for display attributes of text.

param theAspect

type theAspect

Prs3d_TextAspect

rtype

None

SetTypeOfDeflection()¶

Sets the type of chordal deflection. This indicates whether the deflection value is absolute or relative to the size of the object.

param theTypeOfDeflection

type theTypeOfDeflection

Aspect_TypeOfDeflection

rtype

None

SetTypeOfHLR()¶

Sets the type of HLR algorithm used by drawer’s interactive objects

param theTypeOfHLR

type theTypeOfHLR

Prs3d_TypeOfHLR

rtype

None

SetUIsoAspect()¶

Parameters

theAspect –

type theAspect: Prs3d_IsoAspect
rtype: None

SetUnFreeBoundaryAspect()¶

Sets the parameter theAspect for the display of shared boundaries. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetUnFreeBoundaryDraw()¶

Enables or disables drawing of shared boundaries for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the shared boundaries should be drawn or not.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetVIsoAspect()¶

Sets the appearance of V isoparameters - theAspect.

param theAspect

type theAspect

Prs3d_IsoAspect

rtype

None

SetVectorAspect()¶

Sets the modality theAspect for the display of vectors.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetVertexDrawMode()¶

Sets the mode of visualization of vertices of a TopoDS_Shape instance. By default, only stand-alone vertices (not belonging topologically to an edge) are drawn, that corresponds to Prs3d_VDM_Standalone mode. Switching to Prs3d_VDM_Standalone mode makes all shape’s vertices visible. To inherit this parameter from the global drawer instance (‘the link’) when it is present, Prs3d_VDM_Inherited value should be used.

param theMode

type theMode

Prs3d_VertexDrawMode

rtype

None

SetWireAspect()¶

Sets the parameter theAspect for display of wires.

param theAspect

type theAspect

Prs3d_LineAspect

rtype

None

SetWireDraw()¶

Sets WireDraw on or off by setting the parameter theIsEnabled to true or false.

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetupOwnFaceBoundaryAspect()¶

Sets own face boundary aspect. Returns False if the drawer already has its own attribute for face boundary aspect.

param theDefaults

default value is opencascade::handle<Prs3d_Drawer>()

type theDefaults

Prs3d_Drawer

rtype

bool

SetupOwnPointAspect()¶

Sets own point aspect. Returns False if the drawer already has its own attribute for point aspect.

param theDefaults

default value is opencascade::handle<Prs3d_Drawer>()

type theDefaults

Prs3d_Drawer

rtype

bool

SetupOwnShadingAspect()¶

Sets own shading aspect. Returns False if the drawer already has its own attribute for shading aspect.

param theDefaults

default value is opencascade::handle<Prs3d_Drawer>()

type theDefaults

Prs3d_Drawer

rtype

bool

ShadingAspect()¶

Returns settings for shading aspects. These settings can be edited. The default values are: - Color: Quantity_NOC_YELLOW - Material: Graphic3d_NOM_BRASS Shading aspect is obtained through decomposition of 3d faces into triangles, each side of each triangle being a chord of the corresponding curved edge in the face. Reflection of light in each projector perspective is then calculated for each of the resultant triangular planes.

rtype

opencascade::handle<Prs3d_ShadingAspect>

TextAspect()¶

Returns settings for text aspect. These settings can be edited. The default value is: - Color: Quantity_NOC_YELLOW

rtype

opencascade::handle<Prs3d_TextAspect>

TypeOfDeflection()¶

Returns the type of chordal deflection. This indicates whether the deflection value is absolute or relative to the size of the object.

rtype

Aspect_TypeOfDeflection

TypeOfHLR()¶

Returns the type of HLR algorithm currently in use.

rtype

Prs3d_TypeOfHLR

UIsoAspect()¶

Defines the attributes which are used when drawing an U isoparametric curve of a face. Defines the number of U isoparametric curves to be drawn for a single face. The LineAspect for U isoparametric lines can be edited (methods SetColor, SetTypeOfLine, SetWidth, SetNumber) The default values are: COLORQuantity_NOC_GRAY75 TYPE OF LINE: Aspect_TOL_SOLID WIDTH0.5 //! These attributes are used by the following algorithms: Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace

rtype

opencascade::handle<Prs3d_IsoAspect>

UnFreeBoundaryAspect()¶

Returns settings for shared boundary line aspects. The LineAspect for the unfree boundaries can be edited. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_SOLID Width: 1. These attributes are used by the algorithm Prs3d_WFShape

rtype

opencascade::handle<Prs3d_LineAspect>

UnFreeBoundaryDraw()¶

Returns True if the drawing of the shared boundaries is enabled. True is the default setting.

rtype

bool

UnsetFaceBoundaryUpperContinuity()¶

Unset the most edge continuity class for face boundaries.

rtype

None

UpdatePreviousDeviationAngle()¶

Updates the previous deviation angle to the current value

rtype

None

UpdatePreviousDeviationCoefficient()¶

Updates the previous value used for the chordal deviation coefficient to the current state.

rtype

None

VIsoAspect()¶

Defines the attributes which are used when drawing an V isoparametric curve of a face. Defines the number of V isoparametric curves to be drawn for a single face. The LineAspect for V isoparametric lines can be edited (methods SetColor, SetTypeOfLine, SetWidth, SetNumber) The default values are: COLORQuantity_NOC_GRAY82 TYPE OF LINE: Aspect_TOL_SOLID WIDTH0.5 //! These attributes are used by the following algorithms: Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace

rtype

opencascade::handle<Prs3d_IsoAspect>

VectorAspect()¶

Returns settings for the appearance of vectors. These settings can be edited. The default values are: Color: Quantity_NOC_SKYBLUE Type of line: Aspect_TOL_SOLID Width: 1.0

rtype

opencascade::handle<Prs3d_LineAspect>

VertexDrawMode()¶

Returns the current mode of visualization of vertices of a TopoDS_Shape instance.

rtype

Prs3d_VertexDrawMode

WireAspect()¶

Returns wire aspect settings. The LineAspect for the free boundaries can be edited. The default values are: Color: Quantity_NOC_GREEN Type of line: Aspect_TOL_SOLID Width: 1.0 These attributes are used by the algorithm Prs3d_WFShape.

rtype

opencascade::handle<Prs3d_LineAspect>

WireDraw()¶

Returns True if the drawing of the wire is enabled.

rtype

bool

property thisown¶: The membership flag

class Prs3d_IsoAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_LineAspect

Constructs a framework to define display attributes of isoparameters. These include: - the color attribute aColor - the type of line aType - the width value aWidth - aNumber, the number of isoparameters to be displayed.

param theColor

type theColor

Quantity_Color

param theType

type theType

Aspect_TypeOfLine

param theWidth

type theWidth

float

param theNumber

type theNumber

int

rtype

None

static DownCast(t)¶

Number()¶

returns the number of U or V isoparametric curves drawn for a single face.

rtype

int

SetNumber()¶

defines the number of U or V isoparametric curves to be drawn for a single face. Default value: 10

param theNumber

type theNumber

int

rtype

None

property thisown¶: The membership flag

class Prs3d_LineAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs a framework for line aspect defined by - the color aColor - the type of line aType and - the line thickness aWidth. Type of line refers to whether the line is solid or dotted, for example.

param theColor

type theColor

Quantity_Color

param theType

type theType

Aspect_TypeOfLine

param theWidth

type theWidth

float

rtype

None:param theAspect:

type theAspect

Graphic3d_AspectLine3d

rtype

None

Aspect()¶

Returns the line aspect. This is defined as the set of color, type and thickness attributes.

rtype

opencascade::handle<Graphic3d_AspectLine3d>

static DownCast(t)¶

DumpJsonToString(Prs3d_LineAspect self, int depth=-1) → std::string¶

SetAspect()¶

Parameters

theAspect –

type theAspect: Graphic3d_AspectLine3d
rtype: None

SetColor()¶

Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW

param theColor

type theColor

Quantity_Color

rtype

None

SetTypeOfLine()¶

Sets the type of line defined at the time of construction. This could, for example, be solid, dotted or made up of dashes. Default value: Aspect_TOL_SOLID

param theType

type theType

Aspect_TypeOfLine

rtype

None

SetWidth()¶

Sets the line width defined at the time of construction. Default value: 1.

param theWidth

type theWidth

float

rtype

None

property thisown¶: The membership flag

class Prs3d_NListOfSequenceOfPnt(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class Prs3d_PlaneAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs an empty framework for the display of planes.

rtype

None

ArrowAspect()¶

Returns the settings for displaying an arrow.

rtype

opencascade::handle<Prs3d_LineAspect>

ArrowsAngle()¶

Returns the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

rtype

float

ArrowsLength()¶

Returns the length of the arrow shaft used in the display of arrows.

rtype

float

ArrowsSize()¶

Returns the size of arrows used in the display of planes.

rtype

float

DisplayCenterArrow()¶

Returns true if the display of center arrows is allowed.

rtype

bool

DisplayEdges()¶

Return type: bool

DisplayEdgesArrows()¶

Returns true if the display of edge arrows is allowed.

rtype

bool

DisplayIso()¶

Returns true if the display of isoparameters is allowed.

rtype

bool

static DownCast(t)¶

DumpJsonToString(Prs3d_PlaneAspect self, int depth=-1) → std::string¶

EdgesAspect()¶

Returns the attributes of displayed edges involved in the presentation of planes.

rtype

opencascade::handle<Prs3d_LineAspect>

IsoAspect()¶

Returns the attributes of displayed isoparameters involved in the presentation of planes.

rtype

opencascade::handle<Prs3d_LineAspect>

IsoDistance()¶

Returns the distance between isoparameters used in the display of planes.

rtype

float

PlaneXLength()¶

Returns the length of the x axis used in the display of planes.

rtype

float

PlaneYLength()¶

Returns the length of the y axis used in the display of planes.

rtype

float

SetArrowsAngle()¶

Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

param theAngle

type theAngle

float

rtype

None

SetArrowsLength()¶

Parameters

theLength –

type theLength: float
rtype: None

SetArrowsSize()¶

Sets the angle of the arrowhead used in the display of planes.

param theSize

type theSize

float

rtype

None

SetDisplayCenterArrow()¶

Sets the display attributes defined in DisplayCenterArrow to active.

param theToDraw

type theToDraw

bool

rtype

None

SetDisplayEdges()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetDisplayEdgesArrows()¶

Sets the display attributes defined in DisplayEdgesArrows to active.

param theToDraw

type theToDraw

bool

rtype

None

SetDisplayIso()¶

Sets the display attributes defined in DisplayIso to active.

param theToDraw

type theToDraw

bool

rtype

None

SetIsoDistance()¶

Sets the distance L between isoparameters used in the display of planes.

param theL

type theL

float

rtype

None

SetPlaneLength()¶

Parameters

theLX –

type theLX: float
param theLY
type theLY: float
rtype: None

property thisown¶: The membership flag

class Prs3d_PointAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Parameters

theType –

type theType: Aspect_TypeOfMarker
param theColor
type theColor: Quantity_Color
param theScale
type theScale: float
rtype: None* Defines the user defined marker point.
param theColor
type theColor: Quantity_Color
param theWidth
type theWidth: int
param theHeight
type theHeight: int
param theTexture
type theTexture: TColStd_HArray1OfByte
rtype: None:param theAspect:
type theAspect: Graphic3d_AspectMarker3d
rtype: None

Aspect()¶

Return type: opencascade::handle<Graphic3d_AspectMarker3d>

static DownCast(t)¶

DumpJsonToString(Prs3d_PointAspect self, int depth=-1) → std::string¶

GetTexture()¶

Returns marker’s texture.

rtype

opencascade::handle<Graphic3d_MarkerImage>

GetTextureSize()¶

Returns marker’s texture size.

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

None

SetAspect()¶

Parameters

theAspect –

type theAspect: Graphic3d_AspectMarker3d
rtype: None

SetColor()¶

defines the color to be used when drawing a point. Default value: Quantity_NOC_YELLOW

param theColor

type theColor

Quantity_Color

rtype

None

SetScale()¶

defines the size of the marker used when drawing a point. Default value: 1.

param theScale

type theScale

float

rtype

None

SetTypeOfMarker()¶

defines the type of representation to be used when drawing a point. Default value: Aspect_TOM_PLUS

param theType

type theType

Aspect_TypeOfMarker

rtype

None

property thisown¶: The membership flag

class Prs3d_PresentationShadow(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Structure

Constructs a shadow of existing presentation object.

param theViewer

type theViewer

Graphic3d_StructureManager

param thePrs

type thePrs

Graphic3d_Structure

rtype

None

static DownCast(t)¶

ParentAffinity()¶

Returns view affinity of the parent presentation

rtype

inline opencascade::handle<Graphic3d_ViewAffinity>

ParentId()¶

Returns the id of the parent presentation

rtype

inline int

property thisown¶: The membership flag

class Prs3d_Projector(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters

Pr –

type Pr: HLRAlgo_Projector
rtype: None* Constructs a projector framework from the following parameters - Pers is true if the view is a perspective view and false if it is an axonometric one; - Focus is the focal length if a perspective view is defined; - DX, DY and DZ are the coordinates of the projection vector; - XAt, YAt and ZAt are the coordinates of the view point; - XUp, YUp and ZUp are the coordinates of the vertical direction vector.
param Pers
type Pers: bool
param Focus
type Focus: float
param DX
type DX: float
param DY
type DY: float
param DZ
type DZ: float
param XAt
type XAt: float
param YAt
type YAt: float
param ZAt
type ZAt: float
param XUp
type XUp: float
param YUp
type YUp: float
param ZUp
type ZUp: float
rtype: None

static DownCast(t)¶

Projector()¶

Returns a projector object for use in a hidden line removal algorithm.

rtype

HLRAlgo_Projector

property thisown¶: The membership flag

class Prs3d_Root¶

Bases: object

static CurrentGroup()¶

Returns the current (last created) group of primititves inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it.

param thePrs3d

type thePrs3d

Prs3d_Presentation

rtype

opencascade::handle<Graphic3d_Group>

static NewGroup()¶

Returns the new group of primitives inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it.

param thePrs3d

type thePrs3d

Prs3d_Presentation

rtype

opencascade::handle<Graphic3d_Group>

property thisown¶: The membership flag

class Prs3d_ShadingAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs an empty framework to display shading.

rtype

None* Constructor with initialization.

param theAspect

type theAspect

Graphic3d_AspectFillArea3d

rtype

None

Aspect()¶

Returns the polygons aspect properties.

rtype

opencascade::handle<Graphic3d_AspectFillArea3d>

Color()¶

Returns the polygons color.

param aModel

default value is Aspect_TOFM_FRONT_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

Quantity_Color

static DownCast(t)¶

DumpJsonToString(Prs3d_ShadingAspect self, int depth=-1) → std::string¶

Material()¶

Returns the polygons material aspect.

param aModel

default value is Aspect_TOFM_FRONT_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

Graphic3d_MaterialAspect

SetAspect()¶

Parameters

theAspect –

type theAspect: Graphic3d_AspectFillArea3d
rtype: None

SetColor()¶

Change the polygons interior color and material ambient color.

param aColor

type aColor

Quantity_Color

param aModel

default value is Aspect_TOFM_BOTH_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

None

SetMaterial()¶

Change the polygons material aspect.

param aMaterial

type aMaterial

Graphic3d_MaterialAspect

param aModel

default value is Aspect_TOFM_BOTH_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

None

SetTransparency()¶

Change the polygons transparency value. WarningaValue must be in the range 0,1. 0 is the default (NO transparent)

param aValue

type aValue

float

param aModel

default value is Aspect_TOFM_BOTH_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

None

Transparency()¶

Returns the polygons transparency value.

param aModel

default value is Aspect_TOFM_FRONT_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

float

property thisown¶: The membership flag

class Prs3d_ShapeTool(*args)¶

Bases: object

Constructs the tool and initializes it using theShape and theAllVertices (optional) arguments. By default, only isolated and internal vertices are considered, however if theAllVertices argument is equal to True, all shape’s vertices are taken into account.

param theShape

type theShape

TopoDS_Shape

param theAllVertices

default value is Standard_False

type theAllVertices

bool

rtype

None

CurrentTriangulation()¶

Parameters

l –

type l: TopLoc_Location
rtype: opencascade::handle<Poly_Triangulation>

CurveBound()¶

Return type: Bnd_Box

FaceBound()¶

Return type: Bnd_Box

FacesOfEdge()¶

Return type: opencascade::handle<TopTools_HSequenceOfShape>

GetCurve()¶

Return type: TopoDS_Edge

GetFace()¶

Return type: TopoDS_Face

GetVertex()¶

Return type: TopoDS_Vertex

HasCurve()¶

Return type: bool

HasSurface()¶

Return type: bool

InitCurve()¶

Return type: None

InitFace()¶

Return type: None

InitVertex()¶

Return type: None

static IsPlanarFace()¶

Return type: bool:param theFace: :type theFace: TopoDS_Face :rtype: bool

MoreCurve()¶

Return type: bool

MoreFace()¶

Return type: bool

MoreVertex()¶

Return type: bool

Neighbours()¶

Return type: int

NextCurve()¶

Return type: None

NextFace()¶

Return type: None

NextVertex()¶

Return type: None

Polygon3D()¶

Parameters

l –

type l: TopLoc_Location
rtype: opencascade::handle<Poly_Polygon3D>

PolygonOnTriangulation()¶

Parameters

Indices –

type Indices: Poly_PolygonOnTriangulation
param T
type T: Poly_Triangulation
param l
type l: TopLoc_Location
rtype: None

property thisown¶: The membership flag

class Prs3d_Text¶

Bases: OCC.Core.Prs3d.Prs3d_Root

static Draw()¶

Defines the display of the text. @param theGroup group to add primitives @param theAspect presentation attributes @param theText text to draw @param theAttachmentPoint attachment point

param theGroup

type theGroup

Graphic3d_Group

param theAspect

type theAspect

Prs3d_TextAspect

param theText

type theText

TCollection_ExtendedString

param theAttachmentPoint

type theAttachmentPoint

gp_Pnt

rtype

void* Draws the text label. @param theGroup group to add primitives @param theAspect presentation attributes @param theText text to draw @param theOrientation location and orientation specified in the model 3D space @param theHasOwnAnchor

param theGroup

type theGroup

Graphic3d_Group

param theAspect

type theAspect

Prs3d_TextAspect

param theText

type theText

TCollection_ExtendedString

param theOrientation

type theOrientation

gp_Ax2

param theHasOwnAnchor

default value is Standard_True

type theHasOwnAnchor

bool

rtype

void* Alias to another method Draw() for backward compatibility.

param thePrs

type thePrs

Prs3d_Presentation

param theDrawer

type theDrawer

Prs3d_Drawer

param theText

type theText

TCollection_ExtendedString

param theAttachmentPoint

type theAttachmentPoint

gp_Pnt

rtype

None* Alias to another method Draw() for backward compatibility.

param thePrs

type thePrs

Prs3d_Presentation

param theAspect

type theAspect

Prs3d_TextAspect

param theText

type theText

TCollection_ExtendedString

param theOrientation

type theOrientation

gp_Ax2

param theHasOwnAnchor

default value is Standard_True

type theHasOwnAnchor

bool

rtype

None* Alias to another method Draw() for backward compatibility.

param thePrs

type thePrs

Prs3d_Presentation

param theAspect

type theAspect

Prs3d_TextAspect

param theText

type theText

TCollection_ExtendedString

param theAttachmentPoint

type theAttachmentPoint

gp_Pnt

rtype

None

property thisown¶: The membership flag

class Prs3d_TextAspect(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_BasicAspect

Constructs an empty framework for defining display attributes of text.

rtype

None:param theAspect:

type theAspect

Graphic3d_AspectText3d

rtype

None

Angle()¶

Returns the angle

rtype

float

Aspect()¶

Returns the purely textual attributes used in the display of text. These include: - color - font - height/width ratio, that is, the expansion factor, and - space between characters.

rtype

opencascade::handle<Graphic3d_AspectText3d>

static DownCast(t)¶

DumpJsonToString(Prs3d_TextAspect self, int depth=-1) → std::string¶

Height()¶

Returns the height of the text box.

rtype

float

HorizontalJustification()¶

Returns the horizontal alignment of the text. The range of values includes: - left - center - right, and - normal (justified).

rtype

Graphic3d_HorizontalTextAlignment

Orientation()¶

Returns the orientation of the text. Text can be displayed in the following directions: - up - down - left, or - right

rtype

Graphic3d_TextPath

SetAngle()¶

Sets the angle

param theAngle

type theAngle

float

rtype

None

SetAspect()¶

Parameters

theAspect –

type theAspect: Graphic3d_AspectText3d
rtype: None

SetColor()¶

Sets the color of the type used in text display.

param theColor

type theColor

Quantity_Color

rtype

None

SetFont()¶

Sets the font used in text display.

param theFont

type theFont

char *

rtype

None

SetHeight()¶

Sets the height of the text.

param theHeight

type theHeight

float

rtype

None

SetHorizontalJustification()¶

Sets horizontal alignment of text.

param theJustification

type theJustification

Graphic3d_HorizontalTextAlignment

rtype

None

SetOrientation()¶

Sets the orientation of text.

param theOrientation

type theOrientation

Graphic3d_TextPath

rtype

None

SetVerticalJustification()¶

Sets the vertical alignment of text.

param theJustification

type theJustification

Graphic3d_VerticalTextAlignment

rtype

None

VerticalJustification()¶

Returns the vertical alignment of the text. The range of values includes: - normal - top - cap - half - base - bottom

rtype

Graphic3d_VerticalTextAlignment

property thisown¶: The membership flag

class Prs3d_ToolCylinder(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_ToolQuadric

Initializes the algorithm.

param theBottomRad

type theBottomRad

float

param theTopRad

type theTopRad

float

param theHeight

type theHeight

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

rtype

None

static Create()¶

Generate primitives for 3D quadric surface and return a filled array.

param theBottomRad

type theBottomRad

float

param theTopRad

type theTopRad

float

param theHeight

type theHeight

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

param theTrsf

type theTrsf

gp_Trsf

rtype

opencascade::handle<Graphic3d_ArrayOfTriangles>

property thisown¶: The membership flag

class Prs3d_ToolDisk(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_ToolQuadric

Initializes the algorithm.

param theInnerRadius

type theInnerRadius

float

param theOuterRadius

type theOuterRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

rtype

None

static Create()¶

Generate primitives for 3D quadric surface and return a filled array.

param theInnerRadius

type theInnerRadius

float

param theOuterRadius

type theOuterRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

param theTrsf

type theTrsf

gp_Trsf

rtype

opencascade::handle<Graphic3d_ArrayOfTriangles>

SetAngleRange()¶

Set angle range in radians [0, 2*PI] by default. @param theStartAngle [in] Start angle in counter clockwise order @param theEndAngle [in] End angle in counter clockwise order

param theStartAngle

type theStartAngle

float

param theEndAngle

type theEndAngle

float

rtype

None

property thisown¶: The membership flag

class Prs3d_ToolQuadric(*args, **kwargs)¶

Bases: object

FillArray()¶

Generate primitives for 3D quadric surface and fill the given array. Optional transformation is applied.

param theArray

type theArray

Graphic3d_ArrayOfTriangles

param theTrsf

type theTrsf

gp_Trsf

rtype

None* Generate primitives for 3D quadric surface presentation and fill the given array and poly triangulation structure. Optional transformation is applied.

param theArray

type theArray

Graphic3d_ArrayOfTriangles

param theTriangulation

type theTriangulation

Poly_Triangulation

param theTrsf

type theTrsf

gp_Trsf

rtype

None

static TrianglesNb()¶

Number of triangles for presentation with the given params.

param theSlicesNb

type theSlicesNb

int

param theStacksNb

type theStacksNb

int

rtype

int

property thisown¶: The membership flag

class Prs3d_ToolSector(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_ToolQuadric

Initializes the algorithm.

param theRadius

type theRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

rtype

None

static Create()¶

Generate primitives for 3D quadric surface and return a filled array.

param theRadius

type theRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

param theTrsf

type theTrsf

gp_Trsf

rtype

opencascade::handle<Graphic3d_ArrayOfTriangles>

property thisown¶: The membership flag

class Prs3d_ToolSphere(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_ToolQuadric

Initializes the algorithm.

param theRadius

type theRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

rtype

None

static Create()¶

Generate primitives for 3D quadric surface and return a filled array.

param theRadius

type theRadius

float

param theNbSlices

type theNbSlices

int

param theNbStacks

type theNbStacks

int

param theTrsf

type theTrsf

gp_Trsf

rtype

opencascade::handle<Graphic3d_ArrayOfTriangles>

property thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class prs3d¶

Bases: object

static AddPrimitivesGroup()¶

Add primitives into new group in presentation and clear the list of polylines.

param thePrs

type thePrs

Prs3d_Presentation

param theAspect

type theAspect

Prs3d_LineAspect

param thePolylines

type thePolylines

Prs3d_NListOfSequenceOfPnt

rtype

void

static GetDeflection()¶

Computes the absolute deflection value depending on the type of deflection in theDrawer: <ul> <li>Aspect_TOD_RELATIVE: the absolute deflection is computed using the relative deviation coefficient from theDrawer and the shape’s bounding box;</li> <li>Aspect_TOD_ABSOLUTE: the maximal chordial deviation from theDrawer is returned.</li> </ul> In case of the type of deflection in theDrawer computed relative deflection for shape is stored as absolute deflection. It is necessary to use it later on for sub-shapes. This function should always be used to compute the deflection value for building discrete representations of the shape (triangualtion, wireframe) to avoid incosistencies between different representations of the shape and undesirable visual artifacts.

param theShape

type theShape

TopoDS_Shape

param theDrawer

type theDrawer

Prs3d_Drawer

rtype

float

static MatchSegment()¶

draws an arrow at a given location, with respect to a given direction.

param X

type X

float

param Y

type Y

float

param Z

type Z

float

param aDistance

type aDistance

float

param p1

type p1

gp_Pnt

param p2

type p2

gp_Pnt

param dist

type dist

float

rtype

bool

static PrimitivesFromPolylines()¶

Assembles array of primitives for sequence of polylines. @param thePoints [in] the polylines sequence returns array of primitives

param thePoints

type thePoints

Prs3d_NListOfSequenceOfPnt

rtype

opencascade::handle<Graphic3d_ArrayOfPrimitives>

property thisown¶: The membership flag