OCC.Core.AIS module<a class="headerlink" href="#module-OCC.Core.AIS" title="Permalink to this headline">¶

Constructs minimum angle dimension between two linear edges (where possible). These two edges should be intersected by each other. Otherwise the geometry is not valid. @param theFirstEdge [in] the first edge. @param theSecondEdge [in] the second edge.

param theFirstEdge

type theFirstEdge

TopoDS_Edge

param theSecondEdge

type theSecondEdge

TopoDS_Edge

rtype

None* Constructs the angle display object defined by three points. @param theFirstPoint [in] the first point (point on first angle flyout). @param theSecondPoint [in] the center point of angle dimension. @param theThirdPoint [in] the second point (point on second angle flyout).

param theFirstPoint

type theFirstPoint

gp_Pnt

param theSecondPoint

type theSecondPoint

gp_Pnt

param theThirdPoint

type theThirdPoint

gp_Pnt

rtype

None* Constructs the angle display object defined by three vertices. @param theFirstVertex [in] the first vertex (vertex for first angle flyout). @param theSecondVertex [in] the center vertex of angle dimension. @param theThirdPoint [in] the second vertex (vertex for second angle flyout).

param theFirstVertex

type theFirstVertex

TopoDS_Vertex

param theSecondVertex

type theSecondVertex

TopoDS_Vertex

param theThirdVertex

type theThirdVertex

TopoDS_Vertex

rtype

None* Constructs angle dimension for the cone face. @param theCone [in] the conical face.

param theCone

type theCone

TopoDS_Face

rtype

None* Constructs angle dimension between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face.

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

rtype

None* Constructs angle dimension between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face. @param thePoint [in] the point which the dimension plane should pass through. This point can lay on the one of the faces or not.

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

param thePoint

type thePoint

gp_Pnt

rtype

None

CenterPoint()¶

returns center point forming the angle.

rtype

gp_Pnt

static DownCast(t)¶

FirstPoint()¶

returns first point forming the angle.

rtype

gp_Pnt

FirstShape()¶

returns first argument shape.

rtype

TopoDS_Shape

GetArrowsVisibility()¶

returns the type of visibility of arrows.

rtype

AIS_TypeOfAngleArrowVisibility

GetTextPosition()¶

Return type: gp_Pnt

GetType()¶

returns the current angle type.

rtype

AIS_TypeOfAngle

SecondPoint()¶

returns second point forming the angle.

rtype

gp_Pnt

SecondShape()¶

returns second argument shape.

rtype

TopoDS_Shape

SetArrowsVisibility()¶

Sets visible arrows type @param theType [in] the type of visibility of arrows.

param theType

type theType

AIS_TypeOfAngleArrowVisibility

rtype

None

SetDisplayUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetMeasuredGeometry()¶

Measures minimum angle dimension between two linear edges. These two edges should be intersected by each other. Otherwise the geometry is not valid. @param theFirstEdge [in] the first edge. @param theSecondEdge [in] the second edge.

param theFirstEdge

type theFirstEdge

TopoDS_Edge

param theSecondEdge

type theSecondEdge

TopoDS_Edge

rtype

None* Measures angle defined by three points. @param theFirstPoint [in] the first point (point on first angle flyout). @param theSecondPoint [in] the center point of angle dimension. @param theThirdPoint [in] the second point (point on second angle flyout).

param theFirstPoint

type theFirstPoint

gp_Pnt

param theSecondPoint

type theSecondPoint

gp_Pnt

param theThridPoint

type theThridPoint

gp_Pnt

rtype

None* Measures angle defined by three vertices. @param theFirstVertex [in] the first vertex (vertex for first angle flyout). @param theSecondVertex [in] the center vertex of angle dimension. @param theThirdPoint [in] the second vertex (vertex for second angle flyout).

param theFirstVertex

type theFirstVertex

TopoDS_Vertex

param theSecondVertex

type theSecondVertex

TopoDS_Vertex

param theThirdVertex

type theThirdVertex

TopoDS_Vertex

rtype

None* Measures angle of conical face. @param theCone [in] the shape to measure.

param theCone

type theCone

TopoDS_Face

rtype

None* Measures angle between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face..

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

rtype

None* Measures angle between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face. @param thePoint [in] the point which the dimension plane should pass through. This point can lay on the one of the faces or not.

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

param thePoint

type thePoint

gp_Pnt

rtype

None

SetModelUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetTextPosition()¶

Principle of horizontal text alignment settings: - divide circle into two halves according to attachment points - if aTextPos is between attach points -> Center + positive flyout - if aTextPos is not between attach points but in this half -> Left or Right + positive flyout - if aTextPos is between reflections of attach points -> Center + negative flyout - if aTextPos is not between reflections of attach points -> Left or Right + negative flyout

param theTextPos

type theTextPos

gp_Pnt

rtype

void

SetType()¶

Sets angle type. @param theType [in] the type value.

param theType

type theType

AIS_TypeOfAngle

rtype

None

ThirdShape()¶

returns third argument shape.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class AIS_Animation(*args)¶

Creates empty animation.

param theAnimationName

type theAnimationName

TCollection_AsciiString

rtype

None

Add()¶

Add single animation to the timeline. @param theAnimation input animation

param theAnimation

type theAnimation

AIS_Animation

rtype

None

Children()¶

Return sequence of child animations.

rtype

NCollection_Sequence<opencascade::handle<AIS_Animation> >

Clear()¶

Clear animation timeline - remove all animations from it.

rtype

None

CopyFrom()¶

Clears own children and then copy child animations from another object. Copy also Start Time and Duration values.

param theOther

type theOther

AIS_Animation

rtype

None

static DownCast(t)¶

Duration()¶

returns duration of the animation in the timeline

rtype

float

ElapsedTime()¶

Return elapsed time.

rtype

float

Find()¶

Return the child animation with the given name.

param theAnimationName

type theAnimationName

TCollection_AsciiString

rtype

opencascade::handle<AIS_Animation>

HasOwnDuration()¶

Return true if duration is defined.

rtype

bool

IsStopped()¶

Check if animation is to be performed in the animation timeline. returns True if it is stopped of finished.

rtype

bool

Name()¶

Animation name.

rtype

TCollection_AsciiString

OwnDuration()¶

returns own duration of the animation in the timeline

rtype

float

Pause()¶

Pause the process timeline.

rtype

void

Remove()¶

Remove the child animation.

param theAnimation

type theAnimation

AIS_Animation

rtype

bool

Replace()¶

Replace the child animation.

param theAnimationOld

type theAnimationOld

AIS_Animation

param theAnimationNew

type theAnimationNew

AIS_Animation

rtype

bool

SetOwnDuration()¶

Defines duration of the animation.

param theDuration

type theDuration

float

rtype

None

SetStartPts()¶

Sets time limits for animation in the animation timeline

param thePtsStart

type thePtsStart

float

rtype

None

Start()¶

Start animation. This method changes status of the animation to Started. This status defines whether animation is to be performed in the timeline or not. @param theToUpdate call Update() method

param theToUpdate

type theToUpdate

bool

rtype

void

StartPts()¶

returns start time of the animation in the timeline

rtype

float

StartTimer()¶

Start animation with internally defined timer instance. Calls ::Start() internally. //! Note, that this method initializes a timer calculating an elapsed time (presentation timestamps within AIS_Animation::UpdateTimer()), not a multimedia timer executing Viewer updates at specific intervals! Viewer redrawing should be managed at application level, so that AIS_Animation::UpdateTimer() is called once right before each redrawing of a Viewer content. //! @param theStartPts starting timer position (presentation timestamp) @param thePlaySpeed playback speed (1.0 means normal speed) @param theToUpdate flag to update defined animations to specified start position @param theToStopTimer flag to pause timer at the starting position

param theStartPts

type theStartPts

float

param thePlaySpeed

type thePlaySpeed

float

param theToUpdate

type theToUpdate

bool

param theToStopTimer

default value is Standard_False

type theToStopTimer

bool

rtype

void

Stop()¶

Stop animation. This method changed status of the animation to Stopped. This status shows that animation will not be performed in the timeline or it is finished.

rtype

void

Update()¶

Update single frame of animation, update timer state @param thePts [in] the time moment within [0; Duration()] returns True if timeline is in progress

param thePts

type thePts

float

rtype

bool

UpdateTimer()¶

Update single frame of animation, update timer state returns current time of timeline progress.

rtype

float

UpdateTotalDuration()¶

Update total duration considering all animations on timeline.

rtype

None

property thisown¶: The membership flag

class AIS_AnimationCamera(*args)¶

Bases: OCC.Core.AIS.AIS_Animation

Main constructor.

param theAnimationName

type theAnimationName

TCollection_AsciiString

param theView

type theView

V3d_View

rtype

None

CameraEnd()¶

Return camera end position.

rtype

opencascade::handle<Graphic3d_Camera>

CameraStart()¶

Return camera start position.

rtype

opencascade::handle<Graphic3d_Camera>

static DownCast(t)¶

SetCameraEnd()¶

Define camera end position.

param theCameraEnd

type theCameraEnd

Graphic3d_Camera

rtype

None

SetCameraStart()¶

Define camera start position.

param theCameraStart

type theCameraStart

Graphic3d_Camera

rtype

None

SetView()¶

Set target view.

param theView

type theView

V3d_View

rtype

None

View()¶

Return the target view.

rtype

opencascade::handle<V3d_View>

property thisown¶: The membership flag

class AIS_AnimationObject(*args)¶

Bases: OCC.Core.AIS.AIS_Animation

Constructor with initialization. Note that start/end transformations specify exactly local transformation of the object, not the transformation to be applied to existing local transformation. @param theAnimationName animation identifier @param theContext interactive context where object have been displayed @param theObject object to apply local transformation @param theTrsfStart local transformation at the start of animation (e.g. theObject->LocalTransformation()) @param theTrsfEnd local transformation at the end of animation

param theAnimationName

type theAnimationName

TCollection_AsciiString

param theContext

type theContext

AIS_InteractiveContext

param theObject

type theObject

AIS_InteractiveObject

param theTrsfStart

type theTrsfStart

gp_Trsf

param theTrsfEnd

type theTrsfEnd

gp_Trsf

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_AnimationProgress(*args)¶

Bases: object

//!< normalized position within current animation within 0..1 range

rtype

None

property LocalNormalized¶

property LocalPts¶

property Pts¶

property thisown¶: The membership flag

class AIS_AttributeFilter(*args)¶

Constructs an empty attribute filter object. This filter object determines whether selectable interactive objects have a non-null owner.

rtype

None* Constructs an attribute filter object defined by the color attribute aCol.

param aCol

type aCol

Quantity_NameOfColor

rtype

None* Constructs an attribute filter object defined by the line width attribute aWidth.

param aWidth

type aWidth

float

rtype

None

static DownCast(t)¶

HasColor()¶

Indicates that the Interactive Object has the color setting specified by the argument aCol at construction time.

rtype

bool

HasWidth()¶

Indicates that the Interactive Object has the width setting specified by the argument aWidth at construction time.

rtype

bool

SetColor()¶

Sets the color aCol. This must be chosen from the list of colors in Quantity_NameOfColor.

param aCol

type aCol

Quantity_NameOfColor

rtype

None

SetWidth()¶

Sets the line width aWidth.

param aWidth

type aWidth

float

rtype

None

UnsetColor()¶

Removes the setting for color from the filter.

rtype

None

UnsetWidth()¶

Removes the setting for width from the filter.

rtype

None

property thisown¶: The membership flag

class AIS_BadEdgeFilter(*args)¶

Constructs an empty filter object for bad edges.

rtype

None

AddEdge()¶

Adds an edge to the list of non-selectionnable edges.

param anEdge

type anEdge

TopoDS_Edge

param Index

type Index

int

rtype

None

static DownCast(t)¶

RemoveEdges()¶

removes from the list of non-selectionnable edges all edges in the contour <Index>.

param Index

type Index

int

rtype

None

SetContour()¶

sets <myContour> with current contour. used by IsOk.

param Index

type Index

int

rtype

None

property thisown¶: The membership flag

class AIS_C0RegularityFilter(*args)¶

Parameters

aShape –

type aShape: TopoDS_Shape
rtype: None

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_CameraFrustum(*args)¶

Constructs camera frustum with default configuration.

rtype

None

AcceptDisplayMode()¶

Return true if specified display mode is supported.

param theMode

type theMode

int

rtype

bool

SelectionMode_Edges = 0¶

SelectionMode_Volume = 1¶

SetCameraFrustum()¶

Sets camera frustum.

param theCamera

type theCamera

Graphic3d_Camera

rtype

None

SetColor()¶

Setup custom color.

param theColor

type theColor

Quantity_Color

rtype

void

UnsetColor()¶

Restore default color.

rtype

void

property thisown¶: The membership flag

class AIS_Chamf2dDimension(*args)¶

Constructs the display object for 2D chamfers. This object is defined by the face aFShape, the dimension aVal, the plane aPlane and the text aText.

param aFShape

type aFShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

rtype

None* Constructs the display object for 2D chamfers. This object is defined by the face aFShape, the plane aPlane, the dimension aVal, the position aPosition, the type of arrow aSymbolPrs with the size anArrowSize, and the text aText.

param aFShape

type aFShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

param aPosition

type aPosition

gp_Pnt

param aSymbolPrs

type aSymbolPrs

DsgPrs_ArrowSide

param anArrowSize

default value is 0.0

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_Chamf3dDimension(*args)¶

Constructs a display object for 3D chamfers. This object is defined by the shape aFShape, the dimension aVal and the text aText.

param aFShape

type aFShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

rtype

None* Constructs a display object for 3D chamfers. This object is defined by the shape aFShape, the dimension aVal, the text aText, the point of origin of the chamfer aPosition, the type of arrow aSymbolPrs with the size anArrowSize.

param aFShape

type aFShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

param aPosition

type aPosition

gp_Pnt

param aSymbolPrs

type aSymbolPrs

DsgPrs_ArrowSide

param anArrowSize

default value is 0.0

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_Circle(*args)¶

Initializes this algorithm for constructing AIS circle datums initializes the circle aCircle

param aCircle

type aCircle

Geom_Circle

rtype

None* Initializes this algorithm for constructing AIS circle datums. Initializes the circle theCircle, the arc starting point theUStart, the arc ending point theUEnd, and the type of sensitivity theIsFilledCircleSens.

param theCircle

type theCircle

Geom_Circle

param theUStart

type theUStart

float

param theUEnd

type theUEnd

float

param theIsFilledCircleSens

default value is Standard_False

type theIsFilledCircleSens

bool

rtype

None

Circle()¶

Returns the circle component defined in SetCircle.

rtype

opencascade::handle<Geom_Circle>

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

IsFilledCircleSens()¶

Returns the type of sensitivity for the circle;

rtype

bool

Parameters()¶

Constructs instances of the starting point and the end point parameters, theU1 and theU2.

param theU1

type theU1

float

param theU2

type theU2

float

rtype

None

SetCircle()¶

Allows you to provide settings for the circle datum aCircle.

param theCircle

type theCircle

Geom_Circle

rtype

None

SetColor()¶

Parameters

aColor –

type aColor: Quantity_Color
rtype: None

SetFilledCircleSens()¶

Sets the type of sensitivity for the circle. If theIsFilledCircleSens set to Standard_True then the whole circle will be detectable, otherwise only the boundary of the circle.

param theIsFilledCircleSens

type theIsFilledCircleSens

bool

rtype

None

SetFirstParam()¶

Allows you to set the parameter theU for the starting point of an arc.

param theU

type theU

float

rtype

None

SetLastParam()¶

Allows you to provide the parameter theU for the end point of an arc.

param theU

type theU

float

rtype

None

SetWidth()¶

Assigns the width aValue to the solid line boundary of the circle datum.

param aValue

type aValue

float

rtype

None

Signature()¶

Returns index 6 by default.

rtype

int

Type()¶

Indicates that the type of Interactive Object is a datum.

rtype

AIS_KindOfInteractive

UnsetColor()¶

Removes color from the solid line boundary of the circle datum.

rtype

None

UnsetWidth()¶

Removes width settings from the solid line boundary of the circle datum.

rtype

None

property thisown¶: The membership flag

class AIS_ColorScale(*args)¶

Default constructor.

rtype

None

AcceptDisplayMode()¶

Return true if specified display mode is supported.

param theMode

type theMode

int

rtype

bool

ColorRange()¶

Returns color range corresponding to minimum and maximum values, blue to red by default.

param theMinColor

type theMinColor

Quantity_Color

param theMaxColor

type theMaxColor

Quantity_Color

rtype

None

Compute()¶

Compute presentation.

param thePresentationManager

type thePresentationManager

PrsMgr_PresentationManager3d

param thePresentation

type thePresentation

Prs3d_Presentation

param theMode

type theMode

int

rtype

void

ComputeSelection()¶

Compute selection - not implemented for color scale.

param &

type &

SelectMgr_Selection

param Standard_Integer

type Standard_Integer

rtype

None

static DownCast(t)¶

FindColor()¶

Calculate color according passed value; returns true if value is in range or false, if isn’t

param theValue

type theValue

float

param theMin

type theMin

float

param theMax

type theMax

float

param theColorsCount

type theColorsCount

int

param theColorHlsMin

type theColorHlsMin

Graphic3d_Vec3d

param theColorHlsMax

type theColorHlsMax

Graphic3d_Vec3d

param theColor

type theColor

Quantity_Color

rtype

bool* Calculate color according passed value; returns true if value is in range or false, if isn’t

param theValue

type theValue

float

param theMin

type theMin

float

param theMax

type theMax

float

param theColorsCount

type theColorsCount

int

param theColor

type theColor

Quantity_Color

rtype

bool* Calculate color according passed value; returns true if value is in range or false, if isn’t

param theValue

type theValue

float

param theColor

type theColor

Quantity_Color

rtype

bool

Format()¶

Returns the format of text.

rtype

TCollection_AsciiString

GetBreadth()¶

Returns the breadth of color bar, 0 by default (e.g. should be set by user explicitly before displaying).

rtype

int

GetColorType()¶

Returns the type of colors, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map

rtype

Aspect_TypeOfColorScaleData

GetColors()¶

Returns the user specified colors.

param theColors

type theColors

Aspect_SequenceOfColor

rtype

None* Returns the user specified colors.

rtype

Aspect_SequenceOfColor

GetFormat()¶

Returns the format for numbers, ‘%.4g’ by default. The same like format for function printf(). Used if GetLabelType() is TOCSD_AUTO;

rtype

TCollection_AsciiString

GetHeight()¶

Returns the height of color bar, 0 by default (e.g. should be set by user explicitly before displaying).

rtype

int

GetIntervalColor()¶

Returns the user specified color from color map with index (starts at 1). Returns default color if index is out of range in color map.

param theIndex

type theIndex

int

rtype

Quantity_Color

GetLabel()¶

Returns the user specified label with index theIndex. Index is in range from 1 to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. Returns empty string if label not defined.

param theIndex

type theIndex

int

rtype

TCollection_ExtendedString

GetLabelPosition()¶

Returns the position of labels concerning color filled rectangles, Aspect_TOCSP_RIGHT by default.

rtype

Aspect_TypeOfColorScalePosition

GetLabelType()¶

Returns the type of labels, Aspect_TOCSD_AUTO by default. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used

rtype

Aspect_TypeOfColorScaleData

GetLabels()¶

Returns the user specified labels.

param theLabels

type theLabels

TColStd_SequenceOfExtendedString

rtype

None

GetMax()¶

Returns maximal value of color scale, 1.0 by default.

rtype

float

GetMin()¶

Returns minimal value of color scale, 0.0 by default.

rtype

float

GetNumberOfIntervals()¶

Returns the number of color scale intervals, 10 by default.

rtype

int

GetPosition()¶

Returns the bottom-left position of color scale, 0x0 by default.

param theX

type theX

float

param theY

type theY

float

rtype

None

GetRange()¶

Returns minimal and maximal values of color scale, 0.0 to 1.0 by default.

param theMin

type theMin

float

param theMax

type theMax

float

rtype

None

GetSize()¶

Returns the size of color bar, 0 and 0 by default (e.g. should be set by user explicitly before displaying).

param theBreadth

type theBreadth

int

param theHeight

type theHeight

int

rtype

None

GetTextHeight()¶

Returns the font height of text labels, 20 by default.

rtype

int

GetTitle()¶

Returns the color scale title string, empty string by default.

rtype

TCollection_ExtendedString

GetTitlePosition()¶

Returns the position of color scale title, Aspect_TOCSP_LEFT by default.

rtype

Aspect_TypeOfColorScalePosition

GetXPosition()¶

Returns the left position of color scale, 0 by default.

rtype

int

GetYPosition()¶

Returns the bottom position of color scale, 0 by default.

rtype

int

HueMax()¶

Returns the hue angle corresponding to maximum value, 0 by default (red).

rtype

float

HueMin()¶

Returns the hue angle corresponding to minimum value, 230 by default (blue).

rtype

float

HueRange()¶

Returns the hue angle range corresponding to minimum and maximum values, 230 to 0 by default (blue to red).

param theMinAngle

type theMinAngle

float

param theMaxAngle

type theMaxAngle

float

rtype

None

IsLabelAtBorder()¶

Returns True if the labels are placed at border of color intervals, True by default. The automatically generated label will show value exactly on the current position: - value connecting two neighbor intervals (True) - value in the middle of interval (False)

rtype

bool

IsLogarithmic()¶

Returns True if the color scale has logarithmic intervals, False by default.

rtype

bool

IsReversed()¶

Returns True if the labels and colors used in reversed order, False by default. - Normal, bottom-up order with Minimal value on the Bottom and Maximum value on Top. - Reversed, top-down order with Maximum value on the Bottom and Minimum value on Top.

rtype

bool

IsSmoothTransition()¶

Return True if color transition between neighbor intervals should be linearly interpolated, False by default.

rtype

bool

Labels()¶

Returns the user specified labels.

rtype

TColStd_SequenceOfExtendedString

SetBreadth()¶

Sets the width of color bar.

param theBreadth

type theBreadth

int

rtype

None

SetColorRange()¶

Sets color range corresponding to minimum and maximum values.

param theMinColor

type theMinColor

Quantity_Color

param theMaxColor

type theMaxColor

Quantity_Color

rtype

None

SetColorType()¶

Sets the type of colors. Aspect_TOCSD_AUTO - value between Red and Blue Aspect_TOCSD_USER - user specified color from color map

param theType

type theType

Aspect_TypeOfColorScaleData

rtype

None

SetColors()¶

Sets the color scale colors. The length of the sequence should be equal to GetNumberOfIntervals().

param theSeq

type theSeq

Aspect_SequenceOfColor

rtype

None

SetFormat()¶

Sets the color scale auto label format specification.

param theFormat

type theFormat

TCollection_AsciiString

rtype

None

SetHeight()¶

Sets the height of color bar.

param theHeight

type theHeight

int

rtype

None

SetHueRange()¶

Sets hue angle range corresponding to minimum and maximum values. The valid angle range is [0, 360], see Quantity_Color and Quantity_TOC_HLS for more details.

param theMinAngle

type theMinAngle

float

param theMaxAngle

type theMaxAngle

float

rtype

None

SetIntervalColor()¶

Sets the color of the specified interval. Note that list is automatically resized to include specified index. @param theColor color value to set @param theIndex index in range [1, GetNumberOfIntervals()]; appended to the end of list if -1 is specified

param theColor

type theColor

Quantity_Color

param theIndex

type theIndex

int

rtype

None

SetLabel()¶

Sets the color scale label at index. Note that list is automatically resized to include specified index. @param theLabel new label text @param theIndex index in range [1, GetNumberOfIntervals()] or [1, GetNumberOfIntervals() + 1] if IsLabelAtBorder() is true; label is appended to the end of list if negative index is specified

param theLabel

type theLabel

TCollection_ExtendedString

param theIndex

type theIndex

int

rtype

None

SetLabelAtBorder()¶

Sets true if the labels are placed at border of color intervals (True by default). If set to False, labels will be drawn at color intervals rather than at borders.

param theOn

type theOn

bool

rtype

None

SetLabelPosition()¶

Sets the color scale labels position relative to color bar.

param thePos

type thePos

Aspect_TypeOfColorScalePosition

rtype

None

SetLabelType()¶

Sets the type of labels. Aspect_TOCSD_AUTO - labels as boundary values for intervals Aspect_TOCSD_USER - user specified label is used

param theType

type theType

Aspect_TypeOfColorScaleData

rtype

None

SetLabels()¶

Sets the color scale labels. The length of the sequence should be equal to GetNumberOfIntervals() or to GetNumberOfIntervals() + 1 if IsLabelAtBorder() is true. If length of the sequence does not much the number of intervals, then these labels will be considered as ‘free’ and will be located at the virtual intervals corresponding to the number of labels (with flag IsLabelAtBorder() having the same effect as in normal case).

param theSeq

type theSeq

TColStd_SequenceOfExtendedString

rtype

None

SetLogarithmic()¶

Sets true if the color scale has logarithmic intervals.

param isLogarithmic

type isLogarithmic

bool

rtype

None

SetMax()¶

Sets the maximal value of color scale.

param theMax

type theMax

float

rtype

None

SetMin()¶

Sets the minimal value of color scale.

param theMin

type theMin

float

rtype

None

SetNumberOfIntervals()¶

Sets the number of color scale intervals.

param theNum

type theNum

int

rtype

None

SetPosition()¶

Sets the position of color scale.

param theX

type theX

int

param theY

type theY

int

rtype

None

SetRange()¶

Sets the minimal and maximal value of color scale. Note that values order will be ignored - the minimum and maximum values will be swapped if needed. ::SetReversed() should be called to swap displaying order.

param theMin

type theMin

float

param theMax

type theMax

float

rtype

None

SetReversed()¶

Sets true if the labels and colors used in reversed order.

param theReverse

type theReverse

bool

rtype

None

SetSize()¶

Sets the size of color bar.

param theBreadth

type theBreadth

int

param theHeight

type theHeight

int

rtype

None

SetSmoothTransition()¶

Setup smooth color transition.

param theIsSmooth

type theIsSmooth

bool

rtype

None

SetTextHeight()¶

Sets the height of text of color scale.

param theHeight

type theHeight

int

rtype

None

SetTitle()¶

Sets the color scale title string.

param theTitle

type theTitle

TCollection_ExtendedString

rtype

None

SetTitlePosition()¶

Sets the color scale title position.

param thePos

type thePos

Aspect_TypeOfColorScalePosition

rtype

None

SetXPosition()¶

Sets the left position of color scale.

param theX

type theX

int

rtype

None

SetYPosition()¶

Sets the bottom position of color scale.

param theY

type theY

int

rtype

None

TextHeight()¶

Returns the height of text. @param theText [in] the text of which to calculate height.

param theText

type theText

TCollection_ExtendedString

rtype

int

TextSize()¶

Parameters

theText –

type theText: TCollection_ExtendedString
param theHeight
type theHeight: int
param theWidth
type theWidth: int
param theAscent
type theAscent: int
param theDescent
type theDescent: int
rtype: None

TextWidth()¶

Returns the width of text. @param theText [in] the text of which to calculate width.

param theText

type theText

TCollection_ExtendedString

rtype

int

static hueToValidRange()¶

Shift hue into valid range. Lightness and Saturation should be specified in valid range [0.0, 1.0], however Hue might be given out of Quantity_Color range to specify desired range for interpolation.

param theHue

type theHue

float

rtype

float

property thisown¶: The membership flag

class AIS_ColoredDrawer(*args)¶

Bases: OCC.Core.Prs3d.Prs3d_Drawer

Default constructor.

param theLink

type theLink

Prs3d_Drawer

rtype

None

static DownCast(t)¶

HasOwnColor()¶

Return type: bool

HasOwnTransparency()¶

Return type: bool

HasOwnWidth()¶

Return type: bool

IsHidden()¶

Return type: bool

SetHidden()¶

Parameters

theToHide –

type theToHide: bool
rtype: None

SetOwnColor()¶

Parameters

& –

type &: Quantity_Color
rtype: None

SetOwnTransparency()¶

:param :: :type : float :rtype: None

SetOwnWidth()¶

Parameters

Standard_Real –

type Standard_Real
rtype: None

UnsetOwnColor()¶

Return type: None

UnsetOwnTransparency()¶

Return type: None

UnsetOwnWidth()¶

Return type: None

property myHasOwnColor¶: myHasOwnColor : bool

property myHasOwnTransp¶: myHasOwnTransp : bool

property myHasOwnWidth¶: myHasOwnWidth : bool

property myIsHidden¶: myIsHidden : bool

property thisown¶: The membership flag

class AIS_ColoredShape(*args)¶

Bases: OCC.Core.AIS.AIS_Shape

Default constructor

param theShape

type theShape

TopoDS_Shape

rtype

None* Copy constructor

param theShape

type theShape

AIS_Shape

rtype

None

ChangeCustomAspectsMap()¶

Return the map of custom aspects.

rtype

AIS_DataMapOfShapeDrawer

ClearCustomAspects()¶

Reset the map of custom sub-shape aspects.

rtype

void

CustomAspects()¶

@name sub-shape aspects Customize properties of specified sub-shape. The shape will be stored in the map but ignored, if it is not sub-shape of main Shape! This method can be used to mark sub-shapes with customizable properties.

param theShape

type theShape

TopoDS_Shape

rtype

opencascade::handle<AIS_ColoredDrawer>

CustomAspectsMap()¶

Return the map of custom aspects.

rtype

AIS_DataMapOfShapeDrawer

static DownCast(t)¶

SetCustomColor()¶

Customize color of specified sub-shape

param theShape

type theShape

TopoDS_Shape

param theColor

type theColor

Quantity_Color

rtype

None

SetCustomTransparency()¶

Customize transparency of specified sub-shape

param theShape

type theShape

TopoDS_Shape

param theTransparency

type theTransparency

float

rtype

None

SetCustomWidth()¶

Customize line width of specified sub-shape

param theShape

type theShape

TopoDS_Shape

param theLineWidth

type theLineWidth

float

rtype

None

UnsetCustomAspects()¶

Reset custom properties of specified sub-shape. @param theToUnregister unregister or not sub-shape from the map

param theShape

type theShape

TopoDS_Shape

param theToUnregister

default value is Standard_False

type theToUnregister

bool

rtype

None

property thisown¶: The membership flag

class AIS_ConcentricRelation(*args)¶

Constructs the display object for concentric relations between shapes. This object is defined by the two shapes, aFShape and aSShape and the plane aPlane. aPlane is provided to create an axis along which the relation of concentricity can be extended.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_ConnectedInteractive(*args)¶

Disconnects the previous view and sets highlight mode to 0. This highlights the wireframe presentation aTypeOfPresentation3d. Top_AllView deactivates hidden line removal.

param aTypeOfPresentation3d

default value is PrsMgr_TOP_AllView

type aTypeOfPresentation3d

PrsMgr_TypeOfPresentation3d

rtype

None

AcceptDisplayMode()¶

Return true if reference presentation accepts specified display mode.

param theMode

type theMode

int

rtype

bool

AcceptShapeDecomposition()¶

Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection.

rtype

bool

Connect()¶

Establishes the connection between the Connected Interactive Object, anotherIobj, and its reference.

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

rtype

None* Establishes the connection between the Connected Interactive Object, anotherIobj, and its reference. Locates instance in aLocation.

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

param theLocation

type theLocation

gp_Trsf

rtype

None* Establishes the connection between the Connected Interactive Object, anotherIobj, and its reference. Locates instance in aLocation.

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

param theLocation

type theLocation

Geom_Transformation

rtype

None

ConnectedTo()¶

Returns the connection with the reference Interactive Object.

rtype

opencascade::handle<AIS_InteractiveObject>

Disconnect()¶

Clears the connection with a source reference. The presentation will no longer be displayed. Warning Must be done before deleting the presentation.

rtype

None

static DownCast(t)¶

HasConnection()¶

Returns true if there is a connection established between the presentation and its source reference.

rtype

bool

Signature()¶

Returns 0

rtype

int

Type()¶

Returns KOI_Object

rtype

AIS_KindOfInteractive

property thisown¶: The membership flag

class AIS_DataMapOfIOStatus(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_DataMapOfShapeDrawer(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_DataMapofIntegerListOfinteractive(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

Keys()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_DiameterDimension(*args)¶

Construct diameter dimension for the circle. @param theCircle [in] the circle to measure.

param theCircle

type theCircle

gp_Circ

rtype

None* Construct diameter dimension for the circle and orient it correspondingly to the passed plane. @param theCircle [in] the circle to measure. @param thePlane [in] the plane defining preferred orientation for dimension.

param theCircle

type theCircle

gp_Circ

param thePlane

type thePlane

gp_Pln

rtype

None* Construct diameter on the passed shape, if applicable. @param theShape [in] the shape to measure.

param theShape

type theShape

TopoDS_Shape

rtype

None* Construct diameter on the passed shape, if applicable - and define the preferred plane to orient the dimension. @param theShape [in] the shape to measure. @param thePlane [in] the plane defining preferred orientation for dimension.

param theShape

type theShape

TopoDS_Shape

param thePlane

type thePlane

gp_Pln

rtype

None

AnchorPoint()¶

returns anchor point on circle for diameter dimension.

rtype

gp_Pnt

Circle()¶

returns measured geometry circle.

rtype

gp_Circ

static DownCast(t)¶

GetTextPosition()¶

Return type: gp_Pnt

SetDisplayUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetMeasuredGeometry()¶

Measure diameter of the circle. The actual dimension plane is used for determining anchor points on the circle to attach the dimension lines to. The dimension will become invalid if the diameter of the circle is less than Precision::Confusion(). @param theCircle [in] the circle to measure.

param theCircle

type theCircle

gp_Circ

rtype

None* Measure diameter on the passed shape, if applicable. The dimension will become invalid if the passed shape is not measurable or if measured diameter value is less than Precision::Confusion(). @param theShape [in] the shape to measure.

param theShape

type theShape

TopoDS_Shape

rtype

None

SetModelUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetTextPosition()¶

Parameters

theTextPos –

type theTextPos: gp_Pnt
rtype: void

Shape()¶

returns the measured shape.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class AIS_Dimension(*args, **kwargs)¶

Empty constructor

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

AcceptDisplayMode()¶

Returns true if the class of objects accepts the display mode theMode. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by object.

param theMode

type theMode

int

rtype

bool

ComputeMode_All = 0¶

ComputeMode_Line = 1¶

ComputeMode_Text = 2¶

DimensionAspect()¶

Gets the dimension aspect from AIS object drawer. Dimension aspect contains aspects of line, text and arrows for dimension presentation.

rtype

opencascade::handle<Prs3d_DimensionAspect>

DisplaySpecialSymbol()¶

returns dimension special symbol display options.

rtype

AIS_DisplaySpecialSymbol

static DownCast(t)¶

GetCustomValue()¶

Gets user-defined dimension value. returns dimension value string.

rtype

TCollection_ExtendedString

GetDisplayUnits()¶

Return type: TCollection_AsciiString

GetFlyout()¶

returns flyout value for dimension.

rtype

float

GetGeometryType()¶

Geometry type defines type of shapes on which the dimension is to be built. returns type of geometry on which the dimension will be built.

rtype

int

GetModelUnits()¶

Return type: TCollection_AsciiString

GetPlane()¶

Get the dimension plane in which the 2D dimension presentation is computed. By default, if plane is not defined by user, it is computed automatically after dimension geometry is computed. If computed dimension geometry (points) can’t be placed on the user-defined plane, dimension geometry was set as invalid (validity flag is set to false) and dimension presentation will not be computed. If user-defined plane allow geometry placement on it, it will be used for computing of the dimension presentation. returns dimension plane used for presentation computing.

rtype

gp_Pln

GetTextPosition()¶

Computes absolute text position from dimension parameters (flyout, plane and text alignment).

rtype

gp_Pnt

GetValue()¶

Gets dimension measurement value. If the value to display is not specified by user, then the dimension object is responsible to compute it on its own in model space coordinates. returns the dimension value (in model units) which is used during display of the presentation.

rtype

float

IsTextPositionCustom()¶

returns True if text position is set by user with method SetTextPosition().

rtype

bool

IsValid()¶

Check that the input geometry for dimension is valid and the presentation can be successfully computed. returns True if dimension geometry is ok.

rtype

bool

KindOfDimension()¶

returns the kind of dimension.

rtype

AIS_KindOfDimension

SelToleranceForText2d()¶

Returns selection tolerance for text2d: For 2d text selection detection sensitive point with tolerance is used Important! Only for 2d text.

rtype

float

SetComputedValue()¶

Sets computed dimension value. Resets custom value mode if it was set.

rtype

None

SetCustomPlane()¶

Sets user-defined plane where the 2D dimension presentation will be placed. Checks validity of this plane if geometry has been set already. Validity of the plane is checked according to the geometry set and has different criteria for different kinds of dimensions.

param thePlane

type thePlane

gp_Pln

rtype

void

SetCustomValue()¶

Sets user-defined dimension value. The user-defined dimension value is specified in model space, and affect by unit conversion during the display. @param theValue [in] the user-defined value to display.

param theValue

type theValue

float

rtype

None* Sets user-defined dimension value. Unit conversion during the display is not applyed. @param theValue [in] the user-defined value to display.

param theValue

type theValue

TCollection_ExtendedString

rtype

None

SetDimensionAspect()¶

Sets new dimension aspect for the interactive object drawer. The dimension aspect provides dynamic properties which are generally used during computation of dimension presentations.

param theDimensionAspect

type theDimensionAspect

Prs3d_DimensionAspect

rtype

None

SetDisplaySpecialSymbol()¶

Specifies whether to display special symbol or not.

param theDisplaySpecSymbol

type theDisplaySpecSymbol

AIS_DisplaySpecialSymbol

rtype

None

SetDisplayUnits()¶

Parameters

& –

type &: TCollection_AsciiString
rtype: None

SetFlyout()¶

Sets flyout value for dimension.

param theFlyout

type theFlyout

float

rtype

None

SetModelUnits()¶

Parameters

& –

type &: TCollection_AsciiString
rtype: None

SetSelToleranceForText2d()¶

Sets selection tolerance for text2d: For 2d text selection detection sensitive point with tolerance is used to change this tolerance use this method Important! Only for 2d text.

param theTol

type theTol

float

rtype

None

SetSpecialSymbol()¶

Specifies special symbol.

param theSpecialSymbol

type theSpecialSymbol

Standard_ExtCharacter

rtype

None

SetTextPosition()¶

Fixes the absolute text position and adjusts flyout, plane and text alignment according to it. Updates presentation if the text position is valid. ATTENTION! It does not change vertical text alignment. @param theTextPos [in] the point of text position.

param &

type &

gp_Pnt

rtype

None

SpecialSymbol()¶

returns special symbol.

rtype

Standard_ExtCharacter

Type()¶

returns the kind of interactive.

rtype

AIS_KindOfInteractive

UnsetCustomPlane()¶

Unsets user-defined plane. Therefore the plane for dimension will be computed automatically.

rtype

None

UnsetFixedTextPosition()¶

Unsets user defined text positioning and enables text positioning by other parameters: text alignment, extension size, flyout and custom plane.

rtype

None

property thisown¶: The membership flag

class AIS_DimensionOwner(*args)¶

Initializes the dimension owner, theSO, and attributes it the priority, thePriority.

param theSelObject

type theSelObject

SelectMgr_SelectableObject

param theSelMode

type theSelMode

AIS_DimensionSelectionMode

param thePriority

default value is 0

type thePriority

int

rtype

None

static DownCast(t)¶

IsHilighted()¶

Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM.

param thePM

type thePM

PrsMgr_PresentationManager

param theMode

default value is 0

type theMode

int

rtype

bool

SelectionMode()¶

Return type: AIS_DimensionSelectionMode

Unhilight()¶

Removes highlighting from the selected part of dimension.

param thePM

type thePM

PrsMgr_PresentationManager

param theMode

default value is 0

type theMode

int

rtype

void

property thisown¶: The membership flag

class AIS_EllipseRadiusDimension(*args, **kwargs)¶

Empty constructor

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

ComputeGeometry()¶

Return type: None

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_EqualDistanceRelation(*args)¶

Constructs a framework to display equivalent distances between the shapes aShape1, aShape2, aShape3, aShape4 and the plane aPlane. The distance is the length of a projection from the shape to the plane.

param aShape1

type aShape1

TopoDS_Shape

param aShape2

type aShape2

TopoDS_Shape

param aShape3

type aShape3

TopoDS_Shape

param aShape4

type aShape4

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None

Compute()¶

Computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static ComputeOneEdgeOneVertexLength()¶

Compute the interval location between a vertex and an edge. Edge may be a line or a circle.

param aPresentation

type aPresentation

Prs3d_Presentation

param aDrawer

type aDrawer

Prs3d_Drawer

param ArrowSize

type ArrowSize

float

param FirstShape

type FirstShape

TopoDS_Shape

param SecondShape

type SecondShape

TopoDS_Shape

param Plane

type Plane

Geom_Plane

param AutomaticPos

type AutomaticPos

bool

param IsSetBndBox

type IsSetBndBox

bool

param BndBox

type BndBox

Bnd_Box

param Position

type Position

gp_Pnt

param FirstAttach

type FirstAttach

gp_Pnt

param SecondAttach

type SecondAttach

gp_Pnt

param FirstExtreme

type FirstExtreme

gp_Pnt

param SecondExtreme

type SecondExtreme

gp_Pnt

param SymbolPrs

type SymbolPrs

DsgPrs_ArrowSide

rtype

void

static ComputeTwoEdgesLength()¶

Computes the location of an intreval between between two edges. FirstAttach , SecondAttach are the returned extreme points of the interval.

param aPresentation

type aPresentation

Prs3d_Presentation

param aDrawer

type aDrawer

Prs3d_Drawer

param ArrowSize

type ArrowSize

float

param FirstEdge

type FirstEdge

TopoDS_Edge

param SecondEdge

type SecondEdge

TopoDS_Edge

param Plane

type Plane

Geom_Plane

param AutomaticPos

type AutomaticPos

bool

param IsSetBndBox

type IsSetBndBox

bool

param BndBox

type BndBox

Bnd_Box

param Position

type Position

gp_Pnt

param FirstAttach

type FirstAttach

gp_Pnt

param SecondAttach

type SecondAttach

gp_Pnt

param FirstExtreme

type FirstExtreme

gp_Pnt

param SecondExtreme

type SecondExtreme

gp_Pnt

param SymbolPrs

type SymbolPrs

DsgPrs_ArrowSide

rtype

void

static ComputeTwoVerticesLength()¶

Computes the interval position between two vertexs. FirstAttach, SecondAttach are the returned extreme points of the interval.

param aPresentation

type aPresentation

Prs3d_Presentation

param aDrawer

type aDrawer

Prs3d_Drawer

param ArrowSize

type ArrowSize

float

param FirstVertex

type FirstVertex

TopoDS_Vertex

param SecondVertex

type SecondVertex

TopoDS_Vertex

param Plane

type Plane

Geom_Plane

param AutomaticPos

type AutomaticPos

bool

param IsSetBndBox

type IsSetBndBox

bool

param BndBox

type BndBox

Bnd_Box

param TypeDist

type TypeDist

AIS_TypeOfDist

param Position

type Position

gp_Pnt

param FirstAttach

type FirstAttach

gp_Pnt

param SecondAttach

type SecondAttach

gp_Pnt

param FirstExtreme

type FirstExtreme

gp_Pnt

param SecondExtreme

type SecondExtreme

gp_Pnt

param SymbolPrs

type SymbolPrs

DsgPrs_ArrowSide

rtype

void

static DownCast(t)¶

SetShape3()¶

Sets the shape aShape to be used as the shape aShape3 in the framework created at construction time.

param aShape

type aShape

TopoDS_Shape

rtype

None

SetShape4()¶

Sets the shape aShape to be used as the shape aShape4 in the framework created at construction time.

param aShape

type aShape

TopoDS_Shape

rtype

None

Shape3()¶

Returns the shape aShape3 from the framework created at construction time.

rtype

TopoDS_Shape

Shape4()¶

Returns the shape aShape4 from the framework created at construction time.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class AIS_EqualRadiusRelation(*args)¶

Creates equal relation of two arc’s radiuses. If one of edges is not in the given plane, the presentation method projects it onto the plane.

param aFirstEdge

type aFirstEdge

TopoDS_Edge

param aSecondEdge

type aSecondEdge

TopoDS_Edge

param aPlane

type aPlane

Geom_Plane

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_ExclusionFilter(*args)¶

Constructs an empty exclusion filter object defined by the flag setting ExclusionFlagOn. By default, the flag is set to true.

param ExclusionFlagOn

default value is Standard_True

type ExclusionFlagOn

bool

rtype

None* All the AIS objects of <TypeToExclude> Will be rejected by the IsOk Method.

param TypeToExclude

type TypeToExclude

AIS_KindOfInteractive

param ExclusionFlagOn

default value is Standard_True

type ExclusionFlagOn

bool

rtype

None* Constructs an exclusion filter object defined by the enumeration value TypeToExclude, the signature SignatureInType, and the flag setting ExclusionFlagOn. By default, the flag is set to true.

param TypeToExclude

type TypeToExclude

AIS_KindOfInteractive

param SignatureInType

type SignatureInType

int

param ExclusionFlagOn

default value is Standard_True

type ExclusionFlagOn

bool

rtype

None

Add()¶

Adds the type TypeToExclude to the list of types.

param TypeToExclude

type TypeToExclude

AIS_KindOfInteractive

rtype

bool:param TypeToExclude:

type TypeToExclude

AIS_KindOfInteractive

param SignatureInType

type SignatureInType

int

rtype

bool

Clear()¶

Return type: None

static DownCast(t)¶

IsExclusionFlagOn()¶

Return type: bool

IsStored()¶

Parameters

aType –

type aType: AIS_KindOfInteractive
rtype: bool

ListOfSignature()¶

Parameters

aType –

type aType: AIS_KindOfInteractive
param TheStoredList
type TheStoredList: TColStd_ListOfInteger
rtype: None

ListOfStoredTypes()¶

Parameters

TheList –

type TheList: TColStd_ListOfInteger
rtype: None

Remove()¶

Parameters

TypeToExclude –

type TypeToExclude: AIS_KindOfInteractive
rtype: bool:param TypeToExclude:
type TypeToExclude: AIS_KindOfInteractive
param SignatureInType
type SignatureInType: int
rtype: bool

SetExclusionFlag()¶

Parameters

Status –

type Status: bool
rtype: None

property thisown¶: The membership flag

class AIS_FixRelation(*args)¶

initializes the vertex aShape, the plane aPlane and the wire aWire, which connects the two vertices in a fixed relation.

param aShape

type aShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aWire

type aWire

TopoDS_Wire

rtype

None* initializes the vertex aShape, the plane aPlane and the wire aWire, the position aPosition, the arrow size anArrowSize and the wire aWire, which connects the two vertices in a fixed relation.

param aShape

type aShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aWire

type aWire

TopoDS_Wire

param aPosition

type aPosition

gp_Pnt

param anArrowSize

default value is 0.01

type anArrowSize

float

rtype

None* initializes the edge aShape and the plane aPlane.

param aShape

type aShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None* initializes the edge aShape, the plane aPlane, the position aPosition and the arrow size anArrowSize.

param aShape

type aShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aPosition

type aPosition

gp_Pnt

param anArrowSize

default value is 0.01

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

SetWire()¶

Constructs the wire aWire. This connects vertices which are in a fixed relation.

param aWire

type aWire

TopoDS_Wire

rtype

None

Wire()¶

Returns the wire which connects vertices in a fixed relation.

rtype

TopoDS_Wire

property thisown¶: The membership flag

class AIS_GlobalStatus(*args)¶

Return type: None:param aStat: :type aStat: AIS_DisplayStatus :param aDispMode: :type aDispMode: int :param aSelMode: :type aSelMode: int :param ishilighted: default value is Standard_False :type ishilighted: bool :param aLayerIndex: default value is 0 :type aLayerIndex: int :rtype: None

AddSelectionMode()¶

Parameters

theMode –

type theMode: int
rtype: None

ClearSelectionModes()¶

Return type: None

DisplayMode()¶

Returns the display mode.

rtype

int

static DownCast(t)¶

GetLayerIndex()¶

Returns layer index.

rtype

int

GraphicStatus()¶

Return type: AIS_DisplayStatus

HilightStyle()¶

Returns applied highlight style for a particular object

rtype

opencascade::handle<Prs3d_Drawer>

IsHilighted()¶

Return type: bool

IsSModeIn()¶

Parameters

aMode –

type aMode: int
rtype: bool

IsSubIntensityOn()¶

Return type: bool

RemoveSelectionMode()¶

Parameters

aMode –

type aMode: int
rtype: None

SelectionModes()¶

keeps the active selection modes of the object in the main viewer.

rtype

TColStd_ListOfInteger

SetDisplayMode()¶

Sets display mode.

param theMode

type theMode

int

rtype

None

SetGraphicStatus()¶

Parameters

theStatus –

type theStatus: AIS_DisplayStatus
rtype: None

SetHilightStatus()¶

Parameters

theStatus –

type theStatus: bool
rtype: None

SetHilightStyle()¶

Changes applied highlight style for a particular object

param theStyle

type theStyle

Prs3d_Drawer

rtype

None

SetLayerIndex()¶

Parameters

theIndex –

type theIndex: int
rtype: None

SubIntensityOff()¶

Return type: None

SubIntensityOn()¶

Return type: None

property thisown¶: The membership flag

class AIS_GraphicTool¶

Bases: object

static GetInteriorColor()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
rtype: Quantity_NameOfColor:param aDrawer:
type aDrawer: Prs3d_Drawer
param aColor
type aColor: Quantity_Color
rtype: void

static GetLineAtt()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
param TheTypeOfAttributes
type TheTypeOfAttributes: AIS_TypeOfAttribute
param aCol
type aCol: Quantity_NameOfColor
param aWidth
type aWidth: float
param aTyp
type aTyp: Aspect_TypeOfLine
rtype: void

static GetLineColor()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
param TheTypeOfAttributes
type TheTypeOfAttributes: AIS_TypeOfAttribute
rtype: Quantity_NameOfColor:param aDrawer:
type aDrawer: Prs3d_Drawer
param TheTypeOfAttributes
type TheTypeOfAttributes: AIS_TypeOfAttribute
param TheLineColor
type TheLineColor: Quantity_Color
rtype: void

static GetLineType()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
param TheTypeOfAttributes
type TheTypeOfAttributes: AIS_TypeOfAttribute
rtype: Aspect_TypeOfLine

static GetLineWidth()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
param TheTypeOfAttributes
type TheTypeOfAttributes: AIS_TypeOfAttribute
rtype: float

static GetMaterial()¶

Parameters

aDrawer –

type aDrawer: Prs3d_Drawer
rtype: Graphic3d_MaterialAspect

property thisown¶: The membership flag

class AIS_IdenticRelation(*args)¶

Initializes the relation of identity between the two entities, FirstShape and SecondShape. The plane aPlane is initialized in case a visual reference is needed to show identity.

param FirstShape

type FirstShape

TopoDS_Shape

param SecondShape

type SecondShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None

AddUser()¶

Parameters

theUser –

type theUser: Standard_Transient
rtype: None

ClearUsers()¶

Return type: None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

HasUsers()¶

Return type: bool

Users()¶

Return type: TColStd_ListOfTransient

property thisown¶: The membership flag

class AIS_IndexedDataMapOfOwnerPrs(*args)¶

Bases: object

Add()¶

Assign()¶

ChangeFromIndex()¶

ChangeFromKey()¶

ChangeSeek()¶

Clear()¶

Contains()¶

Exchange()¶

FindFromIndex()¶

FindFromKey()¶

FindIndex()¶

FindKey()¶

ReSize()¶

RemoveFromIndex()¶

RemoveKey()¶

RemoveLast()¶

Seek()¶

Set()¶

Size()¶

Substitute()¶

Swap()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_InteractiveContext(*args)¶

@name object display management Constructs the interactive context object defined by the principal viewer MainViewer.

param MainViewer

type MainViewer

V3d_Viewer

rtype

None

Activate()¶

Activates the selection mode aMode whose index is given, for the given interactive entity anIobj.

param theObj

type theObj

AIS_InteractiveObject

param theMode

default value is 0

type theMode

int

param theIsForce

default value is Standard_False

type theIsForce

bool

rtype

None* Activates the given selection mode for the all displayed objects.

param theMode

type theMode

int

param theIsForce

default value is Standard_False

type theIsForce

bool

rtype

None

ActivatedModes()¶

Returns the list of activated selection modes.

param anIobj

type anIobj

AIS_InteractiveObject

param theList

type theList

TColStd_ListOfInteger

rtype

None

AddFilter()¶

Allows you to add the filter.

param theFilter

type theFilter

SelectMgr_Filter

rtype

None

AddOrRemoveCurrentObject()¶

Allows to add or remove the object given to the list of current and highlight/unhighlight it correspondingly. Is valid for global context only; for local context use method AddOrRemoveSelected. Since this method makes sence only for neutral point selection of a whole object, if 0 selection of the object is empty this method simply does nothing.

param theObj

type theObj

AIS_InteractiveObject

param theIsToUpdateViewer

type theIsToUpdateViewer

bool

rtype

None

AddOrRemoveSelected()¶

Allows to highlight or unhighlight the owner given depending on its selection status

param theObject

type theObject

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Allows to highlight or unhighlight the owner given depending on its selection status

param theOwner

type theOwner

SelectMgr_EntityOwner

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

AddSelect()¶

Adds object in the selection.

param theObject

type theObject

SelectMgr_EntityOwner

rtype

AIS_StatusOfPick* Adds object in the selection.

param theObject

type theObject

AIS_InteractiveObject

rtype

AIS_StatusOfPick

Applicative()¶

Returns SelectedInteractive()->GetOwner(). @sa SelectedOwner().

rtype

opencascade::handle<Standard_Transient>

AutomaticHilight()¶

Returns true if the automatic highlight mode is active; True by default. @sa MoveTo(), Select(), HilightWithColor(), Unhilight()

rtype

bool

BeginImmediateDraw()¶

@name immediate mode rendering initializes the list of presentations to be displayed returns False if no local context is opened.

rtype

bool

BoundingBoxOfSelection()¶

Returns bounding box of selected objects.

rtype

Bnd_Box

ClearActiveSensitive()¶

Clear visualization of sensitives.

param aView

type aView

V3d_View

rtype

None

ClearCurrents()¶

Empties previous current objects in order to get the current objects detected by the selector using UpdateCurrent. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

ClearDetected()¶

Clears the list of entities detected by MoveTo() and resets dynamic highlighting. @param theToRedrawImmediate if True, the main Viewer will be redrawn on update returns True if viewer needs to be updated (e.g. there were actually dynamically highlighted entities)

param theToRedrawImmediate

default value is Standard_False

type theToRedrawImmediate

bool

rtype

bool

ClearPrs()¶

Empties the graphic presentation of the mode indexed by aMode. Warning! Removes theIObj. theIObj is still active if it was previously activated.

param theIObj

type theIObj

AIS_InteractiveObject

param theMode

type theMode

int

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

ClearSelected()¶

Empties previous selected objects in order to get the selected objects detected by the selector using UpdateSelected.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

Color()¶

Returns the color of the Object in the interactive context.

param aniobj

type aniobj

AIS_InteractiveObject

param acolor

type acolor

Quantity_Color

rtype

None

Current()¶

Returns the current interactive object. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

rtype

opencascade::handle<AIS_InteractiveObject>

CurrentViewer()¶

Returns the current viewer.

rtype

opencascade::handle<V3d_Viewer>

Deactivate()¶

Deactivates all the activated selection modes of an object.

param theObj

type theObj

AIS_InteractiveObject

rtype

None* Deactivates all the activated selection modes of the interactive object anIobj with a given selection mode aMode.

param theObj

type theObj

AIS_InteractiveObject

param theMode

type theMode

int

rtype

None* Deactivates the given selection mode for all displayed objects.

param theMode

type theMode

int

rtype

None* Deactivates all the activated selection mode at all displayed objects.

rtype

None

DefaultDrawer()¶

@name common properties Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.

rtype

opencascade::handle<Prs3d_Drawer>

DetectedCurrentObject()¶

returns current mouse-detected interactive object or null object, if there is no currently detected interactives @sa DetectedCurrentOwner()/InitDetected()/MoreDetected()/NextDetected().

rtype

opencascade::handle<AIS_InteractiveObject>

DetectedCurrentOwner()¶

Returns the owner from detected list pointed by current iterator position. WARNING! This method is irrelevant to DetectedOwner() which returns last picked Owner regardless of iterator position! @sa InitDetected()/MoreDetected()/NextDetected().

rtype

opencascade::handle<SelectMgr_EntityOwner>

DetectedCurrentShape()¶

returns current mouse-detected shape or empty (null) shape, if current interactive object is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all. @sa DetectedCurrentOwner()/InitDetected()/MoreDetected()/NextDetected().

rtype

TopoDS_Shape

DetectedInteractive()¶

Returns the interactive objects last detected in context. In general this is just a wrapper for opencascade::handle<AIS_InteractiveObject>::DownCast(DetectedOwner()->Selectable()). @sa DetectedOwner()

rtype

opencascade::handle<AIS_InteractiveObject>

DetectedOwner()¶

Returns the owner of the detected sensitive primitive which is currently dynamically highlighted. WARNING! This method is irrelevant to InitDetected()/MoreDetected()/NextDetected(). @sa HasDetected()/HasNextDetected()/HilightPreviousDetected()/HilightNextDetected().

rtype

opencascade::handle<SelectMgr_EntityOwner>

DetectedShape()¶

Returns the shape detected in local context. @sa DetectedOwner()

rtype

TopoDS_Shape

DeviationAngle()¶

Return type: float

DeviationCoefficient()¶

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

rtype

float

DisableDrawHiddenLine()¶

Return type: None

Disconnect()¶

Disconnects theObjToDisconnect from theAssembly and removes dependent selection structures

param theAssembly

type theAssembly

AIS_InteractiveObject

param theObjToDisconnect

default value is NULL

type theObjToDisconnect

AIS_InteractiveObject

rtype

None

Display()¶

Displays the object in this Context using default Display Mode. This will be the object’s default display mode, if there is one. Otherwise, it will be the context mode. The Interactive Object’s default selection mode is activated if GetAutoActivateSelection() is True. In general, this is 0.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Sets status, display mode and selection mode for specified Object If theSelectionMode equals -1, theIObj will not be activated: it will be displayed but will not be selectable.

param theIObj

type theIObj

AIS_InteractiveObject

param theDispMode

type theDispMode

int

param theSelectionMode

type theSelectionMode

int

param theToUpdateViewer

type theToUpdateViewer

bool

param theDispStatus

default value is AIS_DS_None

type theDispStatus

AIS_DisplayStatus

rtype

None:param theIObj:

type theIObj

AIS_InteractiveObject

param theDispMode

type theDispMode

int

param theSelectionMode

type theSelectionMode

int

param theToUpdateViewer

type theToUpdateViewer

bool

param theToAllowDecomposition

type theToAllowDecomposition

bool

param theDispStatus

default value is AIS_DS_None

type theDispStatus

AIS_DisplayStatus

rtype

None

DisplayActiveSensitive()¶

@name debug visualization Visualization of sensitives - for debugging purposes!

param aView

type aView

V3d_View

rtype

None* Visualization of sensitives - for debugging purposes!

param anObject

type anObject

AIS_InteractiveObject

param aView

type aView

V3d_View

rtype

None

DisplayAll()¶

Displays all hidden objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

DisplayMode()¶

@name Display Mode management Returns the Display Mode setting to be used by default.

rtype

int

DisplayPriority()¶

@name object presence management (View affinity, Layer, Priority) Returns the display priority of the Object.

param theIObj

type theIObj

AIS_InteractiveObject

rtype

int

DisplaySelected()¶

Displays current objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

DisplayStatus()¶

Returns the display status of the entity anIobj. This will be one of the following: - AIS_DS_Displayed displayed in main viewer - AIS_DS_Erased hidden in main viewer - AIS_DS_Temporary temporarily displayed - AIS_DS_None nowhere displayed.

param anIobj

type anIobj

AIS_InteractiveObject

rtype

AIS_DisplayStatus

DisplayedObjects()¶

Returns the list of displayed objects of a particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals -1. This means that there is a check on type only.

param aListOfIO

type aListOfIO

AIS_ListOfInteractive

rtype

None* gives the list of displayed objects of a particular Type and signature. by Default, <WhichSignature> = -1 means control only on <WhichKind>.

param theWhichKind

type theWhichKind

AIS_KindOfInteractive

param theWhichSignature

type theWhichSignature

int

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

rtype

None

static DownCast(t)¶

DrawHiddenLine()¶

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

rtype

bool

EnableDrawHiddenLine()¶

Return type: None

EndImmediateDraw()¶

returns True if the immediate display has been done.

param theView

type theView

V3d_View

rtype

bool* Uses the First Active View of Main Viewer! returns True if the immediate display has been done.

rtype

bool

Erase()¶

Hides the object. The object’s presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display().

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

EraseAll()¶

Hides all objects. The object’s presentations are simply flagged as invisible and therefore excluded from redrawing. To show all hidden objects, use DisplayAll().

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

EraseSelected()¶

Hides selected objects. The object’s presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display().

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

ErasedObjects()¶

Returns the list theListOfIO of erased objects (hidden objects) particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only.

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

rtype

None* gives the list of erased objects (hidden objects) Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.

param theWhichKind

type theWhichKind

AIS_KindOfInteractive

param theWhichSignature

type theWhichSignature

int

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

rtype

None

Filters()¶

@name Selection Filters management Returns the list of filters active in a local context.

rtype

SelectMgr_ListOfFilter

FirstSelectedObject()¶

Returns the first selected object in the list of current selected.

rtype

opencascade::handle<AIS_InteractiveObject>

FitSelected()¶

Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.

param theView

type theView

V3d_View

param theMargin

type theMargin

float

param theToUpdate

type theToUpdate

bool

rtype

None* Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.

param theView

type theView

V3d_View

rtype

None

GetAutoActivateSelection()¶

Manages displaying the new object should also automatically activate default selection mode; True by default.

rtype

bool

GetZLayer()¶

Get Z layer id set for displayed interactive object.

param theIObj

type theIObj

AIS_InteractiveObject

rtype

Graphic3d_ZLayerId

GravityPoint()¶

Return rotation gravity point.

param theView

type theView

V3d_View

rtype

gp_Pnt

HLRAngle()¶

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

rtype

float

HLRDeviationCoefficient()¶

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

rtype

float

HasApplicative()¶

Returns SelectedInteractive()->HasOwner(). @sa SelectedOwner().

rtype

bool

HasColor()¶

Returns true if a view of the Interactive Object has color.

param aniobj

type aniobj

AIS_InteractiveObject

rtype

bool

HasDetected()¶

Returns true if there is a mouse-detected entity in context. @sa DetectedOwner()/HasNextDetected()/HilightPreviousDetected()/HilightNextDetected().

rtype

bool

HasDetectedShape()¶

Returns true if there is a detected shape in local context. @sa HasDetected()/DetectedShape()

rtype

bool

HasLocation()¶

Returns true if the Object has a location.

param theObject

type theObject

AIS_InteractiveObject

rtype

bool

HasNextDetected()¶

returns True if other entities were detected in the last mouse detection @sa HilightPreviousDetected()/HilightNextDetected().

rtype

bool

HasPolygonOffsets()¶

Simply calls AIS_InteractiveObject::HasPolygonOffsets().

param anObj

type anObj

AIS_InteractiveObject

rtype

bool

HasSelectedShape()¶

Returns True if the interactive context has a shape selected. @sa SelectedShape().

rtype

bool

HiddenLineAspect()¶

@name HLR (Hidden Line Removal) display attributes Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1.

rtype

opencascade::handle<Prs3d_LineAspect>

HighlightStyle()¶

@name highlighting management Returns highlight style settings.

param theStyleType

type theStyleType

Prs3d_TypeOfHighlight

rtype

opencascade::handle<Prs3d_Drawer>* Returns current dynamic highlight style settings. By default: - the color of dynamic highlight is Quantity_NOC_CYAN1; - the presentation for dynamic highlight is completely opaque; - the type of highlight is Aspect_TOHM_COLOR.

rtype

opencascade::handle<Prs3d_Drawer>* Returns highlight style of the object if it is marked as highlighted via global status @param theObj [in] the object to check

param theObj

type theObj

AIS_InteractiveObject

param theStyle

type theStyle

Prs3d_Drawer

rtype

bool* Returns highlight style of the owner if it is selected @param theOwner [in] the owner to check

param theOwner

type theOwner

SelectMgr_EntityOwner

param theStyle

type theStyle

Prs3d_Drawer

rtype

bool

Hilight()¶

Updates the display in the viewer to take dynamic detection into account. On dynamic detection by the mouse cursor, sensitive primitives are highlighted. The highlight color of entities detected by mouse movement is white by default.

param theObj

type theObj

AIS_InteractiveObject

param theIsToUpdateViewer

type theIsToUpdateViewer

bool

rtype

None

HilightCurrents()¶

Highlights current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

HilightNextDetected()¶

If more than 1 object is detected by the selector, only the ‘best’ owner is hilighted at the mouse position. This Method allows the user to hilight one after another the other detected entities. If The method select is called, the selected entity will be the hilighted one! WARNING: Loop Method. When all the detected entities have been hilighted, the next call will hilight the first one again. returns the Rank of hilighted entity @sa HasNextDetected()/HilightPreviousDetected().

param theView

type theView

V3d_View

param theToRedrawImmediate

default value is Standard_True

type theToRedrawImmediate

bool

rtype

int

HilightPreviousDetected()¶

Same as previous methods in reverse direction. @sa HasNextDetected()/HilightNextDetected().

param theView

type theView

V3d_View

param theToRedrawImmediate

default value is Standard_True

type theToRedrawImmediate

bool

rtype

int

HilightSelected()¶

Highlights selected objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

HilightWithColor()¶

Changes the color of all the lines of the object in view.

param theObj

type theObj

AIS_InteractiveObject

param theStyle

type theStyle

Prs3d_Drawer

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

ImmediateAdd()¶

returns True if <anIObj> has been stored in the list.

param theObj

type theObj

AIS_InteractiveObject

param theMode

default value is 0

type theMode

int

rtype

bool

InitCurrent()¶

Initializes a scan of the current selected objects in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

rtype

None

InitDetected()¶

@name iteration through detected entities Initialization for iteration through mouse-detected objects in interactive context or in local context if it is opened. @sa DetectedCurrentOwner()/MoreDetected()/NextDetected().

rtype

None

InitSelected()¶

Initializes a scan of the selected objects. @sa SelectedOwner()/MoreSelected()/NextSelected().

rtype

None

IsCurrent()¶

Returns true if there is a non-null interactive object in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

param theObject

type theObject

AIS_InteractiveObject

rtype

bool

IsDisplayed()¶

Returns true if Object is displayed in the interactive context.

param anIobj

type anIobj

AIS_InteractiveObject

rtype

bool:param aniobj:

type aniobj

AIS_InteractiveObject

param aMode

type aMode

int

rtype

bool

IsHilighted()¶

Returns true if the object is marked as highlighted via its global status @param theObj [in] the object to check

param theObj

type theObj

AIS_InteractiveObject

rtype

bool* Returns true if the owner is marked as selected @param theOwner [in] the owner to check

param theOwner

type theOwner

SelectMgr_EntityOwner

rtype

bool

IsImmediateModeOn()¶

Return type: bool

IsSelected()¶

Returns true is the owner given is selected

param theOwner

type theOwner

SelectMgr_EntityOwner

rtype

bool* Returns true is the object given is selected

param theObj

type theObj

AIS_InteractiveObject

rtype

bool

IsoNumber()¶

Returns the number of U and V isoparameters displayed.

param WhichIsos

default value is AIS_TOI_Both

type WhichIsos

AIS_TypeOfIso

rtype

int

IsoOnPlane()¶

Returns True if drawing isoparameters on planes is enabled.

param SwitchOn

type SwitchOn

bool

rtype

None* Returns True if drawing isoparameters on planes is enabled. if <forUIsos> = False,

rtype

bool

IsoOnTriangulation()¶

Enables or disables on-triangulation build for isolines for a particular object. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.

param theIsEnabled

type theIsEnabled

bool

param theObject

type theObject

AIS_InteractiveObject

rtype

None* Enables or disables on-triangulation build for isolines for default drawer. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.

param theToSwitchOn

type theToSwitchOn

bool

rtype

None* Returns true if drawing isolines on triangulation algorithm is enabled.

rtype

bool

LastActiveView()¶

Returns last active View (argument of MoveTo()/Select() methods).

rtype

opencascade::handle<V3d_View>

Load()¶

Allows you to load the Interactive Object with a given selection mode, and/or with the desired decomposition option, whether the object is visualized or not. The loaded objects will be selectable but displayable in highlighting only when detected by the Selector.

param theObj

type theObj

AIS_InteractiveObject

param theSelectionMode

default value is -1

type theSelectionMode

int

rtype

None:param theObj:

type theObj

AIS_InteractiveObject

param theSelectionMode

type theSelectionMode

int

:param : :type : bool :rtype: None

Location()¶

Returns the location of the Object.

param theObject

type theObject

AIS_InteractiveObject

rtype

TopLoc_Location

MainPrsMgr()¶

Return type: opencascade::handle<PrsMgr_PresentationManager3d>

MainSelector()¶

Return type: opencascade::handle<StdSelect_ViewerSelector3d>

MoreCurrent()¶

Returns true if there is another object found by the scan of the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

rtype

bool

MoreDetected()¶

Return True if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects. @sa DetectedCurrentOwner()/InitDetected()/NextDetected().

rtype

bool

MoreSelected()¶

Returns true if there is another object found by the scan of the list of selected objects. @sa SelectedOwner()/InitSelected()/NextSelected().

rtype

bool

MoveTo()¶

Relays mouse position in pixels theXPix and theYPix to the interactive context selectors. This is done by the view theView passing this position to the main viewer and updating it. If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object. @sa PickingStrategy()

param theXPix

type theXPix

int

param theYPix

type theYPix

int

param theView

type theView

V3d_View

param theToRedrawOnUpdate

type theToRedrawOnUpdate

bool

rtype

AIS_StatusOfDetection

NbCurrents()¶

Return type: int

NbSelected()¶

Count a number of selected entities using InitSelected()+MoreSelected()+NextSelected() iterator. @sa SelectedOwner()/InitSelected()/MoreSelected()/NextSelected().

rtype

int

NextCurrent()¶

Continues the scan to the next object in the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

rtype

None

NextDetected()¶

Gets next current object during iteration through mouse-detected interactive objects. @sa DetectedCurrentOwner()/InitDetected()/MoreDetected().

rtype

None

NextSelected()¶

Continues the scan to the next object in the list of selected objects. @sa SelectedOwner()/InitSelected()/MoreSelected().

rtype

None

ObjectsByDisplayStatus()¶

Returns the list theListOfIO of objects with indicated display status particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only.

param theStatus

type theStatus

AIS_DisplayStatus

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

rtype

None* gives the list of objects with indicated display status Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.

param WhichKind

type WhichKind

AIS_KindOfInteractive

param WhichSignature

type WhichSignature

int

param theStatus

type theStatus

AIS_DisplayStatus

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

rtype

None

ObjectsForView()¶

Query objects visible or hidden in specified view due to affinity mask.

param theListOfIO

type theListOfIO

AIS_ListOfInteractive

param theView

type theView

V3d_View

param theIsVisibleInView

type theIsVisibleInView

bool

param theStatus

default value is AIS_DS_None

type theStatus

AIS_DisplayStatus

rtype

None

ObjectsInside()¶

fills <aListOfIO> with objects of a particular Type and Signature with no consideration of display status. by Default, <WhichSignature> = -1 means control only on <WhichKind>. if <WhichKind> = AIS_KOI_None and <WhichSignature> = -1, all the objects are put into the list.

param aListOfIO

type aListOfIO

AIS_ListOfInteractive

param WhichKind

default value is AIS_KOI_None

type WhichKind

AIS_KindOfInteractive

param WhichSignature

default value is -1

type WhichSignature

int

rtype

None

PickingStrategy()¶

Return picking strategy; SelectMgr_PickingStrategy_FirstAcceptable by default. @sa MoveTo()/Filters()

rtype

SelectMgr_PickingStrategy

PixelTolerance()¶

Returns the pixel tolerance, default is 2. Pixel Tolerance extends sensitivity within MoveTo() operation (picking by point) and can be adjusted by application based on user input precision (e.g. screen pixel density, input device precision, etc.).

rtype

int

PlaneSize()¶

Returns true if the length in the X direction XSize is the same as that in the Y direction YSize.

param XSize

type XSize

float

param YSize

type YSize

float

rtype

bool

PolygonOffsets()¶

Retrieves current polygon offsets settings for Object.

param anObj

type anObj

AIS_InteractiveObject

param aMode

type aMode

int

param aFactor

type aFactor

Standard_ShortReal

param aUnits

type aUnits

Standard_ShortReal

rtype

None

PurgeDisplay()¶

Clears all the structures which don’t belong to objects displayed at neutral point only effective when no Local Context is opened… returns the number of removed structures from the viewers.

rtype

int

RebuildSelectionStructs()¶

Rebuilds 1st level of BVH selection forcibly

rtype

None

RecomputePrsOnly()¶

Recomputes the displayed presentations, flags the others. Doesn’t update presentations.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

param theAllModes

default value is Standard_False

type theAllModes

bool

rtype

None

RecomputeSelectionOnly()¶

Recomputes the active selections, flags the others. Doesn’t update presentations.

param anIObj

type anIObj

AIS_InteractiveObject

rtype

None

Redisplay()¶

Recomputes the seen parts presentation of the Object. If theAllModes equals true, all presentations are present in the object even if unseen.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

param theAllModes

default value is Standard_False

type theAllModes

bool

rtype

None* Recomputes the Prs/Selection of displayed objects of a given type and a given signature. if signature = -1 doesn’t take signature criterion.

param theTypeOfObject

type theTypeOfObject

AIS_KindOfInteractive

param theSignature

type theSignature

int

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

RedrawImmediate()¶

Redraws immediate structures in all views of the viewer given taking into account its visibility.

param theViewer

type theViewer

V3d_Viewer

rtype

None

Remove()¶

Removes Object from every viewer.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

RemoveAll()¶

Removes all the objects from Context.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

RemoveFilter()¶

Removes a filter from context.

param theFilter

type theFilter

SelectMgr_Filter

rtype

None

RemoveFilters()¶

Remove all filters from context.

rtype

None

ResetLocation()¶

Puts the Object back into its initial position.

param theObject

type theObject

AIS_InteractiveObject

rtype

None

Select()¶

Selects everything found in the bounding rectangle defined by the pixel minima and maxima, XPMin, YPMin, XPMax, and YPMax in the view. The objects detected are passed to the main viewer, which is then updated.

param theXPMin

type theXPMin

int

param theYPMin

type theYPMin

int

param theXPMax

type theXPMax

int

param theYPMax

type theYPMax

int

param theView

type theView

V3d_View

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick* polyline selection; clears the previous picked list

param thePolyline

type thePolyline

TColgp_Array1OfPnt2d

param theView

type theView

V3d_View

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick* Stores and hilights the previous detected; Unhilights the previous picked. @sa MoveTo().

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick

SelectedInteractive()¶

Return opencascade::handle<AIS_InteractiveObject>::DownCast (SelectedOwner()->Selectable()). @sa SelectedOwner().

rtype

opencascade::handle<AIS_InteractiveObject>

SelectedOwner()¶

Returns the owner of the selected entity. @sa InitSelected()/MoreSelected()/NextSelected().

rtype

opencascade::handle<SelectMgr_EntityOwner>

SelectedShape()¶

Returns the selected shape. Basically it is just a shape returned stored by StdSelect_BRepOwner with graphic transformation being applied: @code const opencascade::handle<StdSelect_BRepOwner> aBRepOwner = opencascade::handle<StdSelect_BRepOwner>::DownCast (SelectedOwner()); TopoDS_Shape aSelShape = aBRepOwner->Shape(); TopoDS_Shape aLocatedShape = aSelShape.Located (aBRepOwner->Location() * aSelShape.Location()); @endcode @sa SelectedOwner()/HasSelectedShape().

rtype

TopoDS_Shape

Selection()¶

Returns selection instance

rtype

opencascade::handle<AIS_Selection>

SelectionManager()¶

Return type: opencascade::handle<SelectMgr_SelectionManager>

SelectionStyle()¶

Returns current selection style settings. By default: - the color of selection is Quantity_NOC_GRAY80; - the presentation for selection is completely opaque; - the type of highlight is Aspect_TOHM_COLOR.

rtype

opencascade::handle<Prs3d_Drawer>

SetAngleAndDeviation()¶

Calls the AIS_Shape SetAngleAndDeviation to set both Angle and Deviation coefficients

param theIObj

type theIObj

AIS_InteractiveObject

param theAngle

type theAngle

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetAutoActivateSelection()¶

Enable or disable automatic activation of default selection mode while displaying the object.

param theIsAuto

type theIsAuto

bool

rtype

None

SetAutomaticHilight()¶

Sets the highlighting status of detected and selected entities. This function allows you to disconnect the automatic mode. //! MoveTo() will fill the list of detected entities and Select() will set selected state to detected objects regardless of this flag, but with disabled AutomaticHiligh() their highlighting state will be left unaffected, so that application will be able performing custom highlighting in a different way, if needed. //! This API should be distinguished from SelectMgr_SelectableObject::SetAutoHilight() that is used to implement custom highlighting logic for a specific interactive object class. //! @sa MoveTo(), Select(), HilightWithColor(), Unhilight()

param theStatus

type theStatus

bool

rtype

None

SetColor()¶

Sets the color of the selected entity.

param theIObj

type theIObj

AIS_InteractiveObject

param theColor

type theColor

Quantity_Color

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetCurrentFacingModel()¶

change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face.

param aniobj

type aniobj

AIS_InteractiveObject

param aModel

default value is Aspect_TOFM_BOTH_SIDE

type aModel

Aspect_TypeOfFacingModel

rtype

None

SetCurrentObject()¶

@name obsolete methods Updates the view of the current object in open context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetDeviationAngle()¶

Parameters

theIObj –

type theIObj: AIS_InteractiveObject
param theAngle
type theAngle: float
param theToUpdateViewer
type theToUpdateViewer: bool
rtype: None* default 12 degrees
param anAngle
type anAngle: float
rtype: None

SetDeviationCoefficient()¶

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

param theIObj

type theIObj

AIS_InteractiveObject

param theCoefficient

type theCoefficient

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

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

param theCoefficient

type theCoefficient

float

rtype

None

SetDisplayMode()¶

Sets the display mode of seen Interactive Objects (which have no overridden Display Mode).

param theMode

type theMode

int

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Sets the display mode of seen Interactive Objects. theMode provides the display mode index of the entity theIObj.

param theIObj

type theIObj

AIS_InteractiveObject

param theMode

type theMode

int

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetDisplayPriority()¶

Sets the display priority of the seen parts presentation of the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param thePriority

type thePriority

int

rtype

None

SetHLRAngle()¶

Sets the HLR angle.

param theAngle

type theAngle

float

rtype

None

SetHLRAngleAndDeviation()¶

Computes a HLRAngle and a HLRDeviationCoefficient by means of the angle anAngle and sets the corresponding methods in the default drawing tool with these values.

param theIObj

type theIObj

AIS_InteractiveObject

param theAngle

type theAngle

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* compute with theAngle a HLRAngle and a HLRDeviationCoefficient and set them in myHLRAngle and in myHLRDeviationCoefficient of myDefaultDrawer; theAngle is in radian; ( 1 deg < angle in deg < 20 deg)

param theAngle

type theAngle

float

rtype

None

SetHLRDeviationAngle()¶

Parameters

theIObj –

type theIObj: AIS_InteractiveObject
param theAngle
type theAngle: float
param theToUpdateViewer
type theToUpdateViewer: bool
rtype: None

SetHLRDeviationCoefficient()¶

Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.

param theIObj

type theIObj

AIS_InteractiveObject

param theCoefficient

type theCoefficient

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.

param aCoefficient

type aCoefficient

float

rtype

None

SetHiddenLineAspect()¶

Sets the hidden line aspect anAspect. Aspect defines display attributes for hidden lines in HLR projections.

param anAspect

type anAspect

Prs3d_LineAspect

rtype

None

SetHighlightStyle()¶

Setup highlight style settings. It is preferred modifying existing style returned by method HighlightStyle() instead of creating a new drawer. //! If a new highlight style is created, its presentation Zlayer should be checked, otherwise highlighting might not work as expected. Default values are: - Prs3d_TypeOfHighlight_Dynamic: Graphic3d_ZLayerId_Top, object highlighting is drawn on top of main scene within Immediate Layers, so that V3d_View::RedrawImmediate() will be enough to see update; - Prs3d_TypeOfHighlight_LocalDynamic: Graphic3d_ZLayerId_Topmost, object parts highlighting is drawn on top of main scene within Immediate Layers with depth cleared (even overlapped geometry will be revealed); - Prs3d_TypeOfHighlight_Selected: Graphic3d_ZLayerId_UNKNOWN, object highlighting is drawn on top of main scene within the same layer as object itself (e.g. Graphic3d_ZLayerId_Default by default) and increased priority.

param theStyleType

type theStyleType

Prs3d_TypeOfHighlight

param theStyle

type theStyle

Prs3d_Drawer

rtype

None* Setup the style of dynamic highlighting. It is preferred modifying existing style returned by method HighlightStyle() instead of creating a new drawer. //! If a new highlight style is created, its presentation Zlayer should be checked, otherwise highlighting might not work as expected. Default value is Graphic3d_ZLayerId_Top, object highlighting is drawn on top of main scene within Immediate Layers, so that V3d_View::RedrawImmediate() will be enough to see update;

param theStyle

type theStyle

Prs3d_Drawer

rtype

None

SetIsoNumber()¶

@name iso-line display attributes Sets the number of U and V isoparameters displayed.

param NbIsos

type NbIsos

int

param WhichIsos

default value is AIS_TOI_Both

type WhichIsos

AIS_TypeOfIso

rtype

None

SetLocalAttributes()¶

@name common object display attributes Sets the graphic attributes of the interactive object, such as visualization mode, color, and material.

param theIObj

type theIObj

AIS_InteractiveObject

param theDrawer

type theDrawer

Prs3d_Drawer

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetLocation()¶

@name object local transformation management Puts the location on the initial graphic representation and the selection for the Object.

param theObject

type theObject

AIS_InteractiveObject

param theLocation

type theLocation

TopLoc_Location

rtype

None

SetMaterial()¶

Provides the type of material setting for the view of the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theMaterial

type theMaterial

Graphic3d_MaterialAspect

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetPickingStrategy()¶

Setup picking strategy - which entities detected by picking line will be accepted, considering Selection Filters. By default (SelectMgr_PickingStrategy_FirstAcceptable), Selection Filters reduce the list of entities so that the context accepts topmost in remaining. //! This means that entities behind non-selectable (by filters) parts can be picked by user. If this behavior is undesirable, and user wants that non-selectable (by filters) parts should remain an obstacle for picking, SelectMgr_PickingStrategy_OnlyTopmost can be set instead. //! Notice, that since Selection Manager operates only objects registered in it, SelectMgr_PickingStrategy_OnlyTopmost will NOT prevent picking entities behind visible by unregistered in Selection Manager presentations (e.g. deactivated). Hence, SelectMgr_PickingStrategy_OnlyTopmost changes behavior only with Selection Filters enabled.

param theStrategy

type theStrategy

SelectMgr_PickingStrategy

rtype

None

SetPixelTolerance()¶

@name mouse picking logic (detection and dynamic highlighting of entities under cursor) Setup pixel tolerance for MoveTo() operation. @sa MoveTo().

param thePrecision

default value is 2

type thePrecision

int

rtype

None

SetPlaneSize()¶

@name plane display attributes Sets the plane size defined by the length in the X direction XSize and that in the Y direction YSize.

param theSizeX

type theSizeX

float

param theSizeY

type theSizeY

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Sets the plane size aSize.

param theSize

type theSize

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetPolygonOffsets()¶

Sets up polygon offsets for the given AIS_InteractiveObject. It simply calls AIS_InteractiveObject::SetPolygonOffsets().

param theIObj

type theIObj

AIS_InteractiveObject

param theMode

type theMode

int

param theFactor

type theFactor

Standard_ShortReal

param theUnits

type theUnits

Standard_ShortReal

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetSelected()¶

Unhighlights previously selected owners and marks them as not selected. Marks owner given as selected and highlights it. Performs selection filters check.

param theOwners

type theOwners

SelectMgr_EntityOwner

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None* Puts the interactive object aniObj in the list of selected objects. Performs selection filters check.

param theObject

type theObject

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetSelectedAspect()¶

@name Selection management Sets the graphic basic aspect to the current presentation of ALL selected objects.

param theAspect

type theAspect

Prs3d_BasicAspect

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetSelectedState()¶

Updates Selected state of specified owner without calling HilightSelected(). Has no effect if Selected state is not changed, and redirects to AddOrRemoveSelected() otherwise. @param theOwner owner object to set selected state @param theIsSelected new selected state returns True if Selected state has been changed

param theOwner

type theOwner

SelectMgr_EntityOwner

param theIsSelected

type theIsSelected

bool

rtype

bool

SetSelection()¶

Sets selection instance to manipulate a container of selected owners @param theSelection an instance of the selection

param theSelection

type theSelection

AIS_Selection

rtype

None

SetSelectionModeActive()¶

@name management of active Selection Modes Activates or deactivates the selection mode for specified object. Has no effect if selection mode was already active/deactivated. @param theObj object to activate/deactivate selection mode @param theMode selection mode to activate/deactivate; deactivation of -1 selection mode will effectively deactivate all selection modes; activation of -1 selection mode with AIS_SelectionModesConcurrency_Single will deactivate all selection modes, and will has no effect otherwise @param theToActivate activation/deactivation flag @param theConcurrency specifies how to handle already activated selection modes; default value (AIS_SelectionModesConcurrency_Multiple) means active selection modes should be left as is, AIS_SelectionModesConcurrency_Single can be used if only one selection mode is expected to be active and AIS_SelectionModesConcurrency_GlobalOrLocal can be used if either AIS_InteractiveObject::GlobalSelectionMode() or any combination of Local selection modes is acceptable; this value is considered only if theToActivate set to True @param theIsForce when set to True, the display status will be ignored while activating selection mode

param theObj

type theObj

AIS_InteractiveObject

param theMode

type theMode

int

param theToActivate

type theToActivate

bool

param theConcurrency

default value is AIS_SelectionModesConcurrency_Multiple

type theConcurrency

AIS_SelectionModesConcurrency

param theIsForce

default value is Standard_False

type theIsForce

bool

rtype

None

SetSelectionSensitivity()¶

Allows to manage sensitivity of a particular selection of interactive object theObject and changes previous sensitivity value of all sensitive entities in selection with theMode to the given theNewSensitivity.

param theObject

type theObject

AIS_InteractiveObject

param theMode

type theMode

int

param theNewSensitivity

type theNewSensitivity

int

rtype

None

SetSelectionStyle()¶

Setup the style of selection highlighting.

param theStyle

type theStyle

Prs3d_Drawer

rtype

None

SetSubIntensityColor()¶

Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner’s selection state will not be updated). The method sets up the color for such highlighting. By default, this is Quantity_NOC_GRAY40.

param theColor

type theColor

Quantity_Color

rtype

None

SetToHilightSelected()¶

Specify whether selected object must be hilighted when mouse cursor is moved above it (in MoveTo method). By default this value is false and selected object is not hilighted in this case. @sa MoveTo()

param toHilight

type toHilight

bool

rtype

None

SetTransformPersistence()¶

Sets transform persistence.

param theObject

type theObject

AIS_InteractiveObject

param theTrsfPers

type theTrsfPers

Graphic3d_TransformPers

rtype

None:param theObj:

type theObj

AIS_InteractiveObject

param theFlag

type theFlag

Graphic3d_TransModeFlags

param thePoint

default value is gp_Pnt(0.0,0.0,0.0)

type thePoint

gp_Pnt

rtype

None

SetTransparency()¶

Provides the transparency settings for viewing the Object. The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent.

param theIObj

type theIObj

AIS_InteractiveObject

param theValue

type theValue

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetTrihedronSize()¶

@name trihedron display attributes Sets the size aSize of the trihedron. Is used to change the default value 100 mm for display of trihedra. Use of this function in one of your own interactive objects requires a call to the Compute function of the new class. This will recalculate the presentation for every trihedron displayed.

param theSize

type theSize

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SetViewAffinity()¶

Setup object visibility in specified view. Has no effect if object is not displayed in this context.

param theIObj

type theIObj

AIS_InteractiveObject

param theView

type theView

V3d_View

param theIsVisible

type theIsVisible

bool

rtype

None

SetWidth()¶

Sets the width of the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theValue

type theValue

float

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

void

SetZLayer()¶

Set Z layer id for interactive object. The Z layers can be used to display temporarily presentations of some object in front of the other objects in the scene. The ids for Z layers are generated by V3d_Viewer.

param theIObj

type theIObj

AIS_InteractiveObject

param theLayerId

type theLayerId

int

rtype

None

ShiftSelect()¶

Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List. @sa MoveTo().

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick* Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List.

param thePolyline

type thePolyline

TColgp_Array1OfPnt2d

param theView

type theView

V3d_View

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick* Rectangle of selection; adds new detected entities into the picked list, removes the detected entities that were already stored.

param theXPMin

type theXPMin

int

param theYPMin

type theYPMin

int

param theXPMax

type theXPMax

int

param theYPMax

type theYPMax

int

param theView

type theView

V3d_View

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

AIS_StatusOfPick

SubIntensityColor()¶

@name sub-intensity management (deprecated) Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner’s selection state will not be updated). The method returns the color of such highlighting. By default, it is Quantity_NOC_GRAY40.

rtype

Quantity_Color

SubIntensityOff()¶

Removes the subintensity option for the entity. If a local context is open, the presentation of the Interactive Object activates the selection mode.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

SubIntensityOn()¶

Highlights, and removes highlights from, the displayed object which is displayed at Neutral Point with subintensity color. Available only for active local context. There is no effect if there is no local context. If a local context is open, the presentation of the Interactive Object activates the selection mode.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

ToHilightSelected()¶

Return value specified whether selected object must be hilighted when mouse cursor is moved above it @sa MoveTo()

rtype

bool

TrihedronSize()¶

returns the current value of trihedron size.

rtype

float

Unhilight()¶

Removes hilighting from the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnhilightCurrents()¶

Removes highlighting from current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnhilightSelected()¶

Removes highlighting from selected objects.

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetColor()¶

Removes the color selection for the selected entity.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetDisplayMode()¶

Unsets the display mode of seen Interactive Objects.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetLocalAttributes()¶

Removes the settings for local attributes of the Object and returns to defaults.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetMaterial()¶

Removes the type of material setting for viewing the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetTransparency()¶

Removes the transparency settings for viewing the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

UnsetWidth()¶

Removes the width setting of the Object.

param theIObj

type theIObj

AIS_InteractiveObject

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

void

Update()¶

Updates displayed interactive object by checking and recomputing its flagged as ‘to be recomputed’ presentation and selection structures. This method does not force any recomputation on its own. The method recomputes selections even if they are loaded without activation in particular selector.

param theIObj

type theIObj

AIS_InteractiveObject

param theUpdateViewer

type theUpdateViewer

bool

rtype

None

UpdateCurrent()¶

Updates the list of current objects, i.e. hilights new current objects, removes hilighting from former current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.

rtype

None

UpdateCurrentViewer()¶

Updates the current viewer.

rtype

None

UpdateSelected()¶

Updates the list of selected objects: i.e. highlights the newly selected ones and unhighlights previously selected objects. @sa HilightSelected().

param theToUpdateViewer

type theToUpdateViewer

bool

rtype

None

Width()¶

Returns the width of the Interactive Object in the interactive context.

param aniobj

type aniobj

AIS_InteractiveObject

rtype

float

property thisown¶: The membership flag

class AIS_InteractiveObject(*args, **kwargs)¶

Bases: OCC.Core.SelectMgr.SelectMgr_SelectableObject

Empty constructor

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

ClearOwner()¶

Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient. This method removes the owner from the graphic entity.

rtype

None

static DownCast(t)¶

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

GetContext()¶

Returns the context pointer to the interactive context.

rtype

opencascade::handle<AIS_InteractiveContext>

GetOwner()¶

Returns the owner of the Interactive Object. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. There are two types of owners: - Direct owners, decomposition shapes such as edges, wires, and faces. - Users, presentable objects connecting to sensitive primitives, or a shape which has been decomposed.

rtype

opencascade::handle<Standard_Transient>

HasInteractiveContext()¶

Indicates whether the Interactive Object has a pointer to an interactive context.

rtype

bool

HasOwner()¶

Returns true if the object has an owner attributed to it. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient.

rtype

bool

HasPresentation()¶

Returns True when this object has a presentation in the current DisplayMode()

rtype

bool

InteractiveContext()¶

Returns the context pointer to the interactive context.

rtype

AIS_InteractiveContext *

Presentation()¶

Returns the current presentation of this object according to the current DisplayMode()

rtype

opencascade::handle<Prs3d_Presentation>

Redisplay()¶

Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed. IMPORTANT: It is preferable to call Redisplay method of corresponding AIS_InteractiveContext instance for cases when it is accessible. This method just redirects call to myCTXPtr, so this class field must be up to date for proper result.

param AllModes

default value is Standard_False

type AllModes

bool

rtype

None

SetAspect()¶

Sets the graphic basic aspect to the current presentation.

param anAspect

type anAspect

Prs3d_BasicAspect

rtype

None

SetContext()¶

Sets the interactive context aCtx and provides a link to the default drawing tool or ‘Drawer’ if there is none.

param aCtx

type aCtx

AIS_InteractiveContext

rtype

void

SetOwner()¶

Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient.

param theApplicativeEntity

type theApplicativeEntity

Standard_Transient

rtype

None

Signature()¶

Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures: - Point signature 1 - Axis signature 2 - Trihedron signature 3 - PlaneTrihedron signature 4 - Line signature 5 - Circle signature 6 - Plane signature 7.

rtype

int

Type()¶

Returns the kind of Interactive Object; AIS_KOI_None by default.

rtype

AIS_KindOfInteractive

property thisown¶: The membership flag

class AIS_LengthDimension(*args)¶

Construct length dimension between face and edge. Here dimension can be built without user-defined plane. @param theFace [in] the face (first shape). @param theEdge [in] the edge (second shape).

param theFace

type theFace

TopoDS_Face

param theEdge

type theEdge

TopoDS_Edge

rtype

None* Construct length dimension between two faces. @param theFirstFace [in] the first face (first shape). @param theSecondFace [in] the second face (second shape).

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

rtype

None* Construct length dimension between two points in the specified plane. @param theFirstPoint [in] the first point. @param theSecondPoint [in] the second point. @param thePlane [in] the plane to orient dimension.

param theFirstPoint

type theFirstPoint

gp_Pnt

param theSecondPoint

type theSecondPoint

gp_Pnt

param thePlane

type thePlane

gp_Pln

rtype

None* Construct length dimension between two arbitrary shapes in the specified plane. @param theFirstShape [in] the first shape. @param theSecondShape [in] the second shape. @param thePlane [in] the plane to orient dimension.

param theFirstShape

type theFirstShape

TopoDS_Shape

param theSecondShape

type theSecondShape

TopoDS_Shape

param thePlane

type thePlane

gp_Pln

rtype

None* Construct length dimension of linear edge. @param theEdge [in] the edge to measure. @param thePlane [in] the plane to orient dimension.

param theEdge

type theEdge

TopoDS_Edge

param thePlane

type thePlane

gp_Pln

rtype

None

static DownCast(t)¶

FirstPoint()¶

returns first attachement point.

rtype

gp_Pnt

FirstShape()¶

returns first attachement shape.

rtype

TopoDS_Shape

GetTextPosition()¶

Return type: gp_Pnt

SecondPoint()¶

returns second attachement point.

rtype

gp_Pnt

SecondShape()¶

returns second attachement shape.

rtype

TopoDS_Shape

SetDirection()¶

Set custom direction for dimension. If it is not set, the direction is obtained from the measured geometry (e.g. line between points of dimension) The direction does not change flyout direction of dimension. @param theDirection [in] the dimension direction. @param theUseDirection [in] boolean value if custom direction should be used.

param theDirection

type theDirection

gp_Dir

param theUseDirection

default value is Standard_True

type theUseDirection

bool

rtype

None

SetDisplayUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetMeasuredGeometry()¶

Measure distance between two points. The dimension will become invalid if the new distance between attachement points is less than Precision::Confusion(). @param theFirstPoint [in] the first point. @param theSecondPoint [in] the second point. @param thePlane [in] the user-defined plane

param theFirstPoint

type theFirstPoint

gp_Pnt

param theSecondPoint

type theSecondPoint

gp_Pnt

param thePlane

type thePlane

gp_Pln

rtype

None* Measure length of edge. The dimension will become invalid if the new length of edge is less than Precision::Confusion(). @param theEdge [in] the edge to measure. @param thePlane [in] the user-defined plane

param theEdge

type theEdge

TopoDS_Edge

param thePlane

type thePlane

gp_Pln

rtype

None* Measure distance between two faces. The dimension will become invalid if the distance can not be measured or it is less than Precision::Confusion(). @param theFirstFace [in] the first face (first shape). @param theSecondFace [in] the second face (second shape).

param theFirstFace

type theFirstFace

TopoDS_Face

param theSecondFace

type theSecondFace

TopoDS_Face

rtype

None* Measure distance between face and edge. The dimension will become invalid if the distance can not be measured or it is less than Precision::Confusion(). @param theFace [in] the face (first shape). @param theEdge [in] the edge (second shape).

param theFace

type theFace

TopoDS_Face

param theEdge

type theEdge

TopoDS_Edge

rtype

None

SetMeasuredShapes()¶

Measure distance between generic pair of shapes (edges, vertices, length), where measuring is applicable. @param theFirstShape [in] the first shape. @param theSecondShape [in] the second shape.

param theFirstShape

type theFirstShape

TopoDS_Shape

param theSecondShape

type theSecondShape

TopoDS_Shape

rtype

None

SetModelUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetTextPosition()¶

Parameters

theTextPos –

type theTextPos: gp_Pnt
rtype: void

property thisown¶: The membership flag

class AIS_Line(*args)¶

Initializes the line aLine.

param aLine

type aLine

Geom_Line

rtype

None* Initializes a starting point aStartPoint and a finishing point aEndPoint for the line.

param aStartPoint

type aStartPoint

Geom_Point

param aEndPoint

type aEndPoint

Geom_Point

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

Line()¶

Constructs an infinite line.

rtype

opencascade::handle<Geom_Line>

Points()¶

Returns the starting point thePStart and the end point thePEnd of the line set by SetPoints.

param thePStart

type thePStart

Geom_Point

param thePEnd

type thePEnd

Geom_Point

rtype

None

SetColor()¶

Provides a new color setting aColor for the line in the drawing tool, or ‘Drawer’.

param aColor

type aColor

Quantity_Color

rtype

None

SetLine()¶

instantiates an infinite line.

param theLine

type theLine

Geom_Line

rtype

None

SetPoints()¶

Sets the starting point thePStart and ending point thePEnd of the infinite line to create a finite line segment.

param thePStart

type thePStart

Geom_Point

param thePEnd

type thePEnd

Geom_Point

rtype

None

SetWidth()¶

Provides the new width setting aValue for the line in the drawing tool, or ‘Drawer’.

param aValue

type aValue

float

rtype

None

Signature()¶

Returns the signature 5.

rtype

int

Type()¶

Returns the type Datum.

rtype

AIS_KindOfInteractive

UnsetColor()¶

Removes the color setting and returns the original color.

rtype

None

UnsetWidth()¶

Removes the width setting and returns the original width.

rtype

None

property thisown¶: The membership flag

class AIS_ListIteratorOfListOfInteractive(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class AIS_ListOfInteractive(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_Manipulator(*args)¶

Constructs a manipulator object with default placement and all parts to be displayed.

rtype

None* Constructs a manipulator object with input location and positions of axes and all parts to be displayed.

param thePosition

type thePosition

gp_Ax2

rtype

None

ActiveMode()¶

@name Setters for parameters

rtype

AIS_ManipulatorMode

Attach()¶

Attaches himself to the input interactive object and become displayed in the same context. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.

param theObject

type theObject

AIS_InteractiveObject

param theOptions

default value is OptionsForAttach()

type theOptions

OptionsForAttach

rtype

None* Attaches himself to the input interactive object group and become displayed in the same context. It become attached to the first object, baut manage manipulation of the whole group. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.

param theObject

type theObject

AIS_ManipulatorObjectSequence

param theOptions

default value is OptionsForAttach()

type theOptions

OptionsForAttach

rtype

None

Compute()¶

@name Presentation computation Fills presentation. @note Manipulator presentation does not use display mode and for all modes has the same presentation.

param thePrsMgr

type thePrsMgr

PrsMgr_PresentationManager3d

param thePrs

type thePrs

Prs3d_Presentation

param theMode

default value is 0

type theMode

int

rtype

void

ComputeSelection()¶

Computes selection sensitive zones (triangulation) for manipulator. @param theNode [in] Selection mode that is treated as transformation mode.

param theSelection

type theSelection

SelectMgr_Selection

param theMode

type theMode

int

rtype

void

DeactivateCurrentMode()¶

Make inactive the current selected manipulator part and reset current axis index and current mode. After its call HasActiveMode() returns false. @sa HasActiveMode()

rtype

None

Detach()¶

Detaches himself from the owner object, and removes itself from context.

rtype

None

static DownCast(t)¶

EnableMode()¶

Enable manipualtion mode. @warning It activates selection mode in the current context. If manipulator is not displayed, no mode will be activated.

param theMode

type theMode

AIS_ManipulatorMode

rtype

None

HasActiveMode()¶

returns true if some part of manipulator is selected (transformation mode is active, and owning object can be transformed).

rtype

bool

HasActiveTransformation()¶

Return type: bool

IsAttached()¶

returns true if manipulator is attached to some interactive object (has owning object).

rtype

bool

IsAutoHilight()¶

Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods.

rtype

bool

IsModeActivationOnDetection()¶

returns true if manual mode activation is enabled.

rtype

bool

Object()¶

returns the first (leading) object of the owning objects.

rtype

opencascade::handle<AIS_InteractiveObject>* returns one of the owning objects. @warning raises program error if theIndex is more than owning objects count or less than 1.

param theIndex

type theIndex

int

rtype

opencascade::handle<AIS_InteractiveObject>

ObjectTransformation()¶

Computes transformation of parent object according to the active mode and input motion vector. You can use this method to get object transformation according to current mode or use own algorithm to implement any other tranformation for modes. returns transformation of parent object.

param theX

type theX

int

param theY

type theY

int

param theView

type theView

V3d_View

param theTrsf

type theTrsf

gp_Trsf

rtype

bool

Objects()¶

returns all owning objects.

rtype

opencascade::handle<AIS_ManipulatorObjectSequence>

Position()¶

returns poition of manipulator interactive object.

rtype

gp_Ax2

SetGap()¶

Sets gaps between translator, scaler and rotator sub-presentations.

param theValue

type theValue

Standard_ShortReal

rtype

None

SetModeActivationOnDetection()¶

Enables mode activation on detection (highlighting). By default, mode is activated on selection of manipulator part. @warning If this mode is enabled, selection of parts does nothing.

param theToEnable

type theToEnable

bool

rtype

None

SetPart()¶

Disable or enable visual parts for translation, rotation or scaling for some axis. By default all parts are enabled (will be displayed). @warning Enabling or disabling of visual parts of manipulator does not manage the manipulation (selection) mode. @warning Raises program error if axis index is < 0 or > 2.

param theAxisIndex

type theAxisIndex

int

param theMode

type theMode

AIS_ManipulatorMode

param theIsEnabled

type theIsEnabled

bool

rtype

None* Disable or enable visual parts for translation, rotation or scaling for ALL axes. By default all parts are enabled (will be displayed). @warning Enabling or disabling of visual parts of manipulator does not manage the manipulation (selection) mode. @warning Raises program error if axis index is < 0 or > 2.

param theMode

type theMode

AIS_ManipulatorMode

param theIsEnabled

type theIsEnabled

bool

rtype

None

SetPosition()¶

Sets position of the manipulator object.

param thePosition

type thePosition

gp_Ax2

rtype

None

SetSize()¶

Sets size (length of side of the manipulator cubic bounding box.

param theSideLength

type theSideLength

Standard_ShortReal

rtype

None

SetZoomPersistence()¶

@name Configuration of graphical transformations Enable or disable zoom persistence mode for the manipulator. With this mode turned on the presentation will keep fixed screen size. @warning when turned on this option overrides transform persistence properties and local transformation to achieve necessary visual effect. @warning revise use of AdjustSize argument of of sa AttachToObjects method when enabling zoom persistence.

param theToEnable

type theToEnable

bool

rtype

None

Size()¶

Return type: Standard_ShortReal

StartTransform()¶

Init start (reference) transformation. @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set. If Transform(const Standard_Integer, const Standard_Integer) is used, initial data is set automatically, and it is reset on DeactivateCurrentMode call if it is not reset yet.

param theX

type theX

int

param theY

type theY

int

param theView

type theView

V3d_View

rtype

None

StartTransformation()¶

Return type: gp_Trsf:param theIndex: :type theIndex: int :rtype: gp_Trsf

StopTransform()¶

Reset start (reference) transformation. @param theToApply [in] option to apply or to cancel the started transformation. @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set.

param theToApply

default value is Standard_True

type theToApply

bool

rtype

None

Transform()¶

Apply to the owning objects the input transformation. @remark The transformation is set using SetLocalTransformation for owning objects. The location of the manipulator is stored also in Local Transformation, so that there’s no need to redisplay objects. @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set. @warning It will does nothing if transformation is not initiated (with StartTransform() call).

param aTrsf

type aTrsf

gp_Trsf

rtype

None* Apply transformation made from mouse moving from start position (save on the first Tranform() call and reset on DeactivateCurrentMode() call.) to the in/out mouse position (theX, theY)

param theX

type theX

int

param theY

type theY

int

param theView

type theView

V3d_View

rtype

gp_Trsf

ZoomPersistence()¶

Returns state of zoom persistence mode, whether it turned on or off.

rtype

bool

property thisown¶: The membership flag

class AIS_ManipulatorOwner(*args)¶

Parameters

theSelObject –

type theSelObject: SelectMgr_SelectableObject
param theIndex
type theIndex: int
param theMode
type theMode: AIS_ManipulatorMode
param thePriority: default value is 0
type thePriority: int
rtype: None

static DownCast(t)¶

Index()¶

returns index of manipulator axis.

rtype

int

IsHilighted()¶

Parameters

thePM –

type thePM: PrsMgr_PresentationManager
param theMode
type theMode: int
rtype: bool

Mode()¶

Return type: AIS_ManipulatorMode

Unhilight()¶

Parameters

thePM –

type thePM: PrsMgr_PresentationManager
param theMode
type theMode: int
rtype: void

property thisown¶: The membership flag

class AIS_MapOfInteractive(*args)¶

Bases: object

Add()¶

Added()¶

Assign()¶

Clear()¶

Contains()¶

Differ()¶

Difference()¶

Exchange()¶

HasIntersection()¶

Intersect()¶

Intersection()¶

IsEqual()¶

ReSize()¶

Remove()¶

Set()¶

Size()¶

Subtract()¶

Subtraction()¶

Union()¶

Unite()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class AIS_MaxRadiusDimension(*args)¶

Bases: OCC.Core.AIS.AIS_EllipseRadiusDimension

Max Ellipse radius dimension Shape can be edge , planar face or cylindrical face

param aShape

type aShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

rtype

None* Max Ellipse radius dimension with position Shape can be edge , planar face or cylindrical face

param aShape

type aShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

param aPosition

type aPosition

gp_Pnt

param aSymbolPrs

type aSymbolPrs

DsgPrs_ArrowSide

param anArrowSize

default value is 0.0

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_MediaPlayer(*args)¶

Empty constructor.

rtype

None

Duration()¶

Return duration.

rtype

double

OpenInput()¶

Open specified file.

param thePath

type thePath

TCollection_AsciiString

param theToWait

type theToWait

bool

rtype

None

PlayPause()¶

Switch playback state.

rtype

None

PlayerContext()¶

Return player context.

rtype

opencascade::handle<Media_PlayerContext>

PresentFrame()¶

Display new frame.

param theLeftCorner

type theLeftCorner

Graphic3d_Vec2i

param theMaxSize

type theMaxSize

Graphic3d_Vec2i

rtype

bool

SetCallback()¶

Setup callback to be called on queue progress (e.g. when new frame should be displayed).

param theCallbackFunction

type theCallbackFunction

Graphic3d_MediaTextureSet::CallbackOnUpdate_t

param theCallbackUserPtr

type theCallbackUserPtr

void *

rtype

None

SetClosePlayer()¶

Schedule player to be closed.

rtype

None

property thisown¶: The membership flag

class AIS_MidPointRelation(*args)¶

Parameters

aSymmTool –

type aSymmTool: TopoDS_Shape
param FirstShape
type FirstShape: TopoDS_Shape
param SecondShape
type SecondShape: TopoDS_Shape
param aPlane
type aPlane: Geom_Plane
rtype: None

Compute()¶

Computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

GetTool()¶

Return type: TopoDS_Shape

SetTool()¶

Parameters

aMidPointTool –

type aMidPointTool: TopoDS_Shape
rtype: None

property thisown¶: The membership flag

class AIS_MinRadiusDimension(*args)¶

Bases: OCC.Core.AIS.AIS_EllipseRadiusDimension

Max Ellipse radius dimension Shape can be edge , planar face or cylindrical face

param aShape

type aShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

rtype

None* Max Ellipse radius dimension with position Shape can be edge , planar face or cylindrical face

param aShape

type aShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

param aPosition

type aPosition

gp_Pnt

param aSymbolPrs

type aSymbolPrs

DsgPrs_ArrowSide

param anArrowSize

default value is 0.0

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_MouseGestureMap(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_MultipleConnectedInteractive(*args)¶

Initializes the Interactive Object with multiple connections to AIS_Interactive objects.

rtype

None

AcceptShapeDecomposition()¶

Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection.

rtype

bool

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void:param aProjector:

type aProjector

Prs3d_Projector

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

Connect()¶

Establishes the connection between the Connected Interactive Object, theInteractive, and its reference. Locates instance in theLocation and applies specified transformation persistence mode. returns created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

param theLocation

type theLocation

Geom_Transformation

param theTrsfPers

type theTrsfPers

Graphic3d_TransformPers

rtype

opencascade::handle<AIS_InteractiveObject>* Establishes the connection between the Connected Interactive Object, theInteractive, and its reference. Copies local transformation and transformation persistence mode from theInteractive. returns created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

rtype

opencascade::handle<AIS_InteractiveObject>* Establishes the connection between the Connected Interactive Object, theInteractive, and its reference. Locates instance in theLocation and copies transformation persistence mode from theInteractive. returns created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

param theLocation

type theLocation

gp_Trsf

rtype

opencascade::handle<AIS_InteractiveObject>* Establishes the connection between the Connected Interactive Object, theInteractive, and its reference. Locates instance in theLocation and applies specified transformation persistence mode. returns created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)

param theAnotherObj

type theAnotherObj

AIS_InteractiveObject

param theLocation

type theLocation

gp_Trsf

param theTrsfPers

type theTrsfPers

Graphic3d_TransformPers

rtype

opencascade::handle<AIS_InteractiveObject>:param theInteractive:

type theInteractive

AIS_InteractiveObject

param theLocation

type theLocation

gp_Trsf

param theTrsfPersFlag

type theTrsfPersFlag

Graphic3d_TransModeFlags

param theTrsfPersPoint

type theTrsfPersPoint

gp_Pnt

rtype

opencascade::handle<AIS_InteractiveObject>

Disconnect()¶

Removes the connection with theInteractive.

param theInteractive

type theInteractive

AIS_InteractiveObject

rtype

None

DisconnectAll()¶

Clears all the connections to objects.

rtype

None

static DownCast(t)¶

HasConnection()¶

Returns true if the object is connected to others.

rtype

bool

Signature()¶

Return type: int

Type()¶

Return type: AIS_KindOfInteractive

property thisown¶: The membership flag

class AIS_NListOfEntityOwner(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class AIS_OffsetDimension(*args)¶

Constructs the offset display object defined by the first shape aFShape, the second shape aSShape, the dimension aVal, and the text aText.

param FistShape

type FistShape

TopoDS_Shape

param SecondShape

type SecondShape

TopoDS_Shape

param aVal

type aVal

float

param aText

type aText

TCollection_ExtendedString

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

SetRelativePos()¶

Sets a transformation aTrsf for presentation and selection to a relative position.

param aTrsf

type aTrsf

gp_Trsf

rtype

None

property thisown¶: The membership flag

class AIS_ParallelRelation(*args)¶

Constructs an object to display parallel constraints. This object is defined by the first shape aFShape and the second shape aSShape and the plane aPlane.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None* Constructs an object to display parallel constraints. This object is defined by the first shape aFShape and the second shape aSShape the plane aPlane, the position aPosition, the type of arrow, aSymbolPrs and its size anArrowSize.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param aPosition

type aPosition

gp_Pnt

param aSymbolPrs

type aSymbolPrs

DsgPrs_ArrowSide

param anArrowSize

default value is 0.01

type anArrowSize

float

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_PerpendicularRelation(*args)¶

Constructs an object to display constraints of perpendicularity on shapes. This object is defined by a first shape aFShape, a second shape aSShape, and a plane aPlane. aPlane is the plane of reference to show and test the perpendicular relation between two shapes, at least one of which has a revolved surface.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None* Constructs an object to display constraints of perpendicularity on shapes. This object is defined by a first shape aFShape and a second shape aSShape.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_Plane(*args)¶

initializes the plane aComponent. If the mode aCurrentMode equals true, the drawing tool, ‘Drawer’ is not initialized.

param aComponent

type aComponent

Geom_Plane

param aCurrentMode

default value is Standard_False

type aCurrentMode

bool

rtype

None* initializes the plane aComponent and the point aCenter. If the mode aCurrentMode equals true, the drawing tool, ‘Drawer’ is not initialized. aCurrentMode equals true, the drawing tool, ‘Drawer’ is not initialized.

param aComponent

type aComponent

Geom_Plane

param aCenter

type aCenter

gp_Pnt

param aCurrentMode

default value is Standard_False

type aCurrentMode

bool

rtype

None* initializes the plane aComponent, the point aCenter, and the minimum and maximum points, aPmin and aPmax. If the mode aCurrentMode equals true, the drawing tool, ‘Drawer’ is not initialized.

param aComponent

type aComponent

Geom_Plane

param aCenter

type aCenter

gp_Pnt

param aPmin

type aPmin

gp_Pnt

param aPmax

type aPmax

gp_Pnt

param aCurrentMode

default value is Standard_False

type aCurrentMode

bool

rtype

None:param aComponent:

type aComponent

Geom_Axis2Placement

param aPlaneType

type aPlaneType

AIS_TypeOfPlane

param aCurrentMode

default value is Standard_False

type aCurrentMode

bool

rtype

None

AcceptDisplayMode()¶

Returns true if the display mode selected, aMode, is valid for planes.

param aMode

type aMode

int

rtype

bool

Axis2Placement()¶

Returns the position of the plane’s axis2 system identifying the x, y, or z axis and giving the plane a direction in 3D space. An axis2 system is a right-handed coordinate system.

rtype

opencascade::handle<Geom_Axis2Placement>

Center()¶

Returns the coordinates of the center point.

rtype

gp_Pnt

Component()¶

Returns the component specified in SetComponent.

rtype

opencascade::handle<Geom_Plane>

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

ComputeSelection()¶

Parameters

theSelection –

type theSelection: SelectMgr_Selection
param theMode
type theMode: int
rtype: void

CurrentMode()¶

Returns the non-default current display mode set by SetCurrentMode.

rtype

bool

static DownCast(t)¶

HasOwnSize()¶

Return type: bool

IsXYZPlane()¶

Returns the type of plane - xy, yz, or xz.

rtype

bool

PlaneAttributes()¶

Returns the settings for the selected plane aComponent, provided in SetPlaneAttributes. These include the points aCenter, aPmin, and aPmax

param aComponent

type aComponent

Geom_Plane

param aCenter

type aCenter

gp_Pnt

param aPmin

type aPmin

gp_Pnt

param aPmax

type aPmax

gp_Pnt

rtype

bool

SetAxis2Placement()¶

Allows you to provide settings for the position and direction of one of the plane’s axes, aComponent, in 3D space. The coordinate system used is right-handed, and the type of plane aPlaneType is one of: - AIS_ TOPL_Unknown - AIS_ TOPL_XYPlane - AIS_ TOPL_XZPlane - AIS_ TOPL_YZPlane}.

param aComponent

type aComponent

Geom_Axis2Placement

param aPlaneType

type aPlaneType

AIS_TypeOfPlane

rtype

None

SetCenter()¶

Provides settings for the center theCenter other than (0, 0, 0).

param theCenter

type theCenter

gp_Pnt

rtype

None

SetColor()¶

Parameters

aColor –

type aColor: Quantity_Color
rtype: None

SetComponent()¶

Creates an instance of the plane aComponent.

param aComponent

type aComponent

Geom_Plane

rtype

None

SetCurrentMode()¶

Allows you to provide settings for a non-default current display mode.

param theCurrentMode

type theCurrentMode

bool

rtype

None

SetPlaneAttributes()¶

Allows you to provide settings other than default ones for the selected plane. These include: center point aCenter, maximum aPmax and minimum aPmin.

param aComponent

type aComponent

Geom_Plane

param aCenter

type aCenter

gp_Pnt

param aPmin

type aPmin

gp_Pnt

param aPmax

type aPmax

gp_Pnt

rtype

None

SetSize()¶

Same value for x and y directions

param aValue

type aValue

float

rtype

None* Sets the size defined by the length along the X axis XVal and the length along the Y axis YVal.

param Xval

type Xval

float

param YVal

type YVal

float

rtype

None

SetTypeOfSensitivity()¶

Sets the type of sensitivity for the plane.

param theTypeOfSensitivity

type theTypeOfSensitivity

Select3D_TypeOfSensitivity

rtype

None

Signature()¶

Return type: int

Size()¶

Parameters

X –

type X: float
param Y
type Y: float
rtype: bool

Type()¶

Return type: AIS_KindOfInteractive

TypeOfPlane()¶

Returns the type of plane - xy, yz, xz or unknown.

rtype

AIS_TypeOfPlane

TypeOfSensitivity()¶

Returns the type of sensitivity for the plane;

rtype

Select3D_TypeOfSensitivity

UnsetColor()¶

Return type: None

UnsetSize()¶

Return type: None

property thisown¶: The membership flag

class AIS_PlaneTrihedron(*args)¶

Initializes the plane aPlane. The plane trihedron is constructed from this and an axis.

param aPlane

type aPlane

Geom_Plane

rtype

None

AcceptDisplayMode()¶

Returns true if the display mode selected, aMode, is valid.

param aMode

type aMode

int

rtype

bool

Component()¶

Returns the component specified in SetComponent.

rtype

opencascade::handle<Geom_Plane>

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

GetLength()¶

Returns the length of X and Y axes.

rtype

float

Position()¶

Returns the point of origin of the plane trihedron.

rtype

opencascade::handle<AIS_Point>

SetColor()¶

Allows you to provide settings for the color aColor.

param theColor

type theColor

Quantity_Color

rtype

void

SetComponent()¶

Creates an instance of the component object aPlane.

param aPlane

type aPlane

Geom_Plane

rtype

None

SetLength()¶

Sets the length of the X and Y axes.

param theLength

type theLength

float

rtype

None

SetXLabel()¶

Parameters

theLabel –

type theLabel: TCollection_AsciiString
rtype: None

SetYLabel()¶

Parameters

theLabel –

type theLabel: TCollection_AsciiString
rtype: None

Signature()¶

Return type: int

Type()¶

Returns datum as the type of Interactive Object.

rtype

AIS_KindOfInteractive

XAxis()¶

Returns the ‘XAxis’.

rtype

opencascade::handle<AIS_Line>

YAxis()¶

Returns the ‘YAxis’.

rtype

opencascade::handle<AIS_Line>

property thisown¶: The membership flag

class AIS_Point(*args)¶

Initializes the point aComponent from which the point datum will be built.

param aComponent

type aComponent

Geom_Point

rtype

None

AcceptDisplayMode()¶

Returns true if the display mode selected is valid for point datums.

param aMode

type aMode

int

rtype

bool

Component()¶

Returns the component specified in SetComponent.

rtype

opencascade::handle<Geom_Point>

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

HasMarker()¶

Returns true if the point datum has a marker.

rtype

bool

SetColor()¶

Allows you to provide settings for the Color.

param theColor

type theColor

Quantity_Color

rtype

void

SetComponent()¶

Constructs an instance of the point aComponent.

param aComponent

type aComponent

Geom_Point

rtype

None

SetMarker()¶

Allows you to provide settings for a marker. These include - type of marker, - marker color, - scale factor.

param aType

type aType

Aspect_TypeOfMarker

rtype

None

Signature()¶

Returns index 1, the default index for a point.

rtype

int

Type()¶

Indicates that a point is a datum.

rtype

AIS_KindOfInteractive

UnsetColor()¶

Allows you to remove color settings.

rtype

void

UnsetMarker()¶

Removes the marker settings.

rtype

None

Vertex()¶

Converts a point into a vertex.

rtype

TopoDS_Vertex

property thisown¶: The membership flag

class AIS_PointCloud(*args)¶

Constructor.

rtype

None

DM_BndBox = 2¶

DM_Points = 0¶

static DownCast(t)¶

GetBoundingBox()¶

Get bounding box for presentation.

rtype

Bnd_Box

GetPoints()¶

Get the points array. Method might be overridden to fill in points array dynamically from application data structures. returns the array of points

rtype

opencascade::handle<Graphic3d_ArrayOfPoints>

SM_BndBox = 2¶

SM_Points = 0¶

SM_SubsetOfPoints = 1¶

SetColor()¶

Setup custom color. Affects presentation only when no per-point color attribute has been assigned.

param theColor

type theColor

Quantity_Color

rtype

void

SetPoints()¶

Sets the points from array of points. Method will not copy the input data - array will be stored as handle. @param thePoints [in] the array of points

param thePoints

type thePoints

Graphic3d_ArrayOfPoints

rtype

void* Sets the points with optional colors. The input data will be copied into internal buffer. The input arrays should have equal length, otherwise the presentation will not be computed and displayed. @param theCoords [in] the array of coordinates @param theColors [in] optional array of colors @param theNormals [in] optional array of normals

param theCoords

type theCoords

TColgp_HArray1OfPnt

param theColors

default value is NULL

type theColors

Quantity_HArray1OfColor

param theNormals

default value is NULL

type theNormals

TColgp_HArray1OfDir

rtype

void

UnsetColor()¶

Restore default color.

rtype

void

property thisown¶: The membership flag

class AIS_PointCloudOwner(*args)¶

////DEFINE_STANDARD_RTTIEXT(AIS_PointCloudOwner, SelectMgr_EntityOwner) Main constructor.

param theOrigin

type theOrigin

AIS_PointCloud

rtype

None

Clear()¶

Clears presentation.

param thePrsMgr

type thePrsMgr

PrsMgr_PresentationManager

param theMode

type theMode

int

rtype

void

DetectedPoints()¶

Return last detected points. WARNING! Indexation starts with 0 (shifted by -1 comparing to Graphic3d_ArrayOfPoints::Vertice()).

rtype

opencascade::handle<TColStd_HPackedMapOfInteger>

IsForcedHilight()¶

Always update dynamic highlighting.

rtype

bool

SelectedPoints()¶

Return selected points. WARNING! Indexation starts with 0 (shifted by -1 comparing to Graphic3d_ArrayOfPoints::Vertice()).

rtype

opencascade::handle<TColStd_HPackedMapOfInteger>

Unhilight()¶

Removes highlighting.

param thePrsMgr

type thePrsMgr

PrsMgr_PresentationManager

param theMode

type theMode

int

rtype

void

property thisown¶: The membership flag

class AIS_RadiusDimension(*args)¶

Create radius dimension for the circle geometry. @param theCircle [in] the circle to measure.

param theCircle

type theCircle

gp_Circ

rtype

None* Create radius dimension for the circle geometry and define its orientation by location of the first point on that circle. @param theCircle [in] the circle to measure. @param theAnchorPoint [in] the point to define the position of the dimension attachment on the circle.

param theCircle

type theCircle

gp_Circ

param theAnchorPoint

type theAnchorPoint

gp_Pnt

rtype

None* Create radius dimension for the arbitrary shape (if possible). @param theShape [in] the shape to measure.

param theShape

type theShape

TopoDS_Shape

rtype

None

AnchorPoint()¶

returns anchor point on circle for radius dimension.

rtype

gp_Pnt

Circle()¶

returns measured geometry circle.

rtype

gp_Circ

static DownCast(t)¶

GetTextPosition()¶

Return type: gp_Pnt

SetDisplayUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetMeasuredGeometry()¶

Measure radius of the circle. The dimension will become invalid if the radius of the circle is less than Precision::Confusion(). @param theCircle [in] the circle to measure.

param theCircle

type theCircle

gp_Circ

rtype

None* Measure radius of the circle and orient the dimension so the dimension lines attaches to anchor point on the circle. The dimension will become invalid if the radius of the circle is less than Precision::Confusion(). @param theCircle [in] the circle to measure. @param theAnchorPoint [in] the point to attach the dimension lines, should be on the circle @param theHasAnchor [in] should be set True if theAnchorPoint should be used

param theCircle

type theCircle

gp_Circ

param theAnchorPoint

type theAnchorPoint

gp_Pnt

param theHasAnchor

default value is Standard_True

type theHasAnchor

bool

rtype

None* Measure radius on the passed shape, if applicable. The dimension will become invalid if the passed shape is not measurable or if measured diameter value is less than Precision::Confusion(). @param theShape [in] the shape to measure.

param theShape

type theShape

TopoDS_Shape

rtype

None* Measure radius on the passed shape, if applicable. The dimension will become invalid if the passed shape is not measurable or if measured diameter value is less than Precision::Confusion(). @param theShape [in] the shape to measure. @param theAnchorPoint [in] the point to attach the dimension lines, should be on the circle @param theHasAnchor [in] should be set True if theAnchorPoint should be used

param theShape

type theShape

TopoDS_Shape

param theAnchorPoint

type theAnchorPoint

gp_Pnt

param theHasAnchor

default value is Standard_True

type theHasAnchor

bool

rtype

None

SetModelUnits()¶

Parameters

theUnits –

type theUnits: TCollection_AsciiString
rtype: void

SetTextPosition()¶

Parameters

theTextPos –

type theTextPos: gp_Pnt
rtype: void

Shape()¶

returns the measured shape.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class AIS_Relation(*args, **kwargs)¶

Empty constructor

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

AcceptDisplayMode()¶

Returns true if the display mode aMode is accepted for the Interactive Objects in the relation. ComputeProjPresentation(me; aPresPresentation from Prs3d; Curve1Curve from Geom; Curve2Curve from Geom; FirstP1Pnt from gp; LastP1Pnt from gp; FirstP2Pnt from gp; LastP2Pnt from gp; aColorNameOfColor from Quantity = Quantity_NOC_PURPLE; aWidthReal from Standard = 2; aProjTOLTypeOfLine from Aspect = Aspect_TOL_DASH; aCallTOLTypeOfLine from Aspect = Aspect_TOL_DOT)

param aMode

type aMode

int

rtype

bool

ArrowSize()¶

Returns the value for the size of the arrow identifying the relation between the two shapes.

rtype

float

AutomaticPosition()¶

Return type: bool

static DownCast(t)¶

ExtShape()¶

Returns the status index of the extension shape.

rtype

int

FirstShape()¶

Return type: TopoDS_Shape

IsMovable()¶

Returns true if the interactive object is movable.

rtype

bool

KindOfDimension()¶

Indicates that the type of dimension is unknown.

rtype

AIS_KindOfDimension

Plane()¶

Returns the plane.

rtype

opencascade::handle<Geom_Plane>

Position()¶

Returns the position set using SetPosition.

rtype

gp_Pnt

SecondShape()¶

Returns the second shape.

rtype

TopoDS_Shape

SetArrowSize()¶

Allows you to provide settings for the size of the arrow theArrowSize identifying the relation between the two shapes.

param theArrowSize

type theArrowSize

float

rtype

None

SetAutomaticPosition()¶

Parameters

theStatus –

type theStatus: bool
rtype: None

SetBndBox()¶

Parameters

theXmin –

type theXmin: float
param theYmin
type theYmin: float
param theZmin
type theZmin: float
param theXmax
type theXmax: float
param theYmax
type theYmax: float
param theZmax
type theZmax: float
rtype: None

SetColor()¶

Allows you to provide settings for the color theColor of the lines representing the relation between the two shapes.

param theColor

type theColor

Quantity_Color

rtype

None

SetExtShape()¶

Allows you to set the status of the extension shape by the index aIndex. The status will be one of the following: - 0 - there is no connection to a shape; - 1 - there is a connection to the first shape; - 2 - there is a connection to the second shape.

param theIndex

type theIndex

int

rtype

None

SetFirstShape()¶

Parameters

aFShape –

type aFShape: TopoDS_Shape
rtype: void

SetPlane()¶

Allows you to set the plane thePlane. This is used to define relations and dimensions in several daughter classes.

param thePlane

type thePlane

Geom_Plane

rtype

None

SetPosition()¶

Allows you to provide the objects in the relation with settings for a non-default position.

param thePosition

type thePosition

gp_Pnt

rtype

None

SetSecondShape()¶

Allows you to identify the second shape aSShape relative to the first.

param aSShape

type aSShape

TopoDS_Shape

rtype

void

SetSymbolPrs()¶

Allows you to provide settings for the symbol presentation.

param theSymbolPrs

type theSymbolPrs

DsgPrs_ArrowSide

rtype

None

SetText()¶

Allows you to provide the settings theText for text aspect.

param theText

type theText

TCollection_ExtendedString

rtype

None

SetValue()¶

Allows you to provide settings for the value theVal for each object in the relation.

param theVal

type theVal

float

rtype

None

SymbolPrs()¶

Returns the value of the symbol presentation. This will be one of: - AS_NONE - none - AS_FIRSTAR - first arrow - AS_LASTAR - last arrow - AS_BOTHAR - both arrows - AS_FIRSTPT - first point - AS_LASTPT - last point - AS_BOTHPT - both points - AS_FIRSTAR_LASTPT - first arrow, last point - AS_FIRSTPT_LASTAR - first point, last arrow

rtype

DsgPrs_ArrowSide

Text()¶

Returns settings for text aspect.

rtype

TCollection_ExtendedString

Type()¶

Return type: AIS_KindOfInteractive

UnsetBndBox()¶

Return type: None

UnsetColor()¶

Allows you to remove settings for the color of the lines representing the relation between the two shapes.

rtype

None

Value()¶

Returns the value of each object in the relation.

rtype

float

property thisown¶: The membership flag

class AIS_RubberBand(*args)¶

Constructs rubber band with default configuration: empty filling and white solid lines. @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.

rtype

None* Consructs the rubber band with empty filling and defined line style. @param theLineColor [in] color of rubber band lines @param theType [in] type of rubber band lines @param theLineWidth [in] width of rubber band line. By default it is 1. @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.

param theLineColor

type theLineColor

Quantity_Color

param theType

type theType

Aspect_TypeOfLine

param theLineWidth

default value is 1.0

type theLineWidth

float

param theIsPolygonClosed

default value is Standard_True

type theIsPolygonClosed

bool

rtype

None* Constructs the rubber band with defined filling and line parameters. @param theLineColor [in] color of rubber band lines @param theType [in] type of rubber band lines @param theFillColor [in] color of rubber band filling @param theTransparency [in] transparency of the filling. 0 is for opaque filling. By default it is transparent. @param theLineWidth [in] width of rubber band line. By default it is 1. @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.

param theLineColor

type theLineColor

Quantity_Color

param theType

type theType

Aspect_TypeOfLine

param theFillColor

type theFillColor

Quantity_Color

param theTransparency

default value is 1.0

type theTransparency

float

param theLineWidth

default value is 1.0

type theLineWidth

float

param theIsPolygonClosed

default value is Standard_True

type theIsPolygonClosed

bool

rtype

None

AddPoint()¶

Adds last point to the list of points. They are used to build polygon for rubber band. @sa RemoveLastPoint(), GetPoints()

param thePoint

type thePoint

Graphic3d_Vec2i

rtype

None

ClearPoints()¶

Remove all points for the rubber band polygon.

rtype

None

static DownCast(t)¶

FillColor()¶

returns the color of rubber band filling.

rtype

Quantity_Color

FillTransparency()¶

returns fill transparency.

rtype

float

IsFilling()¶

returns true if filling of rubber band is enabled.

rtype

bool

IsPolygonClosed()¶

returns true if automatic closing of rubber band is enabled.

rtype

bool

LineColor()¶

returns the Color attributes.

rtype

Quantity_Color

LineType()¶

returns type of lines.

rtype

Aspect_TypeOfLine

LineWidth()¶

returns width of lines.

rtype

float

Points()¶

returns points for the rubber band polygon.

rtype

NCollection_Sequence<Graphic3d_Vec2i>

RemoveLastPoint()¶

Remove last point from the list of points for the rubber band polygon. @sa AddPoint(), GetPoints()

rtype

None

SetFillColor()¶

Sets color of rubber band filling.

param theColor

type theColor

Quantity_Color

rtype

None

SetFillTransparency()¶

Sets fill transparency. @param theValue [in] the transparency value. 1.0 is for transparent background

param theValue

type theValue

float

rtype

None

SetFilling()¶

Enable or disable filling of rubber band.

param theIsFilling

type theIsFilling

bool

rtype

None* Enable filling of rubber band with defined parameters. @param theColor [in] color of filling @param theTransparency [in] transparency of the filling. 0 is for opaque filling.

param theColor

type theColor

Quantity_Color

param theTransparency

type theTransparency

float

rtype

None

SetLineColor()¶

Sets color of lines for rubber band presentation.

param theColor

type theColor

Quantity_Color

rtype

None

SetLineType()¶

Sets type of line for rubber band presentation.

param theType

type theType

Aspect_TypeOfLine

rtype

None

SetLineWidth()¶

Sets width of line for rubber band presentation.

param theWidth

type theWidth

float

rtype

None

SetPolygonClosed()¶

Automatically create an additional line connecting the first and the last screen points to close the boundary polyline

param theIsPolygonClosed

type theIsPolygonClosed

bool

rtype

None

SetRectangle()¶

Sets rectangle bounds.

param theMinX

type theMinX

int

param theMinY

type theMinY

int

param theMaxX

type theMaxX

int

param theMaxY

type theMaxY

int

rtype

None

property thisown¶: The membership flag

class AIS_Selection(*args)¶

creates a new selection.

rtype

None

AddSelect()¶

the object is always add int the selection. faster when the number of objects selected is great.

param theObject

type theObject

SelectMgr_EntityOwner

rtype

AIS_SelectStatus

Clear()¶

removes all the object of the selection.

rtype

void

ClearAndSelect()¶

clears the selection and adds the object in the selection.

param theObject

type theObject

SelectMgr_EntityOwner

rtype

None

static DownCast(t)¶

Extent()¶

Return the number of selected objects.

rtype

int

Init()¶

Start iteration through selected objects.

rtype

None

IsEmpty()¶

Return true if list of selected objects is empty.

rtype

bool

IsSelected()¶

checks if the object is in the selection.

param theObject

type theObject

SelectMgr_EntityOwner

rtype

bool

More()¶

Return true if iterator points to selected object.

rtype

bool

Next()¶

Continue iteration through selected objects.

rtype

None

Objects()¶

Return the list of selected objects.

rtype

AIS_NListOfEntityOwner

Select()¶

if the object is not yet in the selection, it will be added. if the object is already in the selection, it will be removed.

param theObject

type theObject

SelectMgr_EntityOwner

rtype

AIS_SelectStatus

Value()¶

Return selected object at iterator position.

rtype

opencascade::handle<SelectMgr_EntityOwner>

property thisown¶: The membership flag

class AIS_SequenceOfDimension(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class AIS_SequenceOfInteractive(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class AIS_Shape(*args)¶

Initializes construction of the shape shap from wires, edges and vertices.

param shap

type shap

TopoDS_Shape

rtype

None

AcceptDisplayMode()¶

Return true if specified display mode is supported.

param theMode

type theMode

int

rtype

bool

AcceptShapeDecomposition()¶

Returns true if the Interactive Object accepts shape decomposition.

rtype

bool

BoundingBox()¶

Constructs a bounding box with which to reconstruct compound topological shapes for presentation.

rtype

Bnd_Box

Color()¶

Returns the Color attributes of the shape accordingly to the current facing model;

param aColor

type aColor

Quantity_Color

rtype

void

static DownCast(t)¶

OwnDeviationAngle()¶

Returns true and the values of the deviation angle anAngle and the previous deviation angle aPreviousAngle. If these values are not already set, false is returned.

param anAngle

type anAngle

float

param aPreviousAngle

type aPreviousAngle

float

rtype

bool

OwnDeviationCoefficient()¶

Returns true and the values of the deviation coefficient aCoefficient and the previous deviation coefficient aPreviousCoefficient. If these values are not already set, false is returned.

param aCoefficient

type aCoefficient

float

param aPreviousCoefficient

type aPreviousCoefficient

float

rtype

bool

OwnHLRDeviationAngle()¶

Returns true and the values of the HLR deviation angle anAngle and of the previous HLR deviation angle aPreviousAngle. If these values are not already set, false is returned.

param anAngle

type anAngle

float

param aPreviousAngle

type aPreviousAngle

float

rtype

bool

OwnHLRDeviationCoefficient()¶

Returns true and the values of the HLR deviation coefficient aCoefficient and the previous HLR deviation coefficient aPreviousCoefficient. If these values are not already set, false is returned.

param aCoefficient

type aCoefficient

float

param aPreviousCoefficient

type aPreviousCoefficient

float

rtype

bool

static SelectionMode()¶

Return selection mode for specified shape type.

param theShapeType

type theShapeType

TopAbs_ShapeEnum

rtype

int

static SelectionType()¶

Return shape type for specified selection mode.

param theSelMode

type theSelMode

int

rtype

TopAbs_ShapeEnum

Set()¶

Alias for ::SetShape().

param theShape

type theShape

TopoDS_Shape

rtype

None

SetAngleAndDeviation()¶

this compute a new angle and Deviation from the value anAngle and set the values stored in myDrawer with these that become local to the shape

param anAngle

type anAngle

float

rtype

None

SetColor()¶

Sets the color aColor in the reconstructed compound shape. Acts via the Drawer methods below on the appearance of: - free boundaries: Prs3d_Drawer_FreeBoundaryAspect, - isos: Prs3d_Drawer_UIsoAspect, Prs3dDrawer_VIsoAspect, - shared boundaries: Prs3d_Drawer_UnFreeBoundaryAspect, - shading: Prs3d_Drawer_ShadingAspect, - visible line color in hidden line mode: Prs3d_Drawer_SeenLineAspect - hidden line color in hidden line mode: Prs3d_Drawer_HiddenLineAspect.

param theColor

type theColor

Quantity_Color

rtype

void

SetHLRAngleAndDeviation()¶

this compute a new Angle and Deviation from the value anAngle for HLR and set the values stored in myDrawer for with these that become local to the shape

param anAngle

type anAngle

float

rtype

None

SetOwnDeviationAngle()¶

Sets a local value for deviation angle for this specific shape.

rtype

bool* sets myOwnDeviationAngle field in Prs3d_Drawer & recomputes presentation

param anAngle

type anAngle

float

rtype

None

SetOwnDeviationCoefficient()¶

Sets a local value for deviation coefficient for this specific shape.

rtype

bool* Sets a local value for deviation coefficient for this specific shape.

param aCoefficient

type aCoefficient

float

rtype

None

SetOwnHLRDeviationAngle()¶

Sets a local value for HLR deviation angle for this specific shape.

rtype

bool* sets myOwnHLRDeviationAngle field in Prs3d_Drawer & recomputes presentation

param anAngle

type anAngle

float

rtype

None

SetOwnHLRDeviationCoefficient()¶

Sets a local value for HLR deviation coefficient for this specific shape.

rtype

bool* sets myOwnHLRDeviationCoefficient field in Prs3d_Drawer & recomputes presentation

param aCoefficient

type aCoefficient

float

rtype

None

SetShape()¶

Constructs an instance of the shape object theShape.

param theShape

type theShape

TopoDS_Shape

rtype

None

SetTextureOriginUV()¶

Use this method to change the origin of the texture. The texel (0,0) will be mapped to the surface (myUVOrigin.X(), myUVOrigin.Y()).

param theOriginUV

type theOriginUV

gp_Pnt2d

rtype

None

SetTextureRepeatUV()¶

Sets the number of occurrences of the texture on each face. The texture itself is parameterized in (0,1) by (0,1). Each face of the shape to be textured is parameterized in UV space (Umin,Umax) by (Vmin,Vmax).

param theRepeatUV

type theRepeatUV

gp_Pnt2d

rtype

None

SetTextureScaleUV()¶

Use this method to scale the texture (percent of the face). You can specify a scale factor for both U and V. Example: if you set ScaleU and ScaleV to 0.5 and you enable texture repeat, the texture will appear twice on the face in each direction.

param theScaleUV

type theScaleUV

gp_Pnt2d

rtype

None

SetTypeOfHLR()¶

Sets the type of HLR algorithm used by the shape

param theTypeOfHLR

type theTypeOfHLR

Prs3d_TypeOfHLR

rtype

None

SetWidth()¶

Sets the value aValue for line width in the reconstructed compound shape. Changes line aspects for lines presentation.

param aValue

type aValue

float

rtype

void

Shape()¶

Returns this shape object.

rtype

TopoDS_Shape

Signature()¶

Returns index 0. This value refers to SHAPE from TopAbs_ShapeEnum

rtype

int

TextureOriginUV()¶

Return texture origin UV position; (0, 0) by default.

rtype

gp_Pnt2d

TextureRepeatUV()¶

@name methods to alter texture mapping properties Return texture repeat UV values; (1, 1) by default.

rtype

gp_Pnt2d

TextureScaleUV()¶

Return scale factor for UV coordinates; (1, 1) by default.

rtype

gp_Pnt2d

Transparency()¶

Returns the transparency attributes of the shape accordingly to the current facing model;

rtype

float

Type()¶

Returns Object as the type of Interactive Object.

rtype

AIS_KindOfInteractive

TypeOfHLR()¶

Gets the type of HLR algorithm

rtype

Prs3d_TypeOfHLR

UnsetColor()¶

Removes settings for color in the reconstructed compound shape.

rtype

void

UnsetWidth()¶

Removes the setting for line width in the reconstructed compound shape.

rtype

void

UserAngle()¶

gives back the angle initial value put by the User.

rtype

float

static computeHlrPresentation()¶

Compute HLR presentation for specified shape.

param theProjector

type theProjector

Prs3d_Projector

param thePrs

type thePrs

Prs3d_Presentation

param theShape

type theShape

TopoDS_Shape

param theDrawer

type theDrawer

Prs3d_Drawer

rtype

void

property thisown¶: The membership flag

class AIS_SignatureFilter(*args)¶

Bases: OCC.Core.AIS.AIS_TypeFilter

Initializes the signature filter, adding the signature specification, aGivenSignature, to that for type, aGivenKind, in AIS_TypeFilter.

param aGivenKind

type aGivenKind

AIS_KindOfInteractive

param aGivenSignature

type aGivenSignature

int

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_SymmetricRelation(*args)¶

Constructs an object to display constraints of symmetricity. This object is defined by a tool aSymmTool, a first shape FirstShape, a second shape SecondShape, and a plane aPlane. aPlane serves as the axis of symmetry. aSymmTool is the shape composed of FirstShape SecondShape and aPlane. It may be queried and edited using the functions GetTool and SetTool. The two shapes are typically two edges, two vertices or two points.

param aSymmTool

type aSymmTool

TopoDS_Shape

param FirstShape

type FirstShape

TopoDS_Shape

param SecondShape

type SecondShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

GetTool()¶

Returns the tool composed of a first shape, a second shape, and a plane. This tool is created at construction time.

rtype

TopoDS_Shape

SetTool()¶

Sets the tool aSymmetricTool composed of a first shape, a second shape, and a plane. This tool is initially created at construction time.

param aSymmetricTool

type aSymmetricTool

TopoDS_Shape

rtype

None

property thisown¶: The membership flag

class AIS_TangentRelation(*args)¶

TwoFacesTangent or TwoEdgesTangent relation Constructs an object to display tangency constraints. This object is defined by the first shape aFShape, the second shape aSShape, the plane aPlane and the index anExternRef. aPlane serves as an optional axis. anExternRef set to 0 indicates that there is no relation.

param aFShape

type aFShape

TopoDS_Shape

param aSShape

type aSShape

TopoDS_Shape

param aPlane

type aPlane

Geom_Plane

param anExternRef

default value is 0

type anExternRef

int

rtype

None

Compute()¶

computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can’t be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!!

param aProjector

type aProjector

Prs3d_Projector

param aTrsf

type aTrsf

Geom_Transformation

param aPresentation

type aPresentation

Prs3d_Presentation

rtype

void

static DownCast(t)¶

ExternRef()¶

Returns the external reference for tangency. The values are as follows: - 0 - there is no connection; - 1 - there is a connection to the first shape; - 2 - there is a connection to the second shape. This reference is defined at construction time.

rtype

int

SetExternRef()¶

Sets the external reference for tangency, aRef. The values are as follows: - 0 - there is no connection; - 1 - there is a connection to the first shape; - 2 - there is a connection to the second shape. This reference is initially defined at construction time.

param aRef

type aRef

int

rtype

None

property thisown¶: The membership flag

class AIS_TextLabel(*args)¶

Default constructor

rtype

None

static DownCast(t)¶

HasFlipping()¶

Return type: bool

HasOrientation3D()¶

Returns true if the current text placement mode uses text orientation in the model 3D space.

rtype

bool

Orientation3D()¶

Returns label orientation in the model 3D space.

rtype

gp_Ax2

Position()¶

Returns position.

rtype

gp_Pnt

SetAngle()¶

Setup angle.

param theAngle

type theAngle

float

rtype

None

SetColor()¶

Setup color of entire text.

param theColor

type theColor

Quantity_Color

rtype

void

SetColorSubTitle()¶

Modifies the colour of the subtitle for the TODT_SUBTITLE TextDisplayType and the colour of backgroubd for the TODT_DEKALE TextDisplayType.

param theColor

type theColor

Quantity_Color

rtype

None

SetDisplayType()¶

Define the display type of the text. //! TODT_NORMAL Default display. Text only. TODT_SUBTITLE There is a subtitle under the text. TODT_DEKALE The text is displayed with a 3D style. TODT_BLEND The text is displayed in XOR. TODT_DIMENSION Dimension line under text will be invisible.

param theDisplayType

type theDisplayType

Aspect_TypeOfDisplayText

rtype

None

SetFlipping()¶

Parameters

theIsFlipping –

type theIsFlipping: bool
rtype: None

SetFont()¶

Setup font.

param theFont

type theFont

char *

rtype

None

SetFontAspect()¶

Setup font aspect.

param theFontAspect

type theFontAspect

Font_FontAspect

rtype

None

SetHJustification()¶

Setup horizontal justification.

param theHJust

type theHJust

Graphic3d_HorizontalTextAlignment

rtype

None

SetHeight()¶

Setup height.

param theHeight

type theHeight

float

rtype

None

SetOrientation3D()¶

Setup label orientation in the model 3D space.

param theOrientation

type theOrientation

gp_Ax2

rtype

None

SetPosition()¶

Setup position.

param thePosition

type thePosition

gp_Pnt

rtype

None

SetText()¶

Setup text.

param theText

type theText

TCollection_ExtendedString

rtype

None

SetVJustification()¶

Setup vertical justification.

param theVJust

type theVJust

Graphic3d_VerticalTextAlignment

rtype

None

SetZoomable()¶

Setup zoomable property.

param theIsZoomable

type theIsZoomable

bool

rtype

None

UnsetOrientation3D()¶

Reset label orientation in the model 3D space.

rtype

None

property thisown¶: The membership flag

class AIS_TexturedShape(*args)¶

Bases: OCC.Core.AIS.AIS_Shape

@name main methods Initializes the textured shape.

param theShape

type theShape

TopoDS_Shape

rtype

None

AcceptDisplayMode()¶

Return true if specified display mode is supported (extends AIS_Shape with Display Mode 3).

param theMode

type theMode

int

rtype

bool

DisableTextureModulate()¶

Disables texture modulation

rtype

None

static DownCast(t)¶

EnableTextureModulate()¶

Enables texture modulation

rtype

None

SetTextureFileName()¶

Sets the texture source. <theTextureFileName> can specify path to texture image or one of the standard predefined textures. The accepted file types are those used in Image_AlienPixMap with extensions such as rgb, png, jpg and more. To specify the standard predefined texture, the <theTextureFileName> should contain integer - the Graphic3d_NameOfTexture2D enumeration index. Setting texture source using this method resets the source pixmap (if was set previously).

param theTextureFileName

type theTextureFileName

TCollection_AsciiString

rtype

void

SetTextureMapOff()¶

Disables texture mapping

rtype

None

SetTextureMapOn()¶

Enables texture mapping

rtype

None

SetTextureOrigin()¶

Use this method to change the origin of the texture. The texel (0,0) will be mapped to the surface (UOrigin,VOrigin)

param theToSetTextureOrigin

type theToSetTextureOrigin

bool

param theUOrigin

default value is 0.0

type theUOrigin

float

param theVOrigin

default value is 0.0

type theVOrigin

float

rtype

None

SetTexturePixMap()¶

Sets the texture source. <theTexturePixMap> specifies image data. Please note that the data should be in Bottom-Up order, the flag of Image_PixMap::IsTopDown() will be ignored by graphic driver. Setting texture source using this method resets the source by filename (if was set previously).

param theTexturePixMap

type theTexturePixMap

Image_PixMap

rtype

void

SetTextureRepeat()¶

Sets the number of occurrences of the texture on each face. The texture itself is parameterized in (0,1) by (0,1). Each face of the shape to be textured is parameterized in UV space (Umin,Umax) by (Vmin,Vmax). If RepeatYN is set to false, texture coordinates are clamped in the range (0,1)x(0,1) of the face.

param theToRepeat

type theToRepeat

bool

param theURepeat

default value is 1.0

type theURepeat

float

param theVRepeat

default value is 1.0

type theVRepeat

float

rtype

None

SetTextureScale()¶

Use this method to scale the texture (percent of the face). You can specify a scale factor for both U and V. Example: if you set ScaleU and ScaleV to 0.5 and you enable texture repeat, the texture will appear twice on the face in each direction.

param theToSetTextureScale

type theToSetTextureScale

bool

param theScaleU

default value is 1.0

type theScaleU

float

param theScaleV

default value is 1.0

type theScaleV

float

rtype

None

TextureFile()¶

returns path to the texture file

rtype

char *

TextureMapState()¶

returns flag to control texture mapping (for presentation mode 3)

rtype

bool

TextureModulate()¶

returns true if texture color modulation is turned on

rtype

bool

TextureOrigin()¶

returns true if texture UV origin has been modified

rtype

bool

TexturePixMap()¶

returns the source pixmap for texture map

rtype

opencascade::handle<Image_PixMap>

TextureRepeat()¶

returns texture repeat flag

rtype

bool

TextureScale()¶

returns true if scale factor should be applied to texture mapping

rtype

bool

TextureScaleU()¶

returns scale factor for U coordinate (1.0 by default)

rtype

float

TextureScaleV()¶

returns scale factor for V coordinate (1.0 by default)

rtype

float

TextureUOrigin()¶

returns texture origin U position (0.0 by default)

rtype

float

TextureVOrigin()¶

returns texture origin V position (0.0 by default)

rtype

float

URepeat()¶

returns texture repeat U value

rtype

float

UpdateAttributes()¶

@name methods to alter texture mapping properties Use this method to display the textured shape without recomputing the whole presentation. Use this method when ONLY the texture content has been changed. If other parameters (ie: scale factors, texture origin, texture repeat…) have changed, the whole presentation has to be recomputed: @code if (myShape->DisplayMode() == 3) { myAISContext->RecomputePrsOnly (myShape); } else { myAISContext->SetDisplayMode (myShape, 3, Standard_False); myAISContext->Display (myShape, Standard_True); } @endcode

rtype

None

VRepeat()¶

returns texture repeat V value

rtype

float

property thisown¶: The membership flag

class AIS_Triangulation(*args)¶

Constructs the Triangulation display object

param aTriangulation

type aTriangulation

Poly_Triangulation

rtype

None

static DownCast(t)¶

GetColors()¶

Get the color for each node. Each 32-bit color is Alpha << 24 + Blue << 16 + Green << 8 + Red

rtype

opencascade::handle<TColStd_HArray1OfInteger>

GetTriangulation()¶

Returns Poly_Triangulation .

rtype

opencascade::handle<Poly_Triangulation>

HasVertexColors()¶

Returns true if triangulation has vertex colors.

rtype

bool

SetColors()¶

Set the color for each node. Each 32-bit color is Alpha << 24 + Blue << 16 + Green << 8 + Red Order of color components is essential for further usage by OpenGL

param aColor

type aColor

TColStd_HArray1OfInteger

rtype

None

SetTriangulation()¶

Parameters

aTriangulation –

type aTriangulation: Poly_Triangulation
rtype: None

property thisown¶: The membership flag

class AIS_Trihedron(*args)¶

Initializes a trihedron entity.

param theComponent

type theComponent

Geom_Axis2Placement

rtype

None

AcceptDisplayMode()¶

Returns true if the display mode selected, aMode, is valid for trihedron datums.

param theMode

type theMode

int

rtype

bool

ArrowColor()¶

Returns trihedron arrow color

rtype

Quantity_Color

Component()¶

Returns the right-handed coordinate system set in SetComponent.

rtype

opencascade::handle<Geom_Axis2Placement>

DatumDisplayMode()¶

Returns datum display mode.

rtype

Prs3d_DatumMode

DatumPartColor()¶

Returns color of datum part: origin or some of trihedron axes.

param thePart

type thePart

Prs3d_DatumParts

rtype

Quantity_Color

static DownCast(t)¶

HasArrowColor()¶

Returns true if trihedron has own arrow color

rtype

bool

HasOwnSize()¶

Returns true if the trihedron object has a size other than the default size of 100 mm. along each axis.

rtype

bool

HasTextColor()¶

Returns true if trihedron has own text color

rtype

bool

IsAutoHilight()¶

Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods.

rtype

bool

Label()¶

Returns text of axis. Parameter thePart should be XAxis, YAxis or ZAxis

param thePart

type thePart

Prs3d_DatumParts

rtype

TCollection_ExtendedString

SelectionPriority()¶

Sets priority of selection for owner of the given type

param thePart

type thePart

Prs3d_DatumParts

rtype

int

SetArrowColor()¶

Sets color of arrow of trihedron axes. Used only in wireframe mode

param theColor

type theColor

Quantity_Color

rtype

None

SetAxisColor()¶

Sets color of z-axis. //Standard_DEPRECATED(‘This method is deprecated - SetColor() should be called instead’)

param theColor

type theColor

Quantity_Color

rtype

None

SetColor()¶

Sets the color theColor for this trihedron object, it changes color of axes.

param theColor

type theColor

Quantity_Color

rtype

None

SetComponent()¶

Constructs the right-handed coordinate system aComponent.

param theComponent

type theComponent

Geom_Axis2Placement

rtype

None

SetDatumDisplayMode()¶

Sets Shading or Wireframe display mode, triangle or segment graphic group is used relatively.

param theMode

type theMode

Prs3d_DatumMode

rtype

None

SetDatumPartColor()¶

Sets color of datum part: origin or some of trihedron axes. If presentation is shading mode, this color is set for both sides of facing model

param thePart

type thePart

Prs3d_DatumParts

param theColor

type theColor

Quantity_Color

rtype

None

SetDrawArrows()¶

Sets whether to draw the arrows in visualization

param theToDraw

type theToDraw

bool

rtype

None

SetLabel()¶

Sets text label for trihedron axis. Parameter thePart should be XAxis, YAxis or ZAxis

param thePart

type thePart

Prs3d_DatumParts

param thePriority

type thePriority

TCollection_ExtendedString

rtype

None

SetOriginColor()¶

Sets color of origin. //Standard_DEPRECATED(‘This method is deprecated - SetColor() should be called instead’)

param theColor

type theColor

Quantity_Color

rtype

None

SetSelectionPriority()¶

Sets priority of selection for owner of the given type

param thePart

type thePart

Prs3d_DatumParts

param thePriority

type thePriority

int

rtype

None

SetSize()¶

Sets the size aValue for the trihedron object. The default value is 100 mm.

param theValue

type theValue

float

rtype

None

SetTextColor()¶

Sets color of label of trihedron axes.

param theColor

type theColor

Quantity_Color

rtype

None

SetXAxisColor()¶

Sets color of x-axis. //Standard_DEPRECATED(‘This method is deprecated - SetColor() should be called instead’)

param theColor

type theColor

Quantity_Color

rtype

None

SetYAxisColor()¶

Sets color of y-axis. //Standard_DEPRECATED(‘This method is deprecated - SetColor() should be called instead’)

param theColor

type theColor

Quantity_Color

rtype

None

Signature()¶

Returns index 3, selection of the planes XOY, YOZ, XOZ.

rtype

int

Size()¶

Return type: float

TextColor()¶

Returns trihedron text color

rtype

Quantity_Color

ToDrawArrows()¶

Returns true if arrows are to be drawn

rtype

bool

Type()¶

Indicates that the type of Interactive Object is datum.

rtype

AIS_KindOfInteractive

UnsetColor()¶

Removes the settings for color.

rtype

void

UnsetSize()¶

Removes any non-default settings for size of this trihedron object. If the object has 1 color, the default size of the drawer is reproduced, otherwise DatumAspect becomes null.

rtype

None

property thisown¶: The membership flag

class AIS_TrihedronOwner(*args)¶

Creates an owner of AIS_Trihedron object.

param theSelObject

type theSelObject

SelectMgr_SelectableObject

param theDatumPart

type theDatumPart

Prs3d_DatumParts

param thePriority

type thePriority

int

rtype

None

DatumPart()¶

Returns the datum part identifier.

rtype

Prs3d_DatumParts

static DownCast(t)¶

IsHilighted()¶

Returns true if the presentation manager thePM highlights selections corresponding to the selection mode aMode.

param thePM

type thePM

PrsMgr_PresentationManager

param theMode

type theMode

int

rtype

bool

Unhilight()¶

Removes highlighting from the owner of a detected selectable object in the presentation manager thePM.

param thePM

type thePM

PrsMgr_PresentationManager

param theMode

type theMode

int

rtype

void

property thisown¶: The membership flag

class AIS_TypeFilter(*args)¶

Initializes filter for type, aGivenKind.

param aGivenKind

type aGivenKind

AIS_KindOfInteractive

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class AIS_ViewController(*args)¶

Bases: object

Empty constructor.

rtype

None

AbortViewAnimation()¶

Interrupt active view animation.

rtype

None

AddTouchPoint()¶

Add touch point with the given ID. This method is expected to be called from UI thread. @param theId touch unique identifier @param thePnt touch coordinates @param theClearBefore if True previously registered touches will be removed

param theId

type theId

Standard_Size

param thePnt

type thePnt

Graphic3d_Vec2d

param theClearBefore

default value is false

type theClearBefore

bool

rtype

void

ChangeInputBuffer()¶

Return input buffer.

param theType

type theType

AIS_ViewInputBufferType

rtype

AIS_ViewInputBuffer

ChangeKeys()¶

Return keyboard state.

rtype

Aspect_VKeySet

ChangeMouseGestureMap()¶

Return map defining mouse gestures.

rtype

AIS_MouseGestureMap

EventTime()¶

Return event time (e.g. current time).

rtype

double

FetchNavigationKeys()¶

Fetch active navigation actions.

param theCrouchRatio

type theCrouchRatio

float

param theRunRatio

type theRunRatio

float

rtype

AIS_WalkDelta

FlushViewEvents()¶

Update buffer for rendering thread. This method is expected to be called within synchronization barrier between GUI and Rendering threads (e.g. GUI thread should be locked beforehand to avoid data races). @param theCtx interactive context @param theView active view @param theToHandle if True, the HandleViewEvents() will be called

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

param theToHandle

default value is Standard_False

type theToHandle

bool

rtype

void

GravityPoint()¶

Compute rotation gravity center point depending on rotation mode. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

rtype

gp_Pnt

HandleViewEvents()¶

Process events within rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

rtype

void

HasPreviousMoveTo()¶

Return True if previous position of MoveTo has been defined.

rtype

bool

HasTouchPoints()¶

Return True if touches map is not empty.

rtype

bool

InputBuffer()¶

Return input buffer.

param theType

type theType

AIS_ViewInputBufferType

rtype

AIS_ViewInputBuffer

KeyDown()¶

Press key. @param theKey key pressed @param theTime event timestamp

param theKey

type theKey

Aspect_VKey

param theTime

type theTime

double

param thePressure

default value is 1.0

type thePressure

double

rtype

void

KeyFromAxis()¶

Simulate key up/down events from axis value.

param theNegative

type theNegative

Aspect_VKey

param thePositive

type thePositive

Aspect_VKey

param theTime

type theTime

double

param thePressure

type thePressure

double

rtype

void

KeyUp()¶

Release key. @param theKey key pressed @param theTime event timestamp

param theKey

type theKey

Aspect_VKey

param theTime

type theTime

double

rtype

void

Keys()¶

@name keyboard input Return keyboard state.

rtype

Aspect_VKeySet

LastMouseFlags()¶

Return active key modifiers passed with last mouse event.

rtype

Aspect_VKeyFlags

LastMousePosition()¶

Return last mouse position.

rtype

Graphic3d_Vec2i

MinZoomDistance()¶

Return minimal camera distance for zoom operation.

rtype

double

MouseAcceleration()¶

Return mouse input acceleration ratio in First Person mode; 1.0 by default.

rtype

float

MouseDoubleClickInterval()¶

Return double click interval in seconds; 0.4 by default.

rtype

double

MouseGestureMap()¶

@name mouse input Return map defining mouse gestures.

rtype

AIS_MouseGestureMap

NavigationMode()¶

Return camera navigation mode; AIS_NavigationMode_Orbit by default.

rtype

AIS_NavigationMode

OnObjectDragged()¶

Callback called by handleMoveTo() on dragging object in 3D Viewer. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

param theAction

type theAction

AIS_DragAction

rtype

void

OnSelectionChanged()¶

Callback called by handleMoveTo() on Selection in 3D Viewer. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

rtype

void

OrbitAcceleration()¶

Return orbit rotation acceleration ratio; 1.0 by default.

rtype

float

PickPoint()¶

Pick closest point under mouse cursor. This method is expected to be called from rendering thread. @param thePnt [out] result point @param theCtx [in] interactive context @param theView [in] active view @param theCursor [in] mouse cursor @param theToStickToPickRay [in] when True, the result point will lie on picking ray returns True if result has been found

param thePnt

type thePnt

gp_Pnt

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

param theCursor

type theCursor

Graphic3d_Vec2i

param theToStickToPickRay

type theToStickToPickRay

bool

rtype

bool

PressMouseButton()¶

Handle mouse button press event. This method is expected to be called from UI thread. @param thePoint mouse cursor position @param theButton pressed button @param theModifiers key modifiers @param theIsEmulated if True then mouse event comes NOT from real mouse but emulated from non-precise input like touch on screen returns True if View should be redrawn

param thePoint

type thePoint

Graphic3d_Vec2i

param theButton

type theButton

Aspect_VKeyMouse

param theModifiers

type theModifiers

Aspect_VKeyFlags

param theIsEmulated

type theIsEmulated

bool

rtype

bool

PressedMouseButtons()¶

Return currently pressed mouse buttons.

rtype

Aspect_VKeyMouse

PreviousMoveTo()¶

Return previous position of MoveTo event in 3D viewer.

rtype

Graphic3d_Vec2i

ReleaseMouseButton()¶

Handle mouse button release event. This method is expected to be called from UI thread. @param thePoint mouse cursor position @param theButton released button @param theModifiers key modifiers @param theIsEmulated if True then mouse event comes NOT from real mouse but emulated from non-precise input like touch on screen returns True if View should be redrawn

param thePoint

type thePoint

Graphic3d_Vec2i

param theButton

type theButton

Aspect_VKeyMouse

param theModifiers

type theModifiers

Aspect_VKeyFlags

param theIsEmulated

type theIsEmulated

bool

rtype

bool

RemoveTouchPoint()¶

Remove touch point with the given ID. This method is expected to be called from UI thread. @param theId touch unique identifier @param theClearSelectPnts if True will initiate clearing of selection points returns True if point has been removed

param theId

type theId

Standard_Size

param theClearSelectPnts

default value is false

type theClearSelectPnts

bool

rtype

bool

ResetPreviousMoveTo()¶

Reset previous position of MoveTo.

rtype

None

ResetViewInput()¶

Reset input state (pressed keys, mouse buttons, etc.) e.g. on window focus loss. This method is expected to be called from UI thread.

rtype

void

RotationMode()¶

@name global parameters Return camera rotation mode, AIS_RotationMode_BndBoxActive by default.

rtype

AIS_RotationMode

SelectInViewer()¶

Perform selection in 3D viewer. This method is expected to be called from UI thread. @param thePnt picking point @param theIsXOR XOR selection flag

param thePnt

type thePnt

Graphic3d_Vec2i

param theIsXOR

default value is false

type theIsXOR

bool

rtype

void* Perform selection in 3D viewer. This method is expected to be called from UI thread. @param thePnts picking point @param theIsXOR XOR selection flag

param thePnts

type thePnts

NCollection_Sequence<Graphic3d_Vec2i>

param theIsXOR

default value is false

type theIsXOR

bool

rtype

void

SetAllowDragging()¶

Set if dynamic highlight on mouse move is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowHighlight()¶

Set if dragging object is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowPanning()¶

Set if panning is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowRotation()¶

Set if camera rotation is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowTouchZRotation()¶

Set if z-rotation via two-touches gesture is enabled.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowZFocus()¶

Set if ZFocus change is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetAllowZooming()¶

Set if zooming is allowed.

param theToEnable

type theToEnable

bool

rtype

None

SetInvertPitch()¶

Set flag inverting pitch direction.

param theToInvert

type theToInvert

bool

rtype

None

SetLockOrbitZUp()¶

Set if camera up orientation within AIS_NavigationMode_Orbit rotation mode should be forced Z up.

param theToForceUp

type theToForceUp

bool

rtype

None

SetMinZoomDistance()¶

Set minimal camera distance for zoom operation.

param theDist

type theDist

double

rtype

None

SetMouseAcceleration()¶

Set mouse input acceleration ratio.

param theRatio

type theRatio

float

rtype

None

SetMouseDoubleClickInterval()¶

Set double click interval in seconds.

param theSeconds

type theSeconds

double

rtype

None

SetNavigationMode()¶

Set camera navigation mode.

param theMode

type theMode

AIS_NavigationMode

rtype

None

SetOrbitAcceleration()¶

Set orbit rotation acceleration ratio.

param theRatio

type theRatio

float

rtype

None

SetRotationMode()¶

Set camera rotation mode.

param theMode

type theMode

AIS_RotationMode

rtype

None

SetShowPanAnchorPoint()¶

Set if panning anchor point within perspective projection should be displayed in 3D Viewer.

param theToShow

type theToShow

bool

rtype

None

SetShowRotateCenter()¶

Set if rotation point should be displayed in 3D Viewer.

param theToShow

type theToShow

bool

rtype

None

SetStickToRayOnRotation()¶

Set if picked point should be projected to picking ray on rotating around point.

param theToEnable

type theToEnable

bool

rtype

None

SetStickToRayOnZoom()¶

Set if picked point should be projected to picking ray on zooming at point.

param theToEnable

type theToEnable

bool

rtype

None

SetThrustSpeed()¶

Set active thrust value.

param theSpeed

type theSpeed

float

rtype

None

SetTouchToleranceScale()¶

Set scale factor for adjusting tolerances for starting multi-touch gestures.

param theTolerance

type theTolerance

float

rtype

None

SetViewAnimation()¶

Set view animation to be handled within handleViewRedraw().

param theAnimation

type theAnimation

AIS_AnimationCamera

rtype

None

SetWalkSpeedAbsolute()¶

Set normal walking speed, in m/s; 1.5 by default.

param theSpeed

type theSpeed

float

rtype

None

SetWalkSpeedRelative()¶

Set walking speed relative to scene bounding box.

param theFactor

type theFactor

float

rtype

None

ThrustSpeed()¶

Return active thrust value; 0.0f by default.

rtype

float

ToAllowDragging()¶

Return True if dragging object is allowed; True by default.

rtype

bool

ToAllowHighlight()¶

Return True if dynamic highlight on mouse move is allowed; True by default.

rtype

bool

ToAllowPanning()¶

Return True if panning is allowed; True by default.

rtype

bool

ToAllowRotation()¶

Return True if camera rotation is allowed; True by default.

rtype

bool

ToAllowTouchZRotation()¶

Return True if z-rotation via two-touches gesture is enabled; False by default.

rtype

bool

ToAllowZFocus()¶

Return True if ZFocus change is allowed; True by default.

rtype

bool

ToAllowZooming()¶

Return True if zooming is allowed; True by default.

rtype

bool

ToInvertPitch()¶

Return True if pitch direction should be inverted while processing Aspect_VKey_NavLookUp/Aspect_VKey_NavLookDown; False by default.

rtype

bool

ToLockOrbitZUp()¶

Return True if camera up orientation within AIS_NavigationMode_Orbit rotation mode should be forced Z up; False by default.

rtype

bool

ToShowPanAnchorPoint()¶

Return True if panning anchor point within perspective projection should be displayed in 3D Viewer; True by default.

rtype

bool

ToShowRotateCenter()¶

Return True if rotation point should be displayed in 3D Viewer; True by default.

rtype

bool

ToStickToRayOnRotation()¶

Return True if picked point should be projected to picking ray on rotating around point; True by default.

rtype

bool

ToStickToRayOnZoom()¶

Return True if picked point should be projected to picking ray on zooming at point; True by default.

rtype

bool

TouchToleranceScale()¶

@name multi-touch input Return scale factor for adjusting tolerances for starting multi-touch gestures; 1.0 by default This scale factor is expected to be computed from touch screen resolution.

rtype

float

UpdateMouseButtons()¶

Handle mouse button press/release event. This method is expected to be called from UI thread. @param thePoint mouse cursor position @param theButtons pressed buttons @param theModifiers key modifiers @param theIsEmulated if True then mouse event comes NOT from real mouse but emulated from non-precise input like touch on screen returns True if View should be redrawn

param thePoint

type thePoint

Graphic3d_Vec2i

param theButtons

type theButtons

Aspect_VKeyMouse

param theModifiers

type theModifiers

Aspect_VKeyFlags

param theIsEmulated

type theIsEmulated

bool

rtype

bool

UpdateMouseClick()¶

Handle mouse button click event (emulated by UpdateMouseButtons() while releasing single button). Note that as this method is called by UpdateMouseButtons(), it should be executed from UI thread. Default implementation redirects to SelectInViewer(). This method is expected to be called from UI thread. @param thePoint mouse cursor position @param theButton clicked button @param theModifiers key modifiers @param theIsDoubleClick flag indicating double mouse click returns True if View should be redrawn

param thePoint

type thePoint

Graphic3d_Vec2i

param theButton

type theButton

Aspect_VKeyMouse

param theModifiers

type theModifiers

Aspect_VKeyFlags

param theIsDoubleClick

type theIsDoubleClick

bool

rtype

bool

UpdateMousePosition()¶

Handle mouse cursor movement event. This method is expected to be called from UI thread. @param thePoint mouse cursor position @param theButtons pressed buttons @param theModifiers key modifiers @param theIsEmulated if True then mouse event comes NOT from real mouse but emulated from non-precise input like touch on screen returns True if View should be redrawn

param thePoint

type thePoint

Graphic3d_Vec2i

param theButtons

type theButtons

Aspect_VKeyMouse

param theModifiers

type theModifiers

Aspect_VKeyFlags

param theIsEmulated

type theIsEmulated

bool

rtype

bool

UpdateMouseScroll()¶

Update mouse scroll event; redirects to UpdateZoom by default. This method is expected to be called from UI thread. @param theDelta mouse cursor position and delta returns True if new event has been created or False if existing one has been updated

param theDelta

type theDelta

Aspect_ScrollDelta

rtype

bool

UpdatePolySelection()¶

Update polygonal selection tool. This method is expected to be called from UI thread. @param thePnt new point to add to polygon @param theToAppend append new point or update the last point

param thePnt

type thePnt

Graphic3d_Vec2i

param theToAppend

type theToAppend

bool

rtype

void

UpdateRubberBand()¶

Update rectangle selection tool. This method is expected to be called from UI thread. @param thePntFrom rectangle first corner @param thePntTo rectangle another corner @param theIsXOR XOR selection flag

param thePntFrom

type thePntFrom

Graphic3d_Vec2i

param thePntTo

type thePntTo

Graphic3d_Vec2i

param theIsXOR

default value is false

type theIsXOR

bool

rtype

void

UpdateTouchPoint()¶

Update touch point with the given ID. If point with specified ID was not registered before, it will be added. This method is expected to be called from UI thread. @param theId touch unique identifier @param thePnt touch coordinates

param theId

type theId

Standard_Size

param thePnt

type thePnt

Graphic3d_Vec2d

rtype

void

UpdateViewOrientation()¶

Reset view orientation. This method is expected to be called from UI thread.

param theOrientation

type theOrientation

V3d_TypeOfOrientation

param theToFitAll

type theToFitAll

bool

rtype

void

UpdateZRotation()¶

Update Z rotation event. @param theAngle rotation angle, in radians. returns True if new zoom event has been created or False if existing one has been updated

param theAngle

type theAngle

double

rtype

bool

UpdateZoom()¶

Update zoom event (e.g. from mouse scroll). This method is expected to be called from UI thread. @param theDelta mouse cursor position to zoom at and zoom delta returns True if new zoom event has been created or False if existing one has been updated

param theDelta

type theDelta

Aspect_ScrollDelta

rtype

bool

ViewAnimation()¶

Return view animation; empty (but not NULL) animation by default.

rtype

opencascade::handle<AIS_AnimationCamera>

WalkSpeedAbsolute()¶

Return normal walking speed, in m/s; 1.5 by default.

rtype

float

WalkSpeedRelative()¶

Return walking speed relative to scene bounding box; 0.1 by default.

rtype

float

handleCameraActions()¶

Perform camera actions. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

param theWalk

type theWalk

AIS_WalkDelta

rtype

void

handleMoveTo()¶

Perform moveto/selection/dragging. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

rtype

void

handleOrbitRotation()¶

Handle orbital rotation events myGL.OrbitRotation. @param theView view to modify @param thePnt 3D point to rotate around @param theToLockZUp amend camera to exclude roll angle (put camera Up vector to plane containing global Z and view direction)

param theView

type theView

V3d_View

param thePnt

type thePnt

gp_Pnt

param theToLockZUp

type theToLockZUp

bool

rtype

void

handlePanning()¶

Handle panning event myGL.Panning.

param theView

type theView

V3d_View

rtype

void

handleViewRedraw()¶

Handle view redraw. This method is expected to be called from rendering thread.

param theCtx

type theCtx

AIS_InteractiveContext

param theView

type theView

V3d_View

rtype

void

handleViewRotation()¶

Handle view direction rotation events myGL.ViewRotation. This method is expected to be called from rendering thread. @param theView camera to modify @param theYawExtra extra yaw increment @param thePitchExtra extra pitch increment @param theRoll roll value @param theToRestartOnIncrement flag indicating flight mode

param theView

type theView

V3d_View

param theYawExtra

type theYawExtra

double

param thePitchExtra

type thePitchExtra

double

param theRoll

type theRoll

double

param theToRestartOnIncrement

type theToRestartOnIncrement

bool

rtype

void

handleZFocusScroll()¶

Handle ZScroll event myGL.ZoomActions. This method is expected to be called from rendering thread.

param theView

type theView

V3d_View

param theParams

type theParams

Aspect_ScrollDelta

rtype

void

handleZRotate()¶

Handle Z rotation event myGL.ZRotate.

param theView

type theView

V3d_View

rtype

void

handleZoom()¶

Handle zoom event myGL.ZoomActions. This method is expected to be called from rendering thread.

param theView

type theView

V3d_View

param theParams

type theParams

Aspect_ScrollDelta

param thePnt

type thePnt

gp_Pnt *

rtype

void

hasPanningAnchorPoint()¶

Return if panning anchor point has been defined.

rtype

bool

panningAnchorPoint()¶

Return active panning anchor point.

rtype

gp_Pnt

setAskNextFrame()¶

Set if another frame should be drawn right after this one.

param theToDraw

default value is true

type theToDraw

bool

rtype

None

setPanningAnchorPoint()¶

Set active panning anchor point.

param thePnt

type thePnt

gp_Pnt

rtype

None

property thisown¶: The membership flag

toAskNextFrame()¶

Return True if another frame should be drawn right after this one.

rtype

bool

class AIS_ViewCube(*args)¶

Empty constructor.

rtype

None

AcceptDisplayMode()¶

@name Presentation computation Return True for supported display mode.

param theMode

type theMode

int

rtype

bool

AxesPadding()¶

Return padding between axes and 3D part (box); 10 by default.

rtype

float

AxisLabel()¶

Return axes labels or empty string if undefined. Default labels: X, Y, Z.

param theAxis

type theAxis

Prs3d_DatumParts

rtype

TCollection_AsciiString

BoxColor()¶

Return value of front color for the 3D part of object.

rtype

Quantity_Color

BoxCornerMinSize()¶

Return minimal size of box corner; 2 by default.

rtype

float

BoxCornerStyle()¶

Return shading style of box corners.

rtype

opencascade::handle<Prs3d_ShadingAspect>

BoxEdgeGap()¶

Return gap between box edges and box sides; 0 by default.

rtype

float

BoxEdgeMinSize()¶

Return minimal size of box edge; 2 by default.

rtype

float

BoxEdgeStyle()¶

Return shading style of box edges.

rtype

opencascade::handle<Prs3d_ShadingAspect>

BoxFacetExtension()¶

Return box facet extension to edge/corner facet split; 10 by default.

rtype

float

BoxSideLabel()¶

Return box side label or empty string if undefined. Default labels: FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM.

param theSide

type theSide

V3d_TypeOfOrientation

rtype

TCollection_AsciiString

BoxSideStyle()¶

@name Style management API Return shading style of box sides.

rtype

opencascade::handle<Prs3d_ShadingAspect>

BoxTransparency()¶

Return transparency for 3D part of object.

rtype

float

Compute()¶

Compute 3D part of View Cube. @param thePrsMgr [in] presentation manager. @param thePrs [in] input presentation that is to be filled with flat presentation primitives. @param theMode [in] display mode. @warning this object accept only 0 display mode.

param thePrsMgr

type thePrsMgr

PrsMgr_PresentationManager3d

param thePrs

type thePrs

Prs3d_Presentation

param theMode

default value is 0

type theMode

int

rtype

void

ComputeSelection()¶

Redefine computing of sensitive entities for View Cube. @param theSelection [in] input selection object that is to be filled with sensitive entities. @param theMode [in] selection mode. @warning object accepts only 0 selection mode.

param theSelection

type theSelection

SelectMgr_Selection

param theMode

type theMode

int

rtype

void

Duration()¶

@name animation methods Return duration of animation in seconds; 0.5 sec by default

rtype

float

Font()¶

Return font name that is used for displaying of sides and axes text. Alias for: @code Attributes()->TextAspect()->Aspect()->SetFont() @endcode

rtype

TCollection_AsciiString

FontHeight()¶

Return height of font

rtype

float

HandleClick()¶

Perform camera transformation corresponding to the input detected owner.

param theOwner

type theOwner

AIS_ViewCubeOwner

rtype

void

HasAnimation()¶

returns True if View Cube has unfinished animation of view camera.

rtype

bool

InnerColor()¶

Return color of sides back material.

rtype

Quantity_Color

IsAutoHilight()¶

Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods.

rtype

bool

static IsBoxCorner()¶

Return True if specified orientation belongs to box corner (vertex).

param theOrient

type theOrient

V3d_TypeOfOrientation

rtype

bool

static IsBoxEdge()¶

Return True if specified orientation belongs to box edge.

param theOrient

type theOrient

V3d_TypeOfOrientation

rtype

bool

static IsBoxSide()¶

////DEFINE_STANDARD_RTTIEXT(AIS_ViewCube, AIS_InteractiveObject) Return True if specified orientation belongs to box side.

param theOrient

type theOrient

V3d_TypeOfOrientation

rtype

bool

IsFixedAnimationLoop()¶

Return True if camera animation should be done in uninterruptible loop; True by default.

rtype

bool

IsYup()¶

Return True if application expects Y-up viewer orientation instead of Z-up; False by default.

rtype

bool

ResetStyles()¶

Reset all size and style parameters to default. @warning It doesn’t reset position of View Cube

rtype

None

RoundRadius()¶

Return relative radius of side corners (round rectangle); 0.0 by default. The value in within [0, 0.5] range meaning absolute radius = RoundRadius() / Size().

rtype

float

SetAutoStartAnimation()¶

Enable/disable automatic camera transformation on selection (highlighting). The automatic logic can be disabled if application wants performing action manually basing on picking results (AIS_ViewCubeOwner).

param theToEnable

type theToEnable

bool

rtype

None

SetAxesLabels()¶

Set axes labels.

param theX

type theX

TCollection_AsciiString

param theY

type theY

TCollection_AsciiString

param theZ

type theZ

TCollection_AsciiString

rtype

None

SetAxesPadding()¶

Set new value of padding between axes and 3D part (box).

param theValue

type theValue

float

rtype

None

SetBoxColor()¶

Set new value of front color for the 3D part of object. @param theColor [in] input color value.

param theColor

type theColor

Quantity_Color

rtype

None

SetBoxCornerMinSize()¶

Set new value of box corner minimal size.

param theValue

type theValue

float

rtype

None

SetBoxEdgeGap()¶

Set new value of box edges gap.

param theValue

type theValue

float

rtype

None

SetBoxEdgeMinSize()¶

Set new value of box edge minimal size.

param theValue

type theValue

float

rtype

None

SetBoxFacetExtension()¶

Set new value of box facet extension.

param theValue

type theValue

float

rtype

None

SetBoxSideLabel()¶

Set box side label.

param theSide

type theSide

V3d_TypeOfOrientation

param theLabel

type theLabel

TCollection_AsciiString

rtype

None

SetBoxTransparency()¶

Set new value of transparency for 3D part of object. @param theValue [in] input transparency value

param theValue

type theValue

float

rtype

None

SetColor()¶

Set new value of color for the whole object. @param theColor [in] input color value.

param theColor

type theColor

Quantity_Color

rtype

None

SetDrawAxes()¶

Enable/disable drawing of trihedron.

param theValue

type theValue

bool

rtype

None

SetDrawEdges()¶

Enable/disable drawing of edges of View Cube.

param theValue

type theValue

bool

rtype

None

SetDrawVertices()¶

Enable/disable drawing of vertices (corners) of View Cube.

param theValue

type theValue

bool

rtype

None

SetDuration()¶

Set duration of animation. @param theValue [in] input value of duration in seconds

param theValue

type theValue

float

rtype

None

SetFitSelected()¶

Set if animation should fit selected objects or to fit entire scene.

param theToFitSelected

type theToFitSelected

bool

rtype

None

SetFixedAnimationLoop()¶

Set if camera animation should be done in uninterruptible loop.

param theToEnable

type theToEnable

bool

rtype

None

SetFont()¶

Set font name that is used for displaying of sides and axes text. Alias for: @code Attributes()->TextAspect()->SetFont() @endcode

param theFont

type theFont

TCollection_AsciiString

rtype

None

SetFontHeight()¶

Change font height. Alias for: @code Attributes()->TextAspect()->SetHeight() @endcode

param theValue

type theValue

float

rtype

None

SetInnerColor()¶

Set color of sides back material. Alias for: @code Attributes()->ShadingAspect()->Aspect()->ChangeBackMaterial().SetColor() @endcode

param theColor

type theColor

Quantity_Color

rtype

None

SetResetCamera()¶

Set if new camera Up direction should be always set to default value for a new camera Direction.

param theToReset

type theToReset

bool

rtype

None

SetRoundRadius()¶

Set relative radius of View Cube sides corners (round rectangle). The value should be within [0, 0.5] range.

param theValue

type theValue

float

rtype

None

SetSize()¶

Sets size (width and height) of View cube sides. @param theToAdaptAnother if True, then other parameters will be adapted to specified size

param theValue

type theValue

float

param theToAdaptAnother

default value is true

type theToAdaptAnother

bool

rtype

None

SetTextColor()¶

Set color of text labels on box sides. Alias for: @code Attributes()->TextAspect()->SetColor() @endcode

param theColor

type theColor

Quantity_Color

rtype

None

SetViewAnimation()¶

Set view animation.

param theAnimation

type theAnimation

AIS_AnimationCamera

rtype

None

SetYup()¶

Set if application expects Y-up viewer orientation instead of Z-up.

param theIsYup

type theIsYup

bool

param theToUpdateLabels

default value is Standard_True

type theToUpdateLabels

bool

rtype

None

Size()¶

@name Geometry management API returns size (width and height) of View cube sides; 100 by default.

rtype

float

StartAnimation()¶

Start camera transformation corresponding to the input detected owner. @param theOwner [in] detected owner.

param theOwner

type theOwner

AIS_ViewCubeOwner

rtype

void

TextColor()¶

Return text color of labels of box sides; BLACK by default.

rtype

Quantity_Color

ToAutoStartAnimation()¶

Return True if automatic camera transformation on selection (highlighting) is enabled; True by default.

rtype

bool

ToDrawAxes()¶

returns True if trihedron is drawn; True by default.

rtype

bool

ToDrawEdges()¶

returns True if edges of View Cube is drawn; True by default.

rtype

bool

ToDrawVertices()¶

Return True if vertices (vertex) of View Cube is drawn; True by default.

rtype

bool

ToFitSelected()¶

Return True if animation should fit selected objects and False to fit entire scene; True by default.

rtype

bool

ToResetCameraUp()¶

Return True if new camera Up direction should be always set to default value for a new camera Direction; False by default. When this flag is False, the new camera Up will be set as current Up orthogonalized to the new camera Direction, and will set to default Up on second click.

rtype

bool

UnsetColor()¶

Reset color for the whole object.

rtype

None

UnsetHilightAttributes()¶

Set default parameters for dynamic highlighting attributes, reset highlight attributes

rtype

None

UpdateAnimation()¶

Perform one step of current camera transformation. theToUpdate [in] enable/disable update of view. returns True if animation is not stopped.

param theToUpdate

type theToUpdate

bool

rtype

bool

ViewAnimation()¶

Return view animation.

rtype

opencascade::handle<AIS_AnimationCamera>

property thisown¶: The membership flag

class AIS_ViewCubeOwner(*args)¶