OCC.Aspect module

class OCC.Aspect.Aspect_Array1OfEdge(*args)

Bases: object

Assign()
Parameters:Other (Aspect_Array1OfEdge &) –
Return type:Aspect_Array1OfEdge
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_Edge
Destroy()
Return type:None
Init()
Parameters:V (Aspect_Edge &) –
Return type:None
IsAllocated()
Return type:bool
Length()
Return type:int
Lower()
Return type:int
Set()
Parameters:Other (Aspect_Array1OfEdge &) –
Return type:Aspect_Array1OfEdge
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • Value (Aspect_Edge &) –
Return type:

None

Upper()
Return type:int
Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_Edge
thisown

The membership flag

class OCC.Aspect.Aspect_AspectFillArea(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

Aspect_AspectFillArea_GetHandle(Aspect_AspectFillArea self) -> Handle_Aspect_AspectFillArea

HatchStyle()
  • Returns the hatch type used when InteriorStyle //! is IS_HATCH
Return type:Aspect_HatchStyle
SetBackInteriorColor()
  • Modifies the colour of the interior of the back face
Parameters:color (Quantity_Color &) –
Return type:None
SetEdgeColor()
  • Modifies the colour of the edge of the face
Parameters:AColor (Quantity_Color &) –
Return type:None
SetEdgeLineType()
  • Modifies the edge line type
Parameters:AType (Aspect_TypeOfLine) –
Return type:None
SetEdgeWidth()
  • Modifies the edge thickness Category: Methods to modify the class definition Warning: Raises AspectFillAreaDefinitionError if the //! width is a negative value.
Parameters:AWidth (float) –
Return type:None
SetHatchStyle()
  • Modifies the hatch type used when InteriorStyle //! is IS_HATCH
Parameters:AStyle (Aspect_HatchStyle) –
Return type:None
SetInteriorColor()
  • Modifies the colour of the interior of the face
Parameters:AColor (Quantity_Color &) –
Return type:None
SetInteriorStyle()
  • Modifies the interior type used for rendering InteriorStyle : IS_EMPTY no interior //! IS_HOLLOW display the boundaries of the surface //! IS_HATCH display hatching //! IS_SOLID display interior entirely filled
Parameters:AStyle (Aspect_InteriorStyle) –
Return type:None
Values()
Parameters:
  • AStyle (Aspect_InteriorStyle &) –
  • AIntColor (Quantity_Color &) –
  • AEdgeColor (Quantity_Color &) –
  • AType (Aspect_TypeOfLine &) –
  • AWidth (float &) –
Return type:

None

  • Returns the current values of the <self> group.
Parameters:
  • AStyle (Aspect_InteriorStyle &) –
  • AIntColor (Quantity_Color &) –
  • BackIntColor (Quantity_Color &) –
  • AEdgeColor (Quantity_Color &) –
  • AType (Aspect_TypeOfLine &) –
  • AWidth (float &) –
Return type:

None

thisown

The membership flag

class OCC.Aspect.Aspect_AspectLine(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

Aspect_AspectLine_GetHandle(Aspect_AspectLine self) -> Handle_Aspect_AspectLine

SetColor()
  • Modifies the colour of <self>.
Parameters:AColor (Quantity_Color &) –
Return type:None
SetType()
  • Modifies the type of <self>.
Parameters:AType (Aspect_TypeOfLine) –
Return type:None
SetWidth()
  • Modifies the thickness of <self>. Category: Methods to modify the class definition Warning: Raises AspectLineDefinitionError if the //! width is a negative value.
Parameters:AWidth (float) –
Return type:None
Values()
  • Returns the current values of the group <self>.
Parameters:
  • AColor (Quantity_Color &) –
  • AType (Aspect_TypeOfLine &) –
  • AWidth (float &) –
Return type:

None

thisown

The membership flag

class OCC.Aspect.Aspect_AspectMarker(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

Aspect_AspectMarker_GetHandle(Aspect_AspectMarker self) -> Handle_Aspect_AspectMarker

SetColor()
  • Modifies the colour of <self>.
Parameters:AColor (Quantity_Color &) –
Return type:None
SetScale()
  • Modifies the scale factor of <self>. //! Marker type Aspect_TOM_POINT is not affected //! by the marker size scale factor. It is always //! the smallest displayable dot. Warning: Raises AspectMarkerDefinitionError if the //! scale is a negative value.
Parameters:AScale (float) –
Return type:None
SetType()
  • Modifies the type of marker <self>.
Parameters:AType (Aspect_TypeOfMarker) –
Return type:None
Values()
  • Returns the current values of the group <self>.
Parameters:
  • AColor (Quantity_Color &) –
  • AType (Aspect_TypeOfMarker &) –
  • AScale (float &) –
Return type:

None

thisown

The membership flag

class OCC.Aspect.Aspect_Background(*args)

Bases: object

Color()
  • Returns the colour of the window background <self>.
Return type:Quantity_Color
SetColor()
  • Modifies the colour of the window background <self>.
Parameters:AColor (Quantity_Color &) –
Return type:None
thisown

The membership flag

class OCC.Aspect.Aspect_CircularGrid(*args)

Bases: OCC.Aspect.Aspect_Grid

DivisionNumber()
  • returns the x step of the grid.
Return type:int
GetHandle()

Aspect_CircularGrid_GetHandle(Aspect_CircularGrid self) -> Handle_Aspect_CircularGrid

RadiusStep()
  • returns the x step of the grid.
Return type:Quantity_Length
SetDivisionNumber()
  • defines the step of the grid.
Parameters:aNumber (Standard_Integer) –
Return type:None
SetGridValues()
Parameters:
  • XOrigin (Quantity_Length) –
  • YOrigin (Quantity_Length) –
  • RadiusStep (Quantity_Length) –
  • DivisionNumber (Standard_Integer) –
  • RotationAngle (Quantity_PlaneAngle) –
Return type:

None

SetRadiusStep()
  • defines the x step of the grid.
Parameters:aStep (Quantity_Length) –
Return type:None
thisown

The membership flag

class OCC.Aspect.Aspect_ColorCubeColorMap(*args)

Bases: OCC.Aspect.Aspect_ColorMap

ColorCubeDefinition()
Parameters:
  • base_pixel (Standard_Integer &) –
  • redmax (Standard_Integer &) –
  • redmult (Standard_Integer &) –
  • greenmax (Standard_Integer &) –
  • greenmult (Standard_Integer &) –
  • bluemax (Standard_Integer &) –
  • bluemult (Standard_Integer &) –
Return type:

None

GetHandle()

Aspect_ColorCubeColorMap_GetHandle(Aspect_ColorCubeColorMap self) -> Handle_Aspect_ColorCubeColorMap

thisown

The membership flag

class OCC.Aspect.Aspect_ColorMap(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

AddEntry()
  • Search an identical color entry in the color map <self> and returns the ColorMapEntry Index if exist. Or add a new entry and returns the computed ColorMapEntry index used.
Parameters:aColor (Quantity_Color &) –
Return type:int
Dump()
Return type:None
Entry()
  • Return the value of the <Index>th element of //! the ColorMap
Parameters:AColorMapIndex (Standard_Integer) –
Return type:Aspect_ColorMapEntry
FindColorMapIndex()
  • Returns the index in the ColorMap of the //! ColorMapEntry.Index() equal to <AnEntryIndex>.
Parameters:AColorMapEntryIndex (Standard_Integer) –
Return type:int
FindEntry()
  • Returns the ColorMapEntry with ColorMapEntry.Index() //! equal to <AnEntryIndex>.
Parameters:AColorMapEntryIndex (Standard_Integer) –
Return type:Aspect_ColorMapEntry
GetHandle()

Aspect_ColorMap_GetHandle(Aspect_ColorMap self) -> Handle_Aspect_ColorMap

Index()
  • Returns the ColorMapEntry.Index of the ColorMap //! at rank <aColormapIndex> .
Parameters:aColormapIndex (Standard_Integer) –
Return type:int
NearestColorMapIndex()
  • Returns the index in the ColorMap of the //! nearest matching ColorMapEntry
Parameters:aColor (Quantity_Color &) –
Return type:int
NearestEntry()
  • Returns the nearest ColorMapEntry that match aColor .
Parameters:aColor (Quantity_Color &) –
Return type:Aspect_ColorMapEntry
Size()
  • Returns the Allocated colormap Size
Return type:int
Type()
Return type:Aspect_TypeOfColorMap
thisown

The membership flag

class OCC.Aspect.Aspect_ColorMapEntry(*args)

Bases: object

Color()
Return type:Quantity_Color
Dump()
Return type:None
Free()
  • Unallocates the colormap entry.
Return type:None
Index()
Return type:int
IsAllocated()
  • Returns True if the colormap entry is allocated. Warning: A colormap entry is allocated when the color and //! the index is defined.
Return type:bool
Set()
Parameters:entry (Aspect_ColorMapEntry &) –
Return type:None
SetColor()
  • Sets color <rgb> of colormap entry.
Parameters:rgb (Quantity_Color &) –
Return type:None
SetIndex()
  • Sets index value of a colormap entry.
Parameters:index (Standard_Integer) –
Return type:None
SetValue()
  • Sets colormap entry value and allocates it.
Parameters:
  • index (Standard_Integer) –
  • rgb (Quantity_Color &) –
Return type:

None

  • Sets colormap entry value and allocates it.
Parameters:entry (Aspect_ColorMapEntry &) –
Return type:None
thisown

The membership flag

class OCC.Aspect.Aspect_ColorPixel(*args)

Bases: OCC.Aspect.Aspect_Pixel

HashCode()
  • Returns a hashed value denoting <self>. This value is in the range 1..<Upper>.
Parameters:Upper (Standard_Integer) –
Return type:int
IsEqual()
Parameters:Other (Aspect_ColorPixel &) –
Return type:bool
IsNotEqual()
Parameters:Other (Aspect_ColorPixel &) –
Return type:bool
PrintToString()

Aspect_ColorPixel_PrintToString(Aspect_ColorPixel self) -> std::string

SetValue()
Parameters:aColor (Quantity_Color &) –
Return type:None
Value()
Return type:Quantity_Color
thisown

The membership flag

class OCC.Aspect.Aspect_ColorRampColorMap(*args)

Bases: OCC.Aspect.Aspect_ColorMap

ColorRampDefinition()
  • Get Color Ramp Colormap definition .
Parameters:
  • basepixel (Standard_Integer &) –
  • dimension (Standard_Integer &) –
  • color (Quantity_Color &) –
Return type:

None

GetHandle()

Aspect_ColorRampColorMap_GetHandle(Aspect_ColorRampColorMap self) -> Handle_Aspect_ColorRampColorMap

thisown

The membership flag

class OCC.Aspect.Aspect_ColorScale(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

static FindColor(*args)
  • Calculate color according passed value; returns true if value is in range or false, if isn’t
Parameters:
  • Value (float) –
  • Color (Quantity_Color &) –
  • Value
  • Min (float) –
  • Max (float) –
  • ColorsCount (Standard_Integer) –
  • Color
Return type:

bool

Return type:

bool

GetColor()
  • Returns the user specified color from color map with index <anIndex>. Returns default color if index out of range in color map.
Parameters:anIndex (Standard_Integer) –
Return type:Quantity_Color
GetColorType()
  • Returns the type of colors; Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map
Return type:Aspect_TypeOfColorScaleData
GetColors()
  • Returns the user specified colors.
Parameters:aColors (Aspect_SequenceOfColor &) –
Return type:None
GetFormat()
  • Returns the format for numbers. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;
Return type:TCollection_AsciiString
GetHandle()

Aspect_ColorScale_GetHandle(Aspect_ColorScale self) -> Handle_Aspect_ColorScale

GetHeight()
  • Returns the height of color scale.
Return type:float
GetLabel()
  • Returns the user specified label with index <anIndex>. Returns empty string if label not defined.
Parameters:anIndex (Standard_Integer) –
Return type:TCollection_ExtendedString
GetLabelPosition()
  • Returns the position of labels concerning color filled rectangles.
Return type:Aspect_TypeOfColorScalePosition
GetLabelType()
  • Returns the type of labels; Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used
Return type:Aspect_TypeOfColorScaleData
GetLabels()
  • Returns the user specified labels.
Parameters:aLabels (TColStd_SequenceOfExtendedString &) –
Return type:None
GetMax()
  • Returns maximal value of color scale;
Return type:float
GetMin()
  • Returns minimal value of color scale;
Return type:float
GetNumberOfIntervals()
  • Returns the number of color scale intervals;
Return type:int
GetPosition()
  • Returns the position of color scale.
Parameters:
  • aX (float &) –
  • aY (float &) –
Return type:

None

GetRange()
  • Returns minimal and maximal values of color scale;
Parameters:
  • aMin (float &) –
  • aMax (float &) –
Return type:

None

GetSize()
  • Returns the size of color scale.
Parameters:
  • aWidth (float &) –
  • aHeight (float &) –
Return type:

None

GetTextHeight()
Return type:int
GetTitle()
  • Returns the color scale title string;
Return type:TCollection_ExtendedString
GetTitlePosition()
  • Returns the position of color scale title.
Return type:Aspect_TypeOfColorScalePosition
GetWidth()
  • Returns the width of color scale.
Return type:float
GetXPosition()
  • Returns the X position of color scale.
Return type:float
GetYPosition()
  • Returns the height of color scale.
Return type:float
IsLabelAtBorder()
  • Returns true if the labels placed at border of color filled rectangles.
Return type:bool
IsReversed()
  • Returns true if the labels and colors used in reversed order.
Return type:bool
PaintRect()
Parameters:
  • X (Standard_Integer) –
  • Y (Standard_Integer) –
  • W (Standard_Integer) –
  • H (Standard_Integer) –
  • aColor (Quantity_Color &) –
  • aFilled (bool) – default value is Standard_False
  • X
  • Y
  • W
  • H
  • aColor
  • aFilled – default value is Standard_False
Return type:

void

Return type:

void

PaintText()
Parameters:
  • aText (TCollection_ExtendedString &) –
  • X (Standard_Integer) –
  • Y (Standard_Integer) –
  • aColor (Quantity_Color &) –
Return type:

void

SetColor()
  • Sets the color scale color at index. Index started from 1.
Parameters:
  • aColor (Quantity_Color &) –
  • anIndex (Standard_Integer) – default value is - 1
Return type:

None

  • Sets the color scale color at index. Index started from 1.
Parameters:
  • aColor (Quantity_Color &) –
  • anIndex (Standard_Integer) – default value is - 1
Return type:

None

SetColorType()
  • Sets the type of colors. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map
Parameters:aType (Aspect_TypeOfColorScaleData) –
Return type:None
SetColors()
  • Sets the color scale colors.
Parameters:aMap (Handle_Aspect_ColorMap &) –
Return type:None
  • Sets the color scale colors.
Parameters:aSeq (Aspect_SequenceOfColor &) –
Return type:None
SetFormat()
  • Sets the color scale auto label format specification.
Parameters:aFormat (TCollection_AsciiString &) –
Return type:None
SetHeight()
  • Sets the height of color scale.
Parameters:aHeight (float) –
Return type:None
SetLabel()
  • Sets the color scale label at index. Index started from 1.
Parameters:
  • aLabel (TCollection_ExtendedString &) –
  • anIndex (Standard_Integer) – default value is - 1
Return type:

None

  • Sets the color scale label at index. Index started from 1.
Parameters:
  • aLabel (TCollection_ExtendedString &) –
  • anIndex (Standard_Integer) – default value is - 1
Return type:

None

SetLabelAtBorder()
  • Sets true if the labels placed at border of color filled rectangles.
Parameters:anOn (bool) –
Return type:None
SetLabelPosition()
  • Sets the color scale labels position concerning color filled rectangles.
Parameters:aPos (Aspect_TypeOfColorScalePosition) –
Return type:None
SetLabelType()
  • Sets the type of labels. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used
Parameters:aType (Aspect_TypeOfColorScaleData) –
Return type:None
SetLabels()
  • Sets the color scale labels.
Parameters:aSeq (TColStd_SequenceOfExtendedString &) –
Return type:None
SetMax()
  • Sets the maximal value of color scale.
Parameters:aMax (float) –
Return type:None
SetMin()
  • Sets the minimal value of color scale.
Parameters:aMin (float) –
Return type:None
SetNumberOfIntervals()
  • Sets the number of color scale intervals.
Parameters:aNum (Standard_Integer) –
Return type:None
SetPosition()
  • Sets the position of color scale.
Parameters:
  • aX (float) –
  • aY (float) –
Return type:

None

SetRange()
  • Sets the minimal and maximal value of color scale.
Parameters:
  • aMin (float) –
  • aMax (float) –
Return type:

None

SetReversed()
  • Sets true if the labels and colors used in reversed order.
Parameters:aReverse (bool) –
Return type:None
SetSize()
  • Sets the size of color scale.
Parameters:
  • aWidth (float) –
  • aHeight (float) –
Return type:

None

SetTextHeight()
Parameters:aHeigh (Standard_Integer) –
Return type:None
SetTitle()
  • Sets the color scale title string.
Parameters:aTitle (TCollection_ExtendedString &) –
Return type:None
SetTitlePosition()
  • Sets the color scale title position.
Parameters:aPos (Aspect_TypeOfColorScalePosition) –
Return type:None
SetWidth()
  • Sets the width of color scale.
Parameters:aWidth (float) –
Return type:None
SetXPosition()
  • Sets the X position of color scale.
Parameters:aX (float) –
Return type:None
SetYPosition()
  • Sets the Y position of color scale.
Parameters:aY (float) –
Return type:None
TextHeight()
Parameters:aText (TCollection_ExtendedString &) –
Return type:int
TextWidth()
Parameters:aText (TCollection_ExtendedString &) –
Return type:int
thisown

The membership flag

OCC.Aspect.Aspect_ColorScale_FindColor(*args)
  • Calculate color according passed value; returns true if value is in range or false, if isn’t
Parameters:
  • Value (float) –
  • Color (Quantity_Color &) –
  • Value
  • Min (float) –
  • Max (float) –
  • ColorsCount (Standard_Integer) –
  • Color
Return type:

bool

Return type:

bool

class OCC.Aspect.Aspect_Driver(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

BeginArcs()
  • Begin a set of circles or ellips . Warning: Arcs must be added by the DrawArc() methods.
Return type:void
BeginMarkers()
  • Begin a set of markers . Warning: Markers must be added by the DrawMarker() method.
Return type:void
BeginPoints()
  • Begin a set of points . Warning: Points must be added by the DrawPoint() method.
Return type:void
BeginPolyArcs()
  • Begin a set of polygon circles or ellips . Warning: Arcs must be added by the DrawPolyArc() methods.
Return type:void
BeginPolygon()
  • Begin an incremental polygon primitive of <aNumber> of points . Warning: Points must be added by the the DrawPoint() method.
Parameters:aNumber (Standard_Integer) –
Return type:void
BeginPolyline()
  • Begin an incremental polyline primitive of <aNumber> of points . Warning: Points must be added by the the DrawPoint() method.
Parameters:aNumber (Standard_Integer) –
Return type:void
BeginSegments()
  • Begin a set of segments . Warning: Segments must be added by the DrawSegment() method.
Return type:void
ClearImage()
Parameters:anImageId (Handle_Standard_Transient &) –
Return type:void
ClearImageFile()
Parameters:anImageFile (char *) –
Return type:void
ClosePrimitive()
  • Close the last Begining primitive
Return type:void
ColorMap()
Return type:Handle_Aspect_ColorMap
Convert()
  • Returns the DWU value depending of the PIXEL value.
Parameters:PV (Standard_Integer) –
Return type:Quantity_Length
  • Returns the PIXEL value depending of the DWU value.
Parameters:DV (Quantity_Length) –
Return type:int
  • Returns the DWU position depending of the PIXEL position .
Parameters:
  • PX (Standard_Integer) –
  • PY (Standard_Integer) –
  • DX (Quantity_Length &) –
  • DY (Quantity_Length &) –
Return type:

void

  • Returns the PIXEL position depending of the DWU position . Returns True when the driver must use MDTV fonts //! instead system fonts.
Parameters:
  • DX (Quantity_Length) –
  • DY (Quantity_Length) –
  • PX (Standard_Integer &) –
  • PY (Standard_Integer &) –
Return type:

void

DrawArc()
  • Draws an Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

  • Draws an Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

  • Draws an Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

DrawImage()
Parameters:
  • anImageId (Handle_Standard_Transient &) –
  • aX (Standard_ShortReal) –
  • aY (Standard_ShortReal) –
Return type:

void

DrawImageFile()
Parameters:
  • anImageFile (char *) –
  • aX (Standard_ShortReal) –
  • aY (Standard_ShortReal) –
  • aScale (Quantity_Factor) – default value is 1.0
  • anImageFile
  • aX
  • aY
  • aScale – default value is 1.0
Return type:

void

Return type:

void

DrawMarker()
  • Draws the prevously defined marker <aMarker>
Parameters:
  • aMarker (Standard_Integer) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • Width (Standard_ShortReal) –
  • Height (Standard_ShortReal) –
  • Angle (Standard_ShortReal) – default value is 0.0
Return type:

void

  • Draws the prevously defined marker <aMarker>
Parameters:
  • aMarker (Standard_Integer) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • Width (Standard_ShortReal) –
  • Height (Standard_ShortReal) –
  • Angle (Standard_ShortReal) – default value is 0.0
Return type:

void

DrawPoint()
  • Draws a 1 PIXEL point depending of the SetMarkerAttrib()
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
Return type:

void

DrawPolyArc()
  • Draws an filled Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

  • Draws an filled Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

  • Draws an filled Ellipsoid arc of center <X,Y> and Radius
Parameters:
  • X (Standard_ShortReal) –
  • Y (Standard_ShortReal) –
  • anXradius (Standard_ShortReal) –
  • anYradius (Standard_ShortReal) –
  • aStartAngle (Standard_ShortReal) – default value is 0.0
  • anOpenAngle (Standard_ShortReal) – default value is 6.283185
Return type:

bool

DrawPolyText()
  • Draws an framed text depending of the SetTextAttrib() and SetPolyAttrib() attributes. Warning: Coordinates must be defined in DWU space. //! <aMarge> defines the ratio of the space between the //! polygon borders and the bounding box of the text and //! depending of the height of the text.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • aMarge (Quantity_Ratio) – default value is 0.1
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

  • Draws an framed text depending of the SetTextAttrib() and SetPolyAttrib() attributes. Warning: Coordinates must be defined in DWU space. //! <aMarge> defines the ratio of the space between the //! polygon borders and the bounding box of the text and //! depending of the height of the text.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • aMarge (Quantity_Ratio) – default value is 0.1
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

  • Draws an framed text depending of the SetTextAttrib() and SetPolyAttrib() attributes. Warning: Coordinates must be defined in DWU space. //! <aMarge> defines the ratio of the space between the //! polygon borders and the bounding box of the text and //! depending of the height of the text.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • aMarge (Quantity_Ratio) – default value is 0.1
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

  • Draws an framed text depending of the SetTextAttrib() and SetPolyAttrib() attributes. Warning: Coordinates must be defined in DWU space. //! <aMarge> defines the ratio of the space between the //! polygon borders and the bounding box of the text and //! depending of the height of the text.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • aMarge (Quantity_Ratio) – default value is 0.1
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

DrawPolygon()
  • Draw a polygon depending of the SetPolyAttrib() attributes.
Parameters:
  • aListX (TShort_Array1OfShortReal &) –
  • aListY (TShort_Array1OfShortReal &) –
Return type:

void

DrawPolyline()
  • Draw a polyline depending of the SetLineAttrib() attributes.
Parameters:
  • aListX (TShort_Array1OfShortReal &) –
  • aListY (TShort_Array1OfShortReal &) –
Return type:

void

DrawSegment()
  • Draw a segment depending of the SetLineAttrib() attributes.
Parameters:
  • X1 (Standard_ShortReal) –
  • Y1 (Standard_ShortReal) –
  • X2 (Standard_ShortReal) –
  • Y2 (Standard_ShortReal) –
Return type:

void

DrawText()
  • Draws a text depending of the SetTextAttrib() attributes.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

  • Draws a text depending of the SetTextAttrib() attributes.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

  • Draws a text depending of the SetTextAttrib() attributes.
Parameters:
  • aText (TCollection_ExtendedString &) –
  • Xpos (Standard_ShortReal) –
  • Ypos (Standard_ShortReal) –
  • anAngle (Standard_ShortReal) – default value is 0.0
  • aType (Aspect_TypeOfText) – default value is Aspect_TOT_SOLID
Return type:

void

EndDraw()
  • Flush all graphics and Wait after up to date
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
  • Flush all graphics and Wait after up to date
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
FillAndDrawImage()
  • Fills a complete Image .
Parameters:
  • anImageId (Handle_Standard_Transient &) –
  • aX (Standard_ShortReal) –
  • aY (Standard_ShortReal) –
  • aWidth (Standard_Integer) –
  • aHeight (Standard_Integer) –
  • anArrayOfPixels (Standard_Address) –
Return type:

void

  • Fills a line of the Image . Warning: 0 <= anIndexOfLine < aHeight //! anIndexOfLine = 0 must be the first call
Parameters:
  • anImageId (Handle_Standard_Transient &) –
  • aX (Standard_ShortReal) –
  • aY (Standard_ShortReal) –
  • anIndexOfLine (Standard_Integer) –
  • aWidth (Standard_Integer) –
  • aHeight (Standard_Integer) –
  • anArrayOfPixels (Standard_Address) –
Return type:

void

FontMap()
Return type:Handle_Aspect_FontMap
GetHandle()

Aspect_Driver_GetHandle(Aspect_Driver self) -> Handle_Aspect_Driver

IsKnownImage()
Parameters:anImage (Handle_Standard_Transient &) –
Return type:bool
MarkMap()
Return type:Handle_Aspect_MarkMap
SetColorMap()
Parameters:aColorMap (Handle_Aspect_ColorMap &) –
Return type:None
SetFontMap()
  • Sets the current font map to this driver and Enable/Disable this driver to use MDTV fonts instead system fonts.
Parameters:aFontMap (Handle_Aspect_FontMap &) –
Return type:None
SetLineAttrib()
Parameters:
  • ColorIndex (Standard_Integer) –
  • TypeIndex (Standard_Integer) –
  • WidthIndex (Standard_Integer) –
Return type:

void

SetMarkMap()
Parameters:aMarkMap (Handle_Aspect_MarkMap &) –
Return type:None
SetMarkerAttrib()
Parameters:
  • ColorIndex (Standard_Integer) –
  • WidthIndex (Standard_Integer) –
  • FillMarker (bool) – default value is Standard_False
  • ColorIndex
  • WidthIndex
  • FillMarker – default value is Standard_False
Return type:

void

Return type:

void

SetPolyAttrib()
Parameters:
  • ColorIndex (Standard_Integer) –
  • TileIndex (Standard_Integer) –
  • DrawEdge (bool) – default value is Standard_False
  • ColorIndex
  • TileIndex
  • DrawEdge – default value is Standard_False
Return type:

void

Return type:

void

SetTextAttrib()
Parameters:
  • ColorIndex (Standard_Integer) –
  • FontIndex (Standard_Integer) –
  • ColorIndex
  • FontIndex
  • aSlant (Quantity_PlaneAngle) –
  • aHScale (Quantity_Factor) –
  • aWScale (Quantity_Factor) –
  • isUnderlined (bool) – default value is Standard_False
  • ColorIndex
  • FontIndex
  • aSlant
  • aHScale
  • aWScale
  • isUnderlined – default value is Standard_False
Return type:

void

Return type:

void

Return type:

void

SetTypeMap()
Parameters:aTypeMap (Handle_Aspect_TypeMap &) –
Return type:None
SetWidthMap()
Parameters:aWidthMap (Handle_Aspect_WidthMap &) –
Return type:None
SizeOfImageFile()
Parameters:
  • anImageFile (char *) –
  • aWidth (Standard_Integer &) –
  • aHeight (Standard_Integer &) –
Return type:

bool

TypeMap()
Return type:Handle_Aspect_TypeMap
WidthMap()
Return type:Handle_Aspect_WidthMap
WorkSpace()
  • Returns the Available WorkSpace in DWU coordinates
Parameters:
  • Width (Quantity_Length &) –
  • Heigth (Quantity_Length &) –
Return type:

void

thisown

The membership flag

class OCC.Aspect.Aspect_Edge(*args)

Bases: object

FirstIndex()
  • Returns the index of the begin of the edge <self>.
Return type:int
LastIndex()
  • Returns the index of the end of the edge <self>.
Return type:int
SetValues()
  • Updates the values of an edge <self>. Warning: Raises EdgeDefinitionError if AIndex1 == AIndex2.
Parameters:
  • AIndex1 (Standard_Integer) –
  • AIndex2 (Standard_Integer) –
  • AType (Aspect_TypeOfEdge) –
Return type:

None

Type()
  • Returns the type of the edge <self>.
Return type:Aspect_TypeOfEdge
Values()
  • Returns the index of the vertices and the //! type of edge <self>.
Parameters:
  • AIndex1 (Standard_Integer &) –
  • AIndex2 (Standard_Integer &) –
  • AType (Aspect_TypeOfEdge &) –
Return type:

None

thisown

The membership flag

class OCC.Aspect.Aspect_FontMap

Bases: OCC.MMgt.MMgt_TShared

AddEntry()
  • Adds an entry in the font map <self>. Warning: Raises BadAccess if FontMap size is exceeded.
Parameters:AnEntry (Aspect_FontMapEntry &) –
Return type:None
  • Search an identical font style entry in the font map <self> and returns the FontMapEntry Index if exist. Or add a new entry and returns the computed FontMapEntry index used.
Parameters:aStyle (Aspect_FontStyle &) –
Return type:int
Dump()
Return type:None
Entry()
  • Returns the Font map entry with the index <AnIndex>. Warning: Raises BadAccess if the index less than 1 //! or greater than Size.
Parameters:AnIndex (Standard_Integer) –
Return type:Aspect_FontMapEntry
GetHandle()

Aspect_FontMap_GetHandle(Aspect_FontMap self) -> Handle_Aspect_FontMap

Index()
  • Returns the FontMapEntry.Index of the FontMap at rank <aFontmapIndex> .
Parameters:aFontmapIndex (Standard_Integer) –
Return type:int
Size()
  • Returns the Allocated fontmap Size
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_FontMapEntry(*args)

Bases: object

Dump()
Return type:None
Free()
  • Unallocates the fontmap entry.
Return type:None
Index()
Return type:int
IsAllocated()
  • Returns True if the fontmap entry is allocated. Warning: A fontmap entry is allocated when the font and //! the index is defined.
Return type:bool
Set()
Parameters:entry (Aspect_FontMapEntry &) –
Return type:None
SetIndex()
  • Sets index value of a fontmap entry.
Parameters:index (Standard_Integer) –
Return type:None
SetType()
  • Sets the line style of fontmap entry.
Parameters:Style (Aspect_FontStyle &) –
Return type:None
SetValue()
  • Sets fontmap entry value and allocates it.
Parameters:
  • index (Standard_Integer) –
  • style (Aspect_FontStyle &) –
Return type:

None

  • Sets fontmap entry value and allocates it.
Parameters:entry (Aspect_FontMapEntry &) –
Return type:None
Type()
Return type:Aspect_FontStyle
thisown

The membership flag

class OCC.Aspect.Aspect_FontStyle(*args)

Bases: object

AliasName()
  • Returns a shorter font name which identify the main characteristics of the fonts.
Return type:char *
Assign()
  • Updates the font style <self> from the definition of the //! font style <Other>.
Parameters:Other (Aspect_FontStyle &) –
Return type:Aspect_FontStyle
CapsHeight()
  • Returns the CapsHeight component of a font style
Return type:bool
Dump()
  • Dumps the font attributes.
Return type:None
Encoding()
  • Returns the char set encoding of the font.
Return type:char *
Family()
  • Returns the family of the font.
Return type:char *
Foundry()
  • Returns the foundry of the font.
Return type:char *
FullName()
  • Returns the full normalized font name
Return type:char *
IsEqual()
Parameters:Other (Aspect_FontStyle &) –
Return type:bool
IsNotEqual()
Parameters:Other (Aspect_FontStyle &) –
Return type:bool
Length()
  • Returns the string components length of the font style descriptor
Return type:int
Registry()
  • Returns the char set registry of the font.
Return type:char *
SAverageWidth()
  • Returns the average width of the font.
Return type:char *
SPixelSize()
  • Returns the pixel size of the font.
Return type:char *
SPointSize()
  • Returns the point size of the font.
Return type:char *
SResolutionX()
  • Returns the resolution X of the font.
Return type:char *
SResolutionY()
  • Returns the resolution Y of the font.
Return type:char *
SSlant()
  • Returns the slant of the font.
Return type:char *
SSpacing()
  • Returns the spacing of the font.
Return type:char *
SStyle()
  • Returns the style name of the font.
Return type:char *
SWidth()
  • Returns the width name of the font.
Return type:char *
Set()
Parameters:Other (Aspect_FontStyle &) –
Return type:Aspect_FontStyle
SetEncoding()
  • Sets the encoding of the font.
Parameters:aName (char *) –
Return type:None
SetFamily()
  • Sets the family of the font.
Parameters:aName (char *) –
Return type:None
SetRegistry()
  • Sets the registry of the font.
Parameters:aName (char *) –
Return type:None
SetValues()
  • Updates the font style <self> from the definition of the //! font style <Type>.
Parameters:
  • Type (Aspect_TypeOfFont) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates the font style <self> from the definition of the //! font style <Type>.
Parameters:
  • Type (Aspect_TypeOfFont) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates the font style <self> from the definition of the //! font style <Type>.
Parameters:
  • Type (Aspect_TypeOfFont) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates a font style with the new Abode font descriptor Warning: create the smalest font size if the foundry height
Parameters:
  • Style (char *) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates a font style with the new Abode font descriptor Warning: create the smalest font size if the foundry height
Parameters:
  • Style (char *) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates a font style with the new Abode font descriptor Warning: create the smalest font size if the foundry height
Parameters:
  • Style (char *) –
  • Size (Quantity_Length) –
  • Slant (Quantity_PlaneAngle) – default value is 0.0
  • CapsHeight (bool) – default value is Standard_False
Return type:

None

  • Updates a font style with the new XLFD font descriptor
Parameters:Style (char *) –
Return type:None
SetWeight()
  • Sets the weight of the font.
Parameters:aName (char *) –
Return type:None
Size()
  • Returns the Size component of a font style
Return type:Quantity_Length
Slant()
  • Returns the Slant component of a font style
Return type:Quantity_PlaneAngle
Style()
  • Returns the type of the font style <self>
Return type:Aspect_TypeOfFont
Value()
  • Returns the String component of a font style
Return type:char *
Weight()
  • Returns the weight of the font.
Return type:char *
thisown

The membership flag

class OCC.Aspect.Aspect_GenId(*args)

Bases: object

Available()
  • Returns the number of available identifiers of <self>.
Return type:int
Free()
  • Frees all identifiers of <self>.
Return type:None
  • Frees the identifier <Id> of <self>.
Parameters:Id (Standard_Integer) –
Return type:None
Lower()
  • Returns the lower bound of <self>.
Return type:int
Next()
  • Returns an available identifier of <self>. Warning: Raises IdentDefinitionError if all identifiers are busy.
Return type:int
Upper()
  • Returns the upper bound of <self>.
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_GenericColorMap

Bases: OCC.Aspect.Aspect_ColorMap

AddEntry()
  • Adds an entry in the color map <self>. Warning: Raises BadAccess if the ColorMapEntry index is alreadry defined.
Parameters:AnEntry (Aspect_ColorMapEntry &) –
Return type:None
  • Search an identical color entry in the color map <self> and returns the ColorMapEntry Index if exist. Or add a new entry and returns the computed ColorMapEntry index used.
Parameters:aColor (Quantity_Color &) –
Return type:int
GetHandle()

Aspect_GenericColorMap_GetHandle(Aspect_GenericColorMap self) -> Handle_Aspect_GenericColorMap

RemoveEntry()
  • Remove the ColorMapEntry at position index in the ColorMap Warning: Raises BadAccess if the index is not defined in the //! ColorMap.
Parameters:AColorMapEntryIndex (Standard_Integer) –
Return type:None
thisown

The membership flag

class OCC.Aspect.Aspect_GradientBackground(*args)

Bases: OCC.Aspect.Aspect_Background

BgGradientFillMethod()
  • Returns the current gradient background fill mode.
Return type:Aspect_GradientFillMethod
Colors()
  • Returns colours of the window gradient background <self>.
Parameters:
  • AColor1 (Quantity_Color &) –
  • AColor2 (Quantity_Color &) –
Return type:

None

SetColors()
  • Modifies the colours of the window gradient background <self>.
Parameters:
  • AColor1 (Quantity_Color &) –
  • AColor2 (Quantity_Color &) –
  • AMethod (Aspect_GradientFillMethod) – default value is Aspect_GFM_HOR
Return type:

None

  • Modifies the colours of the window gradient background <self>.
Parameters:
  • AColor1 (Quantity_Color &) –
  • AColor2 (Quantity_Color &) –
  • AMethod (Aspect_GradientFillMethod) – default value is Aspect_GFM_HOR
Return type:

None

thisown

The membership flag

class OCC.Aspect.Aspect_GraphicCallbackStruct(*args, **kwargs)

Bases: object

thisown

The membership flag

class OCC.Aspect.Aspect_Grid(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Activate()
  • activates the grid. The Hit method will return gridx and gridx computed according to the steps of the grid.
Return type:None
Colors()
  • Returns the colors of the grid.
Parameters:
  • aColor (Quantity_Color &) –
  • aTenthColor (Quantity_Color &) –
Return type:

None

Compute()
  • returns the point of the grid the closest to the point X,Y
Parameters:
  • X (Quantity_Length) –
  • Y (Quantity_Length) –
  • gridX (Quantity_Length &) –
  • gridY (Quantity_Length &) –
Return type:

void

Deactivate()
  • deactivates the grid. The hit method will return gridx and gridx as the enter value X & Y.
Return type:None
Display()
  • Display the grid at screen.
Return type:void
DrawMode()
  • Returns the grid aspect.
Return type:Aspect_GridDrawMode
Erase()
  • Erase the grid from screen.
Return type:void
GetHandle()

Aspect_Grid_GetHandle(Aspect_Grid self) -> Handle_Aspect_Grid

Hit()
  • returns the point of the grid the closest to the point X,Y if the grid is active. If the grid is not active returns X,Y.
Parameters:
  • X (Quantity_Length) –
  • Y (Quantity_Length) –
  • gridX (Quantity_Length &) –
  • gridY (Quantity_Length &) –
Return type:

None

Init()
Return type:void
IsActive()
  • Returns True when the grid is active.
Return type:bool
IsDisplayed()
  • Returns True when the grid is displayed at screen.
Return type:bool
Rotate()
  • Rotate the grid from a relative angle.
Parameters:anAngle (Quantity_PlaneAngle) –
Return type:None
RotationAngle()
  • returns the x Angle of the grid.
Return type:Quantity_PlaneAngle
SetColors()
  • Change the colors of the grid
Parameters:
  • aColor (Quantity_Color &) –
  • aTenthColor (Quantity_Color &) –
Return type:

void

SetDrawMode()
  • Change the grid aspect.
Parameters:aDrawMode (Aspect_GridDrawMode) –
Return type:None
SetRotationAngle()
  • defines the orientation of the the grid.
Parameters:anAngle (Quantity_PlaneAngle) –
Return type:None
SetXOrigin()
  • defines the x Origin of the grid.
Parameters:anOrigin (Quantity_Length) –
Return type:None
SetYOrigin()
  • defines the y Origin of the grid.
Parameters:anOrigin (Quantity_Length) –
Return type:None
Translate()
  • Translate the grid from a relative distance.
Parameters:
  • aDx (Quantity_Length) –
  • aDy (Quantity_Length) –
Return type:

None

XOrigin()
  • returns the x Origin of the grid.
Return type:Quantity_Length
YOrigin()
  • returns the x Origin of the grid.
Return type:Quantity_Length
thisown

The membership flag

class OCC.Aspect.Aspect_IndexPixel(*args)

Bases: OCC.Aspect.Aspect_Pixel

HashCode()
  • Returns a hashed value denoting <self>. This value is in the range 1..<Upper>.
Parameters:Upper (Standard_Integer) –
Return type:int
IsEqual()
Parameters:Other (Aspect_IndexPixel &) –
Return type:bool
IsNotEqual()
Parameters:Other (Aspect_IndexPixel &) –
Return type:bool
PrintToString()

Aspect_IndexPixel_PrintToString(Aspect_IndexPixel self) -> std::string

SetValue()
Parameters:anIndex (Standard_Integer) –
Return type:None
Value()
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_LineStyle(*args)

Bases: object

Assign()
  • Updates the line style <self> from the definition of the //! line style <Other>.
Parameters:Other (Aspect_LineStyle &) –
Return type:Aspect_LineStyle
IsEqual()
Parameters:Other (Aspect_LineStyle &) –
Return type:bool
IsNotEqual()
Parameters:Other (Aspect_LineStyle &) –
Return type:bool
Length()
  • Returns the components length of the line style
Return type:int
Set()
Parameters:Other (Aspect_LineStyle &) –
Return type:Aspect_LineStyle
SetValues()
  • Updates the line style <self> from the definition of the //! line style <Type>.
Parameters:Type (Aspect_TypeOfLine) –
Return type:None
  • Updates a line style with the new Float descriptor
Parameters:Style (TColQuantity_Array1OfLength &) –
Return type:None
Style()
  • Returns the type of the line style <self>
Return type:Aspect_TypeOfLine
Values()
  • Returns the components of a line style
Return type:TColQuantity_Array1OfLength
thisown

The membership flag

class OCC.Aspect.Aspect_MarkMap

Bases: OCC.MMgt.MMgt_TShared

AddEntry()
  • Adds an entry in the mark map <self>. Warning: Raises BadAccess if MarkMap size is exceeded.
Parameters:AnEntry (Aspect_MarkMapEntry &) –
Return type:None
  • Search an identical marker style entry in the mark map <self> and returns the MarkMapEntry Index if exist. Or add a new entry and returns the computed MarkMapEntry index used.
Parameters:aStyle (Aspect_MarkerStyle &) –
Return type:int
Dump()
Return type:None
Entry()
  • Returns the Mark map entry with the index <AnIndex>. Warning: Raises BadAccess if the index less than 1 or //! greater than Size.
Parameters:AnIndex (Standard_Integer) –
Return type:Aspect_MarkMapEntry
GetHandle()

Aspect_MarkMap_GetHandle(Aspect_MarkMap self) -> Handle_Aspect_MarkMap

Index()
  • Returns the MarkMapEntry.Index of the MarkMap at rank <aMarkmapIndex> .
Parameters:aMarkmapIndex (Standard_Integer) –
Return type:int
Size()
  • Returns the Allocated markmap Size
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_MarkMapEntry(*args)

Bases: object

Dump()
Return type:None
Free()
  • Unallocates the markmap entry.
Return type:None
Index()
  • Returns index value of a markmap entry. Warning: Raises error if the markmap entry is unallocated .
Return type:int
IsAllocated()
  • Returns True if the markmap entry is allocated. Warning: A markmap entry is allocated when the marker and //! the index is defined.
Return type:bool
Set()
Parameters:entry (Aspect_MarkMapEntry &) –
Return type:None
SetIndex()
  • Sets index value of a markmap entry.
Parameters:index (Standard_Integer) –
Return type:None
SetStyle()
  • Sets the marker style of markmap entry.
Parameters:Style (Aspect_MarkerStyle &) –
Return type:None
SetValue()
  • Sets markmap entry value and allocates it.
Parameters:
  • index (Standard_Integer) –
  • style (Aspect_MarkerStyle &) –
Return type:

None

  • Sets markmap entry value and allocates it.
Parameters:entry (Aspect_MarkMapEntry &) –
Return type:None
Style()
Return type:Aspect_MarkerStyle
thisown

The membership flag

class OCC.Aspect.Aspect_MarkerStyle(*args)

Bases: object

Assign()
  • Updates the marker style <self> from the definition of the marker style <Other>.
Parameters:Other (Aspect_MarkerStyle &) –
Return type:Aspect_MarkerStyle
IsEqual()
Parameters:Other (Aspect_MarkerStyle &) –
Return type:bool
IsNotEqual()
Parameters:Other (Aspect_MarkerStyle &) –
Return type:bool
Length()
  • Returns the components length of the marker descriptors
Return type:int
SValues()
  • Returns the State vector of a marker style descriptor
Return type:TColStd_Array1OfBoolean
Set()
Parameters:Other (Aspect_MarkerStyle &) –
Return type:Aspect_MarkerStyle
Type()
  • Returns the type of the marker style <self>
Return type:Aspect_TypeOfMarker
Values()
  • Returns the point and status of a marker style
Parameters:
  • aRank (Standard_Integer) –
  • aX (float &) –
  • aY (float &) –
Return type:

bool

XValues()
  • Returns the X vector of a marker style descriptor
Return type:TShort_Array1OfShortReal
YValues()
  • Returns the Y vector of a marker style descriptor
Return type:TShort_Array1OfShortReal
thisown

The membership flag

class OCC.Aspect.Aspect_Pixel(*args, **kwargs)

Bases: object

PrintToString()

Aspect_Pixel_PrintToString(Aspect_Pixel self) -> std::string

thisown

The membership flag

class OCC.Aspect.Aspect_RGBPixel(*args, **kwargs)

Bases: object

thisown

The membership flag

class OCC.Aspect.Aspect_RectangularGrid(*args)

Bases: OCC.Aspect.Aspect_Grid

FirstAngle()
  • returns the x Angle of the grid, relatively to the horizontal.
Return type:Quantity_PlaneAngle
GetHandle()

Aspect_RectangularGrid_GetHandle(Aspect_RectangularGrid self) -> Handle_Aspect_RectangularGrid

SecondAngle()
  • returns the y Angle of the grid, relatively to the vertical.
Return type:Quantity_PlaneAngle
SetAngle()
  • defines the angle of the second network the fist angle is given relatively to the horizontal. the second angle is given relatively to the vertical.
Parameters:
  • anAngle1 (Quantity_PlaneAngle) –
  • anAngle2 (Quantity_PlaneAngle) –
Return type:

None

SetGridValues()
Parameters:
  • XOrigin (Quantity_Length) –
  • YOrigin (Quantity_Length) –
  • XStep (Quantity_Length) –
  • YStep (Quantity_Length) –
  • RotationAngle (Quantity_PlaneAngle) –
Return type:

None

SetXStep()
  • defines the x step of the grid.
Parameters:aStep (Quantity_Length) –
Return type:None
SetYStep()
  • defines the y step of the grid.
Parameters:aStep (Quantity_Length) –
Return type:None
XStep()
  • returns the x step of the grid.
Return type:Quantity_Length
YStep()
  • returns the x step of the grid.
Return type:Quantity_Length
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfColor(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfColor_GetHandle(Aspect_SequenceNodeOfSequenceOfColor self) -> Handle_Aspect_SequenceNodeOfSequenceOfColor

Value()
Return type:Quantity_Color
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfColorMapEntry(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfColorMapEntry_GetHandle(Aspect_SequenceNodeOfSequenceOfColorMapEntry self) -> Handle_Aspect_SequenceNodeOfSequenceOfColorMapEntry

Value()
Return type:Aspect_ColorMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfFontMapEntry(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfFontMapEntry_GetHandle(Aspect_SequenceNodeOfSequenceOfFontMapEntry self) -> Handle_Aspect_SequenceNodeOfSequenceOfFontMapEntry

Value()
Return type:Aspect_FontMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfMarkMapEntry(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfMarkMapEntry_GetHandle(Aspect_SequenceNodeOfSequenceOfMarkMapEntry self) -> Handle_Aspect_SequenceNodeOfSequenceOfMarkMapEntry

Value()
Return type:Aspect_MarkMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfTypeMapEntry(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfTypeMapEntry_GetHandle(Aspect_SequenceNodeOfSequenceOfTypeMapEntry self) -> Handle_Aspect_SequenceNodeOfSequenceOfTypeMapEntry

Value()
Return type:Aspect_TypeMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceNodeOfSequenceOfWidthMapEntry(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Aspect_SequenceNodeOfSequenceOfWidthMapEntry_GetHandle(Aspect_SequenceNodeOfSequenceOfWidthMapEntry self) -> Handle_Aspect_SequenceNodeOfSequenceOfWidthMapEntry

Value()
Return type:Aspect_WidthMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfColor

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Quantity_Color &) –
  • S (Aspect_SequenceOfColor &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfColor &) –
Return type:Aspect_SequenceOfColor
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Quantity_Color
Clear()
Return type:None
First()
Return type:Quantity_Color
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Quantity_Color &) –
  • Index
  • S (Aspect_SequenceOfColor &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Quantity_Color &) –
  • Index
  • S (Aspect_SequenceOfColor &) –
Return type:

None

Return type:

None

Last()
Return type:Quantity_Color
Prepend()
Parameters:
  • T (Quantity_Color &) –
  • S (Aspect_SequenceOfColor &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfColor &) –
Return type:Aspect_SequenceOfColor
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Quantity_Color &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfColor &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Quantity_Color
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfColorMapEntry

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Aspect_ColorMapEntry &) –
  • S (Aspect_SequenceOfColorMapEntry &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfColorMapEntry &) –
Return type:Aspect_SequenceOfColorMapEntry
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_ColorMapEntry
Clear()
Return type:None
First()
Return type:Aspect_ColorMapEntry
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_ColorMapEntry &) –
  • Index
  • S (Aspect_SequenceOfColorMapEntry &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_ColorMapEntry &) –
  • Index
  • S (Aspect_SequenceOfColorMapEntry &) –
Return type:

None

Return type:

None

Last()
Return type:Aspect_ColorMapEntry
Prepend()
Parameters:
  • T (Aspect_ColorMapEntry &) –
  • S (Aspect_SequenceOfColorMapEntry &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfColorMapEntry &) –
Return type:Aspect_SequenceOfColorMapEntry
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Aspect_ColorMapEntry &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfColorMapEntry &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_ColorMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfFontMapEntry

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Aspect_FontMapEntry &) –
  • S (Aspect_SequenceOfFontMapEntry &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfFontMapEntry &) –
Return type:Aspect_SequenceOfFontMapEntry
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_FontMapEntry
Clear()
Return type:None
First()
Return type:Aspect_FontMapEntry
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_FontMapEntry &) –
  • Index
  • S (Aspect_SequenceOfFontMapEntry &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_FontMapEntry &) –
  • Index
  • S (Aspect_SequenceOfFontMapEntry &) –
Return type:

None

Return type:

None

Last()
Return type:Aspect_FontMapEntry
Prepend()
Parameters:
  • T (Aspect_FontMapEntry &) –
  • S (Aspect_SequenceOfFontMapEntry &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfFontMapEntry &) –
Return type:Aspect_SequenceOfFontMapEntry
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Aspect_FontMapEntry &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfFontMapEntry &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_FontMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfMarkMapEntry

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Aspect_MarkMapEntry &) –
  • S (Aspect_SequenceOfMarkMapEntry &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfMarkMapEntry &) –
Return type:Aspect_SequenceOfMarkMapEntry
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_MarkMapEntry
Clear()
Return type:None
First()
Return type:Aspect_MarkMapEntry
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_MarkMapEntry &) –
  • Index
  • S (Aspect_SequenceOfMarkMapEntry &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_MarkMapEntry &) –
  • Index
  • S (Aspect_SequenceOfMarkMapEntry &) –
Return type:

None

Return type:

None

Last()
Return type:Aspect_MarkMapEntry
Prepend()
Parameters:
  • T (Aspect_MarkMapEntry &) –
  • S (Aspect_SequenceOfMarkMapEntry &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfMarkMapEntry &) –
Return type:Aspect_SequenceOfMarkMapEntry
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Aspect_MarkMapEntry &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfMarkMapEntry &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_MarkMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfTypeMapEntry

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Aspect_TypeMapEntry &) –
  • S (Aspect_SequenceOfTypeMapEntry &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfTypeMapEntry &) –
Return type:Aspect_SequenceOfTypeMapEntry
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_TypeMapEntry
Clear()
Return type:None
First()
Return type:Aspect_TypeMapEntry
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_TypeMapEntry &) –
  • Index
  • S (Aspect_SequenceOfTypeMapEntry &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_TypeMapEntry &) –
  • Index
  • S (Aspect_SequenceOfTypeMapEntry &) –
Return type:

None

Return type:

None

Last()
Return type:Aspect_TypeMapEntry
Prepend()
Parameters:
  • T (Aspect_TypeMapEntry &) –
  • S (Aspect_SequenceOfTypeMapEntry &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfTypeMapEntry &) –
Return type:Aspect_SequenceOfTypeMapEntry
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Aspect_TypeMapEntry &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfTypeMapEntry &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_TypeMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_SequenceOfWidthMapEntry

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Aspect_WidthMapEntry &) –
  • S (Aspect_SequenceOfWidthMapEntry &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Aspect_SequenceOfWidthMapEntry &) –
Return type:Aspect_SequenceOfWidthMapEntry
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Aspect_WidthMapEntry
Clear()
Return type:None
First()
Return type:Aspect_WidthMapEntry
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_WidthMapEntry &) –
  • Index
  • S (Aspect_SequenceOfWidthMapEntry &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Aspect_WidthMapEntry &) –
  • Index
  • S (Aspect_SequenceOfWidthMapEntry &) –
Return type:

None

Return type:

None

Last()
Return type:Aspect_WidthMapEntry
Prepend()
Parameters:
  • T (Aspect_WidthMapEntry &) –
  • S (Aspect_SequenceOfWidthMapEntry &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Aspect_SequenceOfWidthMapEntry &) –
Return type:Aspect_SequenceOfWidthMapEntry
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Aspect_WidthMapEntry &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Aspect_SequenceOfWidthMapEntry &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Aspect_WidthMapEntry
thisown

The membership flag

class OCC.Aspect.Aspect_TypeMap

Bases: OCC.MMgt.MMgt_TShared

AddEntry()
  • Adds an entry in the type map <self>. Warning: Raises BadAccess if TypeMap size is exceeded.
Parameters:AnEntry (Aspect_TypeMapEntry &) –
Return type:None
  • Search an identical type style entry in the type map <self> and returns the TypeMapEntry Index if exist. Or add a new entry and returns the computed TypeMapEntry index used.
Parameters:aStyle (Aspect_LineStyle &) –
Return type:int
Dump()
Return type:None
Entry()
  • Returns the Type map entry with the index <AnIndex>. Warning: Raises BadAccess if the index less than 1 or //! greater than Size.
Parameters:AnIndex (Standard_Integer) –
Return type:Aspect_TypeMapEntry
GetHandle()

Aspect_TypeMap_GetHandle(Aspect_TypeMap self) -> Handle_Aspect_TypeMap

Index()
  • Returns the TypeMapEntry.Index of the TypeMap at rank <aTypemapIndex> .
Parameters:aTypemapIndex (Standard_Integer) –
Return type:int
Size()
  • Returns the Allocated typemap Size
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_TypeMapEntry(*args)

Bases: object

Dump()
Return type:None
Free()
  • Unallocates the typemap entry.
Return type:None
Index()
  • Returns index value of a typemap entry. Warning: Raises error if the typemap entry is unallocated .
Return type:int
IsAllocated()
  • Returns True if the typemap entry is allocated. Warning: A typemap entry is allocated when the type and //! the index is defined.
Return type:bool
Set()
Parameters:entry (Aspect_TypeMapEntry &) –
Return type:None
SetIndex()
  • Sets index value of a typemap entry.
Parameters:index (Standard_Integer) –
Return type:None
SetType()
  • Sets the line style of typemap entry.
Parameters:Style (Aspect_LineStyle &) –
Return type:None
SetValue()
  • Sets typemap entry value and allocates it.
Parameters:
  • index (Standard_Integer) –
  • style (Aspect_LineStyle &) –
Return type:

None

  • Sets typemap entry value and allocates it.
Parameters:entry (Aspect_TypeMapEntry &) –
Return type:None
Type()
Return type:Aspect_LineStyle
thisown

The membership flag

class OCC.Aspect.Aspect_WidthMap

Bases: OCC.MMgt.MMgt_TShared

AddEntry()
  • Adds an entry in the Width map <self>. Warning: Raises BadAccess if WidthMap size is exceeded.
Parameters:AnEntry (Aspect_WidthMapEntry &) –
Return type:None
  • Search an identical line width entry in the width map <self> and returns the WidthMapEntry Index if exist. Or add a new entry and returns the computed WidthMapEntry index used.
Parameters:aStyle (Aspect_WidthOfLine) –
Return type:int
  • Search an identical line width entry in the width map <self> and returns the WidthMapEntry Index if exist. Or add a new entry and returns the computed WidthMapEntry index used.
Parameters:aStyle (Quantity_Length) –
Return type:int
Dump()
Return type:None
Entry()
  • Returns the Width map entry with the index <AnIndex>. Warning: Raises BadAccess if the index less than 1 or //! greater than Size.
Parameters:AnIndex (Standard_Integer) –
Return type:Aspect_WidthMapEntry
GetHandle()

Aspect_WidthMap_GetHandle(Aspect_WidthMap self) -> Handle_Aspect_WidthMap

Index()
  • Returns the WidthMapEntry.Index of the WidthMap at rank <aWidthmapIndex> .
Parameters:aWidthmapIndex (Standard_Integer) –
Return type:int
Size()
  • Returns the Allocated widthmap Size
Return type:int
thisown

The membership flag

class OCC.Aspect.Aspect_WidthMapEntry(*args)

Bases: object

Dump()
Return type:None
Free()
  • Unallocates the widthmap entry.
Return type:None
Index()
  • Returns index value of a widthmap entry. Warning: Raises error if the widthmap entry is unallocated .
Return type:int
IsAllocated()
  • Returns True if the widthmap entry is allocated. Warning: A widthmap entry is allocated when the width and //! the index is defined.
Return type:bool
Set()
Parameters:entry (Aspect_WidthMapEntry &) –
Return type:None
SetIndex()
  • Sets index value of a widthmap entry.
Parameters:index (Standard_Integer) –
Return type:None
SetType()
  • Sets width style of widthmap entry.
Parameters:Style (Aspect_WidthOfLine) –
Return type:None
SetValue()
  • Sets widthmap entry value from width style //! and allocates it.
Parameters:
  • index (Standard_Integer) –
  • style (Aspect_WidthOfLine) –
Return type:

None

  • Sets widthmap entry value from width value //! and allocates it.
Parameters:
  • index (Standard_Integer) –
  • width (Quantity_Length) –
Return type:

None

  • Sets widthmap entry value and allocates it.
Parameters:entry (Aspect_WidthMapEntry &) –
Return type:None
SetWidth()
  • Sets width value of widthmap entry.
Parameters:Width (Quantity_Length) –
Return type:None
Type()
Return type:Aspect_WidthOfLine
Width()
  • Returns width value of widthmap entry. Warning: Raises error if the widthmap entry is unallocated .
Return type:Quantity_Length
thisown

The membership flag

class OCC.Aspect.Aspect_Window(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Background()
  • Returns the window background.
Return type:Aspect_Background
BackgroundFillMethod()
  • Returns the current image background fill mode.
Return type:Aspect_FillMethod
Destroy()
  • Destroy the Window
Return type:void
DoMapping()
  • Apply the mapping change to the window <self>. and returns True if the window is mapped at screen.
Return type:bool
DoResize()
  • Apply the resizing to the window <self>.
Return type:Aspect_TypeOfResize
GetHandle()

Aspect_Window_GetHandle(Aspect_Window self) -> Handle_Aspect_Window

GradientBackground()
  • Returns the window gradient background.
Return type:Aspect_GradientBackground
IsMapped()
  • Returns True if the window <self> is opened //! and False if the window is closed.
Return type:bool
IsVirtual()
  • Returns True if the window <self> is virtual
Return type:bool
Map()
  • Opens the window <self>.
Return type:void
Position()
  • Returns The Window POSITION in PIXEL
Parameters:
  • X1 (Standard_Integer &) –
  • Y1 (Standard_Integer &) –
  • X2 (Standard_Integer &) –
  • Y2 (Standard_Integer &) –
Return type:

void

Ratio()
  • Returns The Window RATIO equal to the physical //! WIDTH/HEIGHT dimensions
Return type:Quantity_Ratio
SetBackground()
  • Modifies the window background.
Parameters:ABack (Aspect_Background &) –
Return type:None
  • Modifies the window background from a Named Color.
Parameters:theNameOfColor (Quantity_NameOfColor) –
Return type:None
  • Modifies the window background.
Parameters:color (Quantity_Color &) –
Return type:None
  • Modifies the window gradient background.
Parameters:ABackground (Aspect_GradientBackground &) –
Return type:None
  • Modifies the window gradient background.
Parameters:
  • theFirstColor (Quantity_Color &) –
  • theSecondColor (Quantity_Color &) –
  • theFillMethod (Aspect_GradientFillMethod) –
Return type:

None

SetVirtual()
  • Setup the virtual state
Parameters:theVirtual (bool) –
Return type:None
Size()
  • Returns The Window SIZE in PIXEL
Parameters:
  • Width (Standard_Integer &) –
  • Height (Standard_Integer &) –
Return type:

void

Unmap()
  • Closes the window <self>.
Return type:void
thisown

The membership flag

class OCC.Aspect.Aspect_WindowDriver(*args, **kwargs)

Bases: OCC.Aspect.Aspect_Driver

AngleOfBuffer()
  • Returns the current buffer rotate angle from the X axis.
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • anAngle (Quantity_PlaneAngle &) –
Return type:

void

BeginDraw()
  • Begin graphics and drawn directly to the Window or Pixmap if
Parameters:
  • DoubleBuffer (bool) – default value is Standard_True
  • aRetainBuffer (Standard_Integer) – default value is 0
Return type:

void

  • Begin graphics and drawn directly to the Window or Pixmap if
Parameters:
  • DoubleBuffer (bool) – default value is Standard_True
  • aRetainBuffer (Standard_Integer) – default value is 0
Return type:

void

  • Begin graphics and drawn directly to the Window or Pixmap if
Parameters:
  • DoubleBuffer (bool) – default value is Standard_True
  • aRetainBuffer (Standard_Integer) – default value is 0
Return type:

void

BufferIsDrawn()
  • Returns True if the retain buffer s actually displayed at screen.
Parameters:aRetainBuffer (Standard_Integer) –
Return type:bool
BufferIsEmpty()
  • Returns True if the retain buffer has not been opened or empty. Returns False if a lot of primitives have been stored inside because a BeginDraw(..,<aRetainBuffer>) has been done previously.
Parameters:aRetainBuffer (Standard_Integer) –
Return type:bool
BufferIsOpen()
  • Returns True if the retain buffer <aRetainBuffer> is enabled
Parameters:aRetainBuffer (Standard_Integer) –
Return type:bool
ClearBuffer()
  • Erase & Clear ALL primitives retains in the buffer <aRetainBuffer>.
Parameters:aRetainBuffer (Standard_Integer) –
Return type:void
CloseBuffer()
  • Clear & Deallocate the retain buffer <aRetainBuffer>.
Parameters:aRetainBuffer (Standard_Integer) –
Return type:void
ColorBoundIndexs()
  • Returns the min and max driver virtual color indexs.
Parameters:
  • aMinIndex (Standard_Integer &) –
  • aMaxIndex (Standard_Integer &) –
Return type:

void

DrawBuffer()
  • Draw ALL primitives retains in the buffer <aRetainBuffer>. Warning: Note that the aspect of a retain buffer drawing is mono-colored with the current buffer Attributes and Depending of the DoubleBuffer state flag at the BeginDraw() buffer time, when DB is True,an XOR method is use for drawing and erasing buffers in the same way.In this case,some color side effect can occurs depending of the traversal primitive colors and the supported hardware. when DB is False and the background drawing has been generated with DB at True,no color side effect occurs because the DB is used for restoring the drawing context at EraseBuffer() time,this is more powerfull for the drawing quality excepted for large buffers (flicking) .
Parameters:aRetainBuffer (Standard_Integer) –
Return type:void
EraseBuffer()
  • Erase ALL primitives retains in the buffer <aRetainBuffer>.
Parameters:aRetainBuffer (Standard_Integer) –
Return type:void
FontBoundIndexs()
  • Returns the min and max driver virtual font indexs.
Parameters:
  • aMinIndex (Standard_Integer &) –
  • aMaxIndex (Standard_Integer &) –
Return type:

void

FontSize()
  • Returns the font string,slant,size and
Parameters:
  • aSlant (Quantity_PlaneAngle &) –
  • aSize (Standard_ShortReal &) –
  • aBheight (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

char *

  • Returns the font string,slant,size and
Parameters:
  • aSlant (Quantity_PlaneAngle &) –
  • aSize (Standard_ShortReal &) –
  • aBheight (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

char *

GetHandle()

Aspect_WindowDriver_GetHandle(Aspect_WindowDriver self) -> Handle_Aspect_WindowDriver

LocalColorIndex()
  • Returns the local colormap hardware index from a virtual driver color index or returns -1 if the index is not defined.
Parameters:anIndex (Standard_Integer) –
Return type:int
LocalFontIndex()
  • Returns the associated fontmap hardware index from a virtual driver font index or returns -1 if the index is not defined.
Parameters:anIndex (Standard_Integer) –
Return type:int
LocalMarkIndex()
  • Returns the local markmap hardware index from a virtual driver marker index or returns -1 if the index is not defined.
Parameters:anIndex (Standard_Integer) –
Return type:int
LocalTypeIndex()
  • Returns the associated typemap hardware index from a virtual driver type index or returns -1 if the index is not defined.
Parameters:anIndex (Standard_Integer) –
Return type:int
LocalWidthIndex()
  • Returns the associated widthmap hardware index from a virtual driver width index or returns -1 if the index is not defined.
Parameters:anIndex (Standard_Integer) –
Return type:int
MarkBoundIndexs()
  • Returns the min and max driver virtual marker indexs.
Parameters:
  • aMinIndex (Standard_Integer &) –
  • aMaxIndex (Standard_Integer &) –
Return type:

void

MoveBuffer()
  • Erase , Translate and reDraw ALL primitives retains in the buffer
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
Return type:

void

  • Erase , Translate and reDraw ALL primitives retains in the buffer
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
Return type:

void

  • Erase , Translate and reDraw ALL primitives retains in the buffer
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
Return type:

void

OpenBuffer()
  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

  • Allocate the retain buffer <aRetainBuffer> , Defines the DWU coordinates of the pivot point for all primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal) – default value is 0.0
  • aPivotY (Standard_ShortReal) – default value is 0.0
  • aWidthIndex (Standard_Integer) – default value is 0
  • aColorIndex (Standard_Integer) – default value is 0
  • aFontIndex (Standard_Integer) – default value is 0
  • aDrawMode (Aspect_TypeOfDrawMode) – default value is Aspect_TODM_REPLACE
Return type:

bool

PositionOfBuffer()
  • Returns the current buffer position.
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aPivotX (Standard_ShortReal &) –
  • aPivotY (Standard_ShortReal &) –
Return type:

void

ResizeSpace()
Return type:Aspect_TypeOfResize
RotateBuffer()
  • Erase , Rotate the buffer from the Pivot point and reDraw ALL primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • anAngle (Quantity_PlaneAngle) – default value is 0.0
Return type:

void

  • Erase , Rotate the buffer from the Pivot point and reDraw ALL primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • anAngle (Quantity_PlaneAngle) – default value is 0.0
Return type:

void

ScaleBuffer()
  • Erase , Scale the buffer from the Pivot point and reDraw ALL primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aScaleX (Quantity_Factor) – default value is 1.0
  • aScaleY (Quantity_Factor) – default value is 1.0
Return type:

void

  • Erase , Scale the buffer from the Pivot point and reDraw ALL primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aScaleX (Quantity_Factor) – default value is 1.0
  • aScaleY (Quantity_Factor) – default value is 1.0
Return type:

void

  • Erase , Scale the buffer from the Pivot point and reDraw ALL primitives
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aScaleX (Quantity_Factor) – default value is 1.0
  • aScaleY (Quantity_Factor) – default value is 1.0
Return type:

void

ScaleOfBuffer()
  • Returns the current buffer scale factors.
Parameters:
  • aRetainBuffer (Standard_Integer) –
  • aScaleX (Quantity_Factor &) –
  • aScaleY (Quantity_Factor &) –
Return type:

void

SetDrawMode()
  • Change the current drawing mode of the Driver XW_REPLACE : the primitive is drawn with his defined color. //! XW_ERASE : the primitive is erased from the window. //! XW_XOR : the primitive is xored to the window. //! XW_XORLIGHT: the primitive is xored depending of the current //! highlight and background colors.
Parameters:aMode (Aspect_TypeOfDrawMode) –
Return type:void
TextSize()
  • Returns the TEXT size in DWU space depending of the required FontIndex if aFontIndex is >= 0 or the current FontIndex if < 0 (default).
Parameters:
  • aText (TCollection_ExtendedString &) –
  • aWidth (Standard_ShortReal &) –
  • aHeight (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

void

  • Returns the TEXT size in DWU space depending of the required FontIndex if aFontIndex is >= 0 or the current FontIndex if < 0 (default).
Parameters:
  • aText (TCollection_ExtendedString &) –
  • aWidth (Standard_ShortReal &) –
  • aHeight (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

void

  • Returns the TEXT size and offsets //! in DWU space depending of the required FontIndex if aFontIndex is >= 0 or the current FontIndex if < 0 (default).
Parameters:
  • aText (TCollection_ExtendedString &) –
  • aWidth (Standard_ShortReal &) –
  • aHeight (Standard_ShortReal &) –
  • anXoffset (Standard_ShortReal &) –
  • anYoffset (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

void

  • Returns the TEXT size and offsets //! in DWU space depending of the required FontIndex if aFontIndex is >= 0 or the current FontIndex if < 0 (default).
Parameters:
  • aText (TCollection_ExtendedString &) –
  • aWidth (Standard_ShortReal &) –
  • aHeight (Standard_ShortReal &) –
  • anXoffset (Standard_ShortReal &) –
  • anYoffset (Standard_ShortReal &) –
  • aFontIndex (Standard_Integer) – default value is - 1
Return type:

void

TypeBoundIndexs()
  • Returns the min and max driver virtual type indexs.
Parameters:
  • aMinIndex (Standard_Integer &) –
  • aMaxIndex (Standard_Integer &) –
Return type:

void

WidthBoundIndexs()
  • Returns the min and max driver virtual width indexs.
Parameters:
  • aMinIndex (Standard_Integer &) –
  • aMaxIndex (Standard_Integer &) –
Return type:

void

Window()
Return type:Handle_Aspect_Window
thisown

The membership flag

class OCC.Aspect.Handle_Aspect_AspectFillArea(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_AspectLine(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_AspectMarker(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_CircularGrid(*args)

Bases: OCC.Aspect.Handle_Aspect_Grid

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

The membership flag

class OCC.Aspect.Handle_Aspect_ColorCubeColorMap(*args)

Bases: OCC.Aspect.Handle_Aspect_ColorMap

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

The membership flag

class OCC.Aspect.Handle_Aspect_ColorMap(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_ColorRampColorMap(*args)

Bases: OCC.Aspect.Handle_Aspect_ColorMap

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

The membership flag

class OCC.Aspect.Handle_Aspect_ColorScale(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_Driver(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_FontMap(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_GenericColorMap(*args)

Bases: OCC.Aspect.Handle_Aspect_ColorMap

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

The membership flag

class OCC.Aspect.Handle_Aspect_Grid(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_MarkMap(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_RectangularGrid(*args)

Bases: OCC.Aspect.Handle_Aspect_Grid

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfColor(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfColorMapEntry(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfFontMapEntry(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfMarkMapEntry(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfTypeMapEntry(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_SequenceNodeOfSequenceOfWidthMapEntry(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Aspect.Handle_Aspect_TypeMap(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_WidthMap(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_Window(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Aspect.Handle_Aspect_WindowDriver(*args)

Bases: OCC.Aspect.Handle_Aspect_Driver

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

The membership flag

class OCC.Aspect.SwigPyIterator(*args, **kwargs)

Bases: object

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

The membership flag

value()
class OCC.Aspect.aspect(*args, **kwargs)

Bases: object

static Inverse(*args)
  • Inverses <aMat> a 4x4 matrix.
Parameters:
  • aMat (TColStd_Array2OfReal &) –
  • Inv (TColStd_Array2OfReal &) –
Return type:

bool

static ToCString(*args)
  • Translates an ExtendedString to a CString depending of the local format.
Parameters:aString (TCollection_ExtendedString &) –
Return type:char *
static ValuesOfFOSP(*args)
  • Returns the format size according to the default LENGTH unit of the required format <aFOSP>. Returns more the normalized format name.
Parameters:
  • aFOSP (Aspect_FormatOfSheetPaper) –
  • aWidth (Quantity_Length &) –
  • aHeight (Quantity_Length &) –
Return type:

char *

thisown

The membership flag

OCC.Aspect.aspect_Inverse(*args)
  • Inverses <aMat> a 4x4 matrix.
Parameters:
  • aMat (TColStd_Array2OfReal &) –
  • Inv (TColStd_Array2OfReal &) –
Return type:

bool

OCC.Aspect.aspect_ToCString(*args)
  • Translates an ExtendedString to a CString depending of the local format.
Parameters:aString (TCollection_ExtendedString &) –
Return type:char *
OCC.Aspect.aspect_ValuesOfFOSP(*args)
  • Returns the format size according to the default LENGTH unit of the required format <aFOSP>. Returns more the normalized format name.
Parameters:
  • aFOSP (Aspect_FormatOfSheetPaper) –
  • aWidth (Quantity_Length &) –
  • aHeight (Quantity_Length &) –
Return type:

char *