OCC.Visual3d module

class OCC.Visual3d.Handle_Visual3d_HSequenceOfPickPath(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_HSetOfLight(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_HSetOfView(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_Layer(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_LayerItem(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_Light(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_ListNodeOfSetListOfSetOfLight(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_ListNodeOfSetListOfSetOfView(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_SequenceNodeOfSequenceOfPickPath(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_TransientManager(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_View(*args)

Bases: OCC.Graphic3d.Handle_Graphic3d_DataStructureManager

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

The membership flag

class OCC.Visual3d.Handle_Visual3d_ViewManager(*args)

Bases: OCC.Graphic3d.Handle_Graphic3d_StructureManager

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

The membership flag

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

Bases: object

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

The membership flag

value()
class OCC.Visual3d.Visual3d_ContextPick(*args)

Bases: object

Aperture()
  • Returns the size of the pick window <self>.
Return type:float
Depth()
  • Returns the effective pick depth of <self>.
Return type:int
Order()
  • Returns the order of picking of <self>. //! TypeOfOrder : TOO_TOPFIRST //! TOO_BOTTOMFIRST
Return type:Visual3d_TypeOfOrder
SetAperture()
  • Modifies the size of the pick window. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Aperture> is //! a negative value.
Parameters:Aperture (float) –
Return type:None
SetDepth()
  • Modifies the pick depth a priori. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Depth> is //! a negative value.
Parameters:Depth (Standard_Integer) –
Return type:None
SetOrder()
  • Modifies the order of picking. //! TypeOfOrder : TOO_TOPFIRST //! TOO_BOTTOMFIRST
Parameters:Order (Visual3d_TypeOfOrder) –
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_ContextView

Bases: object

ActivatedLight()
Parameters:AnIndex (Standard_Integer) –
Return type:Handle_Visual3d_Light
ActivatedLights()
  • Returns the group of active light sources //! in the view of context <self>.
Return type:Handle_Visual3d_HSetOfLight
AliasingIsOn()
  • Returns the activity of the aliasing.
Return type:bool
BackZClippingIsOn()
  • Returns the activity of the ZClipping.
Return type:bool
ChangeClipPlanes()
  • Change clip planes. returns sequence of clip planes.
Return type:Graphic3d_SequenceOfHClipPlane
ClipPlanes()
  • Returns sequence of clip planes. returns sequence of clip planes.
Return type:Graphic3d_SequenceOfHClipPlane
DepthCueingBackPlane()
  • Returns the definition of the back depth-cueing plane.
Return type:float
DepthCueingFrontPlane()
  • Returns the definition of the front depth-cueing plane.
Return type:float
DepthCueingIsOn()
  • Returns the activity of the depth-cueing.
Return type:bool
FrontZClippingIsOn()
  • Returns the activity of the ZClipping.
Return type:bool
Model()
  • Returns the shading model.
Return type:Visual3d_TypeOfModel
NumberOfActivatedLights()
  • Returns the number of active light sources //! in the view of context <self>.
Return type:int
SetAliasingOff()
  • Deactivates the antialiasing.
Return type:None
SetAliasingOn()
  • Activates antialiasing. //! Antialiasing can be activated on all the structures //! in the view
Return type:None
SetBackZClippingOff()
  • Deactivates the back Z-clipping plane defined by //! SetBackPlane method.
Return type:None
SetBackZClippingOn()
  • Activates the back Z-clipping plane defined by //! SetBackPlane method. Category: Methods to modify the class definition Warning: Raises ZClippingDefinitionError if <BackPlane> is //! front of <FrontPlane>.
Return type:None
SetDepthCueingBackPlane()
  • Modifies the back depth-cueing plane. Category: Methods to modify the class definition Warning: Raises DepthCueingDefinitionError if <BackPlane> //! is front of <FrontPlane> and DepthCueing is ON.
Parameters:ABack (float) –
Return type:None
SetDepthCueingFrontPlane()
  • Modifies the front depth-cueing plane. Category: Methods to modify the class definition Warning: Raises DepthCueingDefinitionError if <BackPlane> is //! front of <FrontPlane> and DepthCueing is ON.
Parameters:ABack (float) –
Return type:None
SetDepthCueingOff()
  • Deactivates the depth-cueing.
Return type:None
SetDepthCueingOn()
  • Activates the depth-cueing. //! Depth-cueing can be activated on all structures //! present in the view. Category: Methods to modify the class definition Warning: Raises DepthCueingDefinitionError if <BackPlane> is //! front of <FrontPlane>.
Return type:None
SetFrontZClippingOff()
  • Deactivates the front Z-clipping plane defined by //! SetFrontPlane method.
Return type:None
SetFrontZClippingOn()
  • Activates the front Z-clipping plane defined by //! SetFrontPlane method.
Return type:None
SetLightOff()
  • Deactivates the light source <ALight>
Parameters:ALight (Handle_Visual3d_Light &) –
Return type:None
SetLightOn()
  • Activates the light source <ALight>
Parameters:ALight (Handle_Visual3d_Light &) –
Return type:None
SetModel()
  • Modifies the shading model when the type of //! visualization is TOV_SHADING //! TypeOfModel : TOM_NONE //! TOM_INTERP_COLOR //! TOM_FACET //! TOM_VERTEX
Parameters:AModel (Visual3d_TypeOfModel) –
Return type:None
SetSurfaceDetail()
  • Selects the kind of rendering default to: TOSD_NONE
Parameters:TOSD (Visual3d_TypeOfSurfaceDetail) –
Return type:None
SetTextureEnv()
  • Sets the environment texture to use no environment texture by default
Parameters:ATexture (Handle_Graphic3d_TextureEnv &) –
Return type:None
SetVisualization()
  • Modifies the mode of visualization. //! TypeOfVisualization : TOV_WIREFRAME //! TOV_SHADING
Parameters:AVisual (Visual3d_TypeOfVisualization) –
Return type:None
SetZClippingBackPlane()
  • Modifies the back Z-clipping plane. Category: Methods to modify the class definition Warning: Raises ZClippingDefinitionError if <BackPlane> is //! front of <FrontPlane> and ZClipping is ON.
Parameters:ABack (float) –
Return type:None
SetZClippingFrontPlane()
  • Modifies the front Z-clipping plane. Category: Methods to modify the class definition Warning: Raises ZClippingDefinitionError if <BackPlane> is //! front of <FrontPlane> and ZClipping is ON.
Parameters:AFront (float) –
Return type:None
SetZClippingOff()
  • Deactivates the Z-clipping planes defined by //! SetFrontPlane and SetBackPlane.
Return type:None
SetZClippingOn()
  • Activates the Z-clipping planes defined by //! SetZClippingFrontPlane and SetZClippingBackPlane. Category: Methods to modify the class definition Warning: Raises ZClippingDefinitionError if <BackPlane> is //! front of <FrontPlane>.
Return type:None
SurfaceDetail()
Return type:Visual3d_TypeOfSurfaceDetail
TextureEnv()
Return type:Handle_Graphic3d_TextureEnv
Visualization()
  • Returns the mode of visualization.
Return type:Visual3d_TypeOfVisualization
ZClippingBackPlane()
  • Returns the definition of the back Z-clipping plane.
Return type:float
ZClippingFrontPlane()
  • Returns the definition of the front Z-clipping plane.
Return type:float
thisown

The membership flag

class OCC.Visual3d.Visual3d_HSequenceOfPickPath

Bases: OCC.MMgt.MMgt_TShared

Append()
Parameters:
  • anItem (Visual3d_PickPath &) –
  • aSequence (Handle_Visual3d_HSequenceOfPickPath &) –
Return type:

None

Return type:

None

ChangeSequence()
Return type:Visual3d_SequenceOfPickPath
ChangeValue()
Parameters:anIndex (Standard_Integer) –
Return type:Visual3d_PickPath
Clear()
Return type:None
Exchange()
Parameters:
  • anIndex (Standard_Integer) –
  • anOtherIndex (Standard_Integer) –
Return type:

None

GetHandle()

Visual3d_HSequenceOfPickPath_GetHandle(Visual3d_HSequenceOfPickPath self) -> Handle_Visual3d_HSequenceOfPickPath

InsertAfter()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Visual3d_PickPath &) –
  • anIndex
  • aSequence (Handle_Visual3d_HSequenceOfPickPath &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Visual3d_PickPath &) –
  • anIndex
  • aSequence (Handle_Visual3d_HSequenceOfPickPath &) –
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Length()
Return type:int
Prepend()
Parameters:
  • anItem (Visual3d_PickPath &) –
  • aSequence (Handle_Visual3d_HSequenceOfPickPath &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • anIndex (Standard_Integer) –
  • fromIndex (Standard_Integer) –
  • toIndex (Standard_Integer) –
Return type:

None

Return type:

None

Reverse()
Return type:None
Sequence()
Return type:Visual3d_SequenceOfPickPath
SetValue()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Visual3d_PickPath &) –
Return type:

None

ShallowCopy()
Return type:Handle_Visual3d_HSequenceOfPickPath
Split()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_Visual3d_HSequenceOfPickPath
Value()
Parameters:anIndex (Standard_Integer) –
Return type:Visual3d_PickPath
thisown

The membership flag

class OCC.Visual3d.Visual3d_HSetOfLight

Bases: OCC.MMgt.MMgt_TShared

Add()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
ChangeSet()
Return type:Visual3d_SetOfLight
Clear()
Return type:None
Contains()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
Difference()
Parameters:B (Handle_Visual3d_HSetOfLight &) –
Return type:Handle_Visual3d_HSetOfLight
Extent()
Return type:int
GetHandle()

Visual3d_HSetOfLight_GetHandle(Visual3d_HSetOfLight self) -> Handle_Visual3d_HSetOfLight

Intersection()
Parameters:B (Handle_Visual3d_HSetOfLight &) –
Return type:Handle_Visual3d_HSetOfLight
IsAProperSubset()
Parameters:S (Handle_Visual3d_HSetOfLight &) –
Return type:bool
IsASubset()
Parameters:S (Handle_Visual3d_HSetOfLight &) –
Return type:bool
IsEmpty()
Return type:bool
Remove()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
Set()
Return type:Visual3d_SetOfLight
ShallowCopy()
Return type:Handle_Visual3d_HSetOfLight
Union()
Parameters:B (Handle_Visual3d_HSetOfLight &) –
Return type:Handle_Visual3d_HSetOfLight
thisown

The membership flag

class OCC.Visual3d.Visual3d_HSetOfView

Bases: OCC.MMgt.MMgt_TShared

Add()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
ChangeSet()
Return type:Visual3d_SetOfView
Clear()
Return type:None
Contains()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
Difference()
Parameters:B (Handle_Visual3d_HSetOfView &) –
Return type:Handle_Visual3d_HSetOfView
Extent()
Return type:int
GetHandle()

Visual3d_HSetOfView_GetHandle(Visual3d_HSetOfView self) -> Handle_Visual3d_HSetOfView

Intersection()
Parameters:B (Handle_Visual3d_HSetOfView &) –
Return type:Handle_Visual3d_HSetOfView
IsAProperSubset()
Parameters:S (Handle_Visual3d_HSetOfView &) –
Return type:bool
IsASubset()
Parameters:S (Handle_Visual3d_HSetOfView &) –
Return type:bool
IsEmpty()
Return type:bool
Remove()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
Set()
Return type:Visual3d_SetOfView
ShallowCopy()
Return type:Handle_Visual3d_HSetOfView
Union()
Parameters:B (Handle_Visual3d_HSetOfView &) –
Return type:Handle_Visual3d_HSetOfView
thisown

The membership flag

class OCC.Visual3d.Visual3d_Layer(*args)

Bases: OCC.MMgt.MMgt_TShared

AddLayerItem()
Parameters:Item (Handle_Visual3d_LayerItem &) –
Return type:None
AddVertex()
  • Puts <X, Y> as a new point in the current primitive. If <AFlag> then it is a draw between last point and this point else it is a move between last point and this point.
Parameters:
  • X (float) –
  • Y (float) –
  • AFlag (bool) – default value is Standard_True
Return type:

None

  • Puts <X, Y> as a new point in the current primitive. If <AFlag> then it is a draw between last point and this point else it is a move between last point and this point.
Parameters:
  • X (float) –
  • Y (float) –
  • AFlag (bool) – default value is Standard_True
Return type:

None

Begin()
  • Begins the definition of the layer <self> Warning: No default attributes
Return type:None
BeginPolygon()
  • After this call, <self> is ready to receive a definition of a polygon with AddEdge().
Return type:None
BeginPolyline()
  • After this call, <self> is ready to receive a definition of a polyline with AddVertex().
Return type:None
CLayer()
  • Returns the associated C structure.
Return type:Aspect_CLayer2d
Clear()
  • Clear all graphics managed by the layer <self>.
Return type:None
ClosePrimitive()
  • After this call, <self> stops the reception of a definition of a Begin... primitive.
Return type:None
Destroy()
  • Suppress the layer <self>.
Return type:None
DrawRectangle()
  • Draws the rectangle at position <X,Y>.
Parameters:
  • X (float) –
  • Y (float) –
  • Width (float) –
  • Height (float) –
Return type:

None

End()
  • Finishs the definition of the layer <self>.
Return type:None
GetHandle()

Visual3d_Layer_GetHandle(Visual3d_Layer self) -> Handle_Visual3d_Layer

GetLayerItemList()
Return type:Visual3d_NListOfLayerItem
RemoveAllLayerItems()
Return type:None
RemoveLayerItem()
Parameters:Item (Handle_Visual3d_LayerItem &) –
Return type:None
RenderLayerItems()
Return type:None
SetColor()
  • Modifies the current color. Warning: No default color
Parameters:AColor (Quantity_Color &) –
Return type:None
SetLineAttributes()
  • Modifies the current lines attributes. Warning: No default attributes
Parameters:
  • AType (Aspect_TypeOfLine) –
  • AWidth (float) –
Return type:

None

SetOrtho()
  • Modifies the current coordinates system of the layer <self>.
Parameters:
  • Left (float) –
  • Right (float) –
  • Bottom (float) –
  • Top (float) –
  • Attach (Aspect_TypeOfConstraint) – default value is Aspect_TOC_BOTTOM_LEFT
Return type:

None

  • Modifies the current coordinates system of the layer <self>.
Parameters:
  • Left (float) –
  • Right (float) –
  • Bottom (float) –
  • Top (float) –
  • Attach (Aspect_TypeOfConstraint) – default value is Aspect_TOC_BOTTOM_LEFT
Return type:

None

SetTextAttributes()
  • Modifies the current texts attributes. <AFont> defines the name of the font to be used. <AType> defines the display type of the text. <AColor> defines the color of decal or subtitle background. To set the color of the text you can use the SetColor method. Warning: No default attributes
Parameters:
  • AFont (char *) –
  • AType (Aspect_TypeOfDisplayText) –
  • AColor (Quantity_Color &) –
Return type:

None

SetTransparency()
  • Modifies the current transparency. Warning: No default transparency
Parameters:ATransparency (Standard_ShortReal) –
Return type:None
SetViewport()
  • Modifies the current viewport of the layer <self>.
Parameters:
  • Width (Standard_Integer) –
  • Height (Standard_Integer) –
Return type:

None

TextSize()
  • Get the size of text. The attributes are given with respect to the plane of projection. <AHeight> : Height of text. (Relative to the Normalized Projection Coordinates (NPC) Space).
Parameters:
  • AText (char *) –
  • AHeight (float) –
  • AWidth (float &) –
  • AnAscent (float &) –
  • ADescent (float &) –
Return type:

None

Type()
  • Returns the type.
Return type:Aspect_TypeOfLayer
UnsetTransparency()
  • Unsets the transparency.
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_LayerItem

Bases: OCC.MMgt.MMgt_TShared

ComputeLayerPrs()
  • virtual function for recompute 2D presentation (empty by default)
Return type:void
GetHandle()

Visual3d_LayerItem_GetHandle(Visual3d_LayerItem self) -> Handle_Visual3d_LayerItem

IsNeedToRecompute()
Return type:bool
RedrawLayerPrs()
  • virtual function for recompute 2D presentation (empty by default)
Return type:void
SetNeedToRecompute()
Parameters:
  • NeedToRecompute (bool) – default value is Standard_True
  • NeedToRecompute – default value is Standard_True
Return type:

None

Return type:

None

thisown

The membership flag

class OCC.Visual3d.Visual3d_Light(*args)

Bases: OCC.MMgt.MMgt_TShared

CLight()
  • Returns the light defintion.
Return type:Graphic3d_CLight
Color()
  • Returns the colour of the light <self>.
Return type:Quantity_Color
GetHandle()

Visual3d_Light_GetHandle(Visual3d_Light self) -> Handle_Visual3d_Light

Headlight()
  • Returns the headlight state of the light <self>
Return type:bool
LightType()
  • Returns the light type of <self>. //! TypeOfLightSource = TOLS_AMBIENT //! TOLS_DIRECTIONAL //! TOLS_POSITIONAL //! TOLS_SPOT
Return type:Visual3d_TypeOfLightSource
SetAngle()
  • Modifies the angle (radians) of the cone created by the spot. //! Works only on TOLS_SPOT lights. Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_SPOT. //! if <AngleCone> is a negative value or greater than PI/2.
Parameters:AngleCone (float) –
Return type:None
SetAttenuation1()
  • Modifies the attenuation factor of the light. //! Works only on the TOLS_POSITIONAL and TOLS_SPOT lights. Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_SPOT or TOLS_POSITIONAL. //! if <Fact1> is a negative value or greater than 1.0.
Parameters:Fact1 (float) –
Return type:None
SetAttenuation2()
  • Modifies the attenuation factor of the light. //! Works only on the TOLS_POSITIONAL and TOLS_SPOT lights. Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_POSITIONAL or TOLS_SPOT. //! if <Fact2> is a negative value or greater than 1.0..
Parameters:Fact2 (float) –
Return type:None
SetColor()
  • Modifies the colour of the light.
Parameters:Color (Quantity_Color &) –
Return type:None
SetConcentration()
  • Modifies the intensity distribution of the light. //! Works only on the TOLS_SPOT lights. Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_SPOT. //! if <Concentration> is a negative value or greater than 1.0.
Parameters:Concentration (float) –
Return type:None
SetDirection()
  • Modifies the light direction. //! Works only on the TOLS_DIRECTIONAL and TOLS_SPOT lights. //! Default z Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_DIRECTIONAL //! or TOLS_SPOT. //! if <Direction> is null.
Parameters:Direction (Graphic3d_Vector &) –
Return type:None
SetHeadlight()
  • Setup headlight flag.
Parameters:theValue (bool) –
Return type:None
SetPosition()
  • Modifies the position of the light. //! Works only on the TOLS_POSITIONAL and TOLS_SPOT lights. Category: Methods to modify the class definition Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_POSITIONAL or TOLS_SPOT.
Parameters:Position (Graphic3d_Vertex &) –
Return type:None
Values()
  • Returns the definition of <self> if <self> is //! a light source of the TOLS_AMBIENT type. Category: Inquire methods Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_AMBIENT.
Parameters:Color (Quantity_Color &) –
Return type:None
  • Returns the definition of <self> if <self> is //! a light source of the TOLS_DIRECTIONAL type. Category: Inquire methods Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_DIRECTIONAL.
Parameters:
  • Color (Quantity_Color &) –
  • Direction (Graphic3d_Vector &) –
Return type:

None

  • Returns the definition of <self> if <self> is //! a light source of the TOLS_POSITIONAL type. Category: Inquire methods Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_POSITIONAL.
Parameters:
  • Color (Quantity_Color &) –
  • Position (Graphic3d_Vertex &) –
  • Fact1 (float &) –
  • Fact2 (float &) –
Return type:

None

  • Returns the definition of <self> if <self> is //! a light source of the TOLS_SPOT type. Category: Inquire methods Warning: Raises LightDefinitionError //! if the type of the light is not TOLS_SPOT.
Parameters:
  • Color (Quantity_Color &) –
  • Position (Graphic3d_Vertex &) –
  • Direction (Graphic3d_Vector &) –
  • Concentration (float &) –
  • Fact1 (float &) –
  • Fact2 (float &) –
  • AngleCone (float &) –
Return type:

None

thisown

The membership flag

class OCC.Visual3d.Visual3d_ListIteratorOfSetListOfSetOfLight(*args)

Bases: object

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

The membership flag

class OCC.Visual3d.Visual3d_ListIteratorOfSetListOfSetOfView(*args)

Bases: object

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

The membership flag

class OCC.Visual3d.Visual3d_ListNodeOfSetListOfSetOfLight(*args)

Bases: OCC.TCollection.TCollection_MapNode

GetHandle()

Visual3d_ListNodeOfSetListOfSetOfLight_GetHandle(Visual3d_ListNodeOfSetListOfSetOfLight self) -> Handle_Visual3d_ListNodeOfSetListOfSetOfLight

Value()
Return type:Handle_Visual3d_Light
thisown

The membership flag

class OCC.Visual3d.Visual3d_ListNodeOfSetListOfSetOfView(*args)

Bases: OCC.TCollection.TCollection_MapNode

GetHandle()

Visual3d_ListNodeOfSetListOfSetOfView_GetHandle(Visual3d_ListNodeOfSetListOfSetOfView self) -> Handle_Visual3d_ListNodeOfSetListOfSetOfView

Value()
Return type:Handle_Visual3d_View
thisown

The membership flag

class OCC.Visual3d.Visual3d_PickDescriptor(*args)

Bases: object

AddPickPath()
  • Adds a PickPath to PickDescriptor <self>.
Parameters:APickPath (Visual3d_PickPath &) –
Return type:None
Clear()
  • Erases all the information in <self>.
Return type:None
Depth()
  • Returns the pick depth, that is the //! number of PickPaths available in the PickDescriptor.
Return type:int
PickPath()
  • Returns the group of PickPaths of <self>.
Return type:Handle_Visual3d_HSequenceOfPickPath
TopElementNumber()
  • Returns the root structure element number. //! If the pick order was of the type TOO_TOPFIRST //! then it’s the first element number. //! If the pick order was of the type TOO_BOTTOMFIRST //! then it’s the last element number. //! The pick order is set by the method SetOrder //! from ContextPick. Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure).
Return type:int
TopPickId()
  • Returns the root structure pickid. //! If the pick order was of the type TOO_TOPFIRST //! then it’s the first pickid. //! If the pick order was of the type TOO_BOTTOMFIRST //! then it’s the last pickid. //! The pick order is set by the method SetOrder //! from ContextPick. Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure).
Return type:int
TopStructure()
  • Returns the root structure. //! If the pick order was of the type TOO_TOPFIRST //! then it’s the first structure. //! If the pick order was of the type TOO_BOTTOMFIRST //! Then it’s the last structure. //! The pick order is set by the method SetOrder //! from ContextPick. Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure).
Return type:Handle_Graphic3d_Structure
thisown

The membership flag

class OCC.Visual3d.Visual3d_PickPath(*args)

Bases: object

ElementNumber()
  • Returns the element number stocked in the PickPath <self>. Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure).
Return type:int
PickIdentifier()
  • Returns the pick identifier stocked in the PickPath <self>. Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure).
Return type:int
SetElementNumber()
  • Modifies the PickPath <self>. //! <AElemNumber> : Element number of the structure picked.
Parameters:AElemNumber (Standard_Integer) –
Return type:None
SetPickIdentifier()
  • Modifies the PickPath <self>. //! <APickId> : Pick identifier of the structure picked.
Parameters:APickId (Standard_Integer) –
Return type:None
SetStructIdentifier()
  • Modifies the PickPath <self>. //! <AStructure> : Identifier of the structure picked.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:None
StructIdentifier()
  • Returns the structure stocked in the PickPath <self>. Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure).
Return type:Handle_Graphic3d_Structure
thisown

The membership flag

class OCC.Visual3d.Visual3d_SequenceNodeOfSequenceOfPickPath(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Visual3d_SequenceNodeOfSequenceOfPickPath_GetHandle(Visual3d_SequenceNodeOfSequenceOfPickPath self) -> Handle_Visual3d_SequenceNodeOfSequenceOfPickPath

Value()
Return type:Visual3d_PickPath
thisown

The membership flag

class OCC.Visual3d.Visual3d_SequenceOfPickPath

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Visual3d_PickPath &) –
  • S (Visual3d_SequenceOfPickPath &) –
Return type:

None

Return type:

None

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

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Visual3d_PickPath &) –
  • Index
  • S (Visual3d_SequenceOfPickPath &) –
Return type:

None

Return type:

None

Last()
Return type:Visual3d_PickPath
Prepend()
Parameters:
  • T (Visual3d_PickPath &) –
  • S (Visual3d_SequenceOfPickPath &) –
Return type:

None

Return type:

None

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

None

Return type:

None

Set()
Parameters:Other (Visual3d_SequenceOfPickPath &) –
Return type:Visual3d_SequenceOfPickPath
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Visual3d_PickPath &) –
Return type:

None

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

None

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

The membership flag

class OCC.Visual3d.Visual3d_SetIteratorOfSetOfLight(*args)

Bases: object

Initialize()
Parameters:S (Visual3d_SetOfLight &) –
Return type:None
More()
Return type:bool
Next()
Return type:None
Value()
Return type:Handle_Visual3d_Light
thisown

The membership flag

class OCC.Visual3d.Visual3d_SetIteratorOfSetOfView(*args)

Bases: object

Initialize()
Parameters:S (Visual3d_SetOfView &) –
Return type:None
More()
Return type:bool
Next()
Return type:None
Value()
Return type:Handle_Visual3d_View
thisown

The membership flag

class OCC.Visual3d.Visual3d_SetListOfSetOfLight

Bases: object

Append()
Parameters:
  • I (Handle_Visual3d_Light &) –
  • I
  • theIt (Visual3d_ListIteratorOfSetListOfSetOfLight &) –
  • Other (Visual3d_SetListOfSetOfLight &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (Visual3d_SetListOfSetOfLight &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_Visual3d_Light
InsertAfter()
Parameters:
  • I (Handle_Visual3d_Light &) –
  • It (Visual3d_ListIteratorOfSetListOfSetOfLight &) –
  • Other (Visual3d_SetListOfSetOfLight &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_Visual3d_Light &) –
  • It (Visual3d_ListIteratorOfSetListOfSetOfLight &) –
  • Other (Visual3d_SetListOfSetOfLight &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_Visual3d_Light
Prepend()
Parameters:
  • I (Handle_Visual3d_Light &) –
  • I
  • theIt (Visual3d_ListIteratorOfSetListOfSetOfLight &) –
  • Other (Visual3d_SetListOfSetOfLight &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (Visual3d_ListIteratorOfSetListOfSetOfLight &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (Visual3d_SetListOfSetOfLight &) –
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_SetListOfSetOfView

Bases: object

Append()
Parameters:
  • I (Handle_Visual3d_View &) –
  • I
  • theIt (Visual3d_ListIteratorOfSetListOfSetOfView &) –
  • Other (Visual3d_SetListOfSetOfView &) –
Return type:

None

Return type:

None

Return type:

None

Assign()
Parameters:Other (Visual3d_SetListOfSetOfView &) –
Return type:None
Clear()
Return type:None
Extent()
Return type:int
First()
Return type:Handle_Visual3d_View
InsertAfter()
Parameters:
  • I (Handle_Visual3d_View &) –
  • It (Visual3d_ListIteratorOfSetListOfSetOfView &) –
  • Other (Visual3d_SetListOfSetOfView &) –
  • It
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • I (Handle_Visual3d_View &) –
  • It (Visual3d_ListIteratorOfSetListOfSetOfView &) –
  • Other (Visual3d_SetListOfSetOfView &) –
  • It
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Last()
Return type:Handle_Visual3d_View
Prepend()
Parameters:
  • I (Handle_Visual3d_View &) –
  • I
  • theIt (Visual3d_ListIteratorOfSetListOfSetOfView &) –
  • Other (Visual3d_SetListOfSetOfView &) –
Return type:

None

Return type:

None

Return type:

None

Remove()
Parameters:It (Visual3d_ListIteratorOfSetListOfSetOfView &) –
Return type:None
RemoveFirst()
Return type:None
Set()
Parameters:Other (Visual3d_SetListOfSetOfView &) –
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_SetOfLight

Bases: object

Add()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
Clear()
Return type:None
Contains()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
Difference()
Parameters:B (Visual3d_SetOfLight &) –
Return type:None
Extent()
Return type:int
Intersection()
Parameters:B (Visual3d_SetOfLight &) –
Return type:None
IsAProperSubset()
Parameters:S (Visual3d_SetOfLight &) –
Return type:bool
IsASubset()
Parameters:S (Visual3d_SetOfLight &) –
Return type:bool
IsEmpty()
Return type:bool
Remove()
Parameters:T (Handle_Visual3d_Light &) –
Return type:bool
Union()
Parameters:B (Visual3d_SetOfLight &) –
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_SetOfView

Bases: object

Add()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
Clear()
Return type:None
Contains()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
Difference()
Parameters:B (Visual3d_SetOfView &) –
Return type:None
Extent()
Return type:int
Intersection()
Parameters:B (Visual3d_SetOfView &) –
Return type:None
IsAProperSubset()
Parameters:S (Visual3d_SetOfView &) –
Return type:bool
IsASubset()
Parameters:S (Visual3d_SetOfView &) –
Return type:bool
IsEmpty()
Return type:bool
Remove()
Parameters:T (Handle_Visual3d_View &) –
Return type:bool
Union()
Parameters:B (Visual3d_SetOfView &) –
Return type:None
thisown

The membership flag

class OCC.Visual3d.Visual3d_TransientManager

Bases: OCC.MMgt.MMgt_TShared

static BeginAddDraw(*args)
  • Begins any add graphics in the view <aView> the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:aView (Handle_Visual3d_View &) –
Return type:int
static BeginDraw(*args)
  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

static ClearDraw(*args)
  • Clear all transient graphics in the view <aView> updates a scene if <aFlush> = true Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • aFlush (bool) – default value is Standard_True
Return type:

void

  • Clear all transient graphics in the view <aView> updates a scene if <aFlush> = true Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • aFlush (bool) – default value is Standard_True
Return type:

void

Destroy()
  • Suppress the TransientManager <self>.
Return type:None
static DrawStructure(*args)
  • Drawn the structure <AStructure>. Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:void
static EndAddDraw()
  • Flush all add graphics to the front buffer. Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Return type:void
static EndDraw(*args)
  • Flush all graphics to the front buffer. Synchronize graphics to the screen if <Synchronize> is True (make becarefull to the performances!). Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
  • Flush all graphics to the front buffer. Synchronize graphics to the screen if <Synchronize> is True (make becarefull to the performances!). Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
GetHandle()

Visual3d_TransientManager_GetHandle(Visual3d_TransientManager self) -> Handle_Visual3d_TransientManager

thisown

The membership flag

OCC.Visual3d.Visual3d_TransientManager_BeginAddDraw(*args)
  • Begins any add graphics in the view <aView> the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:aView (Handle_Visual3d_View &) –
Return type:int
OCC.Visual3d.Visual3d_TransientManager_BeginDraw(*args)
  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

  • Begins any graphics in the view <aView> Redraw any structured graphics in the back buffer before if <DoubleBuffer> is True. Restore the front buffer from the back before if <DoubleBuffer> is False. if <RetainMode> is True. the graphic managed itself exposure,resizing ... if <RetainMode> is False. the application must managed itself exposure,resizing ... Warning: Returns True if transient drawing is enabled in the associated view. Returns False ,if nothing works because something is wrong for the transient principle : Immediat mode is not implemented depending of the graphic library used. MBX,PIXMAP double buffering don’t works depending of the graphic board and the visual of the window supporting the view. Warning: No default attributes Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • DoubleBuffer (bool) – default value is Standard_False
  • RetainMode (bool) – default value is Standard_False
Return type:

int

OCC.Visual3d.Visual3d_TransientManager_ClearDraw(*args)
  • Clear all transient graphics in the view <aView> updates a scene if <aFlush> = true Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • aFlush (bool) – default value is Standard_True
Return type:

void

  • Clear all transient graphics in the view <aView> updates a scene if <aFlush> = true Raises TransientDefinitionError from Visual3d; if Drawing is already opened. or the associated view is not mapped on a window.
Parameters:
  • aView (Handle_Visual3d_View &) –
  • aFlush (bool) – default value is Standard_True
Return type:

void

OCC.Visual3d.Visual3d_TransientManager_DrawStructure(*args)
  • Drawn the structure <AStructure>. Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:void
OCC.Visual3d.Visual3d_TransientManager_EndAddDraw()
  • Flush all add graphics to the front buffer. Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Return type:void
OCC.Visual3d.Visual3d_TransientManager_EndDraw(*args)
  • Flush all graphics to the front buffer. Synchronize graphics to the screen if <Synchronize> is True (make becarefull to the performances!). Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
  • Flush all graphics to the front buffer. Synchronize graphics to the screen if <Synchronize> is True (make becarefull to the performances!). Raises TransientDefinitionError from Visual3d; if Drawing is not opened.
Parameters:Synchronize (bool) – default value is Standard_False
Return type:void
class OCC.Visual3d.Visual3d_View(*args)

Bases: OCC.Graphic3d.Graphic3d_DataStructureManager

Activate()
  • Activates the view <self>. //! Map the associated window on the screen and //! post the view in this window. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Return type:None
BackFacingModel()
  • Returns current state of the back faces display
Return type:Visual3d_TypeOfBackfacingModel
Background()
  • Returns the value of the default window background.
Return type:Aspect_Background
BufferDump()
  • Dump active rendering buffer into specified memory buffer.
Parameters:
  • theImage (Image_PixMap &) –
  • theBufferType (Graphic3d_BufferType &) –
Return type:

bool

CView()
  • Returns the c structure associated to <self>.
Return type:Standard_Address
ComputedMode()
  • Returns the computed HLR mode state
Return type:bool
ContainsFacet()
  • Returns Standard_True if one of the structures //! displayed in the view <self> contains Polygons, //! Triangles or Quadrangles.
Return type:bool
  • Returns Standard_True if one of the structures //! in the set <ASet> contains Polygons, Triangles //! or Quadrangles.
Parameters:ASet (Graphic3d_MapOfStructure &) –
Return type:bool
Context()
  • Returns the current context of the view <self>.
Return type:Visual3d_ContextView
Deactivate()
  • Deactivates the view <self>. //! Unmap the associated window on the screen and //! unpost the view in this window. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Return type:None
DisplayedStructures()
  • Returns the set of structures displayed in //! the view <self>.
Parameters:SG (Graphic3d_MapOfStructure &) –
Return type:None
EnableDepthTest()
  • turns on/off opengl depth
Parameters:enable (bool) –
Return type:None
EnableGLLight()
  • turns on/off opengl lighting, currently used in triedron displaying
Parameters:enable (bool) –
Return type:None
Export()
  • Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.
Parameters:
  • theFileName (char *) –
  • theFormat (Graphic3d_ExportFormat) –
  • theSortType (Graphic3d_SortType) – default value is Graphic3d_ST_BSP_Tree
  • thePrecision (float) – default value is 0.005
  • theProgressBarFunc (Standard_Address) – default value is NULL
  • theProgressObject (Standard_Address) – default value is NULL
Return type:

bool

  • Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.
Parameters:
  • theFileName (char *) –
  • theFormat (Graphic3d_ExportFormat) –
  • theSortType (Graphic3d_SortType) – default value is Graphic3d_ST_BSP_Tree
  • thePrecision (float) – default value is 0.005
  • theProgressBarFunc (Standard_Address) – default value is NULL
  • theProgressObject (Standard_Address) – default value is NULL
Return type:

bool

  • Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.
Parameters:
  • theFileName (char *) –
  • theFormat (Graphic3d_ExportFormat) –
  • theSortType (Graphic3d_SortType) – default value is Graphic3d_ST_BSP_Tree
  • thePrecision (float) – default value is 0.005
  • theProgressBarFunc (Standard_Address) – default value is NULL
  • theProgressObject (Standard_Address) – default value is NULL
Return type:

bool

  • Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.
Parameters:
  • theFileName (char *) –
  • theFormat (Graphic3d_ExportFormat) –
  • theSortType (Graphic3d_SortType) – default value is Graphic3d_ST_BSP_Tree
  • thePrecision (float) – default value is 0.005
  • theProgressBarFunc (Standard_Address) – default value is NULL
  • theProgressObject (Standard_Address) – default value is NULL
Return type:

bool

  • Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.
Parameters:
  • theFileName (char *) –
  • theFormat (Graphic3d_ExportFormat) –
  • theSortType (Graphic3d_SortType) – default value is Graphic3d_ST_BSP_Tree
  • thePrecision (float) – default value is 0.005
  • theProgressBarFunc (Standard_Address) – default value is NULL
  • theProgressObject (Standard_Address) – default value is NULL
Return type:

bool

FBOChangeViewport()
  • Change offscreen FBO viewport.
Parameters:
  • fboPtr (Graphic3d_PtrFrameBuffer &) –
  • width (Standard_Integer) –
  • height (Standard_Integer) –
Return type:

None

FBOCreate()
  • Generate offscreen FBO in the graphic library
Parameters:
  • width (Standard_Integer) –
  • height (Standard_Integer) –
Return type:

Graphic3d_PtrFrameBuffer

FBOGetDimensions()
  • Read offscreen FBO configuration.
Parameters:
  • fboPtr (Graphic3d_PtrFrameBuffer) –
  • width (Standard_Integer &) –
  • height (Standard_Integer &) –
  • widthMax (Standard_Integer &) –
  • heightMax (Standard_Integer &) –
Return type:

None

FBORelease()
  • Remove offscreen FBO from the graphic library
Parameters:fboPtr (Graphic3d_PtrFrameBuffer &) –
Return type:None
GetGraduatedTrihedron()
  • Returns data of a graduated trihedron if displayed (return value is True)
Parameters:
  • xname (TCollection_ExtendedString &) –
  • yname (TCollection_ExtendedString &) –
  • zname (TCollection_ExtendedString &) –
  • xdrawname (bool) –
  • ydrawname (bool) –
  • zdrawname (bool) –
  • xdrawvalues (bool) –
  • ydrawvalues (bool) –
  • zdrawvalues (bool) –
  • drawgrid (bool) –
  • drawaxes (bool) –
  • nbx (Standard_Integer &) –
  • nby (Standard_Integer &) –
  • nbz (Standard_Integer &) –
  • xoffset (Standard_Integer &) –
  • yoffset (Standard_Integer &) –
  • zoffset (Standard_Integer &) –
  • xaxisoffset (Standard_Integer &) –
  • yaxisoffset (Standard_Integer &) –
  • zaxisoffset (Standard_Integer &) –
  • xdrawtickmarks (bool) –
  • ydrawtickmarks (bool) –
  • zdrawtickmarks (bool) –
  • xtickmarklength (Standard_Integer &) –
  • ytickmarklength (Standard_Integer &) –
  • ztickmarklength (Standard_Integer &) –
  • gridcolor (Quantity_Color &) –
  • xnamecolor (Quantity_Color &) –
  • ynamecolor (Quantity_Color &) –
  • znamecolor (Quantity_Color &) –
  • xcolor (Quantity_Color &) –
  • ycolor (Quantity_Color &) –
  • zcolor (Quantity_Color &) –
  • fontOfNames (TCollection_AsciiString &) –
  • styleOfNames (Font_FontAspect &) –
  • sizeOfNames (Standard_Integer &) –
  • fontOfValues (TCollection_AsciiString &) –
  • styleOfValues (Font_FontAspect &) –
  • sizeOfValues (Standard_Integer &) –
Return type:

bool

GetHandle()

Visual3d_View_GetHandle(Visual3d_View self) -> Handle_Visual3d_View

GradientBackground()
  • Returns the value of the window background.
Return type:Aspect_GradientBackground
GraduatedTrihedronDisplay()
  • Displays a graduated trihedron.
Parameters:
  • xname (TCollection_ExtendedString &) –
  • yname (TCollection_ExtendedString &) –
  • zname (TCollection_ExtendedString &) –
  • xdrawname (bool) –
  • ydrawname (bool) –
  • zdrawname (bool) –
  • xdrawvalues (bool) –
  • ydrawvalues (bool) –
  • zdrawvalues (bool) –
  • drawgrid (bool) –
  • drawaxes (bool) –
  • nbx (Standard_Integer) –
  • nby (Standard_Integer) –
  • nbz (Standard_Integer) –
  • xoffset (Standard_Integer) –
  • yoffset (Standard_Integer) –
  • zoffset (Standard_Integer) –
  • xaxisoffset (Standard_Integer) –
  • yaxisoffset (Standard_Integer) –
  • zaxisoffset (Standard_Integer) –
  • xdrawtickmarks (bool) –
  • ydrawtickmarks (bool) –
  • zdrawtickmarks (bool) –
  • xtickmarklength (Standard_Integer) –
  • ytickmarklength (Standard_Integer) –
  • ztickmarklength (Standard_Integer) –
  • gridcolor (Quantity_Color &) –
  • xnamecolor (Quantity_Color &) –
  • ynamecolor (Quantity_Color &) –
  • znamecolor (Quantity_Color &) –
  • xcolor (Quantity_Color &) –
  • ycolor (Quantity_Color &) –
  • zcolor (Quantity_Color &) –
  • fontOfNames (TCollection_AsciiString &) –
  • styleOfNames (Font_FontAspect) –
  • sizeOfNames (Standard_Integer) –
  • fontOfValues (TCollection_AsciiString &) –
  • styleOfValues (Font_FontAspect) –
  • sizeOfValues (Standard_Integer) –
Return type:

None

GraduatedTrihedronErase()
  • Erases a graduated trihedron from the view.
Return type:None
GraphicDriver()
  • Returns the associated GraphicDriver.
Return type:Handle_Graphic3d_GraphicDriver
Identification()
  • Returns the identification number of the view <self>.
Return type:int
IsActive()
  • Returns the activity flag of the view <self>.
Return type:bool
IsDefined()
  • Returns True if the window associated to the view //! <self> is defined.
Return type:bool
IsDeleted()
  • Returns Standard_True is the view <self> is deleted. //! <self> is deleted after the call Remove (me).
Return type:bool
IsDepthTestEnabled()
  • returns current state of the opengl depth testing
Return type:bool
IsGLLightEnabled()
  • returns the current state of the gl lighting currently used in triedron displaying
Return type:bool
LightLimit()
  • Returns the MAX number of light associated to the view <self>.
Return type:int
MatrixOfMapping()
  • Returns the current matrix of mapping of the view <self>. Warning: Stores the current matrix of mapping.
Return type:TColStd_Array2OfReal
MatrixOfOrientation()
  • Returns the current matrix of orientation of the view <self>. Warning: Stores the current matrix of orientation.
Return type:TColStd_Array2OfReal
MinMaxValues()
  • Returns the coordinates of the boundary box of all //! structures displayed in the view <self>.
Parameters:
  • XMin (float &) –
  • YMin (float &) –
  • ZMin (float &) –
  • XMax (float &) –
  • YMax (float &) –
  • ZMax (float &) –
Return type:

None

  • Returns the coordinates of the boundary box of all //! structures in the set <ASet>.
Parameters:
  • ASet (Graphic3d_MapOfStructure &) –
  • XMin (float &) –
  • YMin (float &) –
  • ZMin (float &) –
  • XMax (float &) –
  • YMax (float &) –
  • ZMax (float &) –
Return type:

None

  • Returns the coordinates of the projection of the //! boundary box of all structures displayed in the view <self>.
Parameters:
  • XMin (float &) –
  • YMin (float &) –
  • XMax (float &) –
  • YMax (float &) –
Return type:

None

  • Returns the coordinates of the projection of the //! boundary box of all structures in the set <ASet>.
Parameters:
  • ASet (Graphic3d_MapOfStructure &) –
  • XMin (float &) –
  • YMin (float &) –
  • XMax (float &) –
  • YMax (float &) –
Return type:

None

NumberOfDisplayedStructures()
  • Returns number of displayed structures in //! the view <self>.
Return type:int
OverLayer()
  • Returns the underlay of the view <self>.
Return type:Handle_Visual3d_Layer
PlaneLimit()
  • Returns the MAX number of clipping planes associated to the view <self>.
Return type:int
Plot()
  • Calls the method Plot for each Structure //! displayed in <self>.
Parameters:APlotter (Handle_Graphic3d_Plotter &) –
Return type:None
Projects()
  • Returns the coordinates of the projection of the //! 3d coordinates <AX>, <AY>, <AZ>.
Parameters:
  • AX (float) –
  • AY (float) –
  • AZ (float) –
  • APX (float &) –
  • APY (float &) –
  • APZ (float &) –
Return type:

None

ReCompute()
  • Computes the new presentation of the //! structure <AStructure> displayed in <self> //! with the type Graphic3d_TOS_COMPUTED.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:None
ReadDepths()
  • Reads depths of shown pixels of the given rectangle
Parameters:
  • x (Standard_Integer) –
  • y (Standard_Integer) –
  • width (Standard_Integer) –
  • height (Standard_Integer) –
  • buffer (Standard_Address) –
Return type:

None

Redraw()
  • Updates screen in all cases.
Return type:None
  • Updates screen area in all cases. area is given by his xy min corner and size in pixel coordinates
Parameters:
  • x (Standard_Integer) –
  • y (Standard_Integer) –
  • width (Standard_Integer) –
  • height (Standard_Integer) –
Return type:

None

  • Updates screen in all cases.
Parameters:
  • AnUnderLayer (Handle_Visual3d_Layer &) –
  • AnOverLayer (Handle_Visual3d_Layer &) –
Return type:

None

  • Updates screen area in all cases. area is given by his xy min corner and size in pixel coordinates
Parameters:
  • AnUnderLayer (Handle_Visual3d_Layer &) –
  • AnOverLayer (Handle_Visual3d_Layer &) –
  • x (Standard_Integer) –
  • y (Standard_Integer) –
  • width (Standard_Integer) –
  • height (Standard_Integer) –
Return type:

None

Remove()
  • Deletes and erases the view <self>. Warning: No more graphic operations in <self> after this call.
Return type:None
Resized()
  • Updates the view <self> after the modification //! of the associated window. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Return type:None
SetBackFacingModel()
  • Manages display of the back faces
Parameters:aModel (Visual3d_TypeOfBackfacingModel) –
Return type:None
SetBackground()
  • Modifies the default window background. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Parameters:ABack (Aspect_Background &) –
Return type:None
SetBackgroundImage()
  • Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Parameters:
  • FileName (char *) –
  • FillStyle (Aspect_FillMethod) –
  • update (bool) –
Return type:

None

SetBgGradientStyle()
  • Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Parameters:
  • FillStyle (Aspect_GradientFillMethod) –
  • update (bool) –
Return type:

None

SetBgImageStyle()
  • Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Parameters:
  • FillStyle (Aspect_FillMethod) –
  • update (bool) –
Return type:

None

SetComputedMode()
  • Switches computed HLR mode in the view
Parameters:aMode (bool) –
Return type:None
SetContext()
  • Sets the context <CTX> in the view <self>.
Parameters:CTX (Visual3d_ContextView &) –
Return type:None
SetGradientBackground()
  • Modifies the gradient window background. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Parameters:
  • ABack (Aspect_GradientBackground &) –
  • update (bool) –
Return type:

None

SetTransform()
  • Sets the transformation matrix that is applied to <MyViewOrientation> field of the view <self>. //! <AMatrix> is defined as a 4*4 real matrix. //! ——————- //! | a11 a12 a13 t1 | //! | a21 a22 a23 t2 | //! | a31 a32 a33 t3 | //! | 0 0 0 1 | //! ——————- Category: Methods to modify the class definition Warning: Raises TransformError if the matrix isn’t a 4x4 matrix.
Parameters:AMatrix (TColStd_Array2OfReal &) –
Return type:None
SetTransparency()
  • if <AFlag> is Standard_True then the transparency //! is managed in the view <self>. //! Default Standard_False
Parameters:AFlag (bool) –
Return type:None
SetViewMapping()
  • Modifies the mapping of the view <self>.
Parameters:VM (Visual3d_ViewMapping &) –
Return type:None
SetViewMappingDefault()
  • Saves the current mapping which will be the //! reference value for the reset of the mapping //! done by the ViewmappingReset method.
Return type:None
SetViewOrientation()
  • Modifies the orientation of <self>.
Parameters:VO (Visual3d_ViewOrientation &) –
Return type:None
SetViewOrientationDefault()
  • Saves the current orientation which will be the //! reference value for the reset of the orientation //! done by the ViewOrientationReset method.
Return type:None
SetWindow()
  • Associates the window <AWindow> to the view <self>. //! No new association if the window is already defined. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if it is impossible //! to associate a view and a window. //! (association already done or another problem) //! Modifies the viewmapping of the associated view //! when it calls the SetRatio method. //! After this call, each view is mapped in an unique window. Programming example : An example when we have 1 view and 1 window ——————————————- Handle_Aspect_DisplayConnection aDisplayConnection; // Display connection initialization only needed on Linux platform // and on Mac OS X, in cases when you use Xlib for windows drawing. aDisplayConnection = new Aspect_DisplayConnection(); // Graphic driver initialization Handle_Graphic3d_GraphicDriver aGraphicDriver = Graphic3d::InitGraphicDriver (aDisplayConnection); // Define a view manager Handle_Visual3d_ViewManager aVisualManager = new Visual3d_ViewManager (aGraphicDriver); // Define a view Handle_Visual3d_View aView = new Visual3d_View (aVisaulManager); // Define a window Handle_Xw_Window aWindow = new Xw_Window //! (aDisplayConnection, ‘Graphic View 1’, 0.695, 0.695, 0.600, 0.600, Quantity_NOC_MATRAGRAY); // Associate the view and the window aView->SetWindow (aWindow); // Map the window aWindow->Map (); // Activate the view aView->Activate ();
Parameters:AWindow (Handle_Aspect_Window &) –
Return type:None
  • Associates the window <AWindow> and context <AContext> //! to the view <self>. //! If <AContext> is not NULL the graphic context is used directly to draw something in this view. //! Otherwise an internal context is created. If <ADisplayCB> is not NULL then a user display CB is call at the end of the OCC graphic traversal and just before the swap of buffers. The <aClientData> is pass to this call back. //! No new association if the window is already defined. Category: Methods to modify the class definition Warning: Raises ViewDefinitionError if it is impossible //! to associate a view and a window. //! (association already done or another problem) //! Modifies the viewmapping of the associated view //! when it calls the SetRatio method. //! After this call, each view is mapped in an unique window.
Parameters:
  • AWindow (Handle_Aspect_Window &) –
  • AContext (Aspect_RenderingContext) –
  • ADisplayCB (Aspect_GraphicCallbackProc &) –
  • AClientData (Standard_Address) –
Return type:

None

SetZBufferActivity()
  • Activates the ZBuffer if the integer <AnActivity> //! is equal to 1. //! Deactivates the ZBuffer if the integer <AnActivity> //! is equal to 0. //! If the integer <AnActivity> is equal to -1 then //! - the ZBuffer is activated if //! me->Context ().Visualization () == Visual3d_TOV_SHADING //! - the ZBuffer is deactivated if //! me->Context ().Visualization () == Visual3d_TOV_WIREFRAME
Parameters:AnActivity (Standard_Integer) –
Return type:None
Transform()
  • Returns the transformation associated to the view <self>
Return type:TColStd_Array2OfReal
TriedronDisplay()
  • Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. If AsWireframe is False triedron is shown in shaded mode AColor is not considered for ZBUFFER mode
Parameters:
  • APosition (Aspect_TypeOfTriedronPosition) – default value is Aspect_TOTP_CENTER
  • AColor (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • AScale (float) – default value is 0.02
  • AsWireframe (bool) – default value is Standard_True
Return type:

None

  • Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. If AsWireframe is False triedron is shown in shaded mode AColor is not considered for ZBUFFER mode
Parameters:
  • APosition (Aspect_TypeOfTriedronPosition) – default value is Aspect_TOTP_CENTER
  • AColor (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • AScale (float) – default value is 0.02
  • AsWireframe (bool) – default value is Standard_True
Return type:

None

  • Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. If AsWireframe is False triedron is shown in shaded mode AColor is not considered for ZBUFFER mode
Parameters:
  • APosition (Aspect_TypeOfTriedronPosition) – default value is Aspect_TOTP_CENTER
  • AColor (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • AScale (float) – default value is 0.02
  • AsWireframe (bool) – default value is Standard_True
Return type:

None

  • Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. If AsWireframe is False triedron is shown in shaded mode AColor is not considered for ZBUFFER mode
Parameters:
  • APosition (Aspect_TypeOfTriedronPosition) – default value is Aspect_TOTP_CENTER
  • AColor (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • AScale (float) – default value is 0.02
  • AsWireframe (bool) – default value is Standard_True
Return type:

None

  • Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. If AsWireframe is False triedron is shown in shaded mode AColor is not considered for ZBUFFER mode
Parameters:
  • APosition (Aspect_TypeOfTriedronPosition) – default value is Aspect_TOTP_CENTER
  • AColor (Quantity_NameOfColor) – default value is Quantity_NOC_WHITE
  • AScale (float) – default value is 0.02
  • AsWireframe (bool) – default value is Standard_True
Return type:

None

TriedronEcho()
  • Highlights the echo zone of the Triedron.
Parameters:AType (Aspect_TypeOfTriedronEcho) – default value is Aspect_TOTE_NONE
Return type:None
  • Highlights the echo zone of the Triedron.
Parameters:AType (Aspect_TypeOfTriedronEcho) – default value is Aspect_TOTE_NONE
Return type:None
TriedronErase()
  • Erases the Triedron.
Return type:None
UnderLayer()
  • Returns the underlay of the view <self>.
Return type:Handle_Visual3d_Layer
Update()
  • Updates screen in function of modifications of //! the structures.
Return type:None
  • Updates screen in function of modifications of //! the structures.
Parameters:
  • AnUnderLayer (Handle_Visual3d_Layer &) –
  • AnOverLayer (Handle_Visual3d_Layer &) –
Return type:

None

ViewManager()
  • Returns the view manager handle which manage this view
Return type:Handle_Visual3d_ViewManager
ViewMapping()
  • Returns the current mapping of the view <self>.
Return type:Visual3d_ViewMapping
ViewMappingDefault()
  • Returns the current reset mapping of the view <self>.
Return type:Visual3d_ViewMapping
ViewMappingReset()
  • Sets the value of the mapping to be the same as //! the mapping saved by the SetViewMappingDefaut method.
Return type:None
ViewOrientation()
  • Returns the current orientation of the view <self>.
Return type:Visual3d_ViewOrientation
ViewOrientationDefault()
  • Returns the current reset orientation of the view <self>.
Return type:Visual3d_ViewOrientation
ViewOrientationReset()
  • Sets the value of the orientation to be the same as the //! orientation saved by the SetViewOrientationDefaut method.
Return type:None
Window()
  • Returns the window associated to the view <self>. Warning: Raises ViewDefinitionError if the associated //! window isn’t defined.
Return type:Handle_Aspect_Window
ZBufferIsActivated()
  • Returns Standard_True if the ZBuffer is activated //! in the view <self> and Standard_False if not.
Return type:bool
ZBufferTriedronSetup()
  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

  • Customization of the ZBUFFER Triedron. Initializes Colors of X Y and axis Scale ratio defines decreasing of trihedron size when its position is out of a View
Parameters:
  • XColor (Quantity_NameOfColor) – default value is Quantity_NOC_RED
  • YColor (Quantity_NameOfColor) – default value is Quantity_NOC_GREEN
  • ZColor (Quantity_NameOfColor) – default value is Quantity_NOC_BLUE1
  • SizeRatio (float) – default value is 0.8
  • AxisDiametr (float) – default value is 0.05
  • NbFacettes (Standard_Integer) – default value is 12
Return type:

None

thisown

The membership flag

class OCC.Visual3d.Visual3d_ViewManager(*args)

Bases: OCC.Graphic3d.Graphic3d_StructureManager

Activate()
  • Activates all the views of the manager <self>.
Return type:None
ActivatedView()
  • Returns the group of views activated in the visualiser <self>.
Return type:Handle_Visual3d_HSetOfView
ConvertCoord()
  • Applies the view orientation transformation, the //! view mapping transformation and view clip, the //! display transformation to the vertex <AVertex>. //! Returns the pixel coordinates <AU>, <AV>. Warning: Returns <AU> = <AV> = IntegerLast () if the //! evaluation is impossible. //! – Bad Window, Numeric error...
Parameters:
  • AWindow (Handle_Aspect_Window &) –
  • AVertex (Graphic3d_Vertex &) –
  • AU (Standard_Integer &) –
  • AV (Standard_Integer &) –
Return type:

None

  • Applies the inverse of the display transformation, the //! inverse of the view mapping transformation and view clip, //! the inverse of the view orientation transformation to //! the pixel coordinates <AU>, <AV>. //! Returns the world coordinates <AVertex>. Warning: Returns AVertex (X, Y, Z) with X = Y = Z = RealLast () //! if the evaluation is impossible. //! – Bad Window, Numeric error...
Parameters:
  • AWindow (Handle_Aspect_Window &) –
  • AU (Standard_Integer) –
  • AV (Standard_Integer) –
Return type:

Graphic3d_Vertex

ConvertCoordWithProj()
  • Applies the inverse of the display transformation, the //! inverse of the view mapping transformation and view clip, //! the inverse of the view orientation transformation to //! the pixel coordinates <AU>, <AV>. //! Returns the world coordinates <AVertex> and projection ray <AVector>. Warning: Returns AVertex (X, Y, Z) with X = Y = Z = RealLast () and AVector (VX, VY, VZ) with VX = VY = VZ = 0. //! if the evaluation is impossible. //! – Bad Window, Numeric error...
Parameters:
  • AWindow (Handle_Aspect_Window &) –
  • AU (Standard_Integer) –
  • AV (Standard_Integer) –
  • Point (Graphic3d_Vertex &) –
  • Proj (Graphic3d_Vector &) –
Return type:

None

Deactivate()
  • Deactivates all the views of the manager <self>.
Return type:None
DefinedView()
  • Returns the group of views defined in the visualiser <self>.
Return type:Handle_Visual3d_HSetOfView
Erase()
  • Erases all of the structures displayed in the //! visualiser <self>.
Return type:None
  • Erases the structure <AStructure>.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:None
GetHandle()

Visual3d_ViewManager_GetHandle(Visual3d_ViewManager self) -> Handle_Visual3d_ViewManager

Identification()
  • Returns : //! a new identification number for a new view //! in the visualiser.
Parameters:AView (Handle_Visual3d_View &) –
Return type:int
  • Returns the structure with the identification number <AId>.
Parameters:AId (Standard_Integer) –
Return type:Handle_Graphic3d_Structure
  • Returns the identification number of the visualiser.
Return type:int
MaxNumOfViews()
  • Returns the theoretical maximum number of //! definable views in the view manager <self>. Warning: It’s not possible to accept an infinite //! number of definable views because each //! view must have an identification and we //! have different view managers.
Return type:int
OverLayer()
  • Returns the underlay of the viewer <self>.
Return type:Handle_Visual3d_Layer
ReCompute()
  • Forces a new construction of the structure <AStructure> //! if <AStructure> is displayed and TOS_COMPUTED.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:None
  • Forces a new construction of the structure <AStructure> //! if <AStructure> is displayed in <AProjector> and TOS_COMPUTED.
Parameters:
  • AStructure (Handle_Graphic3d_Structure &) –
  • AProjector (Handle_Graphic3d_DataStructureManager &) –
Return type:

None

Redraw()
  • Redraws all the displayed structures.
Return type:None
Remove()
  • Deletes and erases the 3D visualiser <self>.
Return type:None
SetTransparency()
  • if <AFlag> is Standard_True then the transparency //! is managed. //! Default Standard_False
Parameters:AFlag (bool) –
Return type:None
SetZBufferAuto()
  • if <AFlag> is Standard_True then the zbuffer activity //! is managed automatically. //! Default Standard_False
Parameters:AFlag (bool) –
Return type:None
Transparency()
  • Returns Standard_True if the transparency //! is activated in all activated views. //! Default Standard_False
Return type:bool
UnHighlight()
  • Suppress the highlighting on all the structures.
Return type:None
  • Suppress the highlighting on the structure <AStructure>.
Parameters:AStructure (Handle_Graphic3d_Structure &) –
Return type:None
UnIdentification()
  • Release a unique ID of the view reserved for the view on its creation.
Parameters:aViewId (Standard_Integer) –
Return type:None
UnderLayer()
  • Returns the underlay of the viewer <self>.
Return type:Handle_Visual3d_Layer
ViewExists()
  • Returns Standard_True if the view associated to the //! window <AWindow> exists and is activated. //! <TheViewId> contains the internal identification of //! the associated view.
Parameters:
  • AWindow (Handle_Aspect_Window &) –
  • TheCView (Graphic3d_CView &) –
Return type:

bool

ZBufferAuto()
  • Returns Standard_True if the zbuffer activity //! is managed automatically. //! Default Standard_False
Return type:bool
thisown

The membership flag

class OCC.Visual3d.Visual3d_ViewMapping(*args)

Bases: object

BackPlaneDistance()
  • Returns the distance from the back clipping plane of this view mapping.
Return type:float
FrontPlaneDistance()
  • Returns the distance from the front clipping plane of this view mapping.
Return type:float
IsCustomMatrix()
  • Returns whether the custom PROJECTION matrix is used.
Return type:bool
Projection()
  • Returns the type of projection.
Return type:Visual3d_TypeOfProjection
ProjectionReferencePoint()
  • Returns the PRP.
Return type:Graphic3d_Vertex
SetBackPlaneDistance()
  • Modifies the back clipping plane. Category: Methods to modify the class definition Warning: Raises ViewMappingDefinitionError //! if <PRP> is between the front and back planes. //! if <PRP> is positioned on the view plane. //! if the back plane is in front of the front plane.
Parameters:BPD (float) –
Return type:None
SetCustomProjectionMatrix()
  • Sets custom PROJECTION matrix for the OpenGl context
Parameters:Mat (Handle_TColStd_HArray2OfReal &) –
Return type:None
SetFrontPlaneDistance()
  • Modifies the front clipping plane. Category: Methods to modify the class definition Warning: Raises ViewMappingDefinitionError //! if <PRP> is between the front and back planes. //! if <PRP> is positioned on the view plane. //! if the back plane is in front of the front plane.
Parameters:FPD (float) –
Return type:None
SetProjection()
  • Modifies the type of projection. //! TypeOfProjection : TOP_PERSPECTIVE //! TOP_PARALLEL
Parameters:AType (Visual3d_TypeOfProjection) –
Return type:None
SetProjectionReferencePoint()
  • Modifies the PRP. Category: Methods to modify the class definition Warning: Raises ViewMappingDefinitionError //! if <PRP> is between the front and back planes. //! if <PRP> is positioned on the view plane.
Parameters:PRP (Graphic3d_Vertex &) –
Return type:None
SetViewPlaneDistance()
  • Modifies the distance of the view plane of projection. Category: Methods to modify the class definition Warning: Raises ViewMappingDefinitionError //! if <PRP> is positioned on the view plane.
Parameters:VPD (float) –
Return type:None
SetWindowLimit()
  • Modifies the visible part of the projection plane. Category: Methods to modify the class definition Warning: Raises ViewMappingDefinitionError if the //! specified window is invalid.
Parameters:
  • Umin (float) –
  • Vmin (float) –
  • Umax (float) –
  • Vmax (float) –
Return type:

None

ViewPlaneDistance()
  • Returns the distance from the projection plane.
Return type:float
WindowLimit()
  • Returns the visible part of the projection plane.
Parameters:
  • Umin (float &) –
  • Vmin (float &) –
  • Umax (float &) –
  • Vmax (float &) –
Return type:

None

thisown

The membership flag

class OCC.Visual3d.Visual3d_ViewOrientation(*args)

Bases: object

AxialScale()
  • Returns current values of the axial scale factors.
Parameters:
  • Sx (float &) –
  • Sy (float &) –
  • Sz (float &) –
Return type:

None

IsCustomMatrix()
  • Returns whether the custom MODELVIEW matrix is used.
Return type:bool
SetAxialScale()
  • Sets axial scale factors of the view
Parameters:
  • Sx (float) –
  • Sy (float) –
  • Sz (float) –
Return type:

None

SetCustomModelViewMatrix()
  • Sets custom MODELVIEW matrix for the OpenGl context
Parameters:Mat (Handle_TColStd_HArray2OfReal &) –
Return type:None
SetViewReferencePlane()
  • Modifies the plane of visualisation //! defined by a normal vector. Category: Methods to modify the class definition Warning: Raises ViewOrientationDefinitionError if <VPN> is null.
Parameters:VPN (Graphic3d_Vector &) –
Return type:None
SetViewReferencePoint()
  • Modifies the origin of the VRC coordinate system
Parameters:VRP (Graphic3d_Vertex &) –
Return type:None
SetViewReferenceUp()
  • Modifies the vertical of the observer. Category: Methods to modify the class definition Warning: Raises ViewOrientationDefinitionError if <VUP> is null.
Parameters:VUP (Graphic3d_Vector &) –
Return type:None
Twist()
  • Returns the angle in radians of the V axis in the VRC //! coordinate system with the projection in the plane of //! visualisation of the Zm axis in the model space.
Return type:float
ViewReferencePlane()
  • Returns the normal to the plane of projection.
Return type:Graphic3d_Vector
ViewReferencePoint()
  • Returns origin of the VRC coordinate system.
Return type:Graphic3d_Vertex
ViewReferenceUp()
  • Returns the vertical of the observer.
Return type:Graphic3d_Vector
thisown

The membership flag