OCC.Prs3d module

class OCC.Prs3d.Handle_Prs3d_ArrowAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_BasicAspect(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_DatumAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_DimensionAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_Drawer(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_IsoAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_LineAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_LineAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_PlaneAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_PlaneSet(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_PointAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_Presentation(*args)

Bases: OCC.Graphic3d.Handle_Graphic3d_Structure

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_Projector(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_ShadingAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Handle_Prs3d_TextAspect(*args)

Bases: OCC.Prs3d.Handle_Prs3d_BasicAspect

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

The membership flag

class OCC.Prs3d.Prs3d_Arrow(*args, **kwargs)

Bases: OCC.Prs3d.Prs3d_Root

static Draw(*args)
  • 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(*args)
  • 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 OCC.Prs3d.Prs3d_ArrowAspect(*args)

Bases: OCC.Prs3d.Prs3d_BasicAspect

Angle()
  • returns the current value of the angle used when drawing an arrow.
Return type:Quantity_PlaneAngle
GetHandle()

Prs3d_ArrowAspect_GetHandle(Prs3d_ArrowAspect self) -> Handle_Prs3d_ArrowAspect

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
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
aspect()
Return type:Handle_Graphic3d_AspectLine3d
thisown

The membership flag

OCC.Prs3d.Prs3d_Arrow_Draw(*args)
  • 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

OCC.Prs3d.Prs3d_Arrow_Fill(*args)
  • 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 OCC.Prs3d.Prs3d_BasicAspect(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

Prs3d_BasicAspect_GetHandle(Prs3d_BasicAspect self) -> Handle_Prs3d_BasicAspect

thisown

The membership flag

class OCC.Prs3d.Prs3d_DatumAspect

Bases: OCC.Prs3d.Prs3d_BasicAspect

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

Prs3d_DatumAspect_GetHandle(Prs3d_DatumAspect self) -> Handle_Prs3d_DatumAspect

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 OCC.Prs3d.Prs3d_DimensionAspect

Bases: OCC.Prs3d.Prs3d_BasicAspect

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

Prs3d_DimensionAspect_GetHandle(Prs3d_DimensionAspect self) -> Handle_Prs3d_DimensionAspect

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 OCC.Prs3d.Prs3d_DimensionUnits(*args)

Bases: object

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 OCC.Prs3d.Prs3d_Drawer

Bases: OCC.MMgt.MMgt_TShared

ArrowAspect()
  • Returns the attributes for display of arrows.
Return type:Handle_Prs3d_ArrowAspect
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.
Return type:Handle_Prs3d_DatumAspect
DeviationAngle()
  • Returns the value for deviation angle.
Return type:float
DeviationCoefficient()
  • Returns the deviation coefficient.
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:void
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:void
FaceBoundaryAspect()
  • Returns line aspect of face boundaries.
Return type:Handle_Prs3d_LineAspect
FreeBoundaryAspect()
  • Stores 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. These attributes are used by the algorithm Prs3d_WFShape
Return type:Handle_Prs3d_LineAspect
FreeBoundaryDraw()
  • Returns True if the drawing of the shared boundaries is disabled. True is the default setting.
Return type:bool
GetHandle()

Prs3d_Drawer_GetHandle(Prs3d_Drawer self) -> Handle_Prs3d_Drawer

HLRAngle()
  • Returns the real number value of the deviation angle in hidden line removal views. The default value is 20*PI/180.
Return type:float
HLRDeviationCoefficient()
  • Returns the real number value of the hidden line removal deviation coefficient.
Return type:float
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.
Return type:Handle_Prs3d_LineAspect
IsFaceBoundaryDraw()
  • Checks whether the face boundary drawing is enabled or not.
Return type:bool
IsoOnPlane()
  • Returns True if the drawing of isos on planes is enabled.
Return type:bool
LineArrowDraw()
  • Sets LineArrowDraw on or off by setting the parameter OnOff to true or false.
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. These attributes are used by the following algorithms: Prs3d_Curve Prs3d_Line Prs3d_HLRShape
Return type:Handle_Prs3d_LineAspect
MaximalChordialDeviation()
  • returns the maximal chordial deviation. Default value is 0.1
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. These attributes are used by the algorithms Prs3d_Point.
Return type:Handle_Prs3d_PointAspect
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. 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.
Return type:Handle_Prs3d_LineAspect
SetArrowAspect()
  • Sets the parameter anAspect for display attributes of arrows.
Parameters:anAspect (Handle_Prs3d_ArrowAspect &) –
Return type:void
SetDatumAspect()
  • Sets the modality anAspect for the display of datums.
Parameters:anAspect (Handle_Prs3d_DatumAspect &) –
Return type:void
SetDeviationAngle()
  • Sets deviation angle
Parameters:anAngle (float) –
Return type:void
SetDeviationCoefficient()
  • Sets the deviation coefficient aCoefficient.
Parameters:aCoefficient (float) –
Return type:void
SetDimAngleDisplayUnits()
  • Sets angle units in which value for dimension presentation is displayed.
Parameters:theUnits (TCollection_AsciiString &) –
Return type:void
SetDimAngleModelUnits()
  • Sets dimension angle model units for computing of dimension presentation.
Parameters:theUnits (TCollection_AsciiString &) –
Return type:void
SetDimLengthDisplayUnits()
  • Sets length units in which value for dimension presentation is displayed.
Parameters:theUnits (TCollection_AsciiString &) –
Return type:void
SetDimLengthModelUnits()
  • Sets dimension length model units for computing of dimension presentation.
Parameters:theUnits (TCollection_AsciiString &) –
Return type:void
SetDimensionAspect()
  • Sets the settings for the appearance of dimensions.
Parameters:theAspect (Handle_Prs3d_DimensionAspect &) –
Return type:void
SetDiscretisation()
  • Sets the discretisation parameter d.
Parameters:d (Standard_Integer) –
Return type:void
SetFaceBoundaryAspect()
  • Sets line aspect for face boundaries. theAspect is the line aspect that determines the look of the face boundaries.
Parameters:theAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetFaceBoundaryDraw()
  • Enables or disables face boundary drawing for shading presentations. theIsEnabled is a boolean flag indicating whether the face boundaries should be drawn or not.
Parameters:theIsEnabled (bool) –
Return type:void
SetFreeBoundaryAspect()
  • Sets the parameter anAspect for the display of free boundaries.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetFreeBoundaryDraw()
  • Sets free boundary drawing on or off by setting the parameter OnOff to true or false.
Parameters:OnOff (bool) –
Return type:void
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*PI/180.
Parameters:anAngle (float) –
Return type:void
SetHLRDeviationCoefficient()
  • Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
Parameters:aCoefficient (float) –
Return type:void
SetHiddenLineAspect()
  • Sets the parameter anAspect for the display of hidden lines in hidden line removal mode.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetIsoOnPlane()
  • Sets IsoOnPlane on or off by setting the parameter OnOff to true or false.
Parameters:OnOff (bool) –
Return type:void
SetLineArrowDraw()
  • enables the drawing of an arrow at the end of each line. By default the arrows are not drawn.
Parameters:OnOff (bool) –
Return type:void
SetLineAspect()
  • Sets the parameter anAspect for display attributes of lines.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
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:aChordialDeviation (Quantity_Length) –
Return type:void
SetMaximalParameterValue()
  • defines the maximum value allowed for the first and last parameters of an infinite curve. Default value: 500.
Parameters:Value (float) –
Return type:void
SetPlaneAspect()
  • Sets the parameter anAspect for the display of planes.
Parameters:anAspect (Handle_Prs3d_PlaneAspect &) –
Return type:void
SetPointAspect()
  • Sets the parameter anAspect for display attributes of points
Parameters:anAspect (Handle_Prs3d_PointAspect &) –
Return type:void
SetSectionAspect()
  • Sets the parameter theAspect for display attributes of sections.
Parameters:theAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetSeenLineAspect()
  • Sets the parameter anAspect for the display of seen lines in hidden line removal mode.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetShadingAspect()
  • Sets the parameter anAspect for display attributes of shading.
Parameters:anAspect (Handle_Prs3d_ShadingAspect &) –
Return type:void
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:aValue (bool) –
Return type:void
SetTextAspect()
  • Sets the parameter anAspect for display attributes of text.
Parameters:anAspect (Handle_Prs3d_TextAspect &) –
Return type:void
SetTypeOfDeflection()
  • Sets the type of chordal deflection. This indicates whether the deflection value is absolute or relative to the size of the object.
Parameters:aTypeOfDeflection (Aspect_TypeOfDeflection) –
Return type:void
SetTypeOfHLR()
  • Sets the type of HLR algorithm used by drawer’s interactive objects
Parameters:theTypeOfHLR (Prs3d_TypeOfHLR) –
Return type:void
SetUIsoAspect()
Parameters:anAspect (Handle_Prs3d_IsoAspect &) –
Return type:void
SetUnFreeBoundaryAspect()
  • Sets the parameter anAspect for the display of shared boundaries.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetUnFreeBoundaryDraw()
  • Sets FreeBoundaryDraw on or off by setting the parameter OnOff to true or false. By default the unfree boundaries are drawn.
Parameters:OnOff (bool) –
Return type:void
SetVIsoAspect()
  • Sets the appearance of V isoparameters - anAspect.
Parameters:anAspect (Handle_Prs3d_IsoAspect &) –
Return type:void
SetVectorAspect()
  • Sets the modality anAspect for the display of vectors.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetWireAspect()
  • Sets the parameter anAspect for display of wires.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:void
SetWireDraw()
  • Sets WireDraw on or off by setting the parameter OnOff to true or false.
Parameters:OnOff (bool) –
Return type:void
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()
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()
  • Gets the myTypeOfHLR value
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.
Return type:Handle_Prs3d_LineAspect
WireAspect()
  • Returns wire aspect settings. The LineAspect for the wire can be edited. The default values are: Color: Quantity_NOC_RED Type of line: Aspect_TOL_SOLID Width: 1. 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 OCC.Prs3d.Prs3d_IsoAspect(*args)

Bases: OCC.Prs3d.Prs3d_LineAspect

GetHandle()

Prs3d_IsoAspect_GetHandle(Prs3d_IsoAspect self) -> Handle_Prs3d_IsoAspect

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 (Standard_Integer) –
Return type:None
thisown

The membership flag

class OCC.Prs3d.Prs3d_LineAspect(*args)

Bases: OCC.Prs3d.Prs3d_BasicAspect

GetHandle()

Prs3d_LineAspect_GetHandle(Prs3d_LineAspect self) -> Handle_Prs3d_LineAspect

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
aspect()
  • Returns the line aspect. This is defined as the set of color, type and thickness attributes.
Return type:Handle_Graphic3d_AspectLine3d
thisown

The membership flag

class OCC.Prs3d.Prs3d_PlaneAspect

Bases: OCC.Prs3d.Prs3d_BasicAspect

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

Prs3d_PlaneAspect_GetHandle(Prs3d_PlaneAspect self) -> Handle_Prs3d_PlaneAspect

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 OCC.Prs3d.Prs3d_PlaneSet(*args)

Bases: OCC.MMgt.MMgt_TShared

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

None

GetHandle()

Prs3d_PlaneSet_GetHandle(Prs3d_PlaneSet self) -> Handle_Prs3d_PlaneSet

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 OCC.Prs3d.Prs3d_PointAspect(*args)

Bases: OCC.Prs3d.Prs3d_BasicAspect

GetHandle()

Prs3d_PointAspect_GetHandle(Prs3d_PointAspect self) -> Handle_Prs3d_PointAspect

GetTexture()
  • Returns marker’s texture.
Return type:Graphic3d_MarkerImage_Handle
GetTextureSize()
  • Returns marker’s texture size.
Parameters:
  • AWidth (Standard_Integer &) –
  • AHeight (Standard_Integer &) –
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
aspect()
Return type:Handle_Graphic3d_AspectMarker3d
thisown

The membership flag

class OCC.Prs3d.Prs3d_Presentation(*args)

Bases: OCC.Graphic3d.Graphic3d_Structure

BoundBox()
Return type:None
Clear()
  • removes the whole content of the presentation. Does not remove the other connected presentations. //! if WithDestruction == Standard_False then //! clears all the groups of primitives in the structure.
Parameters:WithDestruction (bool) – default value is Standard_True
Return type:void
  • removes the whole content of the presentation. Does not remove the other connected presentations. //! if WithDestruction == Standard_False then //! clears all the groups of primitives in the structure.
Parameters:WithDestruction (bool) – default value is Standard_True
Return type:void
Color()
  • displays the whole content of the presentation in the specified color.
Parameters:aColor (Quantity_NameOfColor) –
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()

Prs3d_Presentation_GetHandle(Prs3d_Presentation self) -> Handle_Prs3d_Presentation

Highlight()
  • displays the whole content of the presentation in white.
Return type:None
IsPickable()
Return type:bool
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
SetPickable()
Return type:None
SetShadingAspect()
Parameters:aShadingAspect (Handle_Prs3d_ShadingAspect &) –
Return type:None
SetUnPickable()
Return type:None
Transform()
Parameters:aTransformation (Handle_Geom_Transformation &) –
Return type:None
Transformation()
Return type:Handle_Geom_Transformation
thisown

The membership flag

class OCC.Prs3d.Prs3d_Projector(*args)

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

Prs3d_Projector_GetHandle(Prs3d_Projector self) -> Handle_Prs3d_Projector

Projector()
  • Returns a projector object for use in a hidden line removal algorithm.
Return type:HLRAlgo_Projector
thisown

The membership flag

class OCC.Prs3d.Prs3d_Root(*args, **kwargs)

Bases: object

static CurrentGroup(*args)
  • 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(*args)
  • 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

OCC.Prs3d.Prs3d_Root_CurrentGroup(*args)
  • 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
OCC.Prs3d.Prs3d_Root_NewGroup(*args)
  • 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 OCC.Prs3d.Prs3d_ShadingAspect

Bases: OCC.Prs3d.Prs3d_BasicAspect

Color()
  • Returns the polygons color.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:Quantity_Color
  • Returns the polygons color.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:Quantity_Color
GetHandle()

Prs3d_ShadingAspect_GetHandle(Prs3d_ShadingAspect self) -> Handle_Prs3d_ShadingAspect

Material()
  • Returns the polygons material aspect.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:Graphic3d_MaterialAspect
  • Returns the polygons material aspect.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:Graphic3d_MaterialAspect
SetAspect()
  • Change the polygons aspect properties.
Parameters:Asp (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_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

  • 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_MaterialAspect &) –
  • aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE
Return type:

None

  • 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
  • aMaterial
  • aModel – default value is Aspect_TOFM_BOTH_SIDE
Return type:

None

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

  • 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
  • Returns the polygons transparency value.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_FRONT_SIDE
Return type:float
aspect()
  • Returns the polygons aspect properties.
Return type:Handle_Graphic3d_AspectFillArea3d
thisown

The membership flag

class OCC.Prs3d.Prs3d_ShapeTool(*args)

Bases: object

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 OCC.Prs3d.Prs3d_Text(*args, **kwargs)

Bases: OCC.Prs3d.Prs3d_Root

static Draw(*args)
  • 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 OCC.Prs3d.Prs3d_TextAspect

Bases: OCC.Prs3d.Prs3d_BasicAspect

Angle()
  • Returns the angle
Return type:Quantity_PlaneAngle
GetHandle()

Prs3d_TextAspect_GetHandle(Prs3d_TextAspect self) -> Handle_Prs3d_TextAspect

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

The membership flag

OCC.Prs3d.Prs3d_Text_Draw(*args)
  • 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 OCC.Prs3d.SwigPyIterator(*args, **kwargs)

Bases: object

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

The membership flag

value()
class OCC.Prs3d.prs3d(*args, **kwargs)

Bases: object

static MatchSegment(*args)
  • 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

OCC.Prs3d.prs3d_MatchSegment(*args)
  • 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