OCC.Prs3d module¶

The Prs3d package provides the following services- a presentation object (the context for allmodifications to the display, its presentation will bedisplayed in every view of an active viewer)- an attribute manager governing how objects suchas color, width, and type of line are displayed;these are generic objects, whereas those inStdPrs are specific geometries and topologies.- generic algorithms providing default settings forobjects such as points, curves, surfaces and shapes- a root object which provides the abstractframework for the DsgPrs definitions at work indisplay of dimensions, relations and trihedra.

class Handle_Prs3d_ArrowAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_BasicAspect(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_DatumAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_DimensionAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_Drawer(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_IsoAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_LineAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_LineAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_PlaneAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_PlaneSet(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_PointAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_Presentation(*args)¶

Bases: OCC.Graphic3d.Handle_Graphic3d_Structure

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_PresentationShadow(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_Presentation

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_Projector(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_ShadingAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_Prs3d_TextAspect(*args)¶

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Prs3d_Arrow¶

Bases: OCC.Prs3d.Prs3d_Root

static Draw()¶

Defines the representation of the arrow defined by the location point aLocation, the direction aDirection and the length aLength. The angle anAngle defines the angle of opening of the arrow head. The presentation object aPresentation stores the information defined in this framework.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aLocation (gp_Pnt) – aDirection (gp_Dir) – anAngle (Quantity_PlaneAngle) – aLength (Quantity_Length) –
Return type:	void

static Fill()¶

Defines the representation of the arrow defined by the location point aLocation, the direction vector aDirection and the length aLength. The angle anAngle defines the angle of opening of the arrow head, and the drawer aDrawer specifies the display attributes which arrows will have. With this syntax, no presentation object is created.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aLocation (gp_Pnt) – aDirection (gp_Dir) – anAngle (Quantity_PlaneAngle) – aLength (Quantity_Length) –
Return type:	void

thisown¶: The membership flag

class Prs3d_ArrowAspect(*args)¶

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

Return type:	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.

Parameters:	anAngle (Quantity_PlaneAngle) – aLength (Quantity_Length) – theAspect (Handle_Graphic3d_AspectLine3d &) –
Return type:	None
Return type:	None

Angle()¶

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

Return type:	Quantity_PlaneAngle

Aspect()¶

Return type:	Handle_Graphic3d_AspectLine3d

GetHandle()¶

Length()¶

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

Return type:	Quantity_Length

SetAngle()¶

defines the angle of the arrows.

Parameters:	anAngle (Quantity_PlaneAngle) –
Return type:	None

SetAspect()¶

Parameters:	theAspect (Handle_Graphic3d_AspectLine3d &) –
Return type:	None

SetColor()¶

Parameters:	aColor (Quantity_NameOfColor) – aColor –
Return type:	None
Return type:	None

SetLength()¶

defines the length of the arrows.

Parameters:	aLength (Quantity_Length) –
Return type:	None

thisown¶: The membership flag

Prs3d_Arrow_Draw()¶

Defines the representation of the arrow defined by the location point aLocation, the direction aDirection and the length aLength. The angle anAngle defines the angle of opening of the arrow head. The presentation object aPresentation stores the information defined in this framework.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aLocation (gp_Pnt) – aDirection (gp_Dir) – anAngle (Quantity_PlaneAngle) – aLength (Quantity_Length) –
Return type:	void

Prs3d_Arrow_Fill()¶

Defines the representation of the arrow defined by the location point aLocation, the direction vector aDirection and the length aLength. The angle anAngle defines the angle of opening of the arrow head, and the drawer aDrawer specifies the display attributes which arrows will have. With this syntax, no presentation object is created.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aLocation (gp_Pnt) – aDirection (gp_Dir) – anAngle (Quantity_PlaneAngle) – aLength (Quantity_Length) –
Return type:	void

class Prs3d_BasicAspect(*args, **kwargs)¶

Bases: OCC.MMgt.MMgt_TShared

GetHandle()¶

thisown¶: The membership flag

class Prs3d_DatumAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

An empty framework to define the display of datums.

Return type:	None

DrawFirstAndSecondAxis()¶

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

Return type:	bool

DrawThirdAxis()¶

Returns true if the third axis can be drawn.

Return type:	bool

FirstAxisAspect()¶

Returns the attributes for display of the first axis.

Return type:	Handle_Prs3d_LineAspect

FirstAxisLength()¶

Returns the length of the displayed first axis.

Return type:	Quantity_Length

GetHandle()¶

SecondAxisAspect()¶

Returns the attributes for display of the second axis.

Return type:	Handle_Prs3d_LineAspect

SecondAxisLength()¶

Returns the length of the displayed second axis.

Return type:	Quantity_Length

SetAxisLength()¶

Sets the lengths L1, L2 and L3 of the three axes.

Parameters:	L1 (float) – L2 (float) – L3 (float) –
Return type:	None

SetDrawFirstAndSecondAxis()¶

Sets the DrawFirstAndSecondAxis attributes to active.

Parameters:	draw (bool) –
Return type:	None

SetDrawThirdAxis()¶

Sets the DrawThirdAxis attributes to active.

Parameters:	draw (bool) –
Return type:	None

ThirdAxisAspect()¶

Returns the attributes for display of the third axis.

Return type:	Handle_Prs3d_LineAspect

ThirdAxisLength()¶

Returns the length of the displayed third axis.

Return type:	Quantity_Length

thisown¶: The membership flag

class Prs3d_DimensionAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

Constructs an empty framework to define the display of dimensions.

Return type:	None

ArrowAspect()¶

Returns the settings for displaying arrows.

Return type:	Handle_Prs3d_ArrowAspect

ArrowOrientation()¶

Gets orientation of arrows (external or internal).

Return type:	Prs3d_DimensionArrowOrientation

ArrowTailSize()¶

Returns arrow tail size.

Return type:	float

ExtensionSize()¶

Returns extension size.

Return type:	float

GetHandle()¶

IsArrows3d()¶

Gets type of arrows.

Return type:	bool

IsText3d()¶

Check if text for dimension label is 3d.

Return type:	bool

IsTextShaded()¶

Check if 3d text for dimension label is shaded.

Return type:	bool

IsUnitsDisplayed()¶

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

Return type:	bool

LineAspect()¶

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

Return type:	Handle_Prs3d_LineAspect

MakeArrows3d()¶

Sets type of arrows.

Parameters:	isArrows3d (bool) –
Return type:	None

MakeText3d()¶

Sets type of text.

Parameters:	isText3d (bool) –
Return type:	None

MakeTextShaded()¶

Turns on/off text shading for 3d text.

Parameters:	isTextShaded (bool) –
Return type:	None

MakeUnitsDisplayed()¶

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

Parameters:	theIsDisplayed (bool) –
Return type:	None

SetArrowAspect()¶

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

Parameters:	theAspect (Handle_Prs3d_ArrowAspect &) –
Return type:	None

SetArrowOrientation()¶

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

Parameters:	theArrowOrient (Prs3d_DimensionArrowOrientation) –
Return type:	None

SetArrowTailSize()¶

Set size for arrow tail (extension without text).

Parameters:	theSize (float) –
Return type:	None

SetCommonColor()¶

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

Parameters:	theColor (Quantity_Color &) –
Return type:	None

SetExtensionSize()¶

Sets extension size.

Parameters:	theSize (float) –
Return type:	None

SetLineAspect()¶

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

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	None

SetTextAspect()¶

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

Parameters:	theAspect (Handle_Prs3d_TextAspect &) –
Return type:	None

SetTextHorizontalPosition()¶

Sets horizontal text alignment for text label.

Parameters:	thePosition (Prs3d_DimensionTextHorizontalPosition) –
Return type:	None

SetTextVerticalPosition()¶

Sets vertical text alignment for text label.

Parameters:	thePosition (Prs3d_DimensionTextVerticalPosition) –
Return type:	None

SetValueStringFormat()¶

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

Parameters:	theFormat (TCollection_AsciiString &) –
Return type:	None

TextAspect()¶

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

Return type:	Handle_Prs3d_TextAspect

TextHorizontalPosition()¶

Gets horizontal text alignment for text label.

Return type:	Prs3d_DimensionTextHorizontalPosition

TextVerticalPosition()¶

Gets vertical text alignment for text label.

Return type:	Prs3d_DimensionTextVerticalPosition

ValueStringFormat()¶

Returns format.

Return type:	TCollection_AsciiString

thisown¶: The membership flag

class Prs3d_DimensionUnits(*args)¶

Bases: object

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

Return type:	None
Parameters:	theUnits (Prs3d_DimensionUnits &) –
Return type:	None

GetAngleUnits()¶

returns angle units

Return type:	TCollection_AsciiString

GetLengthUnits()¶

returns length units

Return type:	TCollection_AsciiString

SetAngleUnits()¶

Sets angle units

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	None

SetLengthUnits()¶

Sets length units

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	None

thisown¶: The membership flag

class Prs3d_Drawer(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Default constructor.

Return type:	None

ArrowAspect()¶

Returns the attributes for display of arrows.

Return type:	Handle_Prs3d_ArrowAspect

ClearLocalAttributes()¶

Removes local attributes.

Return type:	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

Return type:	Handle_Prs3d_DatumAspect

DeviationAngle()¶

Returns the value for deviation angle.

Return type:	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.

Return type:	float

DimAngleDisplayUnits()¶

Returns angle units in which dimension presentation is displayed.

Return type:	TCollection_AsciiString

DimAngleModelUnits()¶

Returns angle model units for the dimension presentation.

Return type:	TCollection_AsciiString

DimLengthDisplayUnits()¶

Returns length units in which dimension presentation is displayed.

Return type:	TCollection_AsciiString

DimLengthModelUnits()¶

Returns length model units for the dimension presentation.

Return type:	TCollection_AsciiString

DimensionAspect()¶

Returns settings for the appearance of dimensions.

Return type:	Handle_Prs3d_DimensionAspect

DisableDrawHiddenLine()¶

Disables the DrawHiddenLine function.

Return type:	None

Discretisation()¶

Returns the discretisation setting.

Return type:	int

DrawHiddenLine()¶

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

Return type:	bool

EnableDrawHiddenLine()¶

Enables the DrawHiddenLine function.

Return type:	None

FaceBoundaryAspect()¶

Returns line aspect of face boundaries.

Return type:	Handle_Prs3d_LineAspect

FaceBoundaryDraw()¶

Checks whether the face boundary drawing is enabled or not.

Return type:	bool

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

Return type:	Handle_Prs3d_LineAspect

FreeBoundaryDraw()¶

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

Return type:	bool

GetHandle()¶

HLRAngle()¶

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

Return type:	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.

Return type:	float

HasLink()¶

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

Return type:	bool

HasOwnArrowAspect()¶

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

Return type:	bool

HasOwnDatumAspect()¶

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

Return type:	bool

HasOwnDeviationAngle()¶

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

Return type:	bool

HasOwnDeviationCoefficient()¶

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

Return type:	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.

Return type:	bool

HasOwnDimAngleModelUnits()¶

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

Return type:	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.

Return type:	bool

HasOwnDimLengthModelUnits()¶

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

Return type:	bool

HasOwnDimensionAspect()¶

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

Return type:	bool

HasOwnDiscretisation()¶

Returns true if the drawer has discretisation setting active.

Return type:	bool

HasOwnDrawHiddenLine()¶

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

Return type:	bool

HasOwnFaceBoundaryAspect()¶

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

Return type:	bool

HasOwnFaceBoundaryDraw()¶

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

Return type:	bool

HasOwnFreeBoundaryAspect()¶

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

Return type:	bool

HasOwnFreeBoundaryDraw()¶

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

Return type:	bool

HasOwnHLRDeviationAngle()¶

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

Return type:	bool

HasOwnHLRDeviationCoefficient()¶

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

Return type:	bool

HasOwnHiddenLineAspect()¶

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

Return type:	bool

HasOwnIsAutoTriangulation()¶

Returns true if the drawer has IsoOnPlane setting active.

Return type:	bool

HasOwnIsoOnPlane()¶

Returns true if the drawer has IsoOnPlane setting active.

Return type:	bool

HasOwnLineArrowDraw()¶

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

Return type:	bool

HasOwnLineAspect()¶

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

Return type:	bool

HasOwnMaximalChordialDeviation()¶

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

Return type:	bool

HasOwnMaximalParameterValue()¶

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

Return type:	bool

HasOwnPlaneAspect()¶

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

Return type:	bool

HasOwnPointAspect()¶

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

Return type:	bool

HasOwnSectionAspect()¶

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

Return type:	bool

HasOwnSeenLineAspect()¶

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

Return type:	bool

HasOwnShadingAspect()¶

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

Return type:	bool

HasOwnShadingAspectGlobal()¶

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

Return type:	bool

HasOwnTextAspect()¶

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

Return type:	bool

HasOwnTypeOfDeflection()¶

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

Return type:	bool

HasOwnTypeOfHLR()¶

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

Return type:	bool

HasOwnUIsoAspect()¶

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

Return type:	bool

HasOwnUnFreeBoundaryAspect()¶

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

Return type:	bool

HasOwnUnFreeBoundaryDraw()¶

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

Return type:	bool

HasOwnVIsoAspect()¶

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

Return type:	bool

HasOwnVectorAspect()¶

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

Return type:	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.

Return type:	bool

HasOwnWireAspect()¶

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

Return type:	bool

HasOwnWireDraw()¶

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

Return type:	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

Return type:	Handle_Prs3d_LineAspect

IsAutoTriangulation()¶

Returns True if automatic triangulation is enabled.

Return type:	bool

IsoOnPlane()¶

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

Return type:	bool

LineArrowDraw()¶

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

Return type:	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

Return type:	Handle_Prs3d_LineAspect

Link()¶

Returns the drawer to which the current object references.

Return type:	Handle_Prs3d_Drawer

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

Parameters:	theDrawer (Handle_Prs3d_Drawer &) –
Return type:	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.

Return type:	Quantity_Length

MaximalParameterValue()¶

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

Return type:	float

PlaneAspect()¶

Returns settings for the appearance of planes.

Return type:	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.

Return type:	Handle_Prs3d_PointAspect

PreviousDeviationAngle()¶

Returns the previous deviation angle

Return type:	float

PreviousDeviationCoefficient()¶

Saves the previous value used for the chordal deviation coefficient.

Return type:	float

PreviousHLRDeviationAngle()¶

Returns the previous value of the HLR deviation angle.

Return type:	float

PreviousHLRDeviationCoefficient()¶

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

Return type:	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.

Return type:	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

Return type:	Handle_Prs3d_LineAspect

SetArrowAspect()¶

Sets the parameter theAspect for display attributes of arrows.

Parameters:	theAspect (Handle_Prs3d_ArrowAspect &) –
Return type:	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.

Parameters:	theIsEnabled (bool) –
Return type:	None

SetDatumAspect()¶

Sets the modality theAspect for the display of datums.

Parameters:	theAspect (Handle_Prs3d_DatumAspect &) –
Return type:	None

SetDeviationAngle()¶

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

Parameters:	theAngle (float) –
Return type:	None

Sets the hasOwnDeviationAngle flag to Standard_False

Return type:	None

SetDeviationCoefficient()¶

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

Parameters:	theCoefficient (float) –
Return type:	None

Sets the hasOwnDeviationCoefficient flag to Standard_False

Return type:	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.

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	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.

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	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.

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	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.

Parameters:	theUnits (TCollection_AsciiString &) –
Return type:	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.

Parameters:	theAspect (Handle_Prs3d_DimensionAspect &) –
Return type:	None

SetDiscretisation()¶

Sets the discretisation parameter theValue.

Parameters:	theValue (int) –
Return type:	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.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	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.

Parameters:	theIsEnabled (bool) –
Return type:	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.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	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.

Parameters:	theIsEnabled (bool) –
Return type:	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.

Parameters:	theAngle (float) –
Return type:	None

Sets the hasOwnHLRDeviationAngle flag to Standard_False

Return type:	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

Parameters:	theCoefficient (float) –
Return type:	None

Sets the hasOwnHLRDeviationCoefficient flag to Standard_False

Return type:	None

SetHiddenLineAspect()¶

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

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	None

SetIsoOnPlane()¶

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

Parameters:	theIsEnabled (bool) –
Return type:	None

SetLineArrowDraw()¶

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

Parameters:	theIsEnabled (bool) –
Return type:	None

SetLineAspect()¶

Sets the parameter theAspect for display attributes of lines.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	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

Parameters:	theChordialDeviation (Quantity_Length) –
Return type:	None

SetMaximalParameterValue()¶

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

Parameters:	theValue (float) –
Return type:	None

SetPlaneAspect()¶

Sets the parameter theAspect for the display of planes.

Parameters:	theAspect (Handle_Prs3d_PlaneAspect &) –
Return type:	None

SetPointAspect()¶

Sets the parameter theAspect for display attributes of points

Parameters:	theAspect (Handle_Prs3d_PointAspect &) –
Return type:	None

SetSectionAspect()¶

Sets the parameter theAspect for display attributes of sections.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	None

SetSeenLineAspect()¶

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

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	None

SetShadingAspect()¶

Sets the parameter theAspect for display attributes of shading.

Parameters:	theAspect (Handle_Prs3d_ShadingAspect &) –
Return type:	None

SetShadingAspectGlobal()¶

Indicates that the ShadingAspect will be apply to the whole presentation. This allows to modify the aspect without recomputing the content of the presentation.

Parameters:	theValue (bool) –
Return type:	None

SetTextAspect()¶

Sets the parameter theAspect for display attributes of text.

Parameters:	theAspect (Handle_Prs3d_TextAspect &) –
Return type:	None

SetTypeOfDeflection()¶

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

Parameters:	theTypeOfDeflection (Aspect_TypeOfDeflection) –
Return type:	None

SetTypeOfHLR()¶

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

Parameters:	theTypeOfHLR (Prs3d_TypeOfHLR) –
Return type:	None

SetUIsoAspect()¶

Parameters:	theAspect (Handle_Prs3d_IsoAspect &) –
Return type:	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.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	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.

Parameters:	theIsEnabled (bool) –
Return type:	None

SetVIsoAspect()¶

Sets the appearance of V isoparameters - theAspect.

Parameters:	theAspect (Handle_Prs3d_IsoAspect &) –
Return type:	None

SetVectorAspect()¶

Sets the modality theAspect for the display of vectors.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	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.

Parameters:	theMode (Prs3d_VertexDrawMode) –
Return type:	None

SetWireAspect()¶

Sets the parameter theAspect for display of wires.

Parameters:	theAspect (Handle_Prs3d_LineAspect &) –
Return type:	None

SetWireDraw()¶

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

Parameters:	theIsEnabled (bool) –
Return type:	None

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.

Return type:	Handle_Prs3d_ShadingAspect

ShadingAspectGlobal()¶

Returns True if the ShadingAspect is applied to the whole presentation.

Return type:	bool

TextAspect()¶

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

Return type:	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.

Return type:	Aspect_TypeOfDeflection

TypeOfHLR()¶

Returns the type of HLR algorithm currently in use.

Return type:	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: COLOR : Quantity_NOC_GRAY75 TYPE OF LINE: Aspect_TOL_SOLID WIDTH : 0.5 //! These attributes are used by the following algorithms: Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace

Return type:	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

Return type:	Handle_Prs3d_LineAspect

UnFreeBoundaryDraw()¶

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

Return type:	bool

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: COLOR : Quantity_NOC_GRAY82 TYPE OF LINE: Aspect_TOL_SOLID WIDTH : 0.5 //! These attributes are used by the following algorithms: Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace

Return type:	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

Return type:	Handle_Prs3d_LineAspect

VertexDrawMode()¶

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

Return type:	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.

Return type:	Handle_Prs3d_LineAspect

WireDraw()¶

Returns True if the drawing of the wire is enabled.

Return type:	bool

thisown¶: The membership flag

class Prs3d_IsoAspect(*args)¶

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

Parameters:	aColor (Quantity_Color &) – aType (Aspect_TypeOfLine) – aWidth (float) – aNumber (int) – aColor – aType – aWidth – aNumber –
Return type:	None
Return type:	None

GetHandle()¶

Number()¶

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

Return type:	int

SetNumber()¶

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

Parameters:	aNumber (int) –
Return type:	None

thisown¶: The membership flag

class Prs3d_LineAspect(*args)¶

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

Parameters:	aColor (Quantity_Color &) – aType (Aspect_TypeOfLine) – aWidth (float) – aColor – aType – aWidth – theAspect (Handle_Graphic3d_AspectLine3d &) –
Return type:	None
Return type:	None
Return type:	None

Aspect()¶

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

Return type:	Handle_Graphic3d_AspectLine3d

GetHandle()¶

SetAspect()¶

Parameters:	theAspect (Handle_Graphic3d_AspectLine3d &) –
Return type:	None

SetColor()¶

Parameters:	aColor (Quantity_Color &) –
Return type:	None

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

Parameters:	aColor (Quantity_NameOfColor) –
Return type:	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

Parameters:	aType (Aspect_TypeOfLine) –
Return type:	None

SetWidth()¶

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

Parameters:	aWidth (float) –
Return type:	None

thisown¶: The membership flag

class Prs3d_PlaneAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

Constructs an empty framework for the display of planes.

Return type:	None

ArrowAspect()¶

Returns the settings for displaying an arrow.

Return type:	Handle_Prs3d_LineAspect

ArrowsAngle()¶

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

Return type:	Quantity_PlaneAngle

ArrowsLength()¶

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

Return type:	Quantity_Length

ArrowsSize()¶

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

Return type:	Quantity_Length

DisplayCenterArrow()¶

Returns true if the display of center arrows is allowed.

Return type:	bool

DisplayEdges()¶

Return type:	bool

DisplayEdgesArrows()¶

Returns true if the display of edge arrows is allowed.

Return type:	bool

DisplayIso()¶

Returns true if the display of isoparameters is allowed.

Return type:	bool

EdgesAspect()¶

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

Return type:	Handle_Prs3d_LineAspect

GetHandle()¶

IsoAspect()¶

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

Return type:	Handle_Prs3d_LineAspect

IsoDistance()¶

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

Return type:	Quantity_Length

PlaneXLength()¶

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

Return type:	Quantity_Length

PlaneYLength()¶

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

Return type:	Quantity_Length

SetArrowsAngle()¶

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

Parameters:	ang (Quantity_PlaneAngle) –
Return type:	None

SetArrowsLength()¶

Parameters:	L (Quantity_Length) –
Return type:	None

SetArrowsSize()¶

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

Parameters:	L (Quantity_Length) –
Return type:	None

SetDisplayCenterArrow()¶

Sets the display attributes defined in DisplayCenterArrow to active.

Parameters:	draw (bool) –
Return type:	None

SetDisplayEdges()¶

Parameters:	draw (bool) –
Return type:	None

SetDisplayEdgesArrows()¶

Sets the display attributes defined in DisplayEdgesArrows to active.

Parameters:	draw (bool) –
Return type:	None

SetDisplayIso()¶

Sets the display attributes defined in DisplayIso to active.

Parameters:	draw (bool) –
Return type:	None

SetIsoDistance()¶

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

Parameters:	L (Quantity_Length) –
Return type:	None

SetPlaneLength()¶

Parameters:	LX (Quantity_Length) – LY (Quantity_Length) –
Return type:	None

thisown¶: The membership flag

class Prs3d_PlaneSet(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Xdir (float) – Ydir (float) – Zdir (float) – Xloc (Quantity_Length) – Yloc (Quantity_Length) – Zloc (Quantity_Length) – anOffset (Quantity_Length) –
Return type:	None

Direction()¶

Parameters:	X (Quantity_Length &) – Y (Quantity_Length &) – Z (Quantity_Length &) –
Return type:	None

GetHandle()¶

Location()¶

Parameters:	X (Quantity_Length &) – Y (Quantity_Length &) – Z (Quantity_Length &) –
Return type:	None

Offset()¶

Return type:	Quantity_Length

Plane()¶

Return type:	gp_Pln

SetDirection()¶

Parameters:	X (float) – Y (float) – Z (float) –
Return type:	None

SetLocation()¶

Parameters:	X (Quantity_Length) – Y (Quantity_Length) – Z (Quantity_Length) –
Return type:	None

SetOffset()¶

Parameters:	anOffset (Quantity_Length) –
Return type:	None

thisown¶: The membership flag

class Prs3d_PointAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

Parameters:	aType (Aspect_TypeOfMarker) – aColor (Quantity_NameOfColor) – aScale (float) – aType – aColor – aScale –
Return type:	None
Return type:	None

defines only the urer defined marker point.

Parameters:	AColor (Quantity_Color &) – AWidth (int) – AHeight (int) – ATexture (Handle_TColStd_HArray1OfByte &) – theAspect (Handle_Graphic3d_AspectMarker3d &) –
Return type:	None
Return type:	None

Aspect()¶

Return type:	Handle_Graphic3d_AspectMarker3d

GetHandle()¶

GetTexture()¶

Returns marker’s texture.

Return type:	Handle_Graphic3d_MarkerImage

GetTextureSize()¶

Returns marker’s texture size.

Parameters:	AWidth (int &) – AHeight (int &) –
Return type:	None

SetAspect()¶

Parameters:	theAspect (Handle_Graphic3d_AspectMarker3d &) –
Return type:	None

SetColor()¶

Parameters:	aColor (Quantity_Color &) –
Return type:	None

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

Parameters:	aColor (Quantity_NameOfColor) –
Return type:	None

SetScale()¶

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

Parameters:	aScale (float) –
Return type:	None

SetTypeOfMarker()¶

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

Parameters:	aType (Aspect_TypeOfMarker) –
Return type:	None

thisown¶: The membership flag

class Prs3d_Presentation(*args)¶

Bases: OCC.Graphic3d.Graphic3d_Structure

Constructs a presentation object if <Init> is false, no color initialization is done.

Parameters:	theStructManager (Handle_Graphic3d_StructureManager &) – theToInit (bool) – default value is Standard_True
Return type:	None

Constructs a presentation object.

Parameters:	theStructManager (Handle_Graphic3d_StructureManager &) – thePrs (Handle_Prs3d_Presentation &) –
Return type:	None

Compute()¶

Parameters:	aProjector (Handle_Graphic3d_DataStructureManager &) –
Return type:	Handle_Graphic3d_Structure

Returns the new Structure defined for the new visualization

Parameters:	aProjector (Handle_Graphic3d_DataStructureManager &) – AMatrix (TColStd_Array2OfReal &) –
Return type:	Handle_Graphic3d_Structure

Returns the new Structure defined for the new visualization

Parameters:	aProjector (Handle_Graphic3d_DataStructureManager &) – aStructure (Handle_Graphic3d_Structure &) –
Return type:	void

Returns the new Structure defined for the new visualization

Parameters:	aProjector (Handle_Graphic3d_DataStructureManager &) – AMatrix (TColStd_Array2OfReal &) – aStructure (Handle_Graphic3d_Structure &) –
Return type:	void

Connect()¶

Parameters:	aPresentation (Handle_Prs3d_Presentation &) –
Return type:	None

GetHandle()¶

Move()¶

Parameters:	X (Quantity_Length) – Y (Quantity_Length) – Z (Quantity_Length) –
Return type:	None

Multiply()¶

Parameters:	aTransformation (Handle_Geom_Transformation &) –
Return type:	None

Place()¶

Parameters:	X (Quantity_Length) – Y (Quantity_Length) – Z (Quantity_Length) –
Return type:	None

Remove()¶

Parameters:	aPresentation (Handle_Prs3d_Presentation &) –
Return type:	None

RemoveAll()¶

Return type:	None

SetShadingAspect()¶

Parameters:	aShadingAspect (Handle_Prs3d_ShadingAspect &) –
Return type:	None

Transform()¶

Parameters:	aTransformation (Handle_Geom_Transformation &) –
Return type:	None

Transformation()¶

Return type:	Handle_Geom_Transformation

thisown¶: The membership flag

class Prs3d_PresentationShadow(*args)¶

Bases: OCC.Prs3d.Prs3d_Presentation

Constructs a shadow of existing presentation object.

Parameters:	theViewer (Handle_Graphic3d_StructureManager &) – thePrs (Handle_Prs3d_Presentation &) –
Return type:	None

GetHandle()¶

thisown¶: The membership flag

class Prs3d_Projector(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Pr (HLRAlgo_Projector &) –
Return type:	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.

Parameters:	Pers (bool) – Focus (Quantity_Length) – DX (Quantity_Length) – DY (Quantity_Length) – DZ (Quantity_Length) – XAt (Quantity_Length) – YAt (Quantity_Length) – ZAt (Quantity_Length) – XUp (Quantity_Length) – YUp (Quantity_Length) – ZUp (Quantity_Length) –
Return type:	None

GetHandle()¶

Projector()¶

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

Return type:	HLRAlgo_Projector

thisown¶: The membership flag

class Prs3d_Root¶

Bases: object

static CurrentGroup()¶

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

Parameters:	Prs3d (Handle_Prs3d_Presentation &) –
Return type:	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.

Parameters:	Prs3d (Handle_Prs3d_Presentation &) –
Return type:	Handle_Graphic3d_Group

thisown¶: The membership flag

Prs3d_Root_CurrentGroup()¶

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

Parameters:	Prs3d (Handle_Prs3d_Presentation &) –
Return type:	Handle_Graphic3d_Group

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

Parameters:	Prs3d (Handle_Prs3d_Presentation &) –
Return type:	Handle_Graphic3d_Group

class Prs3d_ShadingAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

Constructs an empty framework to display shading.

Return type:	None
Parameters:	theAspect (Handle_Graphic3d_AspectFillArea3d &) –
Return type:	None

Aspect()¶

Returns the polygons aspect properties.

Return type:	Handle_Graphic3d_AspectFillArea3d

Color()¶

Returns the polygons color.

Parameters:	aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:	Quantity_Color

GetHandle()¶

Material()¶

Returns the polygons material aspect.

Parameters:	aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:	Graphic3d_MaterialAspect

SetAspect()¶

Parameters:	theAspect (Handle_Graphic3d_AspectFillArea3d &) –
Return type:	None

SetColor()¶

Change the polygons interior color and material ambient color.

Parameters:	aColor (Quantity_Color &) – aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE
Return type:	None

Change the polygons interior color and material ambient color.

Parameters:	aColor (Quantity_NameOfColor) – aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE
Return type:	None

SetMaterial()¶

Change the polygons material aspect.

Parameters:	aMaterial (Graphic3d_NameOfMaterial) – aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE aMaterial – aModel – default value is Aspect_TOFM_BOTH_SIDE
Return type:	None
Return type:	None

SetTransparency()¶

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

Parameters:	aValue (float) – aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE
Return type:	None

Transparency()¶

Returns the polygons transparency value.

Parameters:	aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:	float

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.

Parameters:	theShape (TopoDS_Shape &) – theAllVertices (bool) – default value is Standard_False
Return type:	None

CurrentTriangulation()¶

Parameters:	l (TopLoc_Location &) –
Return type:	Handle_Poly_Triangulation

CurveBound()¶

Return type:	Bnd_Box

FaceBound()¶

Return type:	Bnd_Box

FacesOfEdge()¶

Return type:	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

IsPlanarFace()¶

Return type:	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 (TopLoc_Location &) –
Return type:	Handle_Poly_Polygon3D

PolygonOnTriangulation()¶

Parameters:	Indices (Handle_Poly_PolygonOnTriangulation &) – T (Handle_Poly_Triangulation &) – l (TopLoc_Location &) –
Return type:	None

thisown¶: The membership flag

class Prs3d_Text¶

Bases: OCC.Prs3d.Prs3d_Root

static Draw()¶

Defines the display of the text aText at the point AttachmentPoint. The drawer aDrawer specifies the display attributes which texts will have. The presentation object aPresentation stores the information defined in this framework. static void Draw (const Handle_Prs3d_Presentation& aPresentation, const Handle_Prs3d_TextAspect& anAspect, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint);

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aDrawer (Handle_Prs3d_Drawer &) – aText (TCollection_ExtendedString &) – AttachmentPoint (gp_Pnt) –
Return type:	void

Defines the display of the text aText at the point AttachmentPoint. The text aspect object anAspect specifies the display attributes which texts will have. The presentation object aPresentation stores the information defined in this framework. This syntax could be used if you had not already defined text display attributes in a drawer or if you wanted to exceptionally overide the definition provided in your drawer.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – anAspect (Handle_Prs3d_TextAspect &) – aText (TCollection_ExtendedString &) – AttachmentPoint (gp_Pnt) –
Return type:	void

thisown¶: The membership flag

class Prs3d_TextAspect(*args)¶

Bases: OCC.Prs3d.Prs3d_BasicAspect

Constructs an empty framework for defining display attributes of text.

Return type:	None
Parameters:	theAspect (Handle_Graphic3d_AspectText3d &) –
Return type:	None

Angle()¶

Returns the angle

Return type:	Quantity_PlaneAngle

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.

Return type:	Handle_Graphic3d_AspectText3d

GetHandle()¶

Height()¶

Returns the height of the text box.

Return type:	float

HorizontalJustification()¶

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

Return type:	Graphic3d_HorizontalTextAlignment

Orientation()¶

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

Return type:	Graphic3d_TextPath

SetAngle()¶

Sets the angle

Parameters:	anAngle (Quantity_PlaneAngle) –
Return type:	None

SetAspect()¶

Parameters:	theAspect (Handle_Graphic3d_AspectText3d &) –
Return type:	None

SetColor()¶

Parameters:	aColor (Quantity_Color &) –
Return type:	None

Sets the color of the type used in text display.

Parameters:	aColor (Quantity_NameOfColor) –
Return type:	None

SetFont()¶

Sets the font used in text display.

Parameters:	aFont (char *) –
Return type:	None

SetHeight()¶

Sets the height of the text.

Parameters:	aHeight (float) –
Return type:	None

SetHeightWidthRatio()¶

Returns the height-width ratio, also known as the expansion factor.

Parameters:	aRatio (float) –
Return type:	None

SetHorizontalJustification()¶

Sets horizontal alignment of text.

Parameters:	aJustification (Graphic3d_HorizontalTextAlignment) –
Return type:	None

SetOrientation()¶

Sets the orientation of text.

Parameters:	anOrientation (Graphic3d_TextPath) –
Return type:	None

SetSpace()¶

Sets the length of the box which text will occupy.

Parameters:	aSpace (Quantity_Length) –
Return type:	None

SetVerticalJustification()¶

Sets the vertical alignment of text.

Parameters:	aJustification (Graphic3d_VerticalTextAlignment) –
Return type:	None

VerticalJustification()¶

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

Return type:	Graphic3d_VerticalTextAlignment

thisown¶: The membership flag

Prs3d_Text_Draw()¶

Defines the display of the text aText at the point AttachmentPoint. The drawer aDrawer specifies the display attributes which texts will have. The presentation object aPresentation stores the information defined in this framework. static void Draw (const Handle_Prs3d_Presentation& aPresentation, const Handle_Prs3d_TextAspect& anAspect, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint);

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – aDrawer (Handle_Prs3d_Drawer &) – aText (TCollection_ExtendedString &) – AttachmentPoint (gp_Pnt) –
Return type:	void

Defines the display of the text aText at the point AttachmentPoint. The text aspect object anAspect specifies the display attributes which texts will have. The presentation object aPresentation stores the information defined in this framework. This syntax could be used if you had not already defined text display attributes in a drawer or if you wanted to exceptionally overide the definition provided in your drawer.

Parameters:	aPresentation (Handle_Prs3d_Presentation &) – anAspect (Handle_Prs3d_TextAspect &) – aText (TCollection_ExtendedString &) – AttachmentPoint (gp_Pnt) –
Return type:	void

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

thisown¶: The membership flag

value()¶

new_instancemethod(func, inst, cls)¶

class prs3d¶

Bases: object

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.

Parameters:	theShape (TopoDS_Shape &) – theDrawer (Handle_Prs3d_Drawer &) –
Return type:	float

static MatchSegment()¶

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

Parameters:	X (Quantity_Length) – Y (Quantity_Length) – Z (Quantity_Length) – aDistance (Quantity_Length) – p1 (gp_Pnt) – p2 (gp_Pnt) – dist (Quantity_Length &) –
Return type:	bool

thisown¶: The membership flag

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

Parameters:	theShape (TopoDS_Shape &) – theDrawer (Handle_Prs3d_Drawer &) –
Return type:	float

prs3d_MatchSegment()¶

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

Parameters:	X (Quantity_Length) – Y (Quantity_Length) – Z (Quantity_Length) – aDistance (Quantity_Length) – p1 (gp_Pnt) – p2 (gp_Pnt) – dist (Quantity_Length &) –
Return type:	bool

register_handle(handle, base_object)¶: Inserts the handle into the base object to prevent memory corruption in certain cases