OCC.AIS module

class AIS_AngleDimension(*args)

Bases: OCC.AIS.AIS_Dimension

  • 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.
Parameters:
  • theFirstEdge (TopoDS_Edge &) –
  • theSecondEdge (TopoDS_Edge &) –
Return type:

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

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).
Parameters:
  • theFirstVertex (TopoDS_Vertex &) –
  • theSecondVertex (TopoDS_Vertex &) –
  • theThirdVertex (TopoDS_Vertex &) –
Return type:

None

  • Constructs angle dimension for the cone face. @param theCone [in] the conical face.
Parameters:theCone (TopoDS_Face &) –
Return type:None
  • Constructs angle dimension between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face.
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
Return type:

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.
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
  • thePoint (gp_Pnt) –
Return type:

None

CenterPoint()
  • returns center point forming the angle.
Return type:gp_Pnt
FirstPoint()
  • returns first point forming the angle.
Return type:gp_Pnt
FirstShape()
  • returns first argument shape.
Return type:TopoDS_Shape
GetHandle()
GetTextPosition()
Return type:gp_Pnt
SecondPoint()
  • returns second point forming the angle.
Return type:gp_Pnt
SecondShape()
  • returns second argument shape.
Return type:TopoDS_Shape
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.
Parameters:
  • theFirstEdge (TopoDS_Edge &) –
  • theSecondEdge (TopoDS_Edge &) –
Return type:

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

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).
Parameters:
  • theFirstVertex (TopoDS_Vertex &) –
  • theSecondVertex (TopoDS_Vertex &) –
  • theThirdVertex (TopoDS_Vertex &) –
Return type:

None

  • Measures angle of conical face. @param theCone [in] the shape to measure.
Parameters:theCone (TopoDS_Face &) –
Return type:None
  • Measures angle between two planar faces. @param theFirstFace [in] the first face. @param theSecondFace [in] the second face..
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
Return type:

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.
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
  • thePoint (gp_Pnt) –
Return type:

None

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
Parameters:theTextPos (gp_Pnt) –
Return type:void
ThirdShape()
  • returns third argument shape.
Return type:TopoDS_Shape
thisown

The membership flag

class AIS_AttributeFilter(*args)

Bases: object

  • Constructs an empty attribute filter object. This filter object determines whether selectable interactive objects have a non-null owner.
Return type:None
  • Constructs an attribute filter object defined by the color attribute aCol.
Parameters:aCol (Quantity_NameOfColor) –
Return type:None
  • Constructs an attribute filter object defined by the line width attribute aWidth.
Parameters:aWidth (float) –
Return type:None
GetHandle()
HasColor()
  • Indicates that the Interactive Object has the color setting specified by the argument aCol at construction time.
Return type:bool
HasWidth()
  • Indicates that the Interactive Object has the width setting specified by the argument aWidth at construction time.
Return type:bool
IsOk()
  • Indicates that the selected Interactive Object passes the filter. The owner, anObj, can be either direct or user. A direct owner is the corresponding construction element, whereas a user is the compound shape of which the entity forms a part. If the Interactive Object returns Standard_True when detected by the Local Context selector through the mouse, the object is kept; if not, it is rejected.
Parameters:anObj (Handle_SelectMgr_EntityOwner &) –
Return type:bool
SetColor()
  • Sets the color aCol. This must be chosen from the list of colors in Quantity_NameOfColor.
Parameters:aCol (Quantity_NameOfColor) –
Return type:None
SetWidth()
  • Sets the line width aWidth.
Parameters:aWidth (float) –
Return type:None
UnsetColor()
  • Removes the setting for color from the filter.
Return type:None
UnsetWidth()
  • Removes the setting for width from the filter.
Return type:None
thisown

The membership flag

class AIS_Axis(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes the line aComponent
Parameters:aComponent (Handle_Geom_Line &) –
Return type:None
  • initializes the axis2 position aComponent. The coordinate system used is right-handed.
Parameters:
  • aComponent (Handle_Geom_Axis2Placement &) –
  • anAxisType (AIS_TypeOfAxis) –
Return type:

None

  • Initializes the axis1 position anAxis.
Parameters:anAxis (Handle_Geom_Axis1Placement &) –
Return type:None
Axis2Placement()
  • Returns the position of axis2 and positions it by identifying it as the x, y, or z axis and giving its direction in 3D space. The coordinate system used is right-handed.
Return type:Handle_Geom_Axis2Placement
Component()
  • Returns the axis entity aComponent and identifies it as a component of a shape.
Return type:Handle_Geom_Line
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
IsXYZAxis()
  • Returns a signature of 2 for axis datums. When you activate mode 2 by a signature, you pick AIS objects of type AIS_Axis.
Return type:bool
SetAxis1Placement()
  • Constructs a new line to serve as the axis anAxis in 3D space.
Parameters:anAxis (Handle_Geom_Axis1Placement &) –
Return type:None
SetAxis2Placement()
  • Allows you to provide settings for aComponent:the position and direction of an axis in 3D space. The coordinate system used is right-handed.
Parameters:
  • aComponent (Handle_Geom_Axis2Placement &) –
  • anAxisType (AIS_TypeOfAxis) –
Return type:

None

SetColor()
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

None

SetComponent()
  • Sets the coordinates of the lin aComponent.
Parameters:aComponent (Handle_Geom_Line &) –
Return type:None
SetTypeOfAxis()
  • Constructs the entity aTypeAxis to stock information concerning type of axis.
Parameters:aTypeAxis (AIS_TypeOfAxis) –
Return type:None
TypeOfAxis()
  • Returns the type of axis.
Return type:AIS_TypeOfAxis
thisown

The membership flag

class AIS_BadEdgeFilter(*args)

Bases: object

  • Constructs an empty filter object for bad edges.
Return type:None
ActsOn()
Parameters:aType (TopAbs_ShapeEnum) –
Return type:bool
AddEdge()
  • Adds an edge to the list of non-selectionnable edges.
Parameters:
  • anEdge (TopoDS_Edge &) –
  • Index (int) –
Return type:

None

GetHandle()
IsOk()
Parameters:EO (Handle_SelectMgr_EntityOwner &) –
Return type:bool
RemoveEdges()
  • removes from the list of non-selectionnable edges all edges in the contour <Index>.
Parameters:Index (int) –
Return type:None
SetContour()
  • sets <myContour> with current contour. used by IsOk.
Parameters:Index (int) –
Return type:None
thisown

The membership flag

class AIS_C0RegularityFilter(*args)

Bases: object

Parameters:aShape (TopoDS_Shape &) –
Return type:None
ActsOn()
Parameters:aType (TopAbs_ShapeEnum) –
Return type:bool
GetHandle()
IsOk()
Parameters:EO (Handle_SelectMgr_EntityOwner &) –
Return type:bool
thisown

The membership flag

class AIS_Chamf2dDimension(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
Return type:

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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
  • aPosition (gp_Pnt) –
  • aSymbolPrs (DsgPrs_ArrowSide) –
  • anArrowSize (float) – default value is 0.0
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_Chamf3dDimension(*args)

Bases: OCC.AIS.AIS_Relation

  • Constructs a display object for 3D chamfers. This object is defined by the shape aFShape, the dimension aVal and the text aText.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
Return type:

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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
  • aPosition (gp_Pnt) –
  • aSymbolPrs (DsgPrs_ArrowSide) –
  • anArrowSize (float) – default value is 0.0
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_Circle(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes this algorithm for constructing AIS circle datums initializes the circle aCircle
Parameters:aCircle (Handle_Geom_Circle &) –
Return type: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.
Parameters:
  • theCircle (Handle_Geom_Circle &) –
  • theUStart (float) –
  • theUEnd (float) –
  • theIsFilledCircleSens (bool) – default value is Standard_False
Return type:

None

Circle()
  • Returns the circle component defined in SetCircle.
Return type: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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
IsFilledCircleSens()
  • Returns the type of sensitivity for the circle;
Return type:bool
Parameters()
  • Constructs instances of the starting point and the end point parameters, u1 and u2.
Parameters:
  • u1 (float &) –
  • u2 (float &) –
Return type:

None

SetCircle()
  • Allows you to provide settings for the circle datum aCircle.
Parameters:aCircle (Handle_Geom_Circle &) –
Return type:None
SetColor()
  • Assigns the color aColor to the solid line boundary of the circle datum.
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

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.
Parameters:theIsFilledCircleSens (bool) –
Return type:None
SetFirstParam()
  • Allows you to set the parameter u for the starting point of an arc.
Parameters:u (float) –
Return type:None
SetLastParam()
  • Allows you to provide the parameter u for the end point of an arc.
Parameters:u (float) –
Return type:None
thisown

The membership flag

class AIS_ColoredDrawer(*args)

Bases: OCC.AIS.AIS_Drawer

Parameters:theLink (Handle_AIS_Drawer &) –
Return type:None
GetHandle()
HasOwnColor()
Return type:bool
HasOwnWidth()
Return type:bool
IsHidden()
Return type:bool
SetHidden()
Parameters:theToHide (bool) –
Return type:None
SetOwnColor()
Parameters:& (Quantity_Color) –
Return type:None
SetOwnWidth()
Parameters:Standard_Real
Return type:None
UnsetOwnColor()
Return type:None
UnsetOwnWidth()
Return type:None
myHasOwnColor
myHasOwnWidth
myIsHidden
thisown

The membership flag

class AIS_ColoredShape(*args)

Bases: OCC.AIS.AIS_Shape

  • Default constructor
Parameters:theShape (TopoDS_Shape &) –
Return type:None
  • Copy constructor
Parameters:theShape (Handle_AIS_Shape &) –
Return type:None
ClearCustomAspects()
  • Reset the map of custom sub-shape aspects.
Return type:None
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.
Parameters:theShape (TopoDS_Shape &) –
Return type:Handle_AIS_ColoredDrawer
GetHandle()
SetCustomColor()
  • Customize color of specified sub-shape
Parameters:
  • theShape (TopoDS_Shape &) –
  • theColor (Quantity_Color &) –
Return type:

None

SetCustomWidth()
  • Customize line width of specified sub-shape
Parameters:
  • theShape (TopoDS_Shape &) –
  • theLineWidth (float) –
Return type:

None

UnsetCustomAspects()
  • Reset custom properties of specified sub-shape. @param theToUnregister unregister or not sub-shape from the map
Parameters:
  • theShape (TopoDS_Shape &) –
  • theToUnregister (bool) – default value is Standard_False
Return type:

None

thisown

The membership flag

class AIS_ConcentricRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aSShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_ConnectedInteractive(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Disconnects the previous view and sets highlight mode to 0. This highlights the wireframe presentation aTypeOfPresentation3d. Top_AllView deactivates hidden line removal.
Parameters:aTypeOfPresentation3d (PrsMgr_TypeOfPresentation3d) – default value is PrsMgr_TOP_AllView
Return type:None
AcceptShapeDecomposition()
  • Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection.
Return type:bool
Connect()
  • Establishes the connection between the Connected Interactive Object, anotherIobj, and its reference.
Parameters:anotherIObj (Handle_AIS_InteractiveObject &) –
Return type:void
  • Establishes the connection between the Connected Interactive Object, anotherIobj, and its reference. Locates instance in aLocation.
Parameters:
  • anotherIobj (Handle_AIS_InteractiveObject &) –
  • aLocation (gp_Trsf) –
Return type:

void

ConnectedTo()
  • Returns the connection with the reference Interactive Object.
Return type: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.
Return type:None
GetHandle()
HasConnection()
  • Returns true if there is a connection established between the presentation and its source reference.
Return type:bool
thisown

The membership flag

class AIS_DataMapIteratorOfDataMapOfILC(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (AIS_DataMapOfILC &) –
Return type:None
Initialize()
Parameters:aMap (AIS_DataMapOfILC &) –
Return type:None
Key()
Return type:int
Value()
Return type:Handle_AIS_LocalContext
thisown

The membership flag

class AIS_DataMapIteratorOfDataMapOfIOStatus(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (AIS_DataMapOfIOStatus &) –
Return type:None
Initialize()
Parameters:aMap (AIS_DataMapOfIOStatus &) –
Return type:None
Key()
Return type:Handle_AIS_InteractiveObject
Value()
Return type:Handle_AIS_GlobalStatus
thisown

The membership flag

class AIS_DataMapIteratorOfDataMapOfSelStat(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (AIS_DataMapOfSelStat &) –
Return type:None
Initialize()
Parameters:aMap (AIS_DataMapOfSelStat &) –
Return type:None
Key()
Return type:Handle_SelectMgr_SelectableObject
Value()
Return type:Handle_AIS_LocalStatus
thisown

The membership flag

class AIS_DataMapIteratorOfDataMapofIntegerListOfinteractive(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (AIS_DataMapofIntegerListOfinteractive &) –
Return type:None
Initialize()
Parameters:aMap (AIS_DataMapofIntegerListOfinteractive &) –
Return type:None
Key()
Return type:int
Value()
Return type:AIS_ListOfInteractive
thisown

The membership flag

class AIS_DataMapNodeOfDataMapOfILC(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (int &) –
  • I (Handle_AIS_LocalContext &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetKey()

AIS_DataMapNodeOfDataMapOfILC_GetKey(AIS_DataMapNodeOfDataMapOfILC self) -> Standard_Integer

SetKey()

AIS_DataMapNodeOfDataMapOfILC_SetKey(AIS_DataMapNodeOfDataMapOfILC self, Standard_Integer value)

Value()
Return type:Handle_AIS_LocalContext
thisown

The membership flag

class AIS_DataMapNodeOfDataMapOfIOStatus(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_AIS_InteractiveObject &) –
  • I (Handle_AIS_GlobalStatus &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:Handle_AIS_InteractiveObject
Value()
Return type:Handle_AIS_GlobalStatus
thisown

The membership flag

class AIS_DataMapNodeOfDataMapOfSelStat(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_SelectMgr_SelectableObject &) –
  • I (Handle_AIS_LocalStatus &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:Handle_SelectMgr_SelectableObject
Value()
Return type:Handle_AIS_LocalStatus
thisown

The membership flag

class AIS_DataMapNodeOfDataMapofIntegerListOfinteractive(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (int &) –
  • I (AIS_ListOfInteractive &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetKey()

AIS_DataMapNodeOfDataMapofIntegerListOfinteractive_GetKey(AIS_DataMapNodeOfDataMapofIntegerListOfinteractive self) -> Standard_Integer

SetKey()

AIS_DataMapNodeOfDataMapofIntegerListOfinteractive_SetKey(AIS_DataMapNodeOfDataMapofIntegerListOfinteractive self, Standard_Integer value)

Value()
Return type:AIS_ListOfInteractive
thisown

The membership flag

class AIS_DataMapOfILC(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (AIS_DataMapOfILC &) –
Return type:AIS_DataMapOfILC
Bind()
Parameters:
  • K (int &) –
  • I (Handle_AIS_LocalContext &) –
Return type:

bool

ChangeFind()
Parameters:K (int &) –
Return type:Handle_AIS_LocalContext
ChangeFind1()
Parameters:K (int &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (int &) –
Return type:Handle_AIS_LocalContext
Find1()
Parameters:K (int &) –
Return type:Standard_Address
IsBound()
Parameters:K (int &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (AIS_DataMapOfILC &) –
Return type:AIS_DataMapOfILC
UnBind()
Parameters:K (int &) –
Return type:bool
thisown

The membership flag

class AIS_DataMapOfIOStatus(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (AIS_DataMapOfIOStatus &) –
Return type:AIS_DataMapOfIOStatus
Bind()
Parameters:
  • K (Handle_AIS_InteractiveObject &) –
  • I (Handle_AIS_GlobalStatus &) –
Return type:

bool

ChangeFind()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:Handle_AIS_GlobalStatus
ChangeFind1()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:Handle_AIS_GlobalStatus
Find1()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:Standard_Address
IsBound()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (AIS_DataMapOfIOStatus &) –
Return type:AIS_DataMapOfIOStatus
UnBind()
Parameters:K (Handle_AIS_InteractiveObject &) –
Return type:bool
thisown

The membership flag

class AIS_DataMapOfSelStat(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (AIS_DataMapOfSelStat &) –
Return type:AIS_DataMapOfSelStat
Bind()
Parameters:
  • K (Handle_SelectMgr_SelectableObject &) –
  • I (Handle_AIS_LocalStatus &) –
Return type:

bool

ChangeFind()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:Handle_AIS_LocalStatus
ChangeFind1()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:Handle_AIS_LocalStatus
Find1()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:Standard_Address
IsBound()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (AIS_DataMapOfSelStat &) –
Return type:AIS_DataMapOfSelStat
UnBind()
Parameters:K (Handle_SelectMgr_SelectableObject &) –
Return type:bool
thisown

The membership flag

class AIS_DataMapofIntegerListOfinteractive(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (AIS_DataMapofIntegerListOfinteractive &) –
Return type:AIS_DataMapofIntegerListOfinteractive
Bind()
Parameters:
  • K (int &) –
  • I (AIS_ListOfInteractive &) –
Return type:

bool

ChangeFind()
Parameters:K (int &) –
Return type:AIS_ListOfInteractive
ChangeFind1()
Parameters:K (int &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (int &) –
Return type:AIS_ListOfInteractive
Find1()
Parameters:K (int &) –
Return type:Standard_Address
IsBound()
Parameters:K (int &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (AIS_DataMapofIntegerListOfinteractive &) –
Return type:AIS_DataMapofIntegerListOfinteractive
UnBind()
Parameters:K (int &) –
Return type:bool
thisown

The membership flag

class AIS_DiameterDimension(*args)

Bases: OCC.AIS.AIS_Dimension

  • Construct diameter dimension for the circle. @param theCircle [in] the circle to measure.
Parameters:theCircle (gp_Circ) –
Return type: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.
Parameters:
Return type:

None

  • Construct diameter on the passed shape, if applicable. @param theShape [in] the shape to measure.
Parameters:theShape (TopoDS_Shape &) –
Return type: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.
Parameters:
  • theShape (TopoDS_Shape &) –
  • thePlane (gp_Pln) –
Return type:

None

AnchorPoint()
  • returns anchor point on circle for diameter dimension.
Return type:gp_Pnt
Circle()
  • returns measured geometry circle.
Return type:gp_Circ
GetHandle()
GetTextPosition()
Return type:gp_Pnt
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.
Parameters:theCircle (gp_Circ) –
Return type: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.
Parameters:theShape (TopoDS_Shape &) –
Return type:None
SetTextPosition()
Parameters:theTextPos (gp_Pnt) –
Return type:void
Shape()
  • returns the measured shape.
Return type:TopoDS_Shape
thisown

The membership flag

class AIS_Dimension(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Constructor with default parameters values. @param theType [in] the type of dimension.
Parameters:theType (AIS_KindOfDimension) –
Return type:None
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.
Return type:Handle_Prs3d_DimensionAspect
DisplaySpecialSymbol()
  • returns dimension special symbol display options.
Return type:AIS_DisplaySpecialSymbol
GetDisplayUnits()
Return type:TCollection_AsciiString
GetFlyout()
  • returns flyout value for dimension.
Return type: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.
Return type:int
GetHandle()
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.
Return type:gp_Pln
GetTextPosition()
  • Computes absolute text position from dimension parameters (flyout, plane and text alignment).
Return type: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.
Return type:float
IsTextPositionCustom()
  • returns True if text position is set by user with method SetTextPosition().
Return type: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.
Return type:bool
KindOfDimension()
  • returns the kind of dimension.
Return type:AIS_KindOfDimension
SelToleranceForText2d()
  • Returns selection tolerance for text2d: For 2d text selection detection sensitive point with tolerance is used Important! Only for 2d text.
Return type:float
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.
Parameters:thePlane (gp_Pln) –
Return type: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.
Parameters:theValue (float) –
Return type: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.
Parameters:theDimensionAspect (Handle_Prs3d_DimensionAspect &) –
Return type:None
SetDisplaySpecialSymbol()
  • Specifies whether to display special symbol or not.
Parameters:theDisplaySpecSymbol (AIS_DisplaySpecialSymbol) –
Return type:None
SetDisplayUnits()
Parameters:& (TCollection_AsciiString) –
Return type:void
SetFlyout()
  • Sets flyout value for dimension.
Parameters:theFlyout (float) –
Return type:None
SetModelUnits()
Parameters:& (TCollection_AsciiString) –
Return type:void
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.
Parameters:theTol (float) –
Return type:None
SetSpecialSymbol()
  • Specifies special symbol.
Parameters:theSpecialSymbol (Standard_ExtCharacter) –
Return type: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.
Parameters:& (gp_Pnt) –
Return type:None
SpecialSymbol()
  • returns special symbol.
Return type:Standard_ExtCharacter
UnsetCustomPlane()
  • Unsets user-defined plane. Therefore the plane for dimension will be computed automatically.
Return type:None
UnsetFixedTextPosition()
  • Unsets user defined text positioning and enables text positioning by other parameters: text alignment, extension size, flyout and custom plane.
Return type:None
thisown

The membership flag

class AIS_DimensionOwner(*args)

Bases: object

  • Initializes the dimension owner, theSO, and attributes it the priority, thePriority.
Parameters:
  • theSelObject (Handle_SelectMgr_SelectableObject &) –
  • theSelMode (AIS_DimensionSelectionMode) –
  • thePriority (int) – default value is 0
Return type:

None

GetHandle()
Hilight()
Parameters:
  • thePM (Handle_PrsMgr_PresentationManager &) –
  • theMode (int) – default value is 0
Return type:

void

HilightWithColor()
Parameters:
  • thePM (Handle_PrsMgr_PresentationManager3d &) –
  • theColor (Quantity_NameOfColor) –
  • theMode (int) – default value is 0
Return type:

void

IsHilighted()
  • Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM.
Parameters:
  • thePM (Handle_PrsMgr_PresentationManager &) –
  • theMode (int) – default value is 0
Return type:

bool

SelectionMode()
Return type:AIS_DimensionSelectionMode
Unhilight()
  • Removes highlighting from the selected part of dimension.
Parameters:
  • thePM (Handle_PrsMgr_PresentationManager &) –
  • theMode (int) – default value is 0
Return type:

void

thisown

The membership flag

class AIS_Drawer(*args)

Bases: OCC.Prs3d.Prs3d_Drawer

  • Constructs an empty attribute management framework.
Return type:None
ClearLocalAttributes()
  • Removes attributes stored in a Local Context.
Return type:void
GetHandle()
HasDatumAspect()
Return type:bool
HasDimensionAspect()
Return type:bool
HasFreeBoundaryAspect()
  • Returns true if the Drawer has a free boundary aspect setting active.
Return type:bool
HasLineAspect()
  • Returns true if the Interactive Object has a line visualization aspect.
Return type:bool
Return type:bool
HasLocalAttributes()
  • Returns true if a Local Context has stored attributes for Interactive Objects.
Return type:bool
HasPlaneAspect()
Return type:bool
HasPointAspect()
  • Returns true if the Drawer has a point aspect setting active.
Return type:bool
HasShadingAspect()
  • Returns True if the Drawer has shading aspect active.
Return type:bool
HasTextAspect()
Return type:bool
HasUIsoAspect()
  • Returns true if the Drawer has a UIso aspect setting active.
Return type:bool
HasUnFreeBoundaryAspect()
  • Returns true if the Drawer has an unfree boundary aspect setting active.
Return type:bool
HasVIsoAspect()
  • Returns true if the Drawer has a VIso aspect setting active.
Return type:bool
HasWireAspect()
  • Returns true if the Drawer has a wire aspect setting active.
Return type:bool
IsOwnDeviationAngle()
  • Returns true if the there is a local setting for deviation angle in this framework for a specific interactive object.
Return type:bool
IsOwnDeviationCoefficient()
  • Returns true if the there is a local setting for deviation coefficient in this framework for a specific interactive object.
Return type:bool
IsOwnFaceBoundaryAspect()
  • Returns true if the drawer has its own attribute for face boundaries aspect that overrides the one in the link.
Return type:bool
IsOwnFaceBoundaryDraw()
  • Returns true if the drawer has its own attribute for ‘draw face boundaries’ flag that overrides the one in the link.
Return type:bool
IsOwnHLRDeviationAngle()
  • Returns true if the there is a setting for HLR deviation angle in this framework for a specific interactive object.
Return type:bool
IsOwnHLRDeviationCoefficient()
  • Returns true if the there is a setting for HLR deviation coefficient in this framework for a specific interactive object.
Return type:bool
IsOwnVertexDrawMode()
  • Returns true if the vertex draw mode is not equal to <b>Prs3d_VDM_Inherited</b>. This means that individual vertex draw mode value (i.e. not inherited from the global drawer) is used for a specific interactive object.
Return type:bool
Return type:Handle_Prs3d_Drawer
Parameters:aDrawer (Handle_Prs3d_Drawer &) –
Return type:None
PreviousDeviationAngle()
  • returns myPreviousDeviationAngle
Return type:float
PreviousDeviationCoefficient()
  • Saves the previous value used for the chordal deviation coefficient. The default value is 0.1.
Return type:float
PreviousHLRDeviationAngle()
  • returns myPreviousHLRDeviationAngle
Return type:float
PreviousHLRDeviationCoefficient()
  • returns myPreviousHLRDeviationCoefficient
Return type:float
SetDeviationAngle()
  • Sets the hasOwnDeviationAngle flag to Standard_False
Return type:None
  • Sets the hasOwnDeviationAngle flag to Standard_True, sets myOwnDeviationAngle and myPreviousDeviationAngle
Parameters:anAngle (float) –
Return type:void
SetDeviationCoefficient()
  • Sets the hasOwnDeviationCoefficient flag to Standard_False
Return type:None
  • Sets the hasOwnDeviationCoefficient flag to Standard_True, sets myOwnDeviationCoefficient and myPreviousDeviationCoefficient
Parameters:aCoefficient (float) –
Return type:None
SetHLRAngle()
  • Sets the angle of maximum chordal deviation for removal of hidden lines created by different viewpoints in different presentations. The default value is 20*PI/180.
Return type:None
  • Sets the hasOwnHLRDeviationAngle flag to Standard_True, sets myOwnHLRDeviationAngle and myPreviousHLRDeviationAngle
Parameters:anAngle (float) –
Return type:None
SetHLRDeviationCoefficient()
  • Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
Return type:None
  • Sets the hasOwnHLRDeviationCoefficient flag to Standard_True, sets myOwnHLRDeviationCoefficient and myPreviousHLRDeviationCoefficient
Parameters:aCoefficient (float) –
Return type:None
WasLastLocal()
  • Returns true if the last called attribute was local; false if it was global.
Return type:bool
thisown

The membership flag

class AIS_EllipseRadiusDimension(*args, **kwargs)

Bases: OCC.AIS.AIS_Relation

ComputeGeometry()
Return type:None
GetHandle()
thisown

The membership flag

class AIS_EqualDistanceRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aShape1 (TopoDS_Shape &) –
  • aShape2 (TopoDS_Shape &) –
  • aShape3 (TopoDS_Shape &) –
  • aShape4 (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

static ComputeOneEdgeOneVertexLength(*args)
  • Compute the interval location between a vertex and an edge. Edge may be a line or a circle.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstShape (TopoDS_Shape &) –
  • SecondShape (TopoDS_Shape &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

static ComputeTwoEdgesLength(*args)
  • Computes the location of an intreval between between two edges. FirstAttach , SecondAttach are the returned extreme points of the interval.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstEdge (TopoDS_Edge &) –
  • SecondEdge (TopoDS_Edge &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

static ComputeTwoVerticesLength(*args)
  • Computes the interval position between two vertexs. FirstAttach, SecondAttach are the returned extreme points of the interval.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstVertex (TopoDS_Vertex &) –
  • SecondVertex (TopoDS_Vertex &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • TypeDist (AIS_TypeOfDist) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

GetHandle()
SetShape3()
  • Sets the shape aShape to be used as the shape aShape3 in the framework created at construction time.
Parameters:aShape (TopoDS_Shape &) –
Return type:None
SetShape4()
  • Sets the shape aShape to be used as the shape aShape4 in the framework created at construction time.
Parameters:aShape (TopoDS_Shape &) –
Return type:None
Shape3()
  • Returns the shape aShape3 from the framework created at construction time.
Return type:TopoDS_Shape
Shape4()
  • Returns the shape aShape4 from the framework created at construction time.
Return type:TopoDS_Shape
thisown

The membership flag

AIS_EqualDistanceRelation_ComputeOneEdgeOneVertexLength(*args)
  • Compute the interval location between a vertex and an edge. Edge may be a line or a circle.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstShape (TopoDS_Shape &) –
  • SecondShape (TopoDS_Shape &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

AIS_EqualDistanceRelation_ComputeTwoEdgesLength(*args)
  • Computes the location of an intreval between between two edges. FirstAttach , SecondAttach are the returned extreme points of the interval.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstEdge (TopoDS_Edge &) –
  • SecondEdge (TopoDS_Edge &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

AIS_EqualDistanceRelation_ComputeTwoVerticesLength(*args)
  • Computes the interval position between two vertexs. FirstAttach, SecondAttach are the returned extreme points of the interval.
Parameters:
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • ArrowSize (float) –
  • FirstVertex (TopoDS_Vertex &) –
  • SecondVertex (TopoDS_Vertex &) –
  • Plane (Handle_Geom_Plane &) –
  • AutomaticPos (bool) –
  • IsSetBndBox (bool) –
  • BndBox (Bnd_Box &) –
  • TypeDist (AIS_TypeOfDist) –
  • Position (gp_Pnt) –
  • FirstAttach (gp_Pnt) –
  • SecondAttach (gp_Pnt) –
  • FirstExtreme (gp_Pnt) –
  • SecondExtreme (gp_Pnt) –
  • SymbolPrs (DsgPrs_ArrowSide &) –
Return type:

void

class AIS_EqualRadiusRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aFirstEdge (TopoDS_Edge &) –
  • aSecondEdge (TopoDS_Edge &) –
  • aPlane (Handle_Geom_Plane &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_ExclusionFilter(*args)

Bases: object

  • Constructs an empty exclusion filter object defined by the flag setting ExclusionFlagOn. By default, the flag is set to true.
Parameters:ExclusionFlagOn (bool) – default value is Standard_True
Return type:None
  • All the AIS objects of <TypeToExclude> Will be rejected by the IsOk Method.
Parameters:
  • TypeToExclude (AIS_KindOfInteractive) –
  • ExclusionFlagOn (bool) – default value is Standard_True
Return type:

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.
Parameters:
  • TypeToExclude (AIS_KindOfInteractive) –
  • SignatureInType (int) –
  • ExclusionFlagOn (bool) – default value is Standard_True
Return type:

None

Add()
  • Adds the type TypeToExclude to the list of types.
Parameters:
  • TypeToExclude (AIS_KindOfInteractive) –
  • TypeToExclude
  • SignatureInType (int) –
Return type:

bool

Return type:

bool

Clear()
Return type:None
GetHandle()
IsExclusionFlagOn()
Return type:bool
IsOk()
Parameters:anObj (Handle_SelectMgr_EntityOwner &) –
Return type:bool
IsStored()
Parameters:aType (AIS_KindOfInteractive) –
Return type:bool
ListOfSignature()
Parameters:
  • aType (AIS_KindOfInteractive) –
  • TheStoredList (TColStd_ListOfInteger &) –
Return type:

None

ListOfStoredTypes()
Parameters:TheList (TColStd_ListOfInteger &) –
Return type:None
Remove()
Parameters:
  • TypeToExclude (AIS_KindOfInteractive) –
  • TypeToExclude
  • SignatureInType (int) –
Return type:

bool

Return type:

bool

SetExclusionFlag()
Parameters:Status (bool) –
Return type:None
thisown

The membership flag

class AIS_FixRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • initializes the vertex aShape, the plane aPlane and the wire aWire, which connects the two vertices in a fixed relation.
Parameters:
  • aShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aWire (TopoDS_Wire &) –
Return type:

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.
Parameters:
  • aShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aWire (TopoDS_Wire &) –
  • aPosition (gp_Pnt) –
  • anArrowSize (float) – default value is 0.01
Return type:

None

  • initializes the edge aShape and the plane aPlane.
Parameters:
  • aShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
Return type:

None

  • initializes the edge aShape, the plane aPlane, the position aPosition and the arrow size anArrowSize.
Parameters:
  • aShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aPosition (gp_Pnt) –
  • anArrowSize (float) – default value is 0.01
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
SetWire()
  • Constructs the wire aWire. This connects vertices which are in a fixed relation.
Parameters:aWire (TopoDS_Wire &) –
Return type:None
Wire()
  • Returns the wire which connects vertices in a fixed relation.
Return type:TopoDS_Wire
thisown

The membership flag

class AIS_GlobalStatus(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:

None

Parameters:
  • aStat (AIS_DisplayStatus) –
  • aDispMode (int) –
  • aSelMode (int) –
  • ishilighted (bool) – default value is Standard_False
  • TheHiCol (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • aLayerIndex (int) – default value is 0
Return type:

None

AddDisplayMode()
Parameters:aMode (int) –
Return type:None
AddSelectionMode()
Parameters:aMode (int) –
Return type:None
ClearSelectionModes()
Return type:None
DisplayedModes()
  • keeps the information of displayed modes in the main viewer.
Return type:TColStd_ListOfInteger
GetHandle()
GraphicStatus()
Return type:AIS_DisplayStatus
HilightColor()
Return type:Quantity_NameOfColor
IsDModeIn()
Parameters:aMode (int) –
Return type:bool
IsHilighted()
Return type:bool
IsSModeIn()
Parameters:aMode (int) –
Return type:bool
IsSubIntensityOn()
Return type:bool
RemoveDisplayMode()
Parameters:aMode (int) –
Return type:None
RemoveSelectionMode()
Parameters:aMode (int) –
Return type:None
SelectionModes()
  • keeps the active selection modes of the object in the main viewer.
Return type:TColStd_ListOfInteger
SetGraphicStatus()
Parameters:aStat (AIS_DisplayStatus) –
Return type:None
SetHilightColor()
Parameters:aHiCol (Quantity_NameOfColor) –
Return type:None
SetHilightStatus()
Parameters:aStat (bool) –
Return type:None
SetLayerIndex()
Parameters:AnIndex (int) –
Return type:None
SubIntensityOff()
Return type:None
SubIntensityOn()
Return type:None
thisown

The membership flag

class AIS_GraphicTool

Bases: object

static GetInteriorColor(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • aDrawer
  • aColor (Quantity_Color &) –
Return type:

Quantity_NameOfColor

Return type:

void

static GetLineAtt(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
  • aCol (Quantity_NameOfColor &) –
  • aWidth (float &) –
  • aTyp (Aspect_TypeOfLine &) –
Return type:

void

static GetLineColor(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
  • aDrawer
  • TheTypeOfAttributes
  • TheLineColor (Quantity_Color &) –
Return type:

Quantity_NameOfColor

Return type:

void

static GetLineType(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
Return type:

Aspect_TypeOfLine

static GetLineWidth(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
Return type:

float

static GetMaterial(*args)
Parameters:aDrawer (Handle_Prs3d_Drawer &) –
Return type:Graphic3d_MaterialAspect
thisown

The membership flag

AIS_GraphicTool_GetInteriorColor(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • aDrawer
  • aColor (Quantity_Color &) –
Return type:

Quantity_NameOfColor

Return type:

void

AIS_GraphicTool_GetLineAtt(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
  • aCol (Quantity_NameOfColor &) –
  • aWidth (float &) –
  • aTyp (Aspect_TypeOfLine &) –
Return type:

void

AIS_GraphicTool_GetLineColor(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
  • aDrawer
  • TheTypeOfAttributes
  • TheLineColor (Quantity_Color &) –
Return type:

Quantity_NameOfColor

Return type:

void

AIS_GraphicTool_GetLineType(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
Return type:

Aspect_TypeOfLine

AIS_GraphicTool_GetLineWidth(*args)
Parameters:
  • aDrawer (Handle_Prs3d_Drawer &) –
  • TheTypeOfAttributes (AIS_TypeOfAttribute) –
Return type:

float

AIS_GraphicTool_GetMaterial(*args)
Parameters:aDrawer (Handle_Prs3d_Drawer &) –
Return type:Graphic3d_MaterialAspect
class AIS_IdenticRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • FirstShape (TopoDS_Shape &) –
  • SecondShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_IndexedDataMapNodeOfIndexedDataMapOfOwnerPrs(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K1 (Handle_SelectMgr_EntityOwner &) –
  • K2 (int) –
  • I (Handle_Prs3d_Presentation &) –
  • n1 (TCollection_MapNodePtr &) –
  • n2 (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
GetKey2()

AIS_IndexedDataMapNodeOfIndexedDataMapOfOwnerPrs_GetKey2(AIS_IndexedDataMapNodeOfIndexedDataMapOfOwnerPrs self) -> Standard_Integer

Key1()
Return type:Handle_SelectMgr_EntityOwner
Next2()
Return type:TCollection_MapNodePtr
SetKey2()

AIS_IndexedDataMapNodeOfIndexedDataMapOfOwnerPrs_SetKey2(AIS_IndexedDataMapNodeOfIndexedDataMapOfOwnerPrs self, Standard_Integer value)

Value()
Return type:Handle_Prs3d_Presentation
thisown

The membership flag

class AIS_IndexedDataMapOfOwnerPrs(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Add()
Parameters:
  • K (Handle_SelectMgr_EntityOwner &) –
  • I (Handle_Prs3d_Presentation &) –
Return type:

int

Assign()
Parameters:Other (AIS_IndexedDataMapOfOwnerPrs &) –
Return type:AIS_IndexedDataMapOfOwnerPrs
ChangeFromIndex()
Parameters:I (int) –
Return type:Handle_Prs3d_Presentation
ChangeFromKey()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:Handle_Prs3d_Presentation
ChangeFromKey1()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:Standard_Address
Clear()
Return type:None
Contains()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:bool
FindFromIndex()
Parameters:I (int) –
Return type:Handle_Prs3d_Presentation
FindFromKey()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:Handle_Prs3d_Presentation
FindFromKey1()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:Standard_Address
FindIndex()
Parameters:K (Handle_SelectMgr_EntityOwner &) –
Return type:int
FindKey()
Parameters:I (int) –
Return type:Handle_SelectMgr_EntityOwner
ReSize()
Parameters:NbBuckets (int) –
Return type:None
RemoveLast()
Return type:None
Set()
Parameters:Other (AIS_IndexedDataMapOfOwnerPrs &) –
Return type:AIS_IndexedDataMapOfOwnerPrs
Substitute()
Parameters:
  • I (int) –
  • K (Handle_SelectMgr_EntityOwner &) –
  • T (Handle_Prs3d_Presentation &) –
Return type:

None

thisown

The membership flag

class AIS_InteractiveContext(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Constructs the interactive context object defined by the principal viewer MainViewer.
Parameters:MainViewer (Handle_V3d_Viewer &) –
Return type:None
Activate()
  • Activates the selection mode aMode whose index is given, for the given interactive entity anIobj.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) – default value is 0
Return type:

None

ActivateStandardMode()
  • Provides an alternative to the Display methods when activating specific selection modes. This has the effect of activating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes. Every new Object which has been loaded into the interactive context and which answers these decomposition criteria is automatically activated according to these modes. Warning If you have opened a local context by loading an object with the default options (<AllowShapeDecomposition >= Standard_True), all objects of the ‘Shape’ type are also activated with the same modes. You can act on the state of these ‘Standard’ objects by using SetShapeDecomposition(Status).
Parameters:aStandardActivation (TopAbs_ShapeEnum) –
Return type:None
ActivatedModes()
  • Returns the list of activated selection modes in an open context.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • theList (TColStd_ListOfInteger &) –
Return type:

None

ActivatedStandardModes()
  • Returns the list of activated standard selection modes available in a local context.
Return type:TColStd_ListOfInteger
AddFilter()
  • Allows you to add the filter aFilter to Neutral Point or to a local context if one or more selection modes have been activated. Only type filters may be active in Neutral Point.
Parameters:aFilter (Handle_SelectMgr_Filter &) –
Return type:None
AddOrRemoveCurrentObject()
  • Allows you to add a current object to the list of current objects or remove it from that list. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

AddOrRemoveSelected()
  • Allows you to add a selected object to the list of selected objects or remove it from that list. This entity can be an Interactive Object aniobj or its owner aShape as can be seen in the two syntaxes above. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • No right to Add a selected Shape (Internal Management of shape Selection). A Previous selected shape may only be removed.
Parameters:
  • aShape (TopoDS_Shape &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • allows to add/remove in the selected list the entities represented by <anOwner> in the selection process.
Parameters:
  • anOwner (Handle_SelectMgr_EntityOwner &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

Applicative()
  • Returns the owner of the applicative entity detected in interactive context. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of.
Return type:Handle_Standard_Transient
AutomaticHilight()
  • Returns true if the automatic highlight mode is active in an open context.
Return type:bool
BeginImmediateDraw()
  • initializes the list of presentations to be displayed returns False if No Local COnte
Return type:bool
Clear()
  • Removes the interactive object aniobj from all viewers. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

ClearActiveAreas()
Parameters:aView (Handle_V3d_View &) –
Return type:None
ClearActiveSensitive()
Parameters:aView (Handle_V3d_View &) –
Return type: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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
ClearLocalContext()
  • clears Objects/Filters/Activated Modes list in the current opened local context.
Parameters:TheMode (AIS_ClearMode) – default value is AIS_CM_All
Return type:None
ClearPrs()
  • Empties the graphic presentation of the mode indexed by aMode. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. Warning Removes anIobj. anIobj is still active if it was previously activated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) – default value is 0
  • updateviewer (bool) – default value is Standard_True
Return type:

None

ClearSelected()
  • Empties previous selected objects in order to get the selected objects detected by the selector using UpdateSelected. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
CloseAllContexts()
  • Allows you to close all local contexts at one go and return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
CloseLocalContext()
  • Allows you to close local contexts. For greater security, you should close the context with the index Index given on opening. When you close a local context, the one before, which is still on the stack, reactivates. If none is left, you return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. Warning When the index isn’t specified, the current context is closed. This option can be dangerous, as other Interactive Functions can open local contexts without necessarily warning the user.
Parameters:
  • Index (int) – default value is -1
  • updateviewer (bool) – default value is Standard_True
Return type:

None

Color()
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:Quantity_NameOfColor
  • Returns the color Color of the entity aniobj in the interactive context.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • acolor (Quantity_Color &) –
Return type:

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.
Return type:Handle_AIS_InteractiveObject
CurrentName()
  • Returns the name of the current selected entity in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:TCollection_AsciiString
CurrentViewer()
  • Returns the current viewer.
Return type:Handle_V3d_Viewer
Deactivate()
  • Deactivates all the activated selection modes of an object.
Parameters:anIObj (Handle_AIS_InteractiveObject &) –
Return type:None
  • Deactivates all the activated selection modes of the interactive object anIobj with a given selection mode aMode.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

None

DeactivateStandardMode()
  • Provides an alternative to the Display methods when deactivating specific selection modes. This has the effect of deactivating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes.
Parameters:aStandardActivation (TopAbs_ShapeEnum) –
Return type:None
DefaultColor()
  • Returns the name of the color used by default. By default, this is Quantity_NOC_GOLDENROD.
Return type:Quantity_NameOfColor
DefaultDrawer()
  • 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.
Return type:Handle_Prs3d_Drawer
DetectedCurrentObject()
Return type:Handle_AIS_InteractiveObject
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.
Return type:TopoDS_Shape
DetectedInteractive()
  • Returns the interactive objects last detected in open context. If there is no open local context, the objects selected are called current objects; selected objects if there is one. Iterators allow entities to be recovered in either case. This method is one of a set which allows you to manipulate the objects which have been placed in these two lists.
Return type:Handle_AIS_InteractiveObject
DetectedOwner()
  • returns the owner of the detected sensitive primitive.
Return type:Handle_SelectMgr_EntityOwner
DetectedShape()
  • Returns the shape detected in local context. If there is no open local context, the objects selected are called current objects; selected objects if there is one. Iterators allow entities to be recovered in either case. This method is one of a set which allows you to manipulate the objects which have been placed in these two lists.
Return type: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 AIS_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.
Return type:float
DisableDrawHiddenLine()
Return type:None
Display()
  • Controls the choice between the using the display and selection modes of open local context which you have defined and activating those available by default. If a local context is open and if updateviewer equals Standard_False, the Interactive Object anIobj is displayed in the default active 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. In general, this is 0. This syntax has the same behavior as local context, open or closed. If you want to view the object in open local context without selection, use the syntax below, setting aSelectionMode to -1.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Controls the choice between the using the display and selection modes of open local context which you have defined and activating those available by default. If no Local Context is opened. and the Interactive Object aniobj has no display mode of its own, the default display mode, 0, is used. Likewise, if aniobj has no selection mode of its own, the default one, 0, is used. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. If aSelectionMode equals -1, anIobj will not be activated: it will be displayed but will not be selectable. Use this if you want to view the object in open local context without selection. Note: This option is only available in Local Context. If allowDecomposition equals true, anIObj can have subshapes detected by selection mechanisms. anIObj must be able to give a shape selection modes which fit the AIS_Shape selection modes: - vertices: 1 - edges: 2 - wires: 3.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • amode (int) –
  • aSelectionMode (int) –
  • updateviewer (bool) – default value is Standard_True
  • allowdecomposition (bool) – default value is Standard_True
Return type:

None

DisplayActiveAreas()
Parameters:
  • aView (Handle_V3d_View &) –
  • anObject (Handle_AIS_InteractiveObject &) –
  • aView
Return type:

None

Return type:

None

DisplayActiveSensitive()
Parameters:
  • aView (Handle_V3d_View &) –
  • anObject (Handle_AIS_InteractiveObject &) –
  • aView
Return type:

None

Return type:

None

DisplayAll()
  • Displays all hidden objects.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
DisplayMode()
  • Returns the display mode setting. Note that mode 3 is only used.
Return type:int
DisplayPriority()
  • Returns the display priority of the entity anIobj. This will be display mode of anIobj if it is in the main viewer.
Parameters:anIobj (Handle_AIS_InteractiveObject &) –
Return type:int
DisplaySelected()
  • Displays selected objects if a local context is open. Displays current objects if there is no active local context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
DisplayStatus()
  • Returns the display status of the entity anIobj. This will be one of the following: - DS_Displayed displayed in main viewer - DS_Erased hidden in main viewer - DS_Temporary temporarily displayed - DS_None nowhere displayed.
Parameters:anIobj (Handle_AIS_InteractiveObject &) –
Return type:AIS_DisplayStatus
DisplayedModes()
  • Returns the list of active display modes for the entity aniobj.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:TColStd_ListOfInteger
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.
Parameters:
  • aListOfIO (AIS_ListOfInteractive &) –
  • OnlyFromNeutral (bool) – default value is Standard_False
Return type:

None

  • gives the list of displayed objects of a particular Type and signature. by Default, <WhichSignature> = -1 means control only on <WhichKind>.
Parameters:
  • WhichKind (AIS_KindOfInteractive) –
  • WhichSignature (int) –
  • aListOfIO (AIS_ListOfInteractive &) –
  • OnlyFromNeutral (bool) – default value is Standard_False
Return type:

None

DomainOfMainViewer()
  • Returns the domain name of the main viewer.
Return type:char *
DrawHiddenLine()
  • returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.
Return type:bool
EnableDrawHiddenLine()
Return type:None
EndImmediateDraw()
  • returns True if the immediate display has been done.
Parameters:theView (Handle_V3d_View &) –
Return type:bool
  • Uses the First Active View of Main Viewer! returns True if the immediate display has been done.
Return type:bool
EntityOwners()
  • Returns a collection containing all entity owners created for the interactive object <theIObj> in the selection mode theMode (in all active modes if the Mode == -1)
Parameters:
  • theOwners (SelectMgr_IndexedMapOfOwner &) –
  • theIObj (Handle_AIS_InteractiveObject &) –
  • theMode (int) – default value is -1
Return type:

None

Erase()
  • Hides the object. The object’s presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display().
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

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().
Parameters:updateviewer (bool) – default value is Standard_True
Return type: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().
Parameters:updateviewer (bool) – default value is Standard_True
Return type: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.
Parameters:theListOfIO (AIS_ListOfInteractive &) –
Return type:None
  • gives the list of erased objects (hidden objects) Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
Parameters:
  • WhichKind (AIS_KindOfInteractive) –
  • WhichSignature (int) –
  • theListOfIO (AIS_ListOfInteractive &) –
Return type:

None

Filters()
  • Returns the list of filters active in a local context.
Return type:SelectMgr_ListOfFilter
FirstCurrentObject()
  • Returns the first current 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.
Return type:Handle_AIS_InteractiveObject
GetAutoActivateSelection()
Return type:bool
GetHandle()
GetZLayer()
  • Get Z layer id set for displayed interactive object. If the object doesn’t exists in context or has no computed presentations, the method returns -1.
Parameters:theIObj (Handle_AIS_InteractiveObject &) –
Return type:int
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.
Return type: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.
Return type:float
HasApplicative()
  • Returns true if the applicative object has an owner from Interactive attributed to it.
Return type:bool
HasColor()
  • Returns true if a view of the Interactive Object aniobj has color.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:bool
HasDetected()
  • Returns true if there is a mouse-detected entity in local context. If there is no open local context, the objects selected are called current objects; selected objects if there is one. Iterators allow entities to be recovered in either case. This method is one of a set which allows you to manipulate the objects which have been placed in these two lists.
Return type:bool
HasDetectedShape()
  • Returns true if there is a detected shape in local context. If there is no open local context, the objects selected are called current objects; selected objects if there is one. Iterators allow entities to be recovered in either case. This method is one of a set which allows you to manipulate the objects which have been placed in these two lists.
Return type:bool
HasLocation()
  • Returns true if the entity aniobj has a location.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:bool
HasNextDetected()
  • returns True if other entities were detected in the last mouse detection
Return type:bool
HasOpenedContext()
  • Returns true if there is an open context.
Return type:bool
HasPolygonOffsets()
  • simply calls anObj->HasPolygonOffsets()
Parameters:anObj (Handle_AIS_InteractiveObject &) –
Return type:bool
HasSelectedShape()
  • Returns true if the interactive context has a shape selected in it which results from the decomposition of another entity in local context. If HasSelectedShape returns true, SelectedShape returns the shape which has been shown to be selected. Interactive returns the Interactive Object from which the shape has been selected. If HasSelectedShape returns false, Interactive returns the interactive entity selected by the click of the mouse.
Return type:bool
HiddenLineAspect()
  • 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.
Return type:Handle_Prs3d_LineAspect
HighestIndex()
Return type:int
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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

HilightColor()
  • Returns the name of the color used to show highlighted entities, that is, entities picked out by the mouse.
Return type:Quantity_NameOfColor
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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type: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! returns the Rank of hilighted entity WARNING : Loop Method. When all the detected entities have been hilighted , the next call will hilight the first one again
Parameters:
  • theView (Handle_V3d_View &) –
  • theToRedrawImmediate (bool) – default value is Standard_True
Return type:

int

HilightPreviousDetected()
  • Same as previous methods in reverse direction...
Parameters:
  • theView (Handle_V3d_View &) –
  • theToRedrawImmediate (bool) – default value is Standard_True
Return type:

int

HilightSelected()
  • Highlights selected objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
HilightWithColor()
  • Changes the color of all the lines of the object in view, aniobj. It paints these lines the color passed as the argument, aCol. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aCol (Quantity_NameOfColor) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

ImmediateAdd()
  • returns True if <anIObj> has been stored in the list.
Parameters:
  • theObj (Handle_AIS_InteractiveObject &) –
  • theMode (int) – default value is 0
Return type:

bool

IndexOfCurrentLocal()
  • returns -1 if no opened local context.
Return type:int
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.
Return type:None
InitDetected()
  • Initialization for iteration through mouse-detected objects in interactive context or in local context if it is opened.
Return type:None
InitSelected()
  • Initializes a scan of the selected objects in local context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:None
Interactive()
  • Returns the location of the selected Interactive Object.
Return type:Handle_AIS_InteractiveObject
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.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:bool
IsDisplayed()
  • Returns true if anIobj is displayed in the interactive context.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

bool

Return type:

bool

IsHilighted()
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:bool
  • if <anIObj> is hilighted with a specific color <WithColor> will be returned True <theHiCol> gives the name of the hilightcolor
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • WithColor (bool) –
  • theHiCol (Quantity_NameOfColor &) –
Return type:

bool

IsImmediateModeOn()
Return type:bool
IsInLocal()
  • returns if possible, the first local context where the object is seen
Parameters:
  • anObject (Handle_AIS_InteractiveObject &) –
  • TheIndex (int &) –
Return type:

bool

IsSelected()
  • Finds the selected object aniobj in local context and returns its name. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:bool
IsoNumber()
  • Returns the number of U and V isoparameters displayed.
Parameters:WhichIsos (AIS_TypeOfIso) – default value is AIS_TOI_Both
Return type:int
IsoOnPlane()
  • Returns True if drawing isoparameters on planes is enabled.
Parameters:SwitchOn (bool) –
Return type:None
  • Returns True if drawing isoparameters on planes is enabled. if <forUIsos> = False,
Return type:bool
KeepTemporary()
  • Changes the status of a temporary object. It will be kept at the neutral point, i.e. put in the list of displayed objects along withwith its temporary attributes. These include display mode and selection mode, for example. Returns true if done. inWhichLocal gives the local context in which anIObj is displayed. By default, the index -1 refers to the last Local Context opened.
Parameters:
  • anIObj (Handle_AIS_InteractiveObject &) –
  • InWhichLocal (int) – default value is -1
Return type:

bool

Load()
  • Allows you to load the Interactive Object aniobj with a given selection mode SelectionMode, and/or with the desired decomposition option, whether the object is visualized or not. If AllowDecomp = Standard_True and, if the interactive object is of the ‘Shape’ type, these ‘standard’ selection modes will be automatically activated as a function of the modes present in the Local Context. The loaded objects will be selectable but displayable in highlighting only when detected by the Selector. This method is available only when Local Contexts are open.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • SelectionMode (int) – default value is -1
  • AllowDecomp (bool) – default value is Standard_False
Return type:

None

LocalContext()
  • This method is only intended for advanced operation, particularly with the aim to improve performance when many objects have to be selected together. Otherwise, you should use other (non-internal) methods of class AIS_InteractiveContext without trying to obtain an instance of AIS_LocalContext.
Return type:Handle_AIS_LocalContext
LocalSelector()
Return type:Handle_StdSelect_ViewerSelector3d
Location()
  • Returns the location of the entity aniobj.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:TopLoc_Location
MainPrsMgr()
Return type:Handle_PrsMgr_PresentationManager3d
MainSelector()
Return type: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.
Return type:bool
MoreDetected()
  • returns true if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects.
Return type:bool
MoreSelected()
  • Returns true if there is another object found by the scan of the list of selected objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type: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. Functions in both Neutral Point and local contexts. If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object.
Parameters:
  • theXPix (int) –
  • theYPix (int) –
  • theView (Handle_V3d_View &) –
  • theToRedrawOnUpdate (bool) – default value is Standard_True
Return type:

AIS_StatusOfDetection

NbCurrents()
Return type:int
NbSelected()
Return type: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.
Return type:None
NextDetected()
  • Gets next current object during iteration through mouse-detected interactive objects.
Return type:None
NextSelected()
  • Continues the scan to the next object in the list of selected objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:None
NotUseDisplayedObjects()
  • when a local Context is opened, one is able to use/not use the displayed objects at neutral point at anytime.
Return type: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.
Parameters:
  • theStatus (AIS_DisplayStatus) –
  • theListOfIO (AIS_ListOfInteractive &) –
Return type:

None

  • gives the list of objects with indicated display status Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
Parameters:
  • WhichKind (AIS_KindOfInteractive) –
  • WhichSignature (int) –
  • theStatus (AIS_DisplayStatus) –
  • theListOfIO (AIS_ListOfInteractive &) –
Return type:

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.
Parameters:
  • aListOfIO (AIS_ListOfInteractive &) –
  • WhichKind (AIS_KindOfInteractive) – default value is AIS_KOI_None
  • WhichSignature (int) – default value is -1
Return type:

None

OpenLocalContext()
  • Opens local contexts and specifies how this is to be done. The options listed above function in the following manner: - UseDisplayedObjects -allows you to load or not load the interactive objects visualized at Neutral Point in the local context which you open. If false, the local context is empty after being opened. If true, the objects at Neutral Point are loaded by their default selection mode. - AllowShapeDecomposition -AIS_Shape allows or prevents decomposition in standard shape location mode of objects at Neutral Point which are type-‘privileged’. This Flag is only taken into account when UseDisplayedObjects is true. - AcceptEraseOfObjects -authorises other local contexts to erase the interactive objects present in this context. This option is rarely used. - BothViewers - Has no use currently defined. This method returns the index of the created local context. It should be kept and used to close the context. Opening a local context allows you to prepare an environment for temporary presentations and selections which will disappear once the local context is closed. You can open several local contexts, but only the last one will be active.
Parameters:
  • UseDisplayedObjects (bool) – default value is Standard_True
  • AllowShapeDecomposition (bool) – default value is Standard_True
  • AcceptEraseOfObjects (bool) – default value is Standard_False
  • BothViewers (bool) – default value is Standard_False
Return type:

int

PixelTolerance()
  • Returns the pixel tolerance.
Return type:int
PlaneSize()
  • Returns true if the length in the X direction XSize is the same as that in the Y direction YSize.
Parameters:
  • XSize (float &) –
  • YSize (float &) –
Return type:

bool

PolygonOffsets()
  • Retrieves current polygon offsets settings for <anObj>.
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • aMode (int &) –
  • aFactor (Standard_ShortReal &) –
  • aUnits (Standard_ShortReal &) –
Return type:

None

PreSelectionColor()
  • Returns the name of the color used to show preselection. By default, this is Quantity_NOC_GREEN.
Return type:Quantity_NameOfColor
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.
Return type:int
RecomputePrsOnly()
  • Recomputes the displayed presentations, flags the others Doesn’t update presentations
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
  • allmodes (bool) – default value is Standard_False
Return type:

None

RecomputeSelectionOnly()
  • Recomputes the active selections, flags the others Doesn’t update presentations
Parameters:anIObj (Handle_AIS_InteractiveObject &) –
Return type:None
Redisplay()
  • Recomputes the seen parts presentation of the entity aniobj. If allmodes equals true, all presentations are present in the object even if unseen. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
  • allmodes (bool) – default value is Standard_False
Return type:

None

  • Recomputes the Prs/Selection of displayed objects of a given type and a given signature. if signature = -1 doesnt take signature criterion.
Parameters:
  • aTypeOfObject (AIS_KindOfInteractive) –
  • Signature (int) – default value is -1
  • updateviewer (bool) – default value is Standard_True
Return type:

None

Remove()
  • Removes aniobj from every viewer. aniobj is no longer referenced in the Context. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

RemoveAll()
  • Removes all the objects from all opened Local Contexts and from the Neutral Point
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
RemoveFilter()
  • Removes a filter from Neutral Point or a local context if one or more selection modes have been activated. Only type filters are activated in Neutral Point.
Parameters:aFilter (Handle_SelectMgr_Filter &) –
Return type:None
RemoveFilters()
  • Remove a filter to Neutral Point or a local context if one or more selection modes have been activated. Only type filters are active in Neutral Point.
Return type:None
ResetLocation()
  • Puts the entity aniobj back into its initial position.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:None
ResetOriginalState()
  • to be used only with no opened local context.. displays and activates objects in their original state before local contexts were opened...
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
Select()
  • Selects everything found in the bounding rectangle defined by the pixel minima and maxima, XPMin, YPMin, XPMax, and YPMax in the view, aView The objects detected are passed to the main viewer, which is then updated.
Parameters:
  • XPMin (int) –
  • YPMin (int) –
  • XPMax (int) –
  • YPMax (int) –
  • aView (Handle_V3d_View &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

AIS_StatusOfPick

  • polyline selection; clears the previous picked list
Parameters:
  • Polyline (TColgp_Array1OfPnt2d) –
  • aView (Handle_V3d_View &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

AIS_StatusOfPick

  • Stores and hilights the previous detected; Unhilights the previous picked.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:AIS_StatusOfPick
SelectedInteractive()
Return type:Handle_AIS_InteractiveObject
SelectedOwner()
  • Returns the owner of the selected entity resulting from the decomposition of another entity in local context.
Return type:Handle_SelectMgr_EntityOwner
SelectedShape()
  • Returns the selected shape in the open local context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:TopoDS_Shape
SelectionColor()
  • Returns the name of the color used to show selected entities. By default, this is Quantity_NOC_GRAY80.
Return type:Quantity_NameOfColor
  • Sets the color used to show selected entities. By default, this is Quantity_NOC_GRAY80.
Parameters:aCol (Quantity_NameOfColor) –
Return type:None
SelectionManager()
Return type:Handle_SelectMgr_SelectionManager
SelectionName()
  • Returns the name of the current selected entity in open local context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:TCollection_AsciiString
Sensitivity()
  • Returns the selection sensitivity value.
Return type:float
SensitivityMode()
  • Returns the selection sensitivity mode.
Return type:StdSelect_SensitivityMode
SetAngleAndDeviation()
  • Calls the AIS_Shape SetAngleAndDeviation to set both Angle and Deviation coefficients
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • anAngle (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetAutoActivateSelection()
Parameters:Auto (bool) –
Return type:None
SetAutomaticHilight()
  • Sets the highlighting status aStatus of detected and selected entities. Whether you are in Neutral Point or local context, this is automatically managed by the Interactive Context. This function allows you to disconnect the automatic mode.
Parameters:aStatus (bool) –
Return type:None
SetColor()
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aColor (Quantity_NameOfColor) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Sets the color of the selected entity. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aColor (Quantity_Color &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

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

None

SetCurrentObject()
  • 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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetDeviationAngle()
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • anAngle (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • default 6degrees
Parameters:anAngle (float) –
Return type:None
SetDeviationCoefficient()
  • Sets the deviation coefficient aCoefficient. 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 aCoefficient 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. default 0.001
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aCoefficient (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Sets the deviation coefficient aCoefficient. 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 aCoefficient 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. default 0.001
Parameters:aCoefficient (float) –
Return type:None
SetDisplayMode()
  • Sets the display mode of seen Interactive Objects. aMode provides the display mode index of the entity aniobj. If updateviewer equals Standard_True, the predominant mode aMode will overule the context mode. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object returns to the default selection mode; the object is displayed but no viewer will be updated. Note that display mode 3 is only used if you have an AIS_Textured Shape.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Sets the display mode of seen Interactive Objects. aMode provides the display mode index of the entity aniobj. If updateviewer equals Standard_True, the predominant mode aMode will overule the context mode. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object returns to the default selection mode; the object is displayed but no viewer will be updated. Note that display mode 3 is only used if you have an AIS_Textured Shape.
Parameters:
  • AMode (AIS_DisplayMode) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetDisplayPriority()
  • Sets the display priority aPriority of the seen parts presentation of the entity anIobj.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • aPriority (int) –
Return type:

None

SetHLRAngle()
  • Sets the HLR angle anAngle.
Parameters:anAngle (float) –
Return type: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.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • anAngle (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • compute with anangle a HLRAngle and a HLRDeviationCoefficient and set them in myHLRAngle and in myHLRDeviationCoefficient of myDefaultDrawer ; anAngle is in radian ; ( 1 deg < angle in deg < 20 deg)
Parameters:anAngle (float) –
Return type:None
SetHLRDeviationAngle()
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • anAngle (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetHLRDeviationCoefficient()
  • Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aCoefficient (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
Parameters:aCoefficient (float) –
Return type:None
SetHiddenLineAspect()
  • Sets the hidden line aspect anAspect. anAspect defines display attributes for hidden lines in HLR projections.
Parameters:anAspect (Handle_Prs3d_LineAspect &) –
Return type:None
SetHilightColor()
  • Sets the color used to show highlighted entities, that is, entities picked by the mouse. By default, this is Quantity_NOC_CYAN1.
Parameters:aHiCol (Quantity_NameOfColor) –
Return type:None
SetIsoNumber()
  • Sets the number of U and V isoparameters displayed.
Parameters:
  • NbIsos (int) –
  • WhichIsos (AIS_TypeOfIso) – default value is AIS_TOI_Both
Return type:

None

SetLocalAttributes()
  • Sets the attributes of the interactive object aniobj by plugging the attribute manager aDrawer into the local context. The graphic attributes of aDrawer such as visualization mode, color, and material, are then used to display aniobj. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aDrawer (Handle_AIS_Drawer &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetLocation()
  • Puts the location aLocation on the initial graphic representation and the selection for the entity aniobj. In other words, aniobj is visible and selectable at a position other than initial position. Graphic and selection primitives are not recomputed. To clean the view correctly, you must reset the previous location.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aLocation (TopLoc_Location &) –
Return type:

None

SetMaterial()
  • Provides the type of material setting for the view of the entity aniobj. The range of settings includes: BRASS, BRONZE, GOLD, PEWTER, SILVER, STONE. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aName (Graphic3d_NameOfMaterial) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetOkCurrent()
Return type:None
SetPixelTolerance()
  • Define the current selection pixel sensitivity for this context or local context if any one is activated. Warning: When a local context is open the sensitivity is apply on it instead on the main context.
Parameters:aPrecision (int) – default value is 4
Return type:None
SetPlaneSize()
  • Sets the plane size defined by the length in the X direction XSize and that in the Y direction YSize. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aSizeX (float) –
  • aSizeY (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • Sets the plane size aSize. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. May be used if PlaneSize returns true.
Parameters:
  • aSize (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetPolygonOffsets()
  • Sets up polygon offsets for the given AIS_InteractiveObject. It simply calls anObj->SetPolygonOffsets()
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
  • aFactor (Standard_ShortReal) – default value is 1.0
  • aUnits (Standard_ShortReal) – default value is 0.0
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetPreselectionColor()
  • Allows you to set the color used to show preselection. By default, this is Quantity_NOC_GREEN. A preselected entity is one which has been selected as the domain of application of a function such as a fillet.
Parameters:aCol (Quantity_NameOfColor) –
Return type:None
SetSelected()
  • Puts the interactive object aniObj in the list of selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniObj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetSelectedAspect()
  • Sets the graphic basic aspect to the current presentation of ALL selected objects. When <globalChange> is True , the full object presentation is changed. When <globalChange> is False , only the current group of the object presentation is changed. Updates the viewer when <updateViewer> is True
Parameters:
  • anAspect (Handle_Prs3d_BasicAspect &) –
  • globalChange (bool) – default value is Standard_True
  • updateViewer (bool) – default value is Standard_True
Return type:

None

SetSelectedCurrent()
  • puts the selected list in the current objects List.
Return type:None
SetSelectionMode()
  • Sets the selection mode of Interactive Objects. aMode provides the selection mode index of the entity aniobj.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

None

SetSensitivity()
  • Sets the sensitivity aPrecision according to the view size for the current context or local context if any is activated. Sets the sensitivity aPrecision in pixels for the current context or local context if any is activated. By default, this sensitivity is equal to 4 pixels. When a local context is open, the defined sensitivity applies to this local context instead of the main context.
Parameters:aPrecision (float) –
Return type:None
SetSensitivityMode()
  • Sets the selection sensitivity mode. SM_WINDOW mode uses the specified pixel tolerance to compute the sensitivity value, SM_VIEW mode allows to define the sensitivity manually.
Parameters:aMode (StdSelect_SensitivityMode) –
Return type:None
SetShapeDecomposition()
  • to be Used only with opened local context and if <anIobj> is of type shape... if <aStatus> = True <anIobj> will be sensitive to shape selection modes activation. = False, <anIobj> will not be senstive any more.
Parameters:
  • anIobj (Handle_AIS_InteractiveObject &) –
  • aStatus (bool) –
Return type:

None

SetSubIntensityColor()
  • Sets the color used to show that an object is not currently selected. By default, this is Quantity_NOC_GRAY40.
Parameters:aCol (Quantity_NameOfColor) –
Return type:None
SetTemporaryAttributes()
  • Sets the temporary graphic attributes of the entity anObj. These are provided by the attribute manager aDrawer and are valid for a particular local context only. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • aDrawer (Handle_Prs3d_Drawer &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

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.
Parameters:toHilight (bool) –
Return type:None
SetTransparency()
  • Provides the transparency settings for viewing the entity aniobj. The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aValue (float) – default value is 0.6
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetTrihedronSize()
  • 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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aSize (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetWidth()
  • Sets the width of the entity aniobj. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • aValue (float) –
  • updateviewer (bool) – default value is Standard_True
Return type:

void

SetZDetection()
  • Enables/Disables the Z detection. If True the detection echo can be partially hidden by the detected object.
Parameters:aStatus (bool) – default value is Standard_False
Return type:None
SetZLayer()
  • Set Z layer id for interactive object. The layer can be specified for displayed object only. 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. Note that Z layers differ from under-/overlayer in V3d_View: under-/overlayer are intended for specific 2D drawings that appear behind/in front of all 3D presentations, while SetZLayer() method applies to regular 3D presentations and does not imply any specific drawing methods.
Parameters:
  • theIObj (Handle_AIS_InteractiveObject &) –
  • theLayerId (int) –
Return type:

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.
Parameters:updateviewer (bool) – default value is Standard_True
Return type: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.
Parameters:
  • Polyline (TColgp_Array1OfPnt2d) –
  • aView (Handle_V3d_View &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

AIS_StatusOfPick

  • rectangle of selection ; adds new detected entities into the picked list, removes the detected entities that were already stored...
Parameters:
  • XPMin (int) –
  • YPMin (int) –
  • XPMax (int) –
  • YPMax (int) –
  • aView (Handle_V3d_View &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

AIS_StatusOfPick

Status()
  • Returns the status astatus of the Interactive Context for the view of the Interactive Object anObj.
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • astatus (TCollection_ExtendedString &) –
Return type:

None

SubIntensityColor()
  • Returns the name of the color used to show that an object is not currently selected. By default, this is Quantity_NOC_GRAY40.
Return type:Quantity_NameOfColor
SubIntensityOff()
  • Removes the subintensity option for the entity aniobj. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • removes subintensity option for all objects.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
SubIntensityOn()
  • Highlights, and removes highlights from, the displayed object aniobj 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 and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

  • hilights/unhilights displayed objects which are displayed at neutral state with subintensity color; available only for active local context. No effect if no local context.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
ToHilightSelected()
  • Return value specified whether selected object must be hilighted when mouse cursor is moved above it
Return type:bool
TrihedronSize()
  • returns the current value of trihedron size.
Return type:float
Unhilight()
  • Removes hilighting from the entity aniobj. Updates the viewer. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

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. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
UnhilightSelected()
  • Removes highlighting from selected objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
UnsetColor()
  • Removes the color selection for the selected entity. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UnsetDisplayMode()
  • Unsets the display mode of seen Interactive Objects. aMode provides the display mode index of the entity aniobj. If updateviewer equals Standard_True, the predominant mode aMode will overule the context mode. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object returns to the default selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UnsetLocalAttributes()
  • Removes the settings for local attributes of the entity anObj and returns to the Neutral Point attributes or those of the previous local context. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UnsetMaterial()
  • Removes the type of material setting for viewing the entity aniobj. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • anObj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UnsetSelectionMode()
  • Removes selection mode from Interactive Objects. aMode provides the selection mode index of the entity aniobj.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:None
UnsetTransparency()
  • Removes the transparency settings for viewing the entity aniobj. The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UnsetWidth()
  • Removes the width setting of the entity aniobj. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

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.
Parameters:
  • theIObj (Handle_AIS_InteractiveObject &) –
  • theUpdateViewer (bool) – default value is Standard_True
Return type:

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.
Return type:None
UpdateCurrentViewer()
  • Updates the current viewer, the viewer in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:None
UpdateSelected()
  • updates the list of selected objects i.e. hilights the new selected unhilights old selected objects
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
UseDisplayedObjects()
Return type:None
WasCurrentTouched()
  • Returns the current selection touched by the cursor. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
Return type:bool
Width()
  • Returns the width of the Interactive Object aniobj in the interactive context.
Parameters:aniobj (Handle_AIS_InteractiveObject &) –
Return type:float
ZDetection()
  • Retrieves the Z detection state.
Return type:bool
thisown

The membership flag

class AIS_InteractiveObject(*args, **kwargs)

Bases: object

AcceptDisplayMode()
  • Returns true if the class of objects accepts the display mode aMode. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by a given class of objects. Consequently, this virtual method allowing us to get information about the class in question must be implemented.
Parameters:aMode (int) –
Return type:bool
AcceptShapeDecomposition()
  • Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape. Activation methods for standard selection modes are proposed in the Interactive Context. These include selection by vertex or by edges. For datums with the same behavior as AIS_Shape, such as vetices and edges, we must redefine the virtual method so that AcceptShapeDecomposition returns false. Rule for selection : Mode 0 : Selection of the interactive Object itself Mode 1 : Selection of vertices Mode 2 : Selection Of Edges Mode 3 : Selection Of Wires Mode 4 : Selection Of Faces ...
Return type:bool
AddUser()
Parameters:aUser (Handle_Standard_Transient &) –
Return type:None
Attributes()
  • Returns the attributes settings.
Return type:Handle_AIS_Drawer
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.
Return type:None
ClearUsers()
Return type:None
Color()
  • Returns the color setting of the Interactive Object.
Return type:Quantity_NameOfColor
Parameters:aColor (Quantity_Color &) –
Return type:None
CurrentFacingModel()
  • Returns the current facing model which is in effect.
Return type:Aspect_TypeOfFacingModel
DefaultDisplayMode()
  • Returns the default display mode. This method is to be implemented when the main mode is not mode 0.
Return type:int
DisplayMode()
  • Returns the display mode setting of the Interactive Object. The range of possibilities is the following: - AIS_WireFrame - AIS_Shaded This range can, however, be extended through the creation of new display modes.
Return type:int
GetContext()
  • Returns the context pointer to the interactive context.
Return type:Handle_AIS_InteractiveContext
GetHandle()
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.
Return type:Handle_Standard_Transient
HasColor()
  • Returns true if the Interactive Object has color.
Return type:bool
HasDisplayMode()
  • Returns true if the Interactive Object has a display mode setting. Otherwise, it is displayed in Neutral Point.
Return type:bool
HasHilightMode()
  • Returns true if the Interactive Object is in highlight mode.
Return type:bool
HasInteractiveContext()
  • Indicates whether the Interactive Object has a pointer to an interactive context.
Return type:bool
HasMaterial()
  • Returns true if the Interactive Object has a setting for material.
Return type: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.
Return type:bool
HasPolygonOffsets()
  • Returns Standard_True if <myDrawer> has non-null shading aspect
Return type:bool
HasPresentation()
  • Returns True when this object has a presentation in the current DisplayMode()
Return type:bool
HasSelectionMode()
  • Allows you to change the selection mode of an Interactive Object. The default selection mode setting is 0. For shapes, for example, the selection modes are as follows: - mode 0 - selection of the shape itself - mode 1 - selection of vertices - mode 2 - selection of edges - mode 3 - selection of wires - mode 4 - selection of faces - mode 5 - selection of shells - mode 6 - selection of solids - mode 7 - selection of compounds For trihedra, on the other hand, the selection modes are the following four: - mode 0 - selection of a trihedron - mode 1 - selection of its origin - mode 2 - selection of its axes - mode 3 - selection of its planes
Return type:bool
HasSelectionPriority()
  • Returns true if there is a setting for selection priority. You can modify selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6.
Return type:bool
HasUsers()
Return type:bool
HasWidth()
  • Returns true if the Interactive Object has width.
Return type:bool
HilightMode()
  • Returns the setting for highlight mode. At dynamic detection, the presentation echoed by the Interactive Context, is by default the presentation already on the screen. You can specify a Highlight presentation mode which is valid no matter what the active representation of the object. It makes no difference whether this choice is temporary or definitive. To do this, we use the following functions: - SetHilightMode - UnSetHilightMode In the case of a shape, whether it is visualized in wireframe presentation or with shading, we want to systematically highlight the wireframe presentation. Consequently, we set the highlight mode to 0.
Return type:int
IsInfinite()
  • Returns true if the interactive object is infinite. In this case, its graphic presentations are not taken into account in the fit-all view.
Return type:bool
IsTransparent()
  • Returns true if there is a transparency setting.
Return type:bool
Material()
  • Returns the current material setting. This will be on of the following materials: - Brass - Bronze - Gold - Pewter - Silver - Stone.
Return type:Graphic3d_NameOfMaterial
PolygonOffsets()
  • Retrieves current polygon offsets settings from <myDrawer>.
Parameters:
  • aMode (int &) –
  • aFactor (Standard_ShortReal &) –
  • aUnits (Standard_ShortReal &) –
Return type:

void

Presentation()
  • Returns the current presentation of this object according to the current DisplayMode()
Return type:Handle_Prs3d_Presentation
Redisplay()
  • Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed.
Parameters:AllModes (bool) – default value is Standard_False
Return type:None
SelectionMode()
  • Returns the selection mode of the interactive object.
Return type:int
SelectionPriority()
  • Returns the selection priority setting. -1 indicates that there is none. You can modify the selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6 if both objects are selected at the same time. You could give vertices priority 8, edges priority 7, faces priority 6, and shapes priority 5. If a vertex, an edge and a face are simultaneously detected during selection, only the vertex will then be highlighted. For trihedra, for example, the default priorities are the following four: - priority 1 - a trihedron - priority 5 - its origin - priority 3 - its axes - priority 2 - its planes
Return type:int
SetAspect()
  • Sets the graphic basic aspect to the current presentation. When <globalChange> is True , the full object presentation is changed. When <globalChange> is False , only the current group of the object presentation is changed.
Parameters:
  • anAspect (Handle_Prs3d_BasicAspect &) –
  • globalChange (bool) – default value is Standard_True
Return type:

None

SetAttributes()
  • Initializes the drawing tool aDrawer.
Parameters:aDrawer (Handle_AIS_Drawer &) –
Return type:void
SetColor()
Parameters:aColor (Quantity_Color &) –
Return type:void
  • only the interactive obj knowns which Drawer attribute is affected by the color (ex: for a wire, it’s the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color) WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myOwnColor)
Parameters:aColor (Quantity_NameOfColor) –
Return type:void
SetContext()
  • Sets the interactive context aCtx and provides a link to the default drawing tool or ‘Drawer’ if there is none.
Parameters:aCtx (Handle_AIS_InteractiveContext &) –
Return type:void
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.
Parameters:aModel (Aspect_TypeOfFacingModel) – default value is Aspect_TOFM_BOTH_SIDE
Return type:None
SetDisplayMode()
  • Sets the display mode aMode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context. The range of possibilities currently proposed is the following: - AIS_WireFrame - AIS_Shaded This range can, however, be extended through the creation of new display modes.
Parameters:aMode (int) –
Return type:None
SetHilightMode()
  • Sets the highlight mode anIndex for the interactive object. If, for example, you want to systematically highlight the wireframe presentation of a shape - whether visualized in wireframe presentation or with shading - you set the highlight mode to 0.
Parameters:anIndex (int) –
Return type:None
SetInfiniteState()
  • Sets the infinite state flag aFlage. if <aFlag> = True , the interactiveObject is considered as infinite, i.e. its graphic presentations are not taken in account for View FitAll...
Parameters:aFlag (bool) – default value is Standard_True
Return type:None
SetMaterial()
  • Sets the name aName for material defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.
Parameters:aName (Graphic3d_NameOfMaterial) –
Return type:void
  • Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.
Parameters:aName (Graphic3d_MaterialAspect &) –
Return type:void
SetOwner()
  • Allows you to attribute the owner ApplicativeEntity 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.
Parameters:ApplicativeEntity (Handle_Standard_Transient &) –
Return type:None
SetPolygonOffsets()
  • Sets up polygon offsets for this object. It modifies all existing presentations of <anObj> (if any), so it is reasonable to call this method after <anObj> has been displayed. Otherwise, Compute() method should pass Graphic3d_AspectFillArea3d aspect from <myDrawer> to Graphic3d_Group to make polygon offsets work. //! <aMode> parameter can contain various combinations of Aspect_PolygonOffsetMode enumeration elements (Aspect_POM_None means that polygon offsets are not changed). If <aMode> is different from Aspect_POM_Off and Aspect_POM_None, then <aFactor> and <aUnits> arguments are used by graphic renderer to calculate a depth offset value: //! offset = <aFactor> * m + <aUnits> * r, where m - maximum depth slope for the polygon currently being displayed, r - minimum window coordinates depth resolution (implementation-specific). //! Deafult settings for OCC 3D viewer: mode = Aspect_POM_Fill, factor = 1., units = 0. //! Negative offset values move polygons closer to the viewport, while positive values shift polygons away. Consult OpenGL reference for details (glPolygonOffset function description). //! NOTE: This method has a side effect - it creates own shading aspect if not yet created, so it is better to set up object material, color, etc. first.
Parameters:
  • aMode (int) –
  • aFactor (Standard_ShortReal) – default value is 1.0
  • aUnits (Standard_ShortReal) – default value is 0.0
Return type:

void

SetSelectionMode()
  • You can change the default selection mode index aMode of an Interactive Object. This is only of interest if you decide that mode 0 adopted by convention will not do.
Parameters:aMode (int) –
Return type:None
SetSelectionPriority()
  • Allows you to provide a setting aPriority for selection priority. You can modify selection priority of an owner to make one entity more selectionable than another one. The default selection priority for an owner is 5, for example. To increase selection priority, choose a setting between 5 and 10. An entity with priority 7 will take priority over one with a setting of 6.
Parameters:aPriority (int) –
Return type:None
SetTransparency()
  • Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible.
Parameters:aValue (float) – default value is 0.6
Return type:void
SetWidth()
  • Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
Parameters:aValue (float) –
Return type:void
Signature()
  • Specifies additional characteristics of Interactive Objects. A signature is, in fact, an index with integer values assigned different properties. This method is frequently used in conjuction with Type to give a particular type and signature to an Interactive Object. By default, the Interactive Object has a None type and a signature of 0. 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.
Return type:int
State()
Parameters:theState (int) –
Return type:None
Return type:int
Transparency()
  • Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent.
Return type:float
Type()
  • Returns the kind of Interactive Object: - None - Datum - Relation - Object By default, the interactive object has a None type. Because specific shapes entail different behavior according to their sub-shapes, you may need to create a Local Context. This will allow you to specify the additional characteristics which you need to handle these shapes.
Return type:AIS_KindOfInteractive
UnsetAttributes()
  • Clears settings provided by the drawing tool aDrawer.
Return type:void
UnsetColor()
  • Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting.
Return type:void
UnsetDisplayMode()
  • Removes display mode settings from the interactive object.
Return type:None
UnsetHilightMode()
  • Allows the user to take a given Prs for hilight ex : for a shape which would be displayed in shading mode the hilight Prs is the wireframe mode. if No specific hilight mode is defined, the displayed Prs will be the hilighted one.
Return type:None
UnsetMaterial()
  • Removes the setting for material.
Return type:void
UnsetSelectionMode()
  • You can change the default selection mode index of an Interactive Object. This is only of interest if you decide that the 0 mode adopted by convention will not do.
Return type:None
UnsetSelectionPriority()
  • Removes the setting for selection priority. SelectionPriority then returns -1.
Return type:None
UnsetTransparency()
  • Removes the transparency setting. The object is opaque by default.
Return type:void
UnsetWidth()
Return type:void
Users()
Return type:TColStd_ListOfTransient
Width()
  • Returns the width setting of the Interactive Object.
Return type:float
thisown

The membership flag

class AIS_LengthDimension(*args)

Bases: OCC.AIS.AIS_Dimension

  • 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).
Parameters:
  • theFace (TopoDS_Face &) –
  • theEdge (TopoDS_Edge &) –
Return type:

None

  • Construct length dimension between two faces. @param theFirstFace [in] the first face (first shape). @param theSecondFace [in] the second face (second shape).
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
Return type:

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

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.
Parameters:
  • theFirstShape (TopoDS_Shape &) –
  • theSecondShape (TopoDS_Shape &) –
  • thePlane (gp_Pln) –
Return type:

None

  • Construct length dimension of linear edge. @param theEdge [in] the edge to measure. @param thePlane [in] the plane to orient dimension.
Parameters:
  • theEdge (TopoDS_Edge &) –
  • thePlane (gp_Pln) –
Return type:

None

FirstPoint()
  • returns first attachement point.
Return type:gp_Pnt
FirstShape()
  • returns first attachement shape.
Return type:TopoDS_Shape
GetHandle()
GetTextPosition()
Return type:gp_Pnt
SecondPoint()
  • returns second attachement point.
Return type:gp_Pnt
SecondShape()
  • returns second attachement shape.
Return type:TopoDS_Shape
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
Parameters:
Return type:

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
Parameters:
  • theEdge (TopoDS_Edge &) –
  • thePlane (gp_Pln) –
Return type:

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).
Parameters:
  • theFirstFace (TopoDS_Face &) –
  • theSecondFace (TopoDS_Face &) –
Return type:

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).
Parameters:
  • theFace (TopoDS_Face &) –
  • theEdge (TopoDS_Edge &) –
Return type:

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.
Parameters:
  • theFirstShape (TopoDS_Shape &) –
  • theSecondShape (TopoDS_Shape &) –
Return type:

None

SetTextPosition()
Parameters:theTextPos (gp_Pnt) –
Return type:void
thisown

The membership flag

class AIS_Line(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes the line aLine.
Parameters:aLine (Handle_Geom_Line &) –
Return type:None
  • Initializes a starting point aStartPoint and a finishing point aEndPoint for the line.
Parameters:
  • aStartPoint (Handle_Geom_Point &) –
  • aEndPoint (Handle_Geom_Point &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
Line()
  • Constructs an infinite line.
Return type:Handle_Geom_Line
Points()
  • Returns the starting point PStart and the end point PEnd of the line set by SetPoints.
Parameters:
  • PStart (Handle_Geom_Point &) –
  • PEnd (Handle_Geom_Point &) –
Return type:

None

SetColor()
  • Provides a new color setting aColor for the line in the drawing tool, or ‘Drawer’.
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

None

SetLine()
  • instantiates an infinite line.
Parameters:L (Handle_Geom_Line &) –
Return type:None
SetPoints()
  • Sets the starting point P1 and ending point P2 of the infinite line to create a finite line segment.
Parameters:
  • P1 (Handle_Geom_Point &) –
  • P2 (Handle_Geom_Point &) –
Return type:

None

thisown

The membership flag

class AIS_ListIteratorOfListOfInteractive(*args)

Bases: object

Return type:None
Parameters:L (AIS_ListOfInteractive &) –
Return type:None
Initialize()
Parameters:L (AIS_ListOfInteractive &) –
Return type:None
More()
Return type:bool
Next()
Return type:None
Value()
Return type:Handle_AIS_InteractiveObject
thisown

The membership flag

class AIS_ListNodeOfListOfInteractive(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_AIS_InteractiveObject
thisown

The membership flag

class AIS_ListOfInteractive(*args)

Bases: object

Return type:None
Parameters:Other (AIS_ListOfInteractive &) –
Return type:None
Append()
Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • I
  • theIt (AIS_ListIteratorOfListOfInteractive &) –
  • Other (AIS_ListOfInteractive &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (AIS_ListOfInteractive &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_AIS_InteractiveObject
InsertAfter()
Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • It (AIS_ListIteratorOfListOfInteractive &) –
  • Other (AIS_ListOfInteractive &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • It (AIS_ListIteratorOfListOfInteractive &) –
  • Other (AIS_ListOfInteractive &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_AIS_InteractiveObject
Prepend()
Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • I
  • theIt (AIS_ListIteratorOfListOfInteractive &) –
  • Other (AIS_ListOfInteractive &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (AIS_ListIteratorOfListOfInteractive &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (AIS_ListOfInteractive &) –
Return type:None
thisown

The membership flag

class AIS_LocalContext(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
  • Constructor By Default, the displayed objects are automatically loaded.
Parameters:
  • aCtx (Handle_AIS_InteractiveContext &) –
  • anIndex (int) –
  • LoadDisplayed (bool) – default value is Standard_True
  • AcceptStandardModes (bool) – default value is Standard_True
  • AcceptErase (bool) – default value is Standard_False
  • UseBothViewers (bool) – default value is Standard_False
Return type:

None

AcceptErase()
  • authorize or not others contexts to erase temporary displayed objects here;
Parameters:aStatus (bool) –
Return type:None
Return type:bool
ActivateMode()
  • optional : activation of a mode which is not 0 for a selectable...
Parameters:
  • aSelectable (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

None

ActivateStandardMode()
  • decomposition of shapes into <aType>
Parameters:aType (TopAbs_ShapeEnum) –
Return type:None
AddFilter()
Parameters:aFilter (Handle_SelectMgr_Filter &) –
Return type:None
AddOrRemoveSelected()
  • useful to update selection with objects coming from Collector or stack
Parameters:
  • anobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
  • aShape (TopoDS_Shape &) –
  • updateviewer – default value is Standard_True
  • theOwner (Handle_SelectMgr_EntityOwner &) –
  • toUpdateViewer (bool) – default value is Standard_True
Return type:

None

Return type:

None

Return type:

None

AutomaticHilight()
Return type:bool
BeginImmediateDraw()
  • Resets the transient list of presentations previously displayed in immediate mode and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
Return type:bool
Clear()
  • according to <atype> , clears the different parts of the selector (filters, modeof activation, objects...)
Parameters:atype (AIS_ClearMode) – default value is AIS_CM_All
Return type:None
ClearAreas()
Parameters:aView (Handle_V3d_View &) –
Return type:None
ClearImmediateDraw()
  • Resets the transient list of presentations previously displayed in immediate mode.
Return type:void
ClearOutdatedSelection()
  • Clears outdated selection and detection of owners for the interactive object. Use this method if selection structures of the interactive object have changed. The method unhilights and removes outdated entity owners from lists of selected and detected owners. @param theIO [in] the interactive object. @param toClearDeactivated [in] pass True to treat deactivated entity owners as ‘outdated’ when clearing the selection.
Parameters:
  • theIO (Handle_AIS_InteractiveObject &) –
  • toClearDeactivated (bool) –
Return type:

None

ClearPrs()
Parameters:
  • anInteractive (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

bool

ClearSelected()
  • Clears local context selection. @param toUpdateViewer [in] if True the viewer will be updated.
Parameters:toUpdateViewer (bool) – default value is Standard_True
Return type:None
ClearSensitive()
Parameters:aView (Handle_V3d_View &) –
Return type:None
Deactivate()
Parameters:aSelectable (Handle_AIS_InteractiveObject &) –
Return type:None
DeactivateMode()
Parameters:
  • aSelectable (Handle_AIS_InteractiveObject &) –
  • aMode (int) –
Return type:

None

DeactivateStandardMode()
Parameters:aType (TopAbs_ShapeEnum) –
Return type:None
DetectedCurrentObject()
  • returns current mouse-detected interactive object or null object if there is no current detected.
Return type:Handle_AIS_InteractiveObject
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.
Return type:TopoDS_Shape
DetectedInteractive()
Return type:Handle_AIS_InteractiveObject
DetectedOwner()
Return type:Handle_SelectMgr_EntityOwner
DetectedShape()
Return type:TopoDS_Shape
Display()
  • returns true if done...
Parameters:
  • anInteractive (Handle_AIS_InteractiveObject &) –
  • DisplayMode (int) – default value is 0
  • AllowShapeDecomposition (bool) – default value is Standard_True
  • ActivationMode (int) – default value is 0
Return type:

bool

DisplayAreas()
Parameters:aviou (Handle_V3d_View &) –
Return type:None
DisplaySensitive()
Parameters:aView (Handle_V3d_View &) –
Return type:None
DisplayedObjects()
Parameters:theMapToFill (TColStd_MapOfTransient &) –
Return type:int
EndImmediateDraw()
  • Allows rapid drawing of the view theView by avoiding an update of the whole background.
Parameters:theView (Handle_V3d_View &) –
Return type:bool
Erase()
  • returns true if done...
Parameters:anInteractive (Handle_AIS_InteractiveObject &) –
Return type:bool
Filter()
Return type:Handle_SelectMgr_OrFilter
FindSelectedOwnerFromIO()
Parameters:anIObj (Handle_AIS_InteractiveObject &) –
Return type:Handle_SelectMgr_EntityOwner
FindSelectedOwnerFromShape()
Parameters:aShape (TopoDS_Shape &) –
Return type:Handle_SelectMgr_EntityOwner
GetHandle()
GetZLayer()
  • Get Z layer id set for displayed interactive object. If the object doesn’t exists in context or has no computed presentations, the method returns -1.
Parameters:theIObj (Handle_AIS_InteractiveObject &) –
Return type:int
HasApplicative()
  • returns True if an interactive element was associated with the current picked entity.
Return type:bool
HasDetected()
Return type:bool
HasDetectedShape()
Return type:bool
HasNextDetected()
  • returns True if more than one entity was detected at the last Mouse position.
Return type:bool
HasSameProjector()
  • compares the current projector of the localContext with <aPrj> returns True if the projectors are identical. (no need to update projection of selection primitives when closing the local context)....
Parameters:aPrj (Handle_Select3D_Projector &) –
Return type:bool
HasShape()
  • returns True if the detected entity is a shape coming from a Decomposition of an element.
Return type:bool
Hilight()
Parameters:
  • anObject (Handle_AIS_InteractiveObject &) –
  • anObject
  • aCol (Quantity_NameOfColor) –
Return type:

None

Return type:

None

HilightNextDetected()
  • returns True if last detected. the next detected will be first one (endless loop)
Parameters:
  • theView (Handle_V3d_View &) –
  • theToRedrawImmediate (bool) –
Return type:

int

HilightPicked()
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
HilightPreviousDetected()
Parameters:
  • theView (Handle_V3d_View &) –
  • theToRedrawImmediate (bool) –
Return type:

int

ImmediateAdd()
  • Stores presentation theMode of object theObj in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method.
Parameters:
  • theObj (Handle_AIS_InteractiveObject &) –
  • theMode (int) – default value is 0
Return type:

bool

InitDetected()
  • Initialization for iteration through mouse-detected objects in local context.
Return type:None
InitSelected()
Return type:None
IsDisplayed()
Parameters:
  • anObject (Handle_AIS_InteractiveObject &) –
  • anObject
  • aMode (int) –
Return type:

bool

Return type:

bool

IsHilighted()
Parameters:
  • anObject (Handle_AIS_InteractiveObject &) –
  • anObject
  • WithColor (bool) –
  • HiCol (Quantity_NameOfColor &) –
Return type:

bool

Return type:

bool

IsImmediateModeOn()
  • Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
Return type:bool
IsIn()
Parameters:anObject (Handle_AIS_InteractiveObject &) –
Return type:bool
IsSelected()
Parameters:
  • aniobj (Handle_AIS_InteractiveObject &) –
  • anOwner (Handle_SelectMgr_EntityOwner &) –
Return type:

bool

Return type:

bool

ListOfFilter()
Return type:SelectMgr_ListOfFilter
Load()
  • loads <anInteractive> with nodisplay... returns true if done
Parameters:
  • anInteractive (Handle_AIS_InteractiveObject &) –
  • AllowShapeDecomposition (bool) – default value is Standard_True
  • ActivationMode (int) – default value is 0
Return type:

bool

LoadContextObjects()
Return type:None
MainSelector()
Return type:Handle_StdSelect_ViewerSelector3d
MoreDetected()
  • returns true if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects.
Return type:bool
MoreSelected()
Return type:bool
MoveTo()
Parameters:
  • theXpix (int) –
  • theYpix (int) –
  • theView (Handle_V3d_View &) –
  • theToRedrawImmediate (bool) –
Return type:

AIS_StatusOfDetection

NextDetected()
  • Gets next current object during iteration through mouse-detected interactive objects.
Return type:None
NextSelected()
Return type:None
PixelTolerance()
  • Returns the pixel tolerance.
Return type:int
Remove()
Parameters:aSelectable (Handle_AIS_InteractiveObject &) –
Return type:bool
RemoveFilter()
Parameters:aFilter (Handle_SelectMgr_Filter &) –
Return type:None
Select()
  • returns the number of selected
Parameters:
  • updateviewer (bool) – default value is Standard_True
  • XPMin (int) –
  • YPMin (int) –
  • XPMax (int) –
  • YPMax (int) –
  • aView (Handle_V3d_View &) –
  • updateviewer – default value is Standard_True
  • Polyline (TColgp_Array1OfPnt2d) –
  • aView
  • updateviewer – default value is Standard_True
Return type:

AIS_StatusOfPick

Return type:

AIS_StatusOfPick

Return type:

AIS_StatusOfPick

SelectedApplicative()
Return type:Handle_Standard_Transient
SelectedInteractive()
Return type:Handle_AIS_InteractiveObject
SelectedOwner()
Return type:Handle_SelectMgr_EntityOwner
SelectedShape()
Return type:TopoDS_Shape
SelectionModes()
Parameters:anObject (Handle_AIS_InteractiveObject &) –
Return type:TColStd_ListOfInteger
SelectionName()
Return type:TCollection_AsciiString
Sensitivity()
  • Returns the selection sensitivity value.
Return type:float
SensitivityMode()
  • Returns the selection sensitivity mode.
Return type:StdSelect_SensitivityMode
SetAutomaticHilight()
  • if <aStatus> = True , the shapes or subshapes detected by the selector will be automatically hilighted in the main viewer. Else the user has to manage the detected shape outside the Shape Selector....
Parameters:aStatus (bool) –
Return type:None
SetContext()
Parameters:aCtx (Handle_AIS_InteractiveContext &) –
Return type:None
SetDisplayPriority()
Parameters:
  • anObject (Handle_AIS_InteractiveObject &) –
  • Prior (int) –
Return type:

None

SetPixelTolerance()
  • Define the current selection sensitivity for this local context according to the view size.
Parameters:aPrecision (int) – default value is 2
Return type:None
SetSelected()
  • useful to update selection with objects coming from Collector or stack
Parameters:
  • anobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

SetSensitivity()
  • Define the current selection sensitivity for this local context according to the view size.
Parameters:aPrecision (float) –
Return type:None
SetSensitivityMode()
  • Sets the selection sensitivity mode. SM_WINDOW mode uses the specified pixel tolerance to compute the sensitivity value, SM_VIEW mode allows to define the sensitivity manually.
Parameters:aMode (StdSelect_SensitivityMode) –
Return type:None
SetShapeDecomposition()
  • allows or forbids the shape decomposition into Activated Standard Mode for <aStoredObject> does nothing if the object doesn’t inherits BasicShape from AIS
Parameters:
  • aStoredObject (Handle_AIS_InteractiveObject &) –
  • aStatus (bool) –
Return type:

None

SetZLayer()
  • Set Z layer id for interactive object. The layer can be specified for displayed object only. 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. Note that Z layers differ from under-/overlayer in V3d_View: under-/overlayer are intended for specific 2D drawings that appear behind/in front of all 3D presentations, while SetZLayer() method applies to regular 3D presentations and does not imply any specific drawing methods.
Parameters:
  • theIObj (Handle_AIS_InteractiveObject &) –
  • theLayerId (int) –
Return type:

None

ShiftSelect()
Parameters:
  • updateviewer (bool) – default value is Standard_True
  • XPMin (int) –
  • YPMin (int) –
  • XPMax (int) –
  • YPMax (int) –
  • aView (Handle_V3d_View &) –
  • updateviewer – default value is Standard_True
  • Polyline (TColgp_Array1OfPnt2d) –
  • aView
  • updateviewer – default value is Standard_True
Return type:

AIS_StatusOfPick

Return type:

AIS_StatusOfPick

Return type:

AIS_StatusOfPick

StandardModes()
Return type:TColStd_ListOfInteger
SubIntensityOff()
Parameters:anObject (Handle_AIS_InteractiveObject &) –
Return type:None
SubIntensityOn()
Parameters:anObject (Handle_AIS_InteractiveObject &) –
Return type:None
Terminate()
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
Unhilight()
Parameters:anObject (Handle_AIS_InteractiveObject &) –
Return type:None
UnhilightLastDetected()
  • returns True if something was done...
Parameters:aView (Handle_V3d_View &) –
Return type:bool
UnhilightPicked()
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
UnloadContextObjects()
Return type:None
UpdateConversion()
Return type:None
UpdateSelected()
Parameters:updateviewer (bool) – default value is Standard_True
Return type:None
  • Part of advanced selection highlighting mechanism. If no owners belonging to anobj are selected, calls anobj->ClearSelected(), otherwise calls anobj->HilightSelected(). This method can be used to avoid redrawing the whole selection belonging to several Selectable Objects.
Parameters:
  • anobj (Handle_AIS_InteractiveObject &) –
  • updateviewer (bool) – default value is Standard_True
Return type:

None

UpdateSort()
Return type:None
thisown

The membership flag

class AIS_LocalStatus(*args)

Bases: OCC.MMgt.MMgt_TShared

Parameters:
  • IsTemporary (bool) – default value is Standard_True
  • Decompose (bool) – default value is Standard_False
  • DisplayMode (int) – default value is -1
  • SelectionMode (int) – default value is -1
  • HilightMode (int) – default value is 0
  • SubIntensity (bool) – default value is 0
  • TheHiCol (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
Return type:

None

AddSelectionMode()
Parameters:aMode (int) –
Return type:None
ClearSelectionModes()
Return type:None
Decomposed()
Return type:bool
DisplayMode()
Return type:int
GetHandle()
HilightColor()
Return type:Quantity_NameOfColor
HilightMode()
Return type:int
IsActivated()
Parameters:aSelMode (int) –
Return type:bool
IsFirstDisplay()
Return type:bool
IsSelModeIn()
Parameters:aMode (int) –
Return type:bool
IsSubIntensityOn()
Return type:bool
IsTemporary()
Return type:bool
PreviousState()
Return type:Handle_Standard_Transient
RemoveSelectionMode()
Parameters:aMode (int) –
Return type:None
SelectionModes()
Return type:TColStd_ListOfInteger
SetDecomposition()
Parameters:astatus (bool) –
Return type:None
SetDisplayMode()
Parameters:aMode (int) –
Return type:None
SetFirstDisplay()
Parameters:aStatus (bool) –
Return type:None
SetHilightColor()
Parameters:aHiCol (Quantity_NameOfColor) –
Return type:None
SetHilightMode()
Parameters:aMode (int) –
Return type:None
SetPreviousState()
Parameters:aStatus (Handle_Standard_Transient &) –
Return type:None
SetTemporary()
Parameters:astatus (bool) –
Return type:None
SubIntensityOff()
Return type:None
SubIntensityOn()
Return type:None
thisown

The membership flag

class AIS_MapIteratorOfMapOfInteractive(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (AIS_MapOfInteractive &) –
Return type:None
Initialize()
Parameters:aMap (AIS_MapOfInteractive &) –
Return type:None
Key()
Return type:Handle_AIS_InteractiveObject
thisown

The membership flag

class AIS_MapOfInteractive(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:
  • NbBuckets (int) – default value is 1
  • Other (AIS_MapOfInteractive &) –
Return type:

None

Return type:

None

Add()
Parameters:aKey (Handle_AIS_InteractiveObject &) –
Return type:bool
Assign()
Parameters:Other (AIS_MapOfInteractive &) –
Return type:AIS_MapOfInteractive
Clear()
Return type:None
Contains()
Parameters:aKey (Handle_AIS_InteractiveObject &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Remove()
Parameters:aKey (Handle_AIS_InteractiveObject &) –
Return type:bool
Set()
Parameters:Other (AIS_MapOfInteractive &) –
Return type:AIS_MapOfInteractive
thisown

The membership flag

class AIS_MaxRadiusDimension(*args)

Bases: OCC.AIS.AIS_EllipseRadiusDimension

  • Max Ellipse radius dimension Shape can be edge , planar face or cylindrical face
Parameters:
  • aShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
Return type:

None

  • Max Ellipse radius dimension with position Shape can be edge , planar face or cylindrical face
Parameters:
  • aShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
  • aPosition (gp_Pnt) –
  • aSymbolPrs (DsgPrs_ArrowSide) –
  • anArrowSize (float) – default value is 0.0
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_MidPointRelation(*args)

Bases: OCC.AIS.AIS_Relation

Parameters:
  • aSymmTool (TopoDS_Shape &) –
  • FirstShape (TopoDS_Shape &) –
  • SecondShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
GetTool()
Return type:TopoDS_Shape
SetTool()
Parameters:aMidPointTool (TopoDS_Shape &) –
Return type:None
thisown

The membership flag

class AIS_MinRadiusDimension(*args)

Bases: OCC.AIS.AIS_EllipseRadiusDimension

  • Max Ellipse radius dimension Shape can be edge , planar face or cylindrical face
Parameters:
  • aShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
Return type:

None

  • Max Ellipse radius dimension with position Shape can be edge , planar face or cylindrical face
Parameters:
  • aShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
  • aPosition (gp_Pnt) –
  • aSymbolPrs (DsgPrs_ArrowSide) –
  • anArrowSize (float) – default value is 0.0
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_MultipleConnectedInteractive(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes the Interactive Object with multiple connections to AIS_Interactive objects.
Return type:None
AcceptShapeDecomposition()
  • Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection.
Return type: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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
  • aProjector
  • aPresentation
Return type:

void

Return type:

void

Connect()
  • 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)
Parameters:theInteractive (Handle_AIS_InteractiveObject &) –
Return type: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)
Parameters:
  • theInteractive (Handle_AIS_InteractiveObject &) –
  • theLocation (gp_Trsf) –
Return type:

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)
Parameters:
  • theInteractive (Handle_AIS_InteractiveObject &) –
  • theLocation (gp_Trsf) –
  • theTrsfPersFlag (Graphic3d_TransModeFlags &) –
  • theTrsfPersPoint (gp_Pnt) –
Return type:

Handle_AIS_InteractiveObject

Disconnect()
  • Removes the connection with theInteractive.
Parameters:theInteractive (Handle_AIS_InteractiveObject &) –
Return type:None
DisconnectAll()
  • Clears all the connections to objects.
Return type:None
GetHandle()
HasConnection()
  • Returns true if the object is connected to others.
Return type:bool
thisown

The membership flag

class AIS_OffsetDimension(*args)

Bases: OCC.AIS.AIS_Relation

  • Constructs the offset display object defined by the first shape aFShape, the second shape aSShape, the dimension aVal, and the text aText.
Parameters:
  • FistShape (TopoDS_Shape &) –
  • SecondShape (TopoDS_Shape &) –
  • aVal (float) –
  • aText (TCollection_ExtendedString &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
SetRelativePos()
  • Sets a transformation aTrsf for presentation and selection to a relative position.
Parameters:aTrsf (gp_Trsf) –
Return type:None
thisown

The membership flag

class AIS_ParallelRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aSShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
Return type:

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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aSShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
  • aPosition (gp_Pnt) –
  • aSymbolPrs (DsgPrs_ArrowSide) –
  • anArrowSize (float) – default value is 0.01
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_PerpendicularRelation(*args)

Bases: OCC.AIS.AIS_Relation

  • 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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aSShape (TopoDS_Shape &) –
  • aPlane (Handle_Geom_Plane &) –
Return type:

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.
Parameters:
  • aFShape (TopoDS_Shape &) –
  • aSShape (TopoDS_Shape &) –
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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
thisown

The membership flag

class AIS_Plane(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • initializes the plane aComponent. If the mode aCurrentMode equals true, the drawing tool, ‘Drawer’ is not initialized.
Parameters:
  • aComponent (Handle_Geom_Plane &) –
  • aCurrentMode (bool) – default value is Standard_False
Return type:

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.
Parameters:
  • aComponent (Handle_Geom_Plane &) –
  • aCenter (gp_Pnt) –
  • aCurrentMode (bool) – default value is Standard_False
Return type:

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.
Parameters:
  • aComponent (Handle_Geom_Axis2Placement &) –
  • aCenter (gp_Pnt) –
  • aPmin (gp_Pnt) –
  • aPmax (gp_Pnt) –
  • aCurrentMode (bool) – default value is Standard_False
  • aComponent
  • aPlaneType (AIS_TypeOfPlane) –
  • aCurrentMode – default value is Standard_False
Return type:

None

Return type:

None

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.
Return type:Handle_Geom_Axis2Placement
Center()
  • Returns the coordinates of the center point.
Return type:gp_Pnt
Component()
  • Returns the component specified in SetComponent.
Return type: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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

ComputeSelection()
Parameters:
  • theSelection (Handle_SelectMgr_Selection &) –
  • theMode (int) –
Return type:

void

CurrentMode()
  • Returns the non-default current display mode set by SetCurrentMode.
Return type:bool
GetHandle()
HasOwnSize()
Return type:bool
IsXYZPlane()
  • Returns the type of plane - xy, yz, or xz.
Return type:bool
PlaneAttributes()
  • Returns the settings for the selected plane aComponent, provided in SetPlaneAttributes. These include the points aCenter, aPmin, and aPmax
Parameters:
  • aComponent (Handle_Geom_Plane &) –
  • aCenter (gp_Pnt) –
  • aPmin (gp_Pnt) –
  • aPmax (gp_Pnt) –
Return type:

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}.
Parameters:
  • aComponent (Handle_Geom_Axis2Placement &) –
  • aPlaneType (AIS_TypeOfPlane) –
Return type:

None

SetCenter()
  • Provides settings for the center aCenter other than (0, 0, 0).
Parameters:aCenter (gp_Pnt) –
Return type:None
SetColor()
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

None

SetComponent()
  • Creates an instance of the plane aComponent.
Parameters:aComponent (Handle_Geom_Plane &) –
Return type:None
SetCurrentMode()
  • Allows you to provide settings for a non-default current display mode.
Parameters:aCurrentMode (bool) –
Return type: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.
Parameters:
  • aComponent (Handle_Geom_Plane &) –
  • aCenter (gp_Pnt) –
  • aPmin (gp_Pnt) –
  • aPmax (gp_Pnt) –
Return type:

None

SetSize()
  • Same value for x and y directions
Parameters:aValue (float) –
Return type:None
  • Sets the size defined by the length along the X axis XVal and the length along the Y axis YVal.
Parameters:
Return type:

None

SetTypeOfSensitivity()
  • Sets the type of sensitivity for the plane.
Parameters:theTypeOfSensitivity (Select3D_TypeOfSensitivity) –
Return type:None
Size()
Parameters:
  • X (float &) –
  • Y (float &) –
Return type:

bool

TypeOfPlane()
  • Returns the type of plane - xy, yz, xz or unknown.
Return type:AIS_TypeOfPlane
TypeOfSensitivity()
  • Returns the type of sensitivity for the plane;
Return type:Select3D_TypeOfSensitivity
UnsetSize()
Return type:None
thisown

The membership flag

class AIS_PlaneTrihedron(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes the plane aPlane. The plane trihedron is constructed from this and an axis.
Parameters:aPlane (Handle_Geom_Plane &) –
Return type:None
Component()
  • Returns the component specified in SetComponent.
Return type: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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
GetLength()
  • Returns the length of X and Y axes.
Return type:float
Position()
  • Returns the point of origin of the plane trihedron.
Return type:Handle_AIS_Point
SetColor()
  • Allows you to provide settings for the color aColor.
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

None

SetComponent()
  • Creates an instance of the component object aPlane.
Parameters:aPlane (Handle_Geom_Plane &) –
Return type:None
SetLength()
  • Sets the length of the X and Y axes.
Parameters:theLength (float) –
Return type:None
SetXLabel()
Parameters:aLabel (TCollection_AsciiString &) –
Return type:None
SetYLabel()
Parameters:aLabel (TCollection_AsciiString &) –
Return type:None
XAxis()
  • Returns the ‘XAxis’.
Return type:Handle_AIS_Line
YAxis()
  • Returns the ‘YAxis’.
Return type:Handle_AIS_Line
thisown

The membership flag

class AIS_Point(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Initializes the point aComponent from which the point datum will be built.
Parameters:aComponent (Handle_Geom_Point &) –
Return type:None
Component()
  • Returns the component specified in SetComponent.
Return type: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 !!!
Parameters:
  • aProjector (Handle_Prs3d_Projector &) –
  • aTrsf (Handle_Geom_Transformation &) –
  • aPresentation (Handle_Prs3d_Presentation &) –
Return type:

void

GetHandle()
HasMarker()
  • Returns true if the point datum has a marker.
Return type:bool
SetColor()
  • Allows you to provide settings for the cp;pr aColor.
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

None

SetComponent()
  • Constructs an instance of the point aComponent.
Parameters:aComponent (Handle_Geom_Point &) –
Return type:None
SetMarker()
  • Allows you to provide settings for a marker. These include - type of marker, - marker color, - scale factor.
Parameters:aType (Aspect_TypeOfMarker) –
Return type:None
UnsetMarker()
  • Removes the marker settings.
Return type:None
Vertex()
  • Converts a point into a vertex.
Return type:TopoDS_Vertex
thisown

The membership flag

class AIS_PointCloud(*args)

Bases: OCC.AIS.AIS_InteractiveObject

  • Constructor.
Return type:None
DM_BndBox = 2
DM_Points = 0
GetBoundingBox()
  • Get bounding box for presentation.
Return type:Bnd_Box
GetHandle()
GetPoints()
  • Get the points array. Method might be overridden to fill in points array dynamically from application data structures. returns the array of points
Return type:Handle_Graphic3d_ArrayOfPoints
SetColor()
  • Setup custom color. Affects presentation only when no per-point color attribute has been assigned.
Parameters:theColor (Quantity_NameOfColor) –
Return type:void
  • Setup custom color. Affects presentation only when no per-point color attribute has been assigned.
Parameters:theColor (Quantity_Color &) –
Return type:void
SetMaterial()
  • Setup custom material. Affects presentation only when normals are defined.
Parameters:theMatName (Graphic3d_NameOfMaterial) –
Return type:void
  • Setup custom material. Affects presentation only when normals are defined.
Parameters:theMat (Graphic3d_MaterialAspect &) –
Return type: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
Parameters:thePoints (Handle_Graphic3d_ArrayOfPoints &) –
Return type: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
Parameters:
Return type:

void

thisown

The membership flag

class AIS_RadiusDimension(*args)

Bases: OCC.AIS.AIS_Dimension

  • Create radius dimension for the circle geometry. @param theCircle [in] the circle to measure.
Parameters:theCircle (gp_Circ) –
Return type: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.
Parameters:
Return type:

None

  • Create radius dimension for the arbitrary shape (if possible). @param theShape [in] the shape to measure.
Parameters:theShape (TopoDS_Shape &) –
Return type:None
AnchorPoint()
  • returns anchor point on circle for radius dimension.
Return type:gp_Pnt
Circle()
  • returns measured geometry circle.
Return type:gp_Circ
GetHandle()
GetTextPosition()
Return type:gp_Pnt
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.
Parameters:theCircle (gp_Circ) –
Return type: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.
Parameters:
Return type:

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.
Parameters:theShape (TopoDS_Shape &) –
Return type:None
SetTextPosition()
Parameters:theTextPos (gp_Pnt) –
Return type:void
Shape()
  • returns the measured shape.
Return type:TopoDS_Shape
thisown

The membership flag

class AIS_Relation(*args, **kwargs)

Bases: OCC.AIS.AIS_InteractiveObject

ArrowSize()
  • Returns the value for the size of the arrow identifying the relation between the two shapes.
Return type:float
AutomaticPosition()
Return type:bool
ExtShape()
  • Returns the status index of the extension shape.
Return type:int
FirstShape()
Return type:TopoDS_Shape
GetHandle()
IsMovable()
  • Returns true if the interactive object is movable.
Return type:bool
KindOfDimension()
  • Indicates that the type of dimension is unknown.
Return type:AIS_KindOfDimension
Plane()
  • Returns the plane.
Return type:Handle_Geom_Plane
Position()
  • Returns the position set using SetPosition.
Return type:gp_Pnt
SecondShape()
  • Returns the second shape.
Return type:TopoDS_Shape
SetArrowSize()
  • Allows you to provide settings for the size of the arrow anArrowsize identifying the relation between the two shapes.
Parameters:anArrowSize (float) –
Return type:None
SetAutomaticPosition()
Parameters:aStatus (bool) –
Return type:None
SetBndBox()
Parameters:
Return type:

None

SetColor()
  • Allows you to provide settings for the color aColor of the lines representing the relation between the two shapes.
Parameters:
  • aColor (Quantity_Color &) –
  • aColor
Return type:

None

Return type:

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.
Parameters:aIndex (int) –
Return type:None
SetFirstShape()
Parameters:aFShape (TopoDS_Shape &) –
Return type:void
SetPlane()
  • Allows you to set the plane aPlane. This is used to define relations and dimensions in several daughter classes.
Parameters:aPlane (Handle_Geom_Plane &) –
Return type:None
SetPosition()
  • Allows you to provide the objects in the relation with settings for a non-default position.
Parameters:aPosition (gp_Pnt) –
Return type:None
SetSecondShape()
  • Allows you to identify the second shape aSShape relative to the first.
Parameters:aSShape (TopoDS_Shape &) –
Return type:void
SetSymbolPrs()
  • Allows you to provide settings for the symbol presentation.
Parameters:aSymbolPrs (DsgPrs_ArrowSide) –
Return type:None
SetText()
  • Allows you to provide the settings aText for text aspect.
Parameters:aText (TCollection_ExtendedString &) –
Return type:None
SetValue()
  • Allows you to provide settings for the value aVal for each object in the relation.
Parameters:aVal (float) –
Return type: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
Return type:DsgPrs_ArrowSide
Text()
  • Returns settings for text aspect.
Return type:TCollection_ExtendedString
UnsetBndBox()
Return type:None
Value()
  • Returns the value of each object in the relation.
Return type:float
thisown

The membership flag

class AIS_Selection(*args)

Bases: OCC.MMgt.MMgt_TShared

  • creates a new selection and make it current in the session. the selection will be accessible later through its name to make it again current. //! Note that if a session has been created, a session with the name ‘default’ is created. //! In this case, the is always a current selection which is the last one created until SetCurrentSelection is used. //! The class methods deals with the current selection. //! Warning : Better Call AIS_Selection::CreateSelection.
Parameters:aName (char *) –
Return type:None
static AddSelect(*args)
  • the object is always add int the selection. faster when the number of objects selected is great.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:AIS_SelectStatus
static ClearAndSelect(*args)
  • clears the selection and adds the object in the selection.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:void
static ClearCurrentSelection(*args)
  • Clears selection.
Return type:void
static CreateSelection(*args)
  • calls the private constructor and puts the new Selection in the list of existing selections. returns False if the selection exists.
Parameters:aName (char *) –
Return type:bool
static CurrentSelection(*args)
Return type:Handle_AIS_Selection
static Extent(*args)
  • returns the number of objects selected.
Return type:int
static Find(*args)
  • returns True if a selection having this name exsits.
Parameters:aName (char *) –
Return type:bool
GetHandle()
static Index(*args)
Parameters:aName (char *) –
Return type:int
Init()
Return type:None
static IsSelected(*args)
Parameters:anObject (Handle_Standard_Transient &) –
Return type:bool
More()
Return type:bool
NbStored()
Return type:int
Next()
Return type:None
Objects()
Return type:AIS_NListTransient
static Remove(*args)
Parameters:aName (char *) –
Return type:void
static Select(*args)
  • removes all the object of the currentselection.
Return type:void
  • if the object is not yet in the current selection, it will be added. if the object is already in the current selection, it will be removed.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:AIS_SelectStatus
static Selection(*args)
Parameters:aName (char *) –
Return type:Handle_AIS_Selection
static SetCurrentSelection(*args)
  • returns False if There is no selection of name <aName>
Parameters:aName (char *) –
Return type:bool
static Single(*args)
  • returns the single object selected. Warning: raises TypeMismatch from Standard if Extent is not equal to 1.
Return type:Handle_Standard_Transient
Value()
Return type:Handle_Standard_Transient
thisown

The membership flag

AIS_Selection_AddSelect(*args)
  • the object is always add int the selection. faster when the number of objects selected is great.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:AIS_SelectStatus
AIS_Selection_ClearAndSelect(*args)
  • clears the selection and adds the object in the selection.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:void
AIS_Selection_ClearCurrentSelection(*args)
  • Clears selection.
Return type:void
AIS_Selection_CreateSelection(*args)
  • calls the private constructor and puts the new Selection in the list of existing selections. returns False if the selection exists.
Parameters:aName (char *) –
Return type:bool
AIS_Selection_CurrentSelection(*args)
Return type:Handle_AIS_Selection
AIS_Selection_Extent(*args)
  • returns the number of objects selected.
Return type:int
AIS_Selection_Find(*args)
  • returns True if a selection having this name exsits.
Parameters:aName (char *) –
Return type:bool
AIS_Selection_Index(*args)
Parameters:aName (char *) –
Return type:int
AIS_Selection_IsSelected(*args)
Parameters:anObject (Handle_Standard_Transient &) –
Return type:bool
AIS_Selection_Remove(*args)
Parameters:aName (char *) –
Return type:void
AIS_Selection_Select(*args)
  • removes all the object of the currentselection.
Return type:void
  • if the object is not yet in the current selection, it will be added. if the object is already in the current selection, it will be removed.
Parameters:anObject (Handle_Standard_Transient &) –
Return type:AIS_SelectStatus
AIS_Selection_Selection(*args)
Parameters:aName (char *) –
Return type:Handle_AIS_Selection
AIS_Selection_SetCurrentSelection(*args)
  • returns False if There is no selection of name <aName>
Parameters:aName (char *) –
Return type:bool
AIS_Selection_Single(*args)
  • returns the single object selected. Warning: raises TypeMismatch from Standard if Extent is not equal to 1.
Return type:Handle_Standard_Transient
class AIS_SequenceNodeOfSequenceOfDimension(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (Handle_AIS_Relation &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_AIS_Relation
thisown

The membership flag

class AIS_SequenceNodeOfSequenceOfInteractive(*args)

Bases: OCC.TCollection.TCollection_SeqNode

Parameters:
  • I (Handle_AIS_InteractiveObject &) –
  • n (TCollection_SeqNodePtr &) –
  • p (TCollection_SeqNodePtr &) –
Return type:

None

GetHandle()
Value()
Return type:Handle_AIS_InteractiveObject
thisown

The membership flag

class AIS_SequenceOfDimension(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (AIS_SequenceOfDimension &) –
Return type:None
Append()
Parameters:
  • T (Handle_AIS_Relation &) –
  • S (AIS_SequenceOfDimension &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (AIS_SequenceOfDimension &) –
Return type:AIS_SequenceOfDimension
ChangeValue()
Parameters:Index (int) –
Return type:Handle_AIS_Relation
Clear()
Return type:None
First()
Return type:Handle_AIS_Relation
InsertAfter()
Parameters:
  • Index (int) –
  • T (Handle_AIS_Relation &) –
  • Index
  • S (AIS_SequenceOfDimension &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (int) –
  • T (Handle_AIS_Relation &) –
  • Index
  • S (AIS_SequenceOfDimension &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_AIS_Relation
Prepend()
Parameters:
  • T (Handle_AIS_Relation &) –
  • S (AIS_SequenceOfDimension &) –
Return type:

None

Return type:

None

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