OCC.PrsMgr module

and is only to be used when you do not want to usethe services provided by AIS.PrsMgr manages display through the following services:- supplying a graphic structure for the object to be presented- recalculating presentations when required, e.g. bymoving the object or changing its color- defining the display mode of the object to bepresented; in the case of AIS_Shape, for example,this determines whether the object is to be displayed in:- wireframe 0- shading 1.Note that each new Interactive Object must have all its display modes defined.

class Handle_PrsMgr_PresentableObject(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_PrsMgr_Presentation(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_PrsMgr_PresentationManager(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class Handle_PrsMgr_Prs(*args)

Bases: OCC.Prs3d.Handle_Prs3d_Presentation

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

The membership flag

class Handle_PrsMgr_SequenceNodeOfPresentations(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class PrsMgr_ModedPresentation(*args)

Bases: object

Return type:

None

Parameters:
  • thePrs (Handle_PrsMgr_Presentation &) –
  • theMode (int) –
Return type:

None

Mode()
Return type:int
Presentation()
Return type:Handle_PrsMgr_Presentation
thisown

The membership flag

class PrsMgr_PresentableObject(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

AddChild()
  • Makes theObject child of current object in scene hierarchy.
Parameters:theObject (Handle_PrsMgr_PresentableObject &) –
Return type:void
AddClipPlane()
  • Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be substracted from limit to predict the maximum possible number of object clipping planes. @param thePlane [in] the clip plane to be appended to map of clip planes.
Parameters:thePlane (Handle_Graphic3d_ClipPlane &) –
Return type:void
Children()
  • Returns children of the current object.
Return type:PrsMgr_ListOfPresentableObjects
GetClipPlanes()
  • Get clip planes. returns set of previously added clip planes for all display mode presentations.
Return type:Graphic3d_SequenceOfHClipPlane
GetHandle()
GetTransformPersistenceMode()
  • Gets Transform Persistence Mode for this object
Return type:Graphic3d_TransModeFlags
GetTransformPersistencePoint()
  • Gets point of transform persistence for this object
Return type:gp_Pnt
HasOwnPresentations()
  • Returns true if object should have own presentations.
Return type:bool
HasTransformation()
  • Returns true if object has a transformation that is different from the identity.
Return type:bool
InversedTransformation()
Return type:gp_Trsf
IsMutable()
  • Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations).
Return type:bool
LocalTransformation()
Return type:gp_Trsf
Parent()
  • Returns parent of current object in scene hierarchy.
Return type:PrsMgr_PresentableObjectPointer
Presentations()
Return type:PrsMgr_Presentations
RemoveChild()
  • Removes theObject from children of current object in scene hierarchy.
Parameters:theObject (Handle_PrsMgr_PresentableObject &) –
Return type:void
RemoveClipPlane()
  • Removes previously added clip plane. @param thePlane [in] the clip plane to be removed from map of clip planes.
Parameters:thePlane (Handle_Graphic3d_ClipPlane &) –
Return type:void
ResetTransformation()
  • resets local transformation to identity.
Return type:void
SetClipPlanes()
  • Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be substracted from limit to predict the maximum possible number of object clipping planes.
Parameters:thePlanes (Graphic3d_SequenceOfHClipPlane &) –
Return type:void
SetLocalTransformation()
  • Sets local transformation to theTransformation.
Parameters:theTransformation (gp_Trsf) –
Return type:void
SetMutable()
  • Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect.
Parameters:theIsMutable (bool) –
Return type:void
SetToUpdate()
  • flags the Prs of mode <AMode> to be Updated. the Update will be done when needed.
Parameters:aMode (int) –
Return type:None
  • flags all the Presentations to be Updated.
Return type:None
SetTransformPersistence()
  • Sets up Transform Persistence Mode for this object. This function used to lock in object position, rotation and / or zooming relative to camera position. Object will be drawn in the origin setted by APoint parameter (except Graphic3d_TMF_TriedronPers flag - see description later). aFlag should be: - Graphic3d_TMF_None - no persistence attributes (reset); - Graphic3d_TMF_PanPers - object doesn’t move; - Graphic3d_TMF_ZoomPers - object doesn’t resize; - Graphic3d_TMF_RotatePers - object doesn’t rotate; - Graphic3d_TMF_FullPers - pan, zoom and rotate transform persistence; - Graphic3d_TMF_TriedronPers - object behaves like trihedron; - combination (Graphic3d_TMF_PanPers | Graphic3d_TMF_ZoomPers); - combination (Graphic3d_TMF_PanPers | Graphic3d_TMF_RotatePers); - combination (Graphic3d_TMF_ZoomPers | Graphic3d_TMF_RotatePers). If Graphic3d_TMF_TriedronPers or Graphic3d_TMF_2d persistence mode selected APoint coordinates X and Y means: - X = 0.0, Y = 0.0 - center of view window; - X > 0.0, Y > 0.0 - right upper corner of view window; - X > 0.0, Y < 0.0 - right lower corner of view window; - X < 0.0, Y > 0.0 - left upper corner of view window; - X < 0.0, Y < 0.0 - left lower corner of view window. And Z coordinate defines the gap from border of view window (except center position).
Parameters:
  • aFlag (Graphic3d_TransModeFlags &) –
  • APoint (gp_Pnt) –
Return type:

void

  • Calls previous method with point (0,0,0)
Parameters:aFlag (Graphic3d_TransModeFlags &) –
Return type:None
SetTypeOfPresentation()
Parameters:aType (PrsMgr_TypeOfPresentation3d) –
Return type:None
SetZLayer()
  • Set Z layer ID and update all presentations of the presentable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.
Parameters:theLayerId (Graphic3d_ZLayerId) –
Return type:void
ToBeUpdated()
  • gives the list of modes which are flagged ‘to be updated’.
Parameters:ListOfMode (TColStd_ListOfInteger &) –
Return type:None
Transformation()
Return type:gp_Trsf
TypeOfPresentation3d()
  • Returns information on whether the object accepts display in HLR mode or not.
Return type:PrsMgr_TypeOfPresentation3d
UpdateTransformation()
Return type:void
Parameters:P (Handle_Prs3d_Presentation &) –
Return type:void
ZLayer()
  • Get ID of Z layer.
Return type:Graphic3d_ZLayerId
thisown

The membership flag

class PrsMgr_Presentation(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Destroy()
  • Destructor
Return type:void
GetHandle()
MustBeUpdated()
Return type:bool
Presentation()
Return type:Handle_Prs3d_Presentation
PresentationManager()
  • returns the PresentationManager in which the presentation has been created.
Return type:Handle_PrsMgr_PresentationManager
SetUpdateStatus()
Parameters:theStat (bool) –
Return type:None
thisown

The membership flag

class PrsMgr_PresentationManager(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates a framework to manage displays and graphic entities with the 3D view theStructureManager.
Parameters:theStructureManager (Handle_Visual3d_ViewManager &) –
Return type:None
AddToImmediateList()
  • Stores thePrs in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method.
Parameters:thePrs (Handle_Prs3d_Presentation &) –
Return type:None
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:None
BoundBox()
  • highlights the boundbox of the presentation
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

Clear()
  • Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

void

ClearImmediateDraw()
  • Resets the transient list of presentations previously displayed in immediate mode.
Return type:None
Color()
  • Highlights the graphic object thePrsObject in the color theColor. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theColor (Quantity_NameOfColor) – default value is Quantity_NOC_YELLOW
  • theMode (int) – default value is 0
  • theSelObj (Handle_PrsMgr_PresentableObject &) – default value is NULL
Return type:

None

Connect()
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theOtherObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
  • theOtherMode (int) – default value is 0
Return type:

None

Display()
  • Displays the presentation of the object in the given Presentation manager with the given mode. The mode should be enumerated by the object which inherits PresentableObject.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

DisplayPriority()
  • Returns the display priority of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) –
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:None
Erase()
  • erases the presentation of the object in the given Presentation manager with the given mode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

GetHandle()
GetZLayer()
  • Get Z layer ID assigned to all presentations of the object. Method returns -1 value if object has no presentations and is impossible to get layer index.
Parameters:thePrsObject (Handle_PrsMgr_PresentableObject &) –
Return type:int
HasPresentation()
  • Returns true if there is a presentation of the presentable object thePrsObject in this framework, thePrsObject having the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

bool

Highlight()
  • Highlights the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

IsDisplayed()
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

bool

IsHighlighted()
  • Returns true if the presentation of the presentable object thePrsObject in this framework with the display mode theMode is highlighted.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

bool

IsImmediateModeOn()
  • Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
Return type:bool
Presentation()
  • Returns the presentation Presentation of the presentable object thePrsObject in this framework. When theToCreate is true - automatically creates presentation for specified mode when not exist. Optional argument theSelObj specifies parent decomposed object to inherit its view affinity.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
  • theToCreate (bool) – default value is Standard_False
  • theSelObj (Handle_PrsMgr_PresentableObject &) – default value is NULL
Return type:

Handle_PrsMgr_Presentation

SetDisplayPriority()
  • Sets the display priority theNewPrior of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) –
  • theNewPrior (int) –
Return type:

None

SetShadingAspect()
  • this method will change the color and the aspect of the presentations containing shaded structures.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theColor (Quantity_NameOfColor) –
  • theMaterial (Graphic3d_NameOfMaterial) –
  • theMode (int) – default value is 0
Return type:

None

  • this method will change the color and the aspect of the presentations containing shaded structures.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theShadingAspect (Handle_Prs3d_ShadingAspect &) –
  • theMode (int) – default value is 0
Return type:

None

SetVisibility()
  • Sets the visibility of presentable object.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) –
  • theValue (bool) –
Return type:

None

SetZLayer()
  • Set Z layer ID for all presentations of the object.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theLayerId (int) –
Return type:

None

StructureManager()
  • Returns the structure manager.
Return type:Handle_Graphic3d_StructureManager
Transform()
  • Sets the transformation theTransformation for the presentable object thePrsObject. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theTransformation (Handle_Geom_Transformation &) –
  • theMode (int) – default value is 0
Return type:

None

Unhighlight()
  • Removes highlighting from the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

Update()
  • Updates the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
Parameters:
  • thePrsObject (Handle_PrsMgr_PresentableObject &) –
  • theMode (int) – default value is 0
Return type:

None

thisown

The membership flag

class PrsMgr_Presentations(*args)

Bases: OCC.TCollection.TCollection_BaseSequence

Return type:None
Parameters:Other (PrsMgr_Presentations &) –
Return type:None
Append()
Parameters:
  • T (PrsMgr_ModedPresentation &) –
  • S (PrsMgr_Presentations &) –
Return type:

None

Return type:

None

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

None

Return type:

None

InsertBefore()
Parameters:
  • Index (int) –
  • T (PrsMgr_ModedPresentation &) –
  • Index
  • S (PrsMgr_Presentations &) –
Return type:

None

Return type:

None

Last()
Return type:PrsMgr_ModedPresentation
Prepend()
Parameters:
  • T (PrsMgr_ModedPresentation &) –
  • S (PrsMgr_Presentations &) –
Return type:

None

Return type:

None

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

None

Return type:

None

Set()
Parameters:Other (PrsMgr_Presentations &) –
Return type:PrsMgr_Presentations
SetValue()
Parameters:
  • Index (int) –
  • I (PrsMgr_ModedPresentation &) –
Return type:

None

Split()
Parameters:
  • Index (int) –
  • Sub (PrsMgr_Presentations &) –
Return type:

None

Value()
Parameters:Index (int) –
Return type:PrsMgr_ModedPresentation
thisown

The membership flag

class PrsMgr_Prs(*args)

Bases: OCC.Prs3d.Prs3d_Presentation

Parameters:
  • theStructManager (Handle_Graphic3d_StructureManager &) –
  • thePresentation (PrsMgr_PresentationPointer &) –
  • theTypeOfPresentation3d (PrsMgr_TypeOfPresentation3d) –
Return type:

None

Compute()
Return type:None
Parameters:aProjector (Handle_Graphic3d_DataStructureManager &) –
Return type:Handle_Graphic3d_Structure
  • the ‘degenerated’ Structure is displayed with a transformation defined by <AMatrix> which is not a Pure Translation. We have to take in account this Transformation in the computation of hidden line removal… returns a filled Graphic Structure.
Parameters:
  • aProjector (Handle_Graphic3d_DataStructureManager &) –
  • AMatrix (TColStd_Array2OfReal &) –
Return type:

Handle_Graphic3d_Structure

  • No need to return a structure, just to fill <ComputedStruct> ….
Parameters:
  • aProjector (Handle_Graphic3d_DataStructureManager &) –
  • ComputedStruct (Handle_Graphic3d_Structure &) –
Return type:

None

  • No Need to return a Structure, just to Fill <aStructure>. The Trsf has to be taken in account in the computation (Rotation Part….)
Parameters:
  • aProjector (Handle_Graphic3d_DataStructureManager &) –
  • AMatrix (TColStd_Array2OfReal &) –
  • aStructure (Handle_Graphic3d_Structure &) –
Return type:

None

GetHandle()
thisown

The membership flag

class PrsMgr_SequenceNodeOfPresentations(*args)

Bases: OCC.TCollection.TCollection_SeqNode

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

None

GetHandle()
Value()
Return type:PrsMgr_ModedPresentation
thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

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

The membership flag

value()
new_instancemethod(func, inst, cls)
register_handle(handle, base_object)

Inserts the handle into the base object to prevent memory corruption in certain cases