OCC.Graphic3d module¶
-Version:This package permits the creation of 3d graphic objectsin a visualiser.These objects, called structures, are composed of groups ofprimitives and attributes.The group is the smallest editable element of a structure.A structure can be displayed, erased, high-lighted.A transformation can be applied to it.Structures can be connected to form a tree of structures,composed by transformations.The visualiser permits global manipulation of structures.-Keywords: Structure, Group, Primitives, Line, Marker, Text,FillAreas, Vertex, Vector, Material, Font, Shading-Warning:-References:
-
class
Graphic3d_Array1OfVector
(*args)¶ Bases:
object
Parameters: Return type: Return type: -
Assign
()¶ Parameters: Other (Graphic3d_Array1OfVector &) – Return type: Graphic3d_Array1OfVector
-
ChangeValue
()¶ Parameters: Index (int) – Return type: Graphic3d_Vector
-
Set
()¶ Parameters: Other (Graphic3d_Array1OfVector &) – Return type: Graphic3d_Array1OfVector
-
Value
()¶ Parameters: Index (int) – Return type: Graphic3d_Vector
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Array1OfVertex
(*args)¶ Bases:
object
Parameters: Return type: Return type: -
Assign
()¶ Parameters: Other (Graphic3d_Array1OfVertex &) – Return type: Graphic3d_Array1OfVertex
-
ChangeValue
()¶ Parameters: Index (int) – Return type: Graphic3d_Vertex
-
Set
()¶ Parameters: Other (Graphic3d_Array1OfVertex &) – Return type: Graphic3d_Array1OfVertex
-
Value
()¶ Parameters: Index (int) – Return type: Graphic3d_Vertex
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Array2OfVertex
(*args)¶ Bases:
object
Parameters: Return type: Return type: -
Assign
()¶ Parameters: Other (Graphic3d_Array2OfVertex &) – Return type: Graphic3d_Array2OfVertex
-
ChangeValue
()¶ Parameters: Return type:
-
Set
()¶ Parameters: Other (Graphic3d_Array2OfVertex &) – Return type: Graphic3d_Array2OfVertex
-
Value
()¶ Parameters: Return type:
-
thisown
¶ The membership flag
-
-
class
Graphic3d_ArrayOfPoints
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of points, a single pixel point is drawn at each vertex. The array must be filled using the AddVertex(Point) method. When <hasVColors> is True , you must use only AddVertex(Point,Color) method. When <hasVNormals> is True , you must use only AddVertex(Point,Normal) method.
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfPolygons
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of polygons, a polygon can be filled as: 1) creating a single polygon defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfPolygons(7) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x7,y7,z7) 2) creating separate polygons defined with a predefined number of bounds and the number of vertex per bound. i.e: myArray = Graphic3d_ArrayOfPolygons(7,2) myArray->AddBound(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddBound(3) myArray->AddVertex(x5,y5,z5) …. myArray->AddVertex(x7,y7,z7) 3) creating a single indexed polygon defined with his vertex ans edges. i.e: myArray = Graphic3d_ArrayOfPolygons(4,0,6) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(4) 4) creating separate polygons defined with a predefined number of bounds and the number of edges per bound. i.e: myArray = Graphic3d_ArrayOfPolygons(6,4,14) myArray->AddBound(3) myArray->AddVertex(x1,y1,z1) myArray->AddVertex(x2,y2,z2) myArray->AddVertex(x3,y3,z3) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddBound(3) myArray->AddVertex(x4,y4,z4) myArray->AddVertex(x5,y5,z5) myArray->AddVertex(x6,y6,z6) myArray->AddEdge(4) myArray->AddEdge(5) myArray->AddEdge(6) myArray->AddBound(4) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(5) myArray->AddEdge(6) myArray->AddBound(4) myArray->AddEdge(1) myArray->AddEdge(3) myArray->AddEdge(5) myArray->AddEdge(4) <maxVertexs> defined the maximun allowed vertex number in the array. <maxBounds> defined the maximun allowed bound number in the array. <maxEdges> defined the maximun allowed edge number in the array. Warning: When <hasVNormals> is True , you must use one of AddVertex(Point,Normal) or AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) methods. When <hasVColors> is True , you must use one of AddVertex(Point,Color) or AddVertex(Point,Normal,Color) methods. When <hasTexels> is True , you must use one of AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) methods. When <hasBColors> is True , <maxBounds> must be > 0 and you must use the AddBound(number,Color) method. Warning: the user is responsible about the orientation of the polygon depending of the order of the created vertex or edges and this orientation must be coherent with the vertex normal optionnaly given at each vertex (See the Orientate() methods).
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfPolylines
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of polylines, a polyline can be filled as: 1) creating a single polyline defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfPolylines(7) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x7,y7,z7) 2) creating separate polylines defined with a predefined number of bounds and the number of vertex per bound. i.e: myArray = Graphic3d_ArrayOfPolylines(7,2) myArray->AddBound(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddBound(3) myArray->AddVertex(x5,y5,z5) …. myArray->AddVertex(x7,y7,z7) 3) creating a single indexed polyline defined with his vertex ans edges. i.e: myArray = Graphic3d_ArrayOfPolylines(4,0,6) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(4) 4) creating separate polylines defined with a predefined number of bounds and the number of edges per bound. i.e: myArray = Graphic3d_ArrayOfPolylines(6,4,14) myArray->AddBound(3) myArray->AddVertex(x1,y1,z1) myArray->AddVertex(x2,y2,z2) myArray->AddVertex(x3,y3,z3) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddBound(3) myArray->AddVertex(x4,y4,z4) myArray->AddVertex(x5,y5,z5) myArray->AddVertex(x6,y6,z6) myArray->AddEdge(4) myArray->AddEdge(5) myArray->AddEdge(6) myArray->AddBound(4) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(5) myArray->AddEdge(6) myArray->AddBound(4) myArray->AddEdge(1) myArray->AddEdge(3) myArray->AddEdge(5) myArray->AddEdge(4) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxBounds> defined the maximun allowed bound number in the array. <maxEdges> defined the maximun allowed edge number in the array. Warning: When <hasVColors> is True , you must use one of AddVertex(Point,Color) or AddVertex(Point,Normal,Color) methods. When <hasBColors> is True , <maxBounds> must be > 0 and you must use the AddBound(number,Color) method.
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfPrimitives
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
AddBound
()¶ - Adds a bound of length <edgeNumber> in the bound array returns the actual bounds number.
Parameters: edgeNumber (int) – Return type: int - Adds a bound of length <edgeNumber> and bound color <aBColor> in the bound array. returns the actual bounds number. Warning: <aBColor> is ignored when the <hasBColors> constructor parameter is False
Parameters: - edgeNumber (int) –
- aBColor (Quantity_Color &) –
Return type: - Adds a bound of length <edgeNumber> and bound color coordinates in the bound array. returns the actual bounds number. Warning: <R,G,B> are ignored when the <hasBColors> constructor parameter is False
Parameters: Return type:
-
AddEdge
()¶ - Adds an edge in the range [1,VertexNumber()] in the array. Returns the actual edges number.
Parameters: vertexIndex (int) – Return type: int
-
AddVertex
()¶ - Adds a vertice in the array. returns the actual vertex number.
Parameters: - aVertice (gp_Pnt) –
- theVertex (Graphic3d_Vec3 &) –
Return type: Return type: - Adds a vertice in the array. returns the actual vertex number.
Parameters: Return type: - Adds a vertice in the array. returns the actual vertex number.
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Z (Standard_ShortReal) –
Return type: - Adds a vertice and vertex color in the vertex array. returns the actual vertex number. Warning: <aColor> is ignored when the <hasVColors> constructor parameter is False
Parameters: - aVertice (gp_Pnt) –
- aColor (Quantity_Color &) –
Return type: - Adds a vertice and vertex color in the vertex array. returns the actual vertex number. Warning: <aColor> is ignored when the <hasVColors> constructor parameter is False aColor = Alpha << 24 + Blue << 16 + Green << 8 + Red On all architecture proccers type (x86 or SPARC) you can use this byte order.
Parameters: Return type: - Adds a vertice and vertex normal in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False.
Parameters: Return type: - Adds a vertice and vertex normal in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False.
Parameters: Return type: - Adds a vertice and vertex normal in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False.
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Z (Standard_ShortReal) –
- NX (Standard_ShortReal) –
- NY (Standard_ShortReal) –
- NZ (Standard_ShortReal) –
Return type: - Adds a vertice,vertex normal and color in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False. <aColor> is ignored when the <hasVColors> constructor parameter is False
Parameters: Return type: - Adds a vertice,vertex normal and color in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False. <aColor> is ignored when the <hasVColors> constructor parameter is False aColor = Alpha << 24 + Blue << 16 + Green << 8 + Red On all architecture proccers type (x86 or SPARC) you can use this byte order.
Parameters: Return type: - Adds a vertice and vertex texture in the vertex array. returns the actual vertex number. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: Return type: - Adds a vertice and vertex texture coordinates in the vertex array. returns the actual vertex number. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: Return type: - Adds a vertice and vertex texture coordinates in the vertex array. returns the actual vertex number. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Z (Standard_ShortReal) –
- TX (Standard_ShortReal) –
- TY (Standard_ShortReal) –
Return type: - Adds a vertice,vertex normal and texture in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: Return type: - Adds a vertice,vertex normal and texture in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: Return type: - Adds a vertice,vertex normal and texture in the vertex array. returns the actual vertex number. Warning: <aNormal> is ignored when the <hasVNormals> constructor parameter is False. <aTexel> is ignored when the <hasVTexels> constructor parameter is False.
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Z (Standard_ShortReal) –
- NX (Standard_ShortReal) –
- NY (Standard_ShortReal) –
- NZ (Standard_ShortReal) –
- TX (Standard_ShortReal) –
- TY (Standard_ShortReal) –
Return type:
-
Attributes
()¶ - Returns vertex attributes buffer (colors, normals, texture coordinates).
Return type: Handle_Graphic3d_Buffer
-
BoundColor
()¶ - Returns the bound color at rank <aRank> from the bound table if defined.
Parameters: aRank (int) – Return type: Quantity_Color - Returns the bound color values at rank <aRank> from the bound table if defined.
Parameters: - aRank (int) –
- R (float &) –
- G (float &) –
- B (float &) –
Return type:
-
Bounds
()¶ - Returns optional bounds buffer.
Return type: Handle_Graphic3d_BoundBuffer
-
Edge
()¶ - Returns the vertex index at rank <aRank> in the range [1,VertexNumber()]
Parameters: aRank (int) – Return type: int
-
GetHandle
()¶
-
Indices
()¶ - Returns optional index buffer.
Return type: Handle_Graphic3d_IndexBuffer
-
SetBoundColor
()¶ - Change the bound color of rank <anIndex> in the array.
Parameters: - anIndex (int) –
- aColor (Quantity_Color &) –
Return type: - Change the bound color of rank <anIndex> in the array.
Parameters: Return type:
-
SetVertexColor
()¶ - Change the vertex color of rank <anIndex> in the array.
Parameters: - anIndex (int) –
- aColor (Quantity_Color &) –
Return type: - Change the vertex color of rank <anIndex> in the array.
Parameters: Return type: - Change the vertex color of rank <anIndex> in the array. aColor = Alpha << 24 + Blue << 16 + Green << 8 + Red On all architecture proccers type (x86 or SPARC) you can use this byte order.
Parameters: Return type:
-
SetVertexNormal
()¶ - Change the vertex normal of rank <anIndex> in the array.
Parameters: Return type: - Change the vertex normal of rank <anIndex> in the array.
Parameters: Return type:
-
SetVertexTexel
()¶ - Change the vertex texel of rank <anIndex> in the array.
Parameters: Return type: - Change the vertex texel of rank <anIndex> in the array.
Parameters: Return type:
-
SetVertice
()¶ - Change the vertice of rank <anIndex> in the array.
Parameters: Return type: - Change the vertice of rank <anIndex> in the array.
Parameters: - anIndex (int) –
- X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Z (Standard_ShortReal) –
Return type:
-
StringType
()¶ - Returns the string type of this primitive
Return type: char *
-
Type
()¶ - Returns the type of this primitive
Return type: Graphic3d_TypeOfPrimitiveArray
-
VertexColor
()¶ - Returns the vertex color at rank <aRank> from the vertex table if defined.
Parameters: aRank (int) – Return type: Quantity_Color - Returns the vertex color values at rank <aRank> from the vertex table if defined.
Parameters: - aRank (int) –
- R (float &) –
- G (float &) –
- B (float &) –
Return type: - Returns the vertex color values at rank <aRank> from the vertex table if defined.
Parameters: - aRank (int) –
- aColor (int &) –
Return type:
-
VertexNormal
()¶ - Returns the vertex normal at rank <aRank> from the vertex table if defined.
Parameters: aRank (int) – Return type: gp_Dir - Returns the vertex normal coordinates at rank <aRank> from the vertex table if defined.
Parameters: - aRank (int) –
- NX (float &) –
- NY (float &) –
- NZ (float &) –
Return type:
-
VertexTexel
()¶ - Returns the vertex texture at rank <aRank> from the vertex table if defined.
Parameters: aRank (int) – Return type: gp_Pnt2d - Returns the vertex texture coordinates at rank <aRank> from the vertex table if defined.
Parameters: - aRank (int) –
- TX (float &) –
- TY (float &) –
Return type:
-
Vertice
()¶ - Returns the vertice at rank <aRank> from the vertex table if defined.
Parameters: aRank (int) – Return type: gp_Pnt - Returns the vertice coordinates at rank <aRank> from the vertex table if defined.
Parameters: - aRank (int) –
- X (float &) –
- Y (float &) –
- Z (float &) –
Return type:
-
thisown
¶ The membership flag
-
-
class
Graphic3d_ArrayOfQuadrangleStrips
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of quadrangle strips, a polygon can be filled as: 1) creating a single strip defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfQuadrangleStrips(7) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x7,y7,z7) 2) creating separate strips defined with a predefined number of strips and the number of vertex per strip. i.e: myArray = Graphic3d_ArrayOfQuadrangleStrips(8,2) myArray->AddBound(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddBound(4) myArray->AddVertex(x5,y5,z5) …. myArray->AddVertex(x8,y8,z8) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxStrips> defined the maximun allowed strip number in the array. The number of quadrangle really drawn is : VertexNumber()/2-Min(1,BoundNumber())
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfQuadrangles
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of quadrangles, a quadrangle can be filled as: 1) creating a set of quadrangles defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfQuadrangles(8) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x8,y8,z8) 3) creating a set of indexed quadrangles defined with his vertex ans edges. i.e: myArray = Graphic3d_ArrayOfQuadrangles(6,8) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x6,y6,z6) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(4) myArray->AddEdge(3) myArray->AddEdge(4) myArray->AddEdge(5) myArray->AddEdge(6) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxEdges> defined the maximun allowed edge number in the array. Warning: When <hasVNormals> is True , you must use one of AddVertex(Point,Normal) or AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) methods. When <hasVColors> is True , you must use one of AddVertex(Point,Color) or AddVertex(Point,Normal,Color) methods. When <hasTexels> is True , you must use one of AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) methods. Warning: the user is responsible about the orientation of the quadrangle depending of the order of the created vertex or edges and this orientation must be coherent with the vertex normal optionnaly given at each vertex (See the Orientate() methods).
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfSegments
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of segments, a segment can be filled as: 1) creating a set of segments defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfSegments(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) 2) creating a set of indexed segments defined with his vertex ans edges. i.e: myArray = Graphic3d_ArrayOfSegments(4,0,8) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(4) myArray->AddEdge(2) myArray->AddEdge(4) myArray->AddEdge(1) myArray->AddEdge(3) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxEdges> defined the maximun allowed edge number in the array. Warning: When <hasVColors> is True , you must use only AddVertex(Point,Color) method
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfTriangleFans
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of triangle fans, a polygon can be filled as: 1) creating a single fan defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfTriangleFans(7) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x7,y7,z7) 2) creating separate fans defined with a predefined number of fans and the number of vertex per fan. i.e: myArray = Graphic3d_ArrayOfTriangleFans(8,2) myArray->AddBound(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddBound(4) myArray->AddVertex(x5,y5,z5) …. myArray->AddVertex(x8,y8,z8) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxFans> defined the maximun allowed fan number in the array. The number of triangle really drawn is : VertexNumber()-2*Min(1,BoundNumber())
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfTriangleStrips
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of triangle strips, a polygon can be filled as: 1) creating a single strip defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfTriangleStrips(7) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x7,y7,z7) 2) creating separate strips defined with a predefined number of strips and the number of vertex per strip. i.e: myArray = Graphic3d_ArrayOfTriangleStrips(8,2) myArray->AddBound(4) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddBound(4) myArray->AddVertex(x5,y5,z5) …. myArray->AddVertex(x8,y8,z8) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxStrips> defined the maximun allowed strip number in the array. The number of triangle really drawn is : VertexNumber()-2*Min(1,BoundNumber()) Warning: When <hasVNormals> is True , you must use one of AddVertex(Point,Normal) or AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) methods. When <hasVColors> is True , you must use one of AddVertex(Point,Color) or AddVertex(Point,Normal,Color) methods. When <hasTexels> is True , you must use one of AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) methods. When <hasBColors> is True , <maxBounds> must be > 0 and you must use the AddBound(number,Color) method. Warning: the user is responsible about the orientation of the strip depending of the order of the created vertex and this orientation must be coherent with the vertex normal optionnaly given at each vertex (See the Orientate() methods).
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_ArrayOfTriangles
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_ArrayOfPrimitives
- Creates an array of triangles, a triangle can be filled as: 1) creating a set of triangles defined with his vertexs. i.e: myArray = Graphic3d_ArrayOfTriangles(6) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x6,y6,z6) 3) creating a set of indexed triangles defined with his vertex ans edges. i.e: myArray = Graphic3d_ArrayOfTriangles(4,6) myArray->AddVertex(x1,y1,z1) …. myArray->AddVertex(x4,y4,z4) myArray->AddEdge(1) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(2) myArray->AddEdge(3) myArray->AddEdge(4) //! <maxVertexs> defined the maximun allowed vertex number in the array. <maxEdges> defined the maximun allowed edge number in the array. Warning: When <hasVNormals> is True , you must use one of AddVertex(Point,Normal) or AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) methods. When <hasVColors> is True , you must use one of AddVertex(Point,Color) or AddVertex(Point,Normal,Color) methods. When <hasTexels> is True , you must use one of AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) methods. Warning: the user is responsible about the orientation of the triangle depending of the order of the created vertex or edges and this orientation must be coherent with the vertex normal optionnaly given at each vertex (See the Orientate() methods).
Parameters: Return type: -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_AspectFillArea3d
(*args)¶ Bases:
OCC.Aspect.Aspect_AspectFillArea
- Creates a context table for fill area primitives defined with the following default values: //! InteriorStyle : IS_EMPTY InteriorColor : NOC_CYAN1 EdgeColor : NOC_WHITE EdgeLineType : TOL_SOLID EdgeWidth : 1.0 FrontMaterial : NOM_BRASS BackMaterial : NOM_BRASS //! Display of back-facing filled polygons. No distinction between external and internal faces of FillAreas. The edges are not drawn. Polygon offset parameters: mode = Aspect_POM_None, factor = 1., units = 0.
Return type: None - Creates a context table for fill area primitives defined with the specified values. //! Display of back-facing filled polygons. No distinction between external and internal faces of FillAreas. The edges are not drawn. Polygon offset parameters: mode = Aspect_POM_None, factor = 1., units = 0. Warning EdgeWidth is the ‘line width scale factor’. The nominal line width is 1 pixel. The width of the line is determined by applying the line width scale factor to this nominal line width. The supported line widths vary by 1-pixel units.
Parameters: - Interior (Aspect_InteriorStyle) –
- InteriorColor (Quantity_Color &) –
- EdgeColor (Quantity_Color &) –
- EdgeLineType (Aspect_TypeOfLine) –
- EdgeWidth (float) –
- FrontMaterial (Graphic3d_MaterialAspect &) –
- BackMaterial (Graphic3d_MaterialAspect &) –
Return type: -
BackFace
()¶ - Returns the Back Face Removal status. Standard_True if SuppressBackFace is activated.
Return type: bool
-
BackMaterial
()¶ - Returns the surface material of internal faces
Return type: Graphic3d_MaterialAspect
-
Edge
()¶ - Returns Standard_True if the edges are drawn and Standard_False if the edges are not drawn.
Return type: bool
-
FrontMaterial
()¶ - Returns the surface material of external faces
Return type: Graphic3d_MaterialAspect
-
GetHandle
()¶
-
PolygonOffsets
()¶ - Returns current polygon offsets settings.
Parameters: - aMode (int &) –
- aFactor (Standard_ShortReal &) –
- aUnits (Standard_ShortReal &) –
Return type:
-
SetBackMaterial
()¶ - Modifies the surface material of internal faces
Parameters: AMaterial (Graphic3d_MaterialAspect &) – Return type: None
-
SetDistinguishOff
()¶ - Forbids distinction between external and internal faces of FillAreas.
Return type: None
-
SetDistinguishOn
()¶ - Allows distinction between external and internal faces of FillAreas.
Return type: None
-
SetFrontMaterial
()¶ - Modifies the surface material of external faces
Parameters: AMaterial (Graphic3d_MaterialAspect &) – Return type: None
-
SetPolygonOffsets
()¶ - Sets up OpenGL polygon offsets mechanism. <aMode> parameter can contain various combinations of Aspect_PolygonOffsetMode enumeration elements (Aspect_POM_None means that polygon offsets are not changed). If <aMode> is different from Aspect_POM_Off and Aspect_POM_None, then <aFactor> and <aUnits> arguments are used by graphic renderer to calculate a depth offset value: //! offset = <aFactor> * m + <aUnits> * r, where m - maximum depth slope for the polygon currently being displayed, r - minimum window coordinates depth resolution (implementation-specific) //! Deafult settings for OCC 3D viewer: mode = Aspect_POM_Fill, factor = 1., units = 0. //! Negative offset values move polygons closer to the viewport, while positive values shift polygons away. Consult OpenGL reference for details (glPolygonOffset function description).
Parameters: - aMode (int) –
- aFactor (Standard_ShortReal) – default value is 1.0
- aUnits (Standard_ShortReal) – default value is 0.0
Return type:
-
SetShaderProgram
()¶ - Sets up OpenGL/GLSL shader program.
Parameters: theProgram (Handle_Graphic3d_ShaderProgram &) – Return type: None
-
ShaderProgram
()¶ Return type: Handle_Graphic3d_ShaderProgram
-
SuppressBackFace
()¶ - Suppress the display of back-facing filled polygons. A back-facing polygon is defined as a polygon whose vertices are in a clockwise order with respect to screen coordinates.
Return type: None
-
TextureMap
()¶ Return type: Handle_Graphic3d_TextureMap
-
thisown
¶ The membership flag
-
class
Graphic3d_AspectLine3d
(*args)¶ Bases:
OCC.Aspect.Aspect_AspectLine
- Creates a context table for line primitives defined with the following default values: //! Colour : NOC_YELLOW Line type : TOL_SOLID Width : 1.0
Return type: None - Creates a context table for line primitives defined with the specified values. Warning: <AWidth> is the ‘linewidth scale factor’. The nominal line width is 1 pixel. The width of the line is determined by applying the linewidth scale factor to this nominal line width. The supported linewidths vary by 1-pixel units.
Parameters: - AColor (Quantity_Color &) –
- AType (Aspect_TypeOfLine) –
- AWidth (float) –
Return type: -
GetHandle
()¶
-
SetShaderProgram
()¶ - Sets up OpenGL/GLSL shader program.
Parameters: theProgram (Handle_Graphic3d_ShaderProgram &) – Return type: None
-
ShaderProgram
()¶ Return type: Handle_Graphic3d_ShaderProgram
-
thisown
¶ The membership flag
-
class
Graphic3d_AspectMarker3d
(*args)¶ Bases:
OCC.Aspect.Aspect_AspectMarker
- Creates a context table for marker primitives defined with the following default values: //! Marker type : TOM_X Colour : YELLOW Scale factor: 1.0
Return type: Parameters: - theType (Aspect_TypeOfMarker) –
- theColor (Quantity_Color &) –
- theScale (float) –
Return type: - Creates a context table for marker primitives defined with the specified values.
Parameters: Return type: - Creates a context table for marker primitives defined with the specified values.
Parameters: theTextureImage (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
GetMarkerImage
()¶ - Returns marker’s image texture. Could be null handle if marker aspect has been initialized as default type of marker.
Return type: Handle_Graphic3d_MarkerImage
-
GetTextureSize
()¶ - Returns marker’s texture size.
Parameters: - theWidth (int &) –
- theHeight (int &) –
Return type:
-
SetBitMap
()¶ Parameters: Return type:
-
SetMarkerImage
()¶ - Set marker’s image texture.
Parameters: theImage (Handle_Graphic3d_MarkerImage &) – Return type: None
-
SetShaderProgram
()¶ - Sets up OpenGL/GLSL shader program.
Parameters: theProgram (Handle_Graphic3d_ShaderProgram &) – Return type: None
-
ShaderProgram
()¶ Return type: Handle_Graphic3d_ShaderProgram
-
thisown
¶ The membership flag
-
class
Graphic3d_AspectText3d
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
- Creates a context table for text primitives defined with the following default values: //! Colour : NOC_YELLOW Font : NOF_ASCII_MONO Expansion factor : 1. Space between characters : 0. The style : TOST_NORMAL The display type : TODT_NORMAL
Return type: None - Creates a context table for text primitives defined with the specified values. AFont may be to take means from User(example ‘Courier New’) or Font name defined in Font_NameOfFont(example Font_NOF_ASCII_MONO) or use default font(‘Courier’)
Parameters: Return type: -
GetHandle
()¶
-
GetTextFontAspect
()¶ - Returns text FontAspect
Return type: Font_FontAspect
-
SetColorSubTitle
()¶ - Modifies the colour of the subtitle for the TODT_SUBTITLE TextDisplayType and the colour of backgroubd for the TODT_DEKALE TextDisplayType.
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetDisplayType
()¶ - Define the display type of the text. //! TODT_NORMAL Default display. Text only. TODT_SUBTITLE There is a subtitle under the text. TODT_DEKALE The text is displayed with a 3D style. TODT_BLEND The text is displayed in XOR. TODT_DIMENSION Dimension line under text will be invisible.
Parameters: ADisplayType (Aspect_TypeOfDisplayText) – Return type: None
-
SetExpansionFactor
()¶ - Modifies the expansion factor (height/width ratio) If the factor is less than 1, the characters will be higher than they are wide.
Parameters: AFactor (float) – Return type: None
-
SetShaderProgram
()¶ - Sets up OpenGL/GLSL shader program.
Parameters: theProgram (Handle_Graphic3d_ShaderProgram &) – Return type: None
-
SetStyle
()¶ - Modifies the style of the text. TOST_NORMAL Default text. The text is displayed like any other graphic object. This text can be hidden by another object that is nearest from the point of view. TOST_ANNOTATION The text is always visible. The texte is displayed over the other object according to the priority.
Parameters: AStyle (Aspect_TypeOfStyleText) – Return type: None
-
SetTextFontAspect
()¶ - Turns usage of Aspect text
Parameters: AFontAspect (Font_FontAspect) – Return type: None
-
ShaderProgram
()¶ Return type: Handle_Graphic3d_ShaderProgram
-
Values
()¶ - Returns the current values of the group <self>.
Parameters: - AColor (Quantity_Color &) –
- AFont (char * &) –
- AnExpansionFactor (float &) –
- ASpace (float &) –
Return type: - Returns the current values of the group <self>.
Parameters: - AColor (Quantity_Color &) –
- AFont (char * &) –
- AnExpansionFactor (float &) –
- ASpace (float &) –
- AStyle (Aspect_TypeOfStyleText &) –
- ADisplayType (Aspect_TypeOfDisplayText &) –
- AColorSubTitle (Quantity_Color &) –
Return type: - Returns the current values of the group <self>.
Parameters: - AColor (Quantity_Color &) –
- AFont (char * &) –
- AnExpansionFactor (float &) –
- ASpace (float &) –
- AStyle (Aspect_TypeOfStyleText &) –
- ADisplayType (Aspect_TypeOfDisplayText &) –
- AColorSubTitle (Quantity_Color &) –
- ATextZoomable (bool) –
- ATextAngle (float &) –
Return type: - Returns the current values of the group <self>.
Parameters: - AColor (Quantity_Color &) –
- AFont (char * &) –
- AnExpansionFactor (float &) –
- ASpace (float &) –
- AStyle (Aspect_TypeOfStyleText &) –
- ADisplayType (Aspect_TypeOfDisplayText &) –
- AColorSubTitle (Quantity_Color &) –
- ATextZoomable (bool) –
- ATextAngle (float &) –
- ATextFontAspect (Font_FontAspect &) –
Return type:
-
thisown
¶ The membership flag
-
class
Graphic3d_Attribute
(*args, **kwargs)¶ Bases:
object
-
DataType
¶
-
Id
¶
-
static
Stride
()¶ - //!< vec2,vec3,vec4,vec4ub
Return type: int - returns size of attribute of specified data type
Parameters: theType (Graphic3d_TypeOfData) – Return type: int
-
thisown
¶ The membership flag
-
-
Graphic3d_Attribute_Stride
()¶ - //!< vec2,vec3,vec4,vec4ub
Return type: int - returns size of attribute of specified data type
Parameters: theType (Graphic3d_TypeOfData) – Return type: int
-
class
Graphic3d_AxisAspect
(*args)¶ Bases:
object
Parameters: - theName (TCollection_ExtendedString) – default value is
- theNameColor (Quantity_Color) – default value is Quantity_NOC_BLACK
- theColor (Quantity_Color) – default value is Quantity_NOC_BLACK
- theValuesOffset (int) – default value is 10
- theNameOffset (int) – default value is 30
- theTickmarksNumber (int) – default value is 5
- theTickmarksLength (int) – default value is 10
- theToDrawName (bool) – default value is Standard_True
- theToDrawValues (bool) – default value is Standard_True
- theToDrawTickmarks (bool) – default value is Standard_True
Return type: -
Color
()¶ - Color of axis and values
Return type: Quantity_Color
-
Name
()¶ Return type: TCollection_ExtendedString
-
NameColor
()¶ Return type: Quantity_Color
-
thisown
¶ The membership flag
-
class
Graphic3d_BoundBuffer
(*args)¶ Bases:
object
- Empty constructor.
Parameters: theAlloc (Handle_NCollection_BaseAllocator &) – Return type: None -
Bounds
¶
-
Colors
¶
-
GetHandle
()¶
-
Init
()¶ - Allocates new empty array
Parameters: Return type:
-
NbBounds
¶
-
thisown
¶ The membership flag
-
class
Graphic3d_CAspectFillArea
(*args)¶ Bases:
object
Return type: None -
Back
¶
-
BackFace
¶
-
BackIntColor
¶
-
Distinguish
¶
-
Edge
¶
-
EdgeColor
¶
-
Front
¶
-
Hatch
¶
-
IntColor
¶
-
IsDef
¶
-
IsSet
¶
-
LineType
¶
-
PolygonOffsetFactor
¶
-
PolygonOffsetMode
¶
-
PolygonOffsetUnits
¶
-
ShaderProgram
¶
-
Style
¶
-
Texture
¶
-
Width
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CAspectLine
(*args, **kwargs)¶ Bases:
object
-
Color
¶
-
IsDef
¶
-
IsSet
¶
-
LineType
¶
-
ShaderProgram
¶
-
Width
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CAspectMarker
(*args)¶ Bases:
object
Return type: None -
Color
¶
-
IsDef
¶
-
IsSet
¶
-
MarkerImage
¶
-
MarkerType
¶
-
Scale
¶
-
ShaderProgram
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CAspectText
(*args, **kwargs)¶ Bases:
object
-
Color
¶
-
ColorSubTitle
¶
-
DisplayType
¶
-
Expan
¶
-
IsDef
¶
-
IsSet
¶
-
ShaderProgram
¶
-
Space
¶
-
Style
¶
-
TextAngle
¶
-
TextFontAspect
¶
-
TextZoomable
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CBitFields16
(*args, **kwargs)¶ Bases:
object
-
bool1
¶
-
bool10
¶
-
bool11
¶
-
bool12
¶
-
bool13
¶
-
bool14
¶
-
bool15
¶
-
bool16
¶
-
bool2
¶
-
bool3
¶
-
bool4
¶
-
bool5
¶
-
bool6
¶
-
bool7
¶
-
bool8
¶
-
bool9
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CBitFields20
(*args, **kwargs)¶ Bases:
object
-
bool1
¶
-
bool10
¶
-
bool11
¶
-
bool12
¶
-
bool13
¶
-
bool14
¶
-
bool15
¶
-
bool16
¶
-
bool17
¶
-
bool18
¶
-
bool19
¶
-
bool2
¶
-
bool20
¶
-
bool3
¶
-
bool4
¶
-
bool5
¶
-
bool6
¶
-
bool7
¶
-
bool8
¶
-
bool9
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CBitFields4
(*args, **kwargs)¶ Bases:
object
-
bool1
¶
-
bool2
¶
-
bool3
¶
-
bool4
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CBitFields8
(*args, **kwargs)¶ Bases:
object
-
bool1
¶
-
bool2
¶
-
bool3
¶
-
bool4
¶
-
bool5
¶
-
bool6
¶
-
bool7
¶
-
bool8
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CLight
(*args)¶ Bases:
object
- Empty constructor
Return type: None -
Angle
()¶ - Angle in radians of the cone created by the spot
Return type: Standard_ShortReal
-
Attenuation
()¶ - Const, Linear attenuation factors of positional light source
Return type: Graphic3d_Vec2
-
ChangeAngle
()¶ Return type: Standard_ShortReal
-
ChangeAttenuation
()¶ Return type: Graphic3d_Vec2
-
ChangeConcentration
()¶ Return type: Standard_ShortReal
-
ChangeConstAttenuation
()¶ Return type: Standard_ShortReal
-
ChangeLinearAttenuation
()¶ Return type: Standard_ShortReal
-
Color
¶
-
Concentration
()¶ - Intensity distribution of the spot light, with 0..1 range.
Return type: Standard_ShortReal
-
ConstAttenuation
()¶ - //!< flag to mark head light Const attenuation factor of positional light source
Return type: Standard_ShortReal
-
Direction
¶
-
IsHeadlight
¶
-
LinearAttenuation
()¶ - Linear attenuation factor of positional light source
Return type: Standard_ShortReal
-
Params
¶
-
Position
¶
-
Type
¶
-
thisown
¶ The membership flag
-
class
Graphic3d_CStructure
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
BoundingBox
()¶ - returns bounding box of this presentation
Return type: Graphic3d_BndBox4f
-
ChangeBoundingBox
()¶ - returns bounding box of this presentation without transformation matrix applied
Return type: Graphic3d_BndBox4f
-
ClipPlanes
()¶ - returns associated clip planes
Return type: Graphic3d_SequenceOfHClipPlane
-
Composition
¶
-
Connect
()¶ - Connect other structure to this one
Parameters: theStructure (Graphic3d_CStructure &) – Return type: None
-
ContainsFacet
¶
-
ContextFillArea
¶
-
ContextLine
¶
-
ContextMarker
¶
-
ContextText
¶
-
Disconnect
()¶ - Disconnect other structure to this one
Parameters: theStructure (Graphic3d_CStructure &) – Return type: None
-
GetHandle
()¶
-
GraphicDriver
()¶ - returns graphic driver created this structure
Return type: Handle_Graphic3d_GraphicDriver
-
Groups
()¶ - returns graphic groups
Return type: Graphic3d_SequenceOfGroup
-
HLRValidation
¶
-
HighlightColor
¶
-
HighlightWithBndBox
()¶ - Highlight structure using boundary box
Parameters: - theStruct (Handle_Graphic3d_Structure &) –
- theToCreate (bool) –
Return type:
-
HighlightWithColor
()¶ - Highlight entire structure with color
Parameters: - theColor (Graphic3d_Vec3 &) –
- theToCreate (bool) –
Return type:
-
Id
¶
-
Is2dText
¶
-
IsForHighlight
¶
-
IsInfinite
¶
-
IsMutable
¶
-
NewGroup
()¶ - Create new group within this structure
Parameters: theStruct (Handle_Graphic3d_Structure &) – Return type: Handle_Graphic3d_Group
-
PreviousPriority
¶
-
Priority
¶
-
RemoveGroup
()¶ - Remove group from this structure
Parameters: theGroup (Handle_Graphic3d_Group &) – Return type: None
-
SetClipPlanes
()¶ - Pass clip planes to the associated graphic driver structure
Parameters: thePlanes (Graphic3d_SequenceOfHClipPlane &) – Return type: None
-
SetZLayer
()¶ - Set z layer ID to display the structure in specified layer
Parameters: theLayerIndex (Graphic3d_ZLayerId) – Return type: None
-
ShadowLink
()¶ - Create shadow link to this structure
Parameters: theManager (Handle_Graphic3d_StructureManager &) – Return type: Handle_Graphic3d_CStructure
-
TransformPersistence
¶
-
Transformation
¶
-
ViewAffinity
¶
-
ZLayer
()¶ - Get z layer ID
Return type: Graphic3d_ZLayerId
-
highlight
¶
-
myZLayer
¶
-
stick
¶
-
thisown
¶ The membership flag
-
visible
¶
-
-
class
Graphic3d_CTexture
(*args)¶ Bases:
object
Return type: None -
TextureMap
¶
-
doTextureMap
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_CView
(*args)¶ Bases:
object
Return type: None -
Active
¶
-
Backfacing
¶
-
Context
¶
-
DefWindow
¶
-
GClientData
¶
-
GContext
¶
-
IsCullingEnabled
¶
-
IsDeleted
¶
-
IsOpen
¶
-
RenderParams
¶
-
ViewId
¶
-
WasRedrawnGL
¶
-
WsId
¶
-
ptrFBO
¶
-
ptrOverLayer
¶
-
ptrUnderLayer
¶
-
ptrView
¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Camera
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Default constructor. Initializes camera with the following properties: Eye (0, 0, -2); Center (0, 0, 0); Up (0, 1, 0); Type (Orthographic); FOVy (45); Scale (1000); IsStereo(false); ZNear (0.001); ZFar (3000.0); Aspect(1); ZFocus(1.0); ZFocusType(Relative); IOD(0.05); IODType(Relative)
Return type: None - Copy constructor. @param theOther [in] the camera to copy from.
Parameters: theOther (Handle_Graphic3d_Camera &) – Return type: None -
ConvertProj2View
()¶ - Convert point from projection coordinate space to view coordinate space. @param thePnt [in] the point in NDC. returns point in VCS.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
ConvertView2Proj
()¶ - Convert point from view coordinate space to projection coordinate space. @param thePnt [in] the point in VCS. returns point in NDC.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
ConvertView2World
()¶ - Convert point from view coordinate space to world coordinates. @param thePnt [in] the 3D point in VCS. returns point in WCS.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
ConvertWorld2View
()¶ - Convert point from world coordinate space to view coordinate space. @param thePnt [in] the 3D point in WCS. returns point in VCS.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
Copy
()¶ - Copy properties of another camera. @param theOther [in] the camera to copy from.
Parameters: theOther (Handle_Graphic3d_Camera &) – Return type: None
-
CopyMappingData
()¶ - Initialize mapping related parameters from other camera handle.
Parameters: theOtherCamera (Handle_Graphic3d_Camera &) – Return type: None
-
CopyOrientationData
()¶ - Initialize orientation related parameters from other camera handle.
Parameters: theOtherCamera (Handle_Graphic3d_Camera &) – Return type: None
-
FocusType_Absolute
= 0¶
-
FocusType_Relative
= 1¶
-
Frustum
()¶ - Calculate WCS frustum planes for the camera projection volume. Frustum is a convex volume determined by six planes directing inwards. The frustum planes are usually used as inputs for camera algorithms. Thus, if any changes to projection matrix calculation are necessary, the frustum planes calculation should be also touched. @param theLeft [out] the frustum plane for left side of view. @param theRight [out] the frustum plane for right side of view. @param theBottom [out] the frustum plane for bottom side of view. @param theTop [out] the frustum plane for top side of view. @param theNear [out] the frustum plane for near side of view. @param theFar [out] the frustum plane for far side of view.
Parameters: Return type:
-
GetHandle
()¶
-
GetIODType
()¶ - Get Intraocular distance definition type. returns definition type used for Intraocular distance.
Return type: IODType
-
IOD
()¶ - Get Intraocular distance value. returns absolute or relative IOD value depending on its definition type.
Return type: float
-
IODType_Absolute
= 0¶
-
IODType_Relative
= 1¶
-
InvalidateOrientation
()¶ - Invalidate orientation matrix. The matrix will be updated on request.
Return type: None
-
InvalidateProjection
()¶ - Invalidate state of projection matrix. The matrix will be updated on request.
Return type: None
-
IsOrthographic
()¶ - Check that the camera projection is orthographic. returns boolean flag that indicates whether the camera’s projection is orthographic or not.
Return type: bool
-
IsStereo
()¶ - Check whether the camera projection is stereo. Please note that stereo rendering is now implemented with support of Quad buffering. returns boolean flag indicating whether the stereographic L/R projection is chosen.
Return type: bool
-
ModelViewState
()¶ - Returns modification state of camera model-view matrix
Return type: Standard_Size
-
OrientationMatrix
()¶ - @name Lazily-computed orientation and projection matrices derived from camera parameters Get orientation matrix. returns camera orientation matrix.
Return type: Graphic3d_Mat4d
-
OrientationMatrixF
()¶ - Get orientation matrix of Standard_ShortReal precision. returns camera orientation matrix.
Return type: Graphic3d_Mat4
-
Project
()¶ - @name Projection methods Project point from world coordinate space to normalized device coordinates (mapping). @param thePnt [in] the 3D point in WCS. returns mapped point in NDC.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
ProjectionMatrix
()¶ - Get monographic or middle point projection matrix used for monographic rendering and for point projection / unprojection. returns monographic projection matrix.
Return type: Graphic3d_Mat4d
-
ProjectionMatrixF
()¶ - Get monographic or middle point projection matrix of Standard_ShortReal precision used for monographic rendering and for point projection / unprojection. returns monographic projection matrix.
Return type: Graphic3d_Mat4
-
ProjectionState
()¶ - @name Camera modification state Returns modification state of camera projection matrix
Return type: Standard_Size
-
ProjectionStereoLeft
()¶ - returns stereographic matrix computed for left eye. Please note that this method is used for rendering for <i>Projection_Stereo</i>.
Return type: Graphic3d_Mat4d
-
ProjectionStereoLeftF
()¶ - returns stereographic matrix of Standard_ShortReal precision computed for left eye. Please note that this method is used for rendering for <i>Projection_Stereo</i>.
Return type: Graphic3d_Mat4
-
ProjectionStereoRight
()¶ - returns stereographic matrix computed for right eye. Please note that this method is used for rendering for <i>Projection_Stereo</i>.
Return type: Graphic3d_Mat4d
-
ProjectionStereoRightF
()¶ - returns stereographic matrix of Standard_ShortReal precision computed for right eye. Please note that this method is used for rendering for <i>Projection_Stereo</i>.
Return type: Graphic3d_Mat4
-
ProjectionType
()¶ - returns camera projection type.
Return type: Projection
-
Projection_MonoLeftEye
= 3¶
-
Projection_MonoRightEye
= 4¶
-
Projection_Orthographic
= 0¶
-
Projection_Perspective
= 1¶
-
Projection_Stereo
= 2¶
-
SetAspect
()¶ - Changes width / height display ratio. @param theAspect [in] the display ratio.
Parameters: theAspect (float) – Return type: None
-
SetAxialScale
()¶ - Set camera axial scale. @param theAxialScale [in] the axial scale vector.
Parameters: theAxialScale (gp_XYZ) – Return type: None
-
SetCenter
()¶ - Sets Center of the camera. @param theCenter [in] the point where the camera looks at.
Parameters: theCenter (gp_Pnt) – Return type: None
-
SetDirection
()¶ - Sets camera look direction. @param theDir [in] the direction.
Parameters: theDir (gp_Dir) – Return type: None
-
SetDistance
()¶ - Set distance of Eye from camera Center. @param theDistance [in] the distance.
Parameters: theDistance (float) – Return type: None
-
SetEye
()¶ - @name Public camera properties Sets camera Eye position. @param theEye [in] the location of camera’s Eye.
Parameters: theEye (gp_Pnt) – Return type: None
-
SetFOVy
()¶ - Set Field Of View (FOV) in y axis for perspective projection. @param theFOVy [in] the FOV in degrees.
Parameters: theFOVy (float) – Return type: None
-
SetIOD
()¶ - Sets Intraocular distance. @param theType [in] the IOD definition type. IOD can be defined as absolute value or relatively to (as coefficient of) camera focal length. @param theIOD [in] the Intraocular distance.
Parameters: - theType (IODType) –
- theIOD (float) –
Return type:
-
SetProjectionType
()¶ - Change camera projection type. When switching to perspective projection from orthographic one, the ZNear and ZFar are reset to default values (0.001, 3000.0) if less than 0.0. @param theProjectionType [in] the camera projection type.
Parameters: theProjection (Projection) – Return type: None
-
SetScale
()¶ - Sets camera scale. For orthographic projection the scale factor corresponds to parallel scale of view mapping (i.e. size of viewport). For perspective camera scale is converted to distance. The scale specifies equal size of the view projection in both dimensions assuming that the aspect is 1.0. The projection height and width are specified with the scale and correspondingly multiplied by the aspect. @param theScale [in] the scale factor.
Parameters: theScale (float) – Return type: None
-
SetUp
()¶ - Sets camera Up direction vector, orthogonal to camera direction. @param theUp [in] the Up direction vector.
Parameters: theUp (gp_Dir) – Return type: None
-
SetZFocus
()¶ - Sets stereographic focus distance. @param theType [in] the focus definition type. Focus can be defined as absolute value or relatively to (as coefficient of) coefficient of camera focal length. @param theZFocus [in] the focus absolute value or coefficient depending on the passed definition type.
Parameters: - theType (FocusType) –
- theZFocus (float) –
Return type:
-
SetZRange
()¶ - Change the Near and Far Z-clipping plane positions. For orthographic projection, theZNear, theZFar can be negative or positive. For perspective projection, only positive values are allowed. Program error exception is raised if non-positive values are specified for perspective projection or theZNear >= theZFar. @param theZNear [in] the distance of the plane from the Eye. @param theZFar [in] the distance of the plane from the Eye.
Parameters: Return type:
-
Transform
()¶ - @name Basic camera operations Transform orientation components of the camera: Eye, Up and Center points. @param theTrsf [in] the transformation to apply.
Parameters: theTrsf (gp_Trsf) – Return type: None
-
UnProject
()¶ - Unproject point from normalized device coordinates to world coordinate space. @param thePnt [in] the NDC point. returns 3D point in WCS.
Parameters: thePnt (gp_Pnt) – Return type: gp_Pnt
-
ViewDimensions
()¶ - Calculate view plane size at center (target) point and distance between ZFar and ZNear planes. returns values in form of gp_Pnt (Width, Height, Depth).
Return type: gp_XYZ
-
ZFar
()¶ - Get the Far Z-clipping plane position. returns the distance of the plane from the Eye.
Return type: float
-
ZFitAll
()¶ - Change Z-min and Z-max planes of projection volume to match the displayed objects. The methods ensures that view volume will be close by depth range to the displayed objects. Fitting assumes that for orthogonal projection the view volume contains the displayed objects completely. For zoomed perspective view, the view volume is adjusted such that it contains the objects or their parts, located in front of the camera. @param theScaleFactor [in] the scale factor for Z-range. The range between Z-min, Z-max projection volume planes evaluated by z fitting method will be scaled using this coefficient. Program error exception is thrown if negative or zero value is passed. @param theMinMax [in] applicative min max boundaries. @param theScaleFactor [in] real graphical boundaries (not accounting infinite flag).
Parameters: - theScaleFactor (float) –
- theMinMax (Bnd_Box &) –
- theGraphicBB (Bnd_Box &) –
Return type:
-
ZFocus
()¶ - Get stereographic focus value. returns absolute or relative stereographic focus value depending on its definition type.
Return type: float
-
ZFocusType
()¶ - Get stereographic focus definition type. returns definition type used for stereographic focus.
Return type: FocusType
-
ZNear
()¶ - Get the Near Z-clipping plane position. returns the distance of the plane from the Eye.
Return type: float
-
thisown
¶ The membership flag
-
class
Graphic3d_ClipPlane
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Default constructor. Initializes clip plane container with the following properties: - Equation (0.0, 0.0, 1.0, 0) - IsOn (True), - IsCapping (False), - Material (Graphic3d_NOM_DEFAULT), - Texture (NULL), - HatchStyle (Aspect_HS_HORIZONTAL), - IsHatchOn (False)
Return type: None - Copy constructor. @param theOther [in] the copied plane.
Parameters: theOther (Graphic3d_ClipPlane &) – Return type: None - Construct clip plane for the passed equation. By default the plane is on, capping is turned off. @param theEquation [in] the plane equation.
Parameters: theEquation (Equation &) – Return type: None - Construct clip plane from the passed geometrical definition. By default the plane is on, capping is turned off. @param thePlane [in] the plane.
Parameters: thePlane (gp_Pln) – Return type: None -
CappingAspect
()¶ - Compute and return capping aspect from the graphical attributes. returns capping surface rendering aspect.
Return type: Handle_Graphic3d_AspectFillArea3d
-
CappingHatch
()¶ - returns hatching style.
Return type: Aspect_HatchStyle
-
CappingMaterial
()¶ - returns capping material.
Return type: Graphic3d_MaterialAspect
-
CappingTexture
()¶ - returns capping texture map.
Return type: Handle_Graphic3d_TextureMap
-
Clone
()¶ - Clone plane. Virtual method to simplify copying procedure if plane class is redefined at application level to add specific fields to it e.g. id, name, etc. returns new instance of clipping plane with same properties and attributes.
Return type: Handle_Graphic3d_ClipPlane
-
GetEquation
()¶ - Get 4-component equation vector for clipping plane. returns clipping plane equation vector.
Return type: Equation
-
GetHandle
()¶
-
GetId
()¶ - This ID is used for managing associated resources in graphical driver. The clip plane can be assigned within a range of IO which can be displayed in separate OpenGl contexts. For each of the context an associated OpenGl resource for graphical aspects should be created and kept. The resources are stored in graphical driver for each of individual groups of shared context under the clip plane identifier. returns clip plane resource identifier string.
Return type: TCollection_AsciiString
-
IsCapping
()¶ - Check state of capping surface rendering. returns true (turned on) or false depending on the state.
Return type: bool
-
IsOn
()¶ - Check that the clipping plane is turned on. returns boolean flag indicating whether the plane is in on or off state.
Return type: bool
-
MCountAspect
()¶ - returns modification counter for aspect.
Return type: unsigned int
-
MCountEquation
()¶ - returns modification counter for equation.
Return type: unsigned int
-
SetCapping
()¶ - Change state of capping surface rendering. @param theIsOn [in] the flag specifying whether the graphic driver should perform rendering of capping surface produced by this plane. The graphic driver produces this surface for convex graphics by means of stencil-test and multi-pass rendering.
Parameters: theIsOn (bool) – Return type: None
-
SetCappingHatch
()¶ - Set hatch style (stipple) and turn hatching on. @param theStyle [in] the hatch style.
Parameters: theStyle (Aspect_HatchStyle) – Return type: None
-
SetCappingMaterial
()¶ - Set material for rendering capping surface. @param theMat [in] the material.
Parameters: theMat (Graphic3d_MaterialAspect &) – Return type: None
-
SetCappingTexture
()¶ - Set texture to be applied on capping surface. @param theTexture [in] the texture.
Parameters: theTexture (Handle_Graphic3d_TextureMap &) – Return type: None
-
SetEquation
()¶ - Set plane equation by its geometrical definition. The equation is specified in ‘world’ coordinate system. @param thePlane [in] the plane.
Parameters: thePlane (gp_Pln) – Return type: None - Set 4-component equation vector for clipping plane. The equation is specified in ‘world’ coordinate system. @param theEquation [in] the XYZW (or ‘ABCD’) equation vector.
Parameters: theEquation (Equation &) – Return type: None
-
SetOn
()¶ - Change state of the clipping plane. @param theIsOn [in] the flag specifying whether the graphic driver clipping by this plane should be turned on or off.
Parameters: theIsOn (bool) – Return type: None
-
ToPlane
()¶ - Get geometrical definition. The plane is built up from the equation clipping plane equation vector. returns geometrical definition of clipping plane.
Return type: gp_Pln
-
thisown
¶ The membership flag
-
class
Graphic3d_DataStructureManager
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
Destroy
()¶ - Deletes the manager <self>.
Return type: void
-
GetHandle
()¶
-
thisown
¶ The membership flag
-
-
class
Graphic3d_GraduatedTrihedron
(*args)¶ Bases:
object
- Default constructor Constructs the default graduated trihedron with grid, X, Y, Z axes, and tickmarks
Parameters: - theNamesFont (TCollection_AsciiString &) – default value is ‘Arial’
- theNamesStyle (Font_FontAspect &) – default value is Font_FA_Bold
- theNamesSize (int) – default value is 12
- theValuesFont (TCollection_AsciiString &) – default value is ‘Arial’
- theValuesStyle (Font_FontAspect &) – default value is Font_FA_Regular
- theValuesSize (int) – default value is 12
- theArrowsLength (Standard_ShortReal) – default value is 30.0f
- theGridColor (Quantity_Color) – default value is Quantity_NOC_WHITE
- theToDrawGrid (bool) – default value is Standard_True
- theToDrawAxes (bool) – default value is Standard_True
Return type: -
ArrowsLength
()¶ Return type: Standard_ShortReal
-
AxisAspect
()¶ Parameters: theIndex (int) – Return type: Graphic3d_AxisAspect
-
ChangeAxisAspect
()¶ Parameters: theIndex (int) – Return type: Graphic3d_AxisAspect
-
ChangeXAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
ChangeYAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
ChangeZAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
GridColor
()¶ Return type: Quantity_Color
-
NamesFont
()¶ Return type: TCollection_AsciiString
-
NamesFontAspect
()¶ Return type: Font_FontAspect
-
PtrVisual3dView
¶
-
ValuesFont
()¶ Return type: TCollection_AsciiString
-
ValuesFontAspect
()¶ Return type: Font_FontAspect
-
XAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
YAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
ZAxisAspect
()¶ Return type: Graphic3d_AxisAspect
-
thisown
¶ The membership flag
-
class
Graphic3d_GraphicDriver
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
ActivateView
()¶ - call_togl_activateview
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
AddZLayer
()¶ - Add a new top-level z layer with ID <theLayerId> for the view. Z layers allow drawing structures in higher layers in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to set the layer ID for the structure.
Parameters: - theCView (Graphic3d_CView &) –
- theLayerId (Graphic3d_ZLayerId) –
Return type: void
-
AntiAliasing
()¶ - call_togl_antialiasing
Parameters: - ACView (Graphic3d_CView &) –
- AFlag (bool) –
Return type: void
-
Background
()¶ - call_togl_background
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
BackgroundImage
()¶ Parameters: - FileName (char *) –
- ACView (Graphic3d_CView &) –
- FillStyle (Aspect_FillMethod) –
Return type: void
-
BeginLayer
()¶ - call_togl_begin_layer2d
Parameters: ACLayer (Aspect_CLayer2d &) – Return type: void
-
BeginPolygon2d
()¶ - call_togl_begin_polygon2d
Return type: void
-
BeginPolyline2d
()¶ - call_togl_begin_polyline2d
Return type: void
-
BufferDump
()¶ - Dump active rendering buffer into specified memory buffer.
Parameters: - theCView (Graphic3d_CView &) –
- theImage (Image_PixMap &) –
- theBufferType (Graphic3d_BufferType &) –
Return type:
-
ChangePriority
()¶ - Changes the priority of a structure within its Z layer in the specified view.
Parameters: - theCStructure (Graphic3d_CStructure &) –
- theCView (Graphic3d_CView &) –
- theNewPriority (int) –
Return type: void
-
ChangeZLayer
()¶ - Change Z layer of a structure already presented in view.
Parameters: - theCStructure (Graphic3d_CStructure &) –
- theCView (Graphic3d_CView &) –
- theNewLayerId (Graphic3d_ZLayerId) –
Return type: void
-
ClearLayer
()¶ - call_togl_clear_layer2d
Parameters: ACLayer (Aspect_CLayer2d &) – Return type: void
-
ClipLimit
()¶ - call_togl_cliplimit
Parameters: - ACView (Graphic3d_CView &) –
- AWait (bool) –
Return type: void
-
DeactivateView
()¶ - call_togl_deactivateview
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
DefaultTextHeight
()¶ Return type: Standard_ShortReal
-
DepthCueing
()¶ - call_togl_cliplimit
Parameters: - ACView (Graphic3d_CView &) –
- AFlag (bool) –
Return type: void
-
DisplayImmediateStructure
()¶ - Display structure in immediate mode on top of general presentation
Parameters: - theCView (Graphic3d_CView &) –
- theStructure (Handle_Graphic3d_Structure &) –
Return type: void
-
DisplayStructure
()¶ - call_togl_displaystructure
Parameters: - theCView (Graphic3d_CView &) –
- theStructure (Handle_Graphic3d_Structure &) –
- thePriority (int) –
Return type: void
-
Draw
()¶ - call_togl_draw2d
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
Return type: void
-
Edge
()¶ - call_togl_edge2d
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
Return type: void
-
EnableVBO
()¶ - enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays
Parameters: status (bool) – Return type: void
-
EndLayer
()¶ - call_togl_end_layer2d
Return type: void
-
EndPolygon2d
()¶ - call_togl_end_polygon2d
Return type: void
-
EndPolyline2d
()¶ - call_togl_end_polyline2d
Return type: void
-
Environment
()¶ Parameters: ACView (Graphic3d_CView &) – Return type: void
-
EraseImmediateStructure
()¶ - Erases immediate structure
Parameters: - theCView (Graphic3d_CView &) –
- theCStructure (Graphic3d_CStructure &) –
Return type: void
-
EraseStructure
()¶ - call_togl_erasestructure
Parameters: - theCView (Graphic3d_CView &) –
- theStructure (Handle_Graphic3d_Structure &) –
Return type: void
-
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) –
- theWidth (int) –
- theHeight (int) –
- theView (Graphic3d_CView &) –
- theLayerUnder (Aspect_CLayer2d &) –
- theLayerOver (Aspect_CLayer2d &) –
- thePrecision (float) – default value is 0.005
- theProgressBarFunc (Standard_Address) – default value is NULL
- theProgressObject (Standard_Address) – default value is NULL
Return type:
-
FBOChangeViewport
()¶ - Change offscreen FBO viewport.
Parameters: Return type: void
-
FBOCreate
()¶ - Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL.
Parameters: Return type: Graphic3d_PtrFrameBuffer
-
FBOGetDimensions
()¶ - Read offscreen FBO configuration.
Parameters: - view (Graphic3d_CView &) –
- fboPtr (Graphic3d_PtrFrameBuffer) –
- width (int &) –
- height (int &) –
- widthMax (int &) –
- heightMax (int &) –
Return type: void
-
FBORelease
()¶ - Remove offscreen FBO from the graphic library
Parameters: - view (Graphic3d_CView &) –
- fboPtr (Graphic3d_PtrFrameBuffer &) –
Return type: void
-
GetDisplayConnection
()¶ - returns Handle to display connection
Return type: Handle_Aspect_DisplayConnection
-
GetHandle
()¶
-
GradientBackground
()¶ - call_togl_gradient_background
Parameters: - ACView (Graphic3d_CView &) –
- AColor1 (Quantity_Color &) –
- AColor2 (Quantity_Color &) –
- FillStyle (Aspect_GradientFillMethod) –
Return type: void
-
GraduatedTrihedronDisplay
()¶ - call_togl_graduatedtrihedron_display
Parameters: - theView (Graphic3d_CView &) –
- theCubic (Graphic3d_GraduatedTrihedron &) –
Return type: void
-
GraduatedTrihedronErase
()¶ - call_togl_graduatedtrihedron_erase
Parameters: theView (Graphic3d_CView &) – Return type: void
-
GraduatedTrihedronMinMaxValues
()¶ - Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. @param theView [in] current graphic view @param theMin [in] the minimum point of scene. @param theMax [in] the maximum point of scene.
Parameters: - theView (Graphic3d_CView &) –
- theMin (Graphic3d_Vec3) –
- theMax (Graphic3d_Vec3) –
Return type: void
-
Invalidate
()¶ - Invalidates content of the view but does not redraw it
Parameters: theCView (Graphic3d_CView &) – Return type: void
-
InvalidateBVHData
()¶ - Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
Parameters: - theCView (Graphic3d_CView &) –
- theLayerId (int) –
Return type: void
-
Layer
()¶ - call_togl_layer2d
Parameters: ACLayer (Aspect_CLayer2d &) – Return type: void
-
MemoryInfo
()¶ - Returns information about GPU memory usage.
Parameters: - theFreeBytes (Standard_Size &) –
- theInfo (TCollection_AsciiString &) –
Return type:
-
Move
()¶ - call_togl_move2d
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
Return type: void
-
RatioWindow
()¶ - call_togl_ratio_window
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
ReadDepths
()¶ - Reads depths of shown pixels of the given rectangle (glReadPixels with GL_DEPTH_COMPONENT)
Parameters: Return type: void
-
Rectangle
()¶ - call_togl_rectangle2d
Parameters: - X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- Width (Standard_ShortReal) –
- Height (Standard_ShortReal) –
Return type: void
-
Redraw
()¶ - Redraw content of the view
Parameters: Return type: void
-
RedrawImmediate
()¶ - Redraw layer of immediate presentations
Parameters: - theCView (Graphic3d_CView &) –
- theCUnderLayer (Aspect_CLayer2d &) –
- theCOverLayer (Aspect_CLayer2d &) –
Return type: void
-
RemoveLayer
()¶ - call_togl_removelayer2d
Parameters: ACLayer (Aspect_CLayer2d &) – Return type: void
-
RemoveStructure
()¶ - call_togl_removestructure
Parameters: theCStructure (Handle_Graphic3d_CStructure &) – Return type: void
-
RemoveView
()¶ - call_togl_removeview
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
RemoveZLayer
()¶ - Remove Z layer from the specified view. All structures displayed at the moment in layer will be displayed in default layer ( the bottom-level z layer ). To unset layer ID from associated structures use method UnsetZLayer (…).
Parameters: - theCView (Graphic3d_CView &) –
- theLayerId (Graphic3d_ZLayerId) –
Return type: void
-
SetBackFacingModel
()¶ - call_togl_backfacing
Parameters: aView (Graphic3d_CView &) – Return type: void
-
SetBgGradientStyle
()¶ Parameters: - ACView (Graphic3d_CView &) –
- FillStyle (Aspect_GradientFillMethod) –
Return type: void
-
SetBgImageStyle
()¶ Parameters: - ACView (Graphic3d_CView &) –
- FillStyle (Aspect_FillMethod) –
Return type: void
-
SetCamera
()¶ - Inform graphic driver if camera assigned to view changes.
Parameters: theCView (Graphic3d_CView &) – Return type: void
-
SetClipPlanes
()¶ - Pass clip planes to the associated graphic driver view.
Parameters: theCView (Graphic3d_CView &) – Return type: void
-
SetColor
()¶ - call_togl_set_color
Parameters: - R (Standard_ShortReal) –
- G (Standard_ShortReal) –
- B (Standard_ShortReal) –
Return type: void
-
SetDepthTestEnabled
()¶ - call_togl_depthtest
Parameters: - view (Graphic3d_CView &) –
- isEnabled (bool) –
Return type: void
-
SetGLLightEnabled
()¶ - call_togl_gllight
Parameters: - view (Graphic3d_CView &) –
- isEnabled (bool) –
Return type: void
-
SetImmediateModeDrawToFront
()¶ - @param theDrawToFrontBuffer Advanced option to modify rendering mode: 1. True. Drawing immediate mode structures directly to the front buffer over the scene image. Fast, so preferred for interactive work (used by default). However these extra drawings will be missed in image dump since it is performed from back buffer. Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen in run-time (in case of slow hardware) and/or tearing may appear. So this is strongly recommended to draw only simple (fast) structures. 2. False. Drawing immediate mode structures to the back buffer. The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync is turned on. But it works in any case and is especially useful for view dump because the dump image is read from the back buffer. returns previous mode.
Parameters: - theCView (Graphic3d_CView &) –
- theDrawToFrontBuffer (bool) –
Return type:
-
SetLight
()¶ - call_togl_setlight
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
SetLineAttributes
()¶ - call_togl_set_line_attributes
Parameters: - Type (int) –
- Width (Standard_ShortReal) –
Return type: void
-
SetTextAttributes
()¶ - Set text attributes for under-/overlayer. <Font> argument defines the name of the font to be used, <Type> argument defines the display type of the text, <R> <G> <B> values define the color of decal or subtitle background. To set the color of the text you can use the SetColor method.
Parameters: - Font (char *) –
- Type (int) –
- R (Standard_ShortReal) –
- G (Standard_ShortReal) –
- B (Standard_ShortReal) –
Return type: void
-
SetTransparency
()¶ - call_togl_set_transparency
Parameters: ATransparency (Standard_ShortReal) – Return type: void
-
SetVisualisation
()¶ - call_togl_setvisualisation
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
SetZLayerSettings
()¶ - Sets the settings for a single Z layer of specified view.
Parameters: - theCView (Graphic3d_CView &) –
- theLayerId (Graphic3d_ZLayerId) –
- theSettings (Graphic3d_ZLayerSettings &) –
Return type: void
-
Structure
()¶ - Creates new empty graphic structure
Parameters: theManager (Handle_Graphic3d_StructureManager &) – Return type: Handle_Graphic3d_CStructure
-
Text
()¶ - call_togl_text2d If AHeight < 0 default text height is used by driver (DefaultTextHeight method)
Parameters: - AText (char *) –
- X (Standard_ShortReal) –
- Y (Standard_ShortReal) –
- AHeight (Standard_ShortReal) –
Return type: void
-
TextSize
()¶ - call_togl_textsize2d
Parameters: - AText (char *) –
- AHeight (Standard_ShortReal) –
- AWidth (Standard_ShortReal &) –
- AnAscent (Standard_ShortReal &) –
- ADescent (Standard_ShortReal &) –
Return type: void
-
TriedronDisplay
()¶ - call_togl_triedron_display
Parameters: Return type: void
-
TriedronEcho
()¶ - call_togl_triedron_echo
Parameters: - ACView (Graphic3d_CView &) –
- AType (Aspect_TypeOfTriedronEcho) – default value is Aspect_TOTE_NONE
Return type: void
-
TriedronErase
()¶ - call_togl_triedron_erase
Parameters: ACView (Graphic3d_CView &) – Return type: void
-
UnsetTransparency
()¶ - call_togl_unset_transparency
Return type: void
-
UnsetZLayer
()¶ - Unset Z layer ID for all structures. The structure indexes will be set to default layer ( the bottom-level z layer with ID = 0 ).
Parameters: theLayerId (Graphic3d_ZLayerId) – Return type: void
-
ZBufferTriedronSetup
()¶ - call_togl_ztriedron_setup
Parameters: - theCView (Graphic3d_CView &) –
- 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 (int) – default value is 12
Return type: void
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Group
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
AddPrimitiveArray
()¶ - Adds an array of primitives for display
Parameters: - theType (Graphic3d_TypeOfPrimitiveArray) –
- theIndices (Handle_Graphic3d_IndexBuffer &) –
- theAttribs (Handle_Graphic3d_Buffer &) –
- theBounds (Handle_Graphic3d_BoundBuffer &) –
- theToEvalMinMax (bool) – default value is Standard_True
Return type: void
- Adds an array of primitives for display
Parameters: - thePrim (Handle_Graphic3d_ArrayOfPrimitives &) –
- theToEvalMinMax (bool) – default value is Standard_True
Return type:
-
BoundingBox
()¶ - Returns boundary box of the group <self> without transformation applied,
Return type: Graphic3d_BndBox4f
-
ChangeBoundingBox
()¶ - Returns non-const boundary box of the group <self> without transformation applied,
Return type: Graphic3d_BndBox4f
-
Clear
()¶ - Supress all primitives and attributes of <self>. To clear group without update in Graphic3d_StructureManager pass Standard_False as <theUpdateStructureMgr>. This used on context and viewer destruction, when the pointer to structure manager in Graphic3d_Structure could be already released (pointers are used here to avoid handle cross-reference);
Parameters: theUpdateStructureMgr (bool) – default value is Standard_True Return type: void
-
ContainsFacet
()¶ - Returns Standard_True if the group <self> contains Polygons, Triangles or Quadrangles.
Return type: bool
-
GetHandle
()¶
-
IsClosed
()¶ - Return true if primitive arrays within this graphic group form closed volume (do no contain open shells).
Return type: bool
-
IsDeleted
()¶ - Returns Standard_True if the group <self> is deleted. <self> is deleted after the call Remove (me) or the associated structure is deleted.
Return type: bool
-
IsGroupPrimitivesAspectSet
()¶ - Returns True if aspect is set for the group.
Parameters: theAspect (Graphic3d_GroupAspect) – Return type: bool
-
Marker
()¶ - Creates a primitive array with single marker using AddPrimitiveArray().
Parameters: - thePoint (Graphic3d_Vertex &) –
- theToEvalMinMax (bool) – default value is Standard_True
Return type:
-
MinMaxValues
()¶ - Returns the coordinates of the boundary box of the group <self>.
Parameters: - XMin (float &) –
- YMin (float &) –
- ZMin (float &) –
- XMax (float &) –
- YMax (float &) –
- ZMax (float &) –
Return type:
-
Remove
()¶ - Supress the group <self> in the structure. Warning: No more graphic operations in <self> after this call. Modifies the current modelling transform persistence (pan, zoom or rotate) Get the current modelling transform persistence (pan, zoom or rotate)
Return type: None
-
SetClosed
()¶ - Changes property shown that primitive arrays within this group form closed volume (do no contain open shells).
Parameters: theIsClosed (bool) – Return type: None
-
SetFlippingOptions
()¶ - sets the flipping to theIsEnabled state.
Parameters: Return type: void
-
SetMinMaxValues
()¶ - Sets the coordinates of the boundary box of the group <self>.
Parameters: Return type:
-
SetPrimitivesAspect
()¶ - Modifies the current context of the group to give another aspect for all the line primitives created after this call in the group.
Parameters: CTX (Handle_Graphic3d_AspectLine3d &) – Return type: None - Modifies the current context of the group to give another aspect for all the face primitives created after this call in the group.
Parameters: CTX (Handle_Graphic3d_AspectFillArea3d &) – Return type: None - Modifies the current context of the group to give another aspect for all the text primitives created after this call in the group.
Parameters: CTX (Handle_Graphic3d_AspectText3d &) – Return type: None - Modifies the current context of the group to give another aspect for all the marker primitives created after this call in the group.
Parameters: CTX (Handle_Graphic3d_AspectMarker3d &) – Return type: None
-
SetStencilTestOptions
()¶ - sets the stencil test to theIsEnabled state;
Parameters: theIsEnabled (bool) – Return type: void
-
Structure
()¶ - Returns the structure containing the group <self>.
Return type: Handle_Graphic3d_Structure
-
Text
()¶ - Creates the string <AText> at position <APoint>. The 3D point of attachment is projected. The text is written in the plane of projection. The attributes are given with respect to the plane of projection. AHeight : Height of text. (Relative to the Normalized Projection Coordinates (NPC) Space). AAngle : Orientation of the text (with respect to the horizontal).
Parameters: Return type: void
- Creates the string <AText> at position <APoint>. The 3D point of attachment is projected. The text is written in the plane of projection. The attributes are given with respect to the plane of projection. AHeight : Height of text. (Relative to the Normalized Projection Coordinates (NPC) Space). The other attributes have the following default values: AAngle : PI / 2. ATp : TP_RIGHT AHta : HTA_LEFT AVta : VTA_BOTTOM
Parameters: Return type: - Creates the string <AText> at position <APoint>. The 3D point of attachment is projected. The text is written in the plane of projection. The attributes are given with respect to the plane of projection. AHeight : Height of text. (Relative to the Normalized Projection Coordinates (NPC) Space). AAngle : Orientation of the text (with respect to the horizontal).
Parameters: Return type: - Creates the string <AText> at position <APoint>. The 3D point of attachment is projected. The text is written in the plane of projection. The attributes are given with respect to the plane of projection. AHeight : Height of text. (Relative to the Normalized Projection Coordinates (NPC) Space). The other attributes have the following default values: AAngle : PI / 2. ATp : TP_RIGHT AHta : HTA_LEFT AVta : VTA_BOTTOM
Parameters: Return type:
-
UserDraw
()¶ - Creates a UserDraw primitive using obsolete API.
Parameters: Return type: void
-
thisown
¶ The membership flag
-
-
class
Graphic3d_HSequenceOfStructure
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
Return type: None -
Append
()¶ Parameters: - anItem (Handle_Graphic3d_Structure &) –
- aSequence (Handle_Graphic3d_HSequenceOfStructure &) –
Return type: Return type:
-
ChangeSequence
()¶ Return type: Graphic3d_SequenceOfStructure
-
ChangeValue
()¶ Parameters: anIndex (int) – Return type: Handle_Graphic3d_Structure
-
GetHandle
()¶
-
InsertAfter
()¶ Parameters: - anIndex (int) –
- anItem (Handle_Graphic3d_Structure &) –
- anIndex –
- aSequence (Handle_Graphic3d_HSequenceOfStructure &) –
Return type: Return type:
-
InsertBefore
()¶ Parameters: - anIndex (int) –
- anItem (Handle_Graphic3d_Structure &) –
- anIndex –
- aSequence (Handle_Graphic3d_HSequenceOfStructure &) –
Return type: Return type:
-
Prepend
()¶ Parameters: - anItem (Handle_Graphic3d_Structure &) –
- aSequence (Handle_Graphic3d_HSequenceOfStructure &) –
Return type: Return type:
-
Remove
()¶ Parameters: Return type: Return type:
-
Sequence
()¶ Return type: Graphic3d_SequenceOfStructure
-
Split
()¶ Parameters: anIndex (int) – Return type: Handle_Graphic3d_HSequenceOfStructure
-
Value
()¶ Parameters: anIndex (int) – Return type: Handle_Graphic3d_Structure
-
thisown
¶ The membership flag
-
-
class
Graphic3d_ListIteratorOfListOfShortReal
(*args)¶ Bases:
object
Return type: None Parameters: L (Graphic3d_ListOfShortReal &) – Return type: None -
Value
()¶ Return type: Standard_ShortReal
-
thisown
¶ The membership flag
-
-
class
Graphic3d_ListNodeOfListOfShortReal
(*args)¶ Bases:
OCC.TCollection.TCollection_MapNode
Parameters: - I (Standard_ShortReal &) –
- n (TCollection_MapNodePtr &) –
Return type: -
GetHandle
()¶
-
Value
()¶ Return type: Standard_ShortReal
-
thisown
¶ The membership flag
-
class
Graphic3d_ListOfShortReal
(*args)¶ Bases:
object
Return type: None Parameters: Other (Graphic3d_ListOfShortReal &) – Return type: None -
Append
()¶ Parameters: - I (Standard_ShortReal &) –
- I –
- theIt (Graphic3d_ListIteratorOfListOfShortReal &) –
- Other (Graphic3d_ListOfShortReal &) –
Return type: Return type: Return type:
-
First
()¶ Return type: Standard_ShortReal
-
InsertAfter
()¶ Parameters: - I (Standard_ShortReal &) –
- It (Graphic3d_ListIteratorOfListOfShortReal &) –
- Other (Graphic3d_ListOfShortReal &) –
- It –
Return type: Return type:
-
InsertBefore
()¶ Parameters: - I (Standard_ShortReal &) –
- It (Graphic3d_ListIteratorOfListOfShortReal &) –
- Other (Graphic3d_ListOfShortReal &) –
- It –
Return type: Return type:
-
Last
()¶ Return type: Standard_ShortReal
-
Prepend
()¶ Parameters: - I (Standard_ShortReal &) –
- I –
- theIt (Graphic3d_ListIteratorOfListOfShortReal &) –
- Other (Graphic3d_ListOfShortReal &) –
Return type: Return type: Return type:
-
thisown
¶ The membership flag
-
-
class
Graphic3d_MarkerImage
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- @param theImage - source image
Parameters: theImage (Handle_Image_PixMap &) – Return type: None - Creates marker image from array of bytes (method for compatibility with old markers definition). @param theBitMap - source bitmap stored as array of bytes @param theWidth - number of bits in a row @param theHeight - number of bits in a column
Parameters: - theBitMap (Handle_TColStd_HArray1OfByte &) –
- theWidth (int &) –
- theHeight (int &) –
Return type: -
GetBitMapArray
()¶ - @param theAlphaValue pixels in the image that have alpha value greater than or equal to this parameter will be stored in bitmap as ‘1’, others will be stored as ‘0’ returns marker image as array of bytes. If an instance of the class has been initialized with image, it will be converted to bitmap based on the parameter theAlphaValue.
Parameters: theAlphaValue (float &) – default value is 0.5 Return type: Handle_TColStd_HArray1OfByte
-
GetHandle
()¶
-
GetImage
()¶ - returns marker image. If an instance of the class has been initialized with a bitmap, it will be converted to image.
Return type: Handle_Image_PixMap
-
GetImageAlpha
()¶ - returns image alpha as grayscale image. Note that if an instance of the class has been initialized with a bitmap or with grayscale image this method will return exactly the same image as GetImage()
Return type: Handle_Image_PixMap
-
GetImageAlphaId
()¶ - returns an unique ID. This ID will be used to manage resource in graphic driver.
Return type: TCollection_AsciiString
-
GetImageId
()¶ - returns an unique ID. This ID will be used to manage resource in graphic driver.
Return type: TCollection_AsciiString
-
GetTextureSize
()¶ - returns texture size
Parameters: - theWidth (int &) –
- theHeight (int &) –
Return type:
-
thisown
¶ The membership flag
-
class
Graphic3d_MaterialAspect
(*args)¶ Bases:
object
- Creates a material from default values.
Return type: None - Creates a generic material calls <AName>
Parameters: AName (Graphic3d_NameOfMaterial) – Return type: None -
AmbientColor
()¶ - Returns the ambient colour of the surface.
Return type: Quantity_Color
-
Color
()¶ - Returns the diffuse colour of the surface.
Return type: Quantity_Color
-
DiffuseColor
()¶ - Returns the diffuse colour of the surface.
Return type: Quantity_Color
-
EmissiveColor
()¶ - Returns the emissive colour of the surface.
Return type: Quantity_Color
-
EnvReflexion
()¶ Return type: Standard_ShortReal
-
IncreaseShine
()¶ - Increases or decreases the luminosity of <self>. <ADelta> is a signed percentage.
Parameters: ADelta (float) – Return type: None
-
IsDifferent
()¶ - Returns Standard_True if the materials <self> and <Other> are different.
Parameters: Other (Graphic3d_MaterialAspect &) – Return type: bool
-
IsEqual
()¶ - Returns Standard_True if the materials <self> and <Other> are identical.
Parameters: Other (Graphic3d_MaterialAspect &) – Return type: bool
-
static
MaterialFromName
()¶ - Returns the material for specified name or Graphic3d_NOM_DEFAULT if name is unknown.
Parameters: theName (char *) – Return type: Graphic3d_NameOfMaterial
-
MaterialName
()¶ - Returns the name of the predefined material of rank <aRank> Trigger: when <aRank> is < 1 or > NumberOfMaterials.
Parameters: aRank (int) – Return type: char * - Returns the name of this material
Return type: char *
-
static
MaterialType
()¶ - Returns Standard_True if MyMaterialType equal the parameter AType, Standard_False otherwise.
Parameters: AType (Graphic3d_TypeOfMaterial) – Return type: bool - Returns the type of the predefined material of rank <aRank> Trigger: when <aRank> is < 1 or > NumberOfMaterials.
Parameters: aRank (int) – Return type: Graphic3d_TypeOfMaterial
-
Name
()¶ - Returns the material name.
Return type: Graphic3d_NameOfMaterial
-
ReflectionMode
()¶ - Returns Standard_True if the reflection mode is active, Standard_False otherwise.
Parameters: AType (Graphic3d_TypeOfReflection) – Return type: bool
-
Reset
()¶ - Resets the material with the original values according to the material name but leave the current color values untouched for the material of type ASPECT.
Return type: None
-
SetAmbient
()¶ - Modifies the reflection properties of the surface. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SetAmbientColor
()¶ - Modifies the ambient colour of the surface.
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetColor
()¶ - Modifies the ambient and diffuse colour of the surface. Category: Methods to modify the class definition
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetDiffuse
()¶ - Modifies the reflection properties of the surface. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SetDiffuseColor
()¶ - Modifies the difuse colour of the surface.
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetEmissive
()¶ - Modifies the reflection properties of the surface. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SetEmissiveColor
()¶ - Modifies the emissive colour of the surface.
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetMaterialName
()¶ - The current matarial become a ‘UserDefined’ material. Set the name of the ‘UserDefined’ material.
Parameters: AName (char *) – Return type: None
-
SetMaterialType
()¶ - Set MyMaterialType to the value of parameter <AType> //! TypeOfMaterial : MATERIAL_ASPECT MATERIAL_PHYSIC
Parameters: AType (Graphic3d_TypeOfMaterial) – Return type: None
-
SetReflectionModeOff
()¶ - Deactivates the reflective properties of the surface <AType>. //! TypeOfReflection : TOR_AMBIENT TOR_DIFFUSE TOR_SPECULAR TOR_EMISSION 1, 2, 3 or 4 types of reflection can be set off for a given surface. Disabling diffuse and specular reflectance is useful for efficient visualization of large amounts of data as definition of normals for graphic primitives is not needed when only ‘all-directional’ reflectance is active. //! NOTE: Disabling all four reflection modes also turns off the following effects: 1. Lighting. Colors of primitives are not affected by the material properties when lighting is off. 2. Transparency.
Parameters: AType (Graphic3d_TypeOfReflection) – Return type: None
-
SetReflectionModeOn
()¶ - Activates the reflective properties of the surface <AType>. //! TypeOfReflection : TOR_AMBIENT TOR_DIFFUSE TOR_SPECULAR TOR_EMISSION 1, 2, 3 or 4 types of reflection can be set for a given surface.
Parameters: AType (Graphic3d_TypeOfReflection) – Return type: None
-
SetRefractionIndex
()¶ - Modifies the refraction index of the material. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <theValue> is a lesser than 1.0.
Parameters: theValue (float) – Return type: None
-
SetShininess
()¶ - Modifies the luminosity of the surface. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SetSpecular
()¶ - Modifies the reflection properties of the surface. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SetSpecularColor
()¶ - Modifies the specular colour of the surface.
Parameters: AColor (Quantity_Color &) – Return type: None
-
SetTransparency
()¶ - Modifies the transparency coefficient of the surface. <AValue> = 0. opaque. (default) <AValue> = 1. transparent. Transparency is applicable to materials that have at least one of reflection modes (ambient, diffuse, specular or emissive) enabled. See also SetReflectionModeOn() and SetReflectionModeOff() methods. //! NOTE: In order for transparency specified through this method to take effect, it is necessary to enable transparency in the viewer. This can be done either directly - see Visual3d_ViewManager::SetTransparency(Standard_Boolean), or indirectly - by calling AIS_InteractiveObject::SetTransparency() before an object is added to an interactive context, or by calling AIS_InteractiveContext::SetTransparency() for a given interactive object already displayed. Category: Methods to modify the class definition Warning: Raises MaterialDefinitionError if <AValue> is a negative value or greater than 1.0.
Parameters: AValue (float) – Return type: None
-
SpecularColor
()¶ - Returns the specular colour of the surface.
Return type: Quantity_Color
-
thisown
¶ The membership flag
-
Graphic3d_MaterialAspect_MaterialFromName
()¶ - Returns the material for specified name or Graphic3d_NOM_DEFAULT if name is unknown.
Parameters: theName (char *) – Return type: Graphic3d_NameOfMaterial
-
Graphic3d_MaterialAspect_MaterialType
()¶ - Returns Standard_True if MyMaterialType equal the parameter AType, Standard_False otherwise.
Parameters: AType (Graphic3d_TypeOfMaterial) – Return type: bool - Returns the type of the predefined material of rank <aRank> Trigger: when <aRank> is < 1 or > NumberOfMaterials.
Parameters: aRank (int) – Return type: Graphic3d_TypeOfMaterial
-
Graphic3d_MaterialAspect_NumberOfMaterials
()¶ - Returns the number of predefined textures.
Return type: int
-
class
Graphic3d_RenderingParams
(*args)¶ Bases:
object
- Creates default rendering parameters.
Return type: None -
AnaglyphFilter
¶
-
AnaglyphLeft
¶
-
AnaglyphRight
¶
-
Anaglyph_GreenMagenta_Simple
= 4¶
-
Anaglyph_RedCyan_Optimized
= 1¶
-
Anaglyph_RedCyan_Simple
= 0¶
-
Anaglyph_UserDefined
= 5¶
-
Anaglyph_YellowBlue_Optimized
= 3¶
-
Anaglyph_YellowBlue_Simple
= 2¶
-
IsAntialiasingEnabled
¶
-
IsReflectionEnabled
¶
-
IsShadowEnabled
¶
-
IsTransparentShadowEnabled
¶
-
Method
¶
-
RaytracingDepth
¶
-
StereoMode
¶
-
ToReverseStereo
¶
-
thisown
¶ The membership flag
-
class
Graphic3d_SequenceNodeOfSequenceOfStructure
(*args)¶ Bases:
OCC.TCollection.TCollection_SeqNode
Parameters: - I (Handle_Graphic3d_Structure &) –
- n (TCollection_SeqNodePtr &) –
- p (TCollection_SeqNodePtr &) –
Return type: -
GetHandle
()¶
-
Value
()¶ Return type: Handle_Graphic3d_Structure
-
thisown
¶ The membership flag
-
class
Graphic3d_SequenceOfStructure
(*args)¶ Bases:
OCC.TCollection.TCollection_BaseSequence
Return type: None Parameters: Other (Graphic3d_SequenceOfStructure &) – Return type: None -
Append
()¶ Parameters: - T (Handle_Graphic3d_Structure &) –
- S (Graphic3d_SequenceOfStructure &) –
Return type: Return type:
-
Assign
()¶ Parameters: Other (Graphic3d_SequenceOfStructure &) – Return type: Graphic3d_SequenceOfStructure
-
ChangeValue
()¶ Parameters: Index (int) – Return type: Handle_Graphic3d_Structure
-
First
()¶ Return type: Handle_Graphic3d_Structure
-
InsertAfter
()¶ Parameters: - Index (int) –
- T (Handle_Graphic3d_Structure &) –
- Index –
- S (Graphic3d_SequenceOfStructure &) –
Return type: Return type:
-
InsertBefore
()¶ Parameters: - Index (int) –
- T (Handle_Graphic3d_Structure &) –
- Index –
- S (Graphic3d_SequenceOfStructure &) –
Return type: Return type:
-
Last
()¶ Return type: Handle_Graphic3d_Structure
-
Prepend
()¶ Parameters: - T (Handle_Graphic3d_Structure &) –
- S (Graphic3d_SequenceOfStructure &) –
Return type: Return type:
-
Remove
()¶ Parameters: Return type: Return type:
-
Set
()¶ Parameters: Other (Graphic3d_SequenceOfStructure &) – Return type: Graphic3d_SequenceOfStructure
-
Value
()¶ Parameters: Index (int) – Return type: Handle_Graphic3d_Structure
-
thisown
¶ The membership flag
-
-
class
Graphic3d_ShaderObject
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
static
CreateFromFile
(*args) → OCC.Graphic3d.Handle_Graphic3d_ShaderObject¶ - Creates new shader object from specified file.
Parameters: - theType (Graphic3d_TypeOfShaderObject) –
- thePath (TCollection_AsciiString &) –
Return type:
-
static
CreateFromSource
(*args) → OCC.Graphic3d.Handle_Graphic3d_ShaderObject¶ - Creates new shader object from specified source.
Parameters: - theType (Graphic3d_TypeOfShaderObject) –
- theSource (TCollection_AsciiString &) –
Return type:
-
GetHandle
()¶
-
GetId
()¶ - Returns unique ID used to manage resource in graphic driver.
Return type: TCollection_AsciiString
-
Path
()¶ - Returns the full path to the shader source.
Return type: OSD_Path
-
Source
()¶ - Returns the source code of the shader object.
Return type: TCollection_AsciiString
-
Type
()¶ - Returns type of the shader object.
Return type: Graphic3d_TypeOfShaderObject
-
thisown
¶ The membership flag
-
static
-
Graphic3d_ShaderObject_CreateFromFile
(*args) → OCC.Graphic3d.Handle_Graphic3d_ShaderObject¶ - Creates new shader object from specified file.
Parameters: - theType (Graphic3d_TypeOfShaderObject) –
- thePath (TCollection_AsciiString &) –
Return type:
-
Graphic3d_ShaderObject_CreateFromSource
(*args) → OCC.Graphic3d.Handle_Graphic3d_ShaderObject¶ - Creates new shader object from specified source.
Parameters: - theType (Graphic3d_TypeOfShaderObject) –
- theSource (TCollection_AsciiString &) –
Return type:
-
class
Graphic3d_ShaderProgram
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Creates new empty program object.
Return type: None - Creates program object from pre-defined shaders. Raises Standard_Failure exception if shader resources are unavailable.
Parameters: theName (Graphic3d_ShaderProgram::ShaderName) – Return type: None -
AttachShader
()¶ - Attaches shader object to the program object.
Parameters: theShader (Handle_Graphic3d_ShaderObject &) – Return type: bool
-
DetachShader
()¶ - Detaches shader object from the program object.
Parameters: theShader (Handle_Graphic3d_ShaderObject &) – Return type: bool
-
GetHandle
()¶
-
GetId
()¶ - Returns unique ID used to manage resource in graphic driver.
Return type: TCollection_AsciiString
-
Header
()¶ - Returns GLSL header (version code and extensions).
Return type: TCollection_AsciiString
-
SetHeader
()¶ - Setup GLSL header containing language version code and used extensions. Will be prepended to the very beginning of the source code. Example: @code #version 300 es #extension GL_ARB_bindless_texture : require @endcode
Parameters: theHeader (TCollection_AsciiString &) – Return type: None
-
ShaderName_Phong
= 1¶
-
ShaderName_UNKNOWN
= 0¶
-
ShaderObjects
()¶ - Returns list of attached shader objects.
Return type: Graphic3d_ShaderObjectList
-
static
ShadersFolder
()¶ - The path to GLSL programs determined from CSF_ShadersDirectory or CASROOT environment variables. returns the root folder with default GLSL programs.
Return type: TCollection_AsciiString
-
Variables
()¶ - Returns list of custom uniform variables.
Return type: Graphic3d_ShaderVariableList
-
thisown
¶ The membership flag
-
Graphic3d_ShaderProgram_ShadersFolder
()¶ - The path to GLSL programs determined from CSF_ShadersDirectory or CASROOT environment variables. returns the root folder with default GLSL programs.
Return type: TCollection_AsciiString
-
class
Graphic3d_ShaderVariable
(*args, **kwargs)¶ Bases:
OCC.Standard.Standard_Transient
-
GetHandle
()¶
-
Name
()¶ - Returns name of shader variable.
Return type: TCollection_AsciiString
-
Value
()¶ - Returns interface of shader variable value.
Return type: Graphic3d_ValueInterface *
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Structure
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
- Creates a graphic object in the manager theManager. It will appear in all the views of the visualiser. Warning: The default values AspectLine, AspectFillArea, AspectText and AspectMarker are NOT applied to the structure. The structure is not displayed when it is created.
Parameters: theManager (Handle_Graphic3d_StructureManager &) – Return type: None - Creates a shadow link to existing graphic object.
Parameters: - theManager (Handle_Graphic3d_StructureManager &) –
- thePrs (Handle_Graphic3d_Structure &) –
Return type: -
static
AcceptConnection
()¶ - Returns Standard_True if the connection is possible between <AStructure1> and <AStructure2> without a creation of a cycle. //! It’s not possible to call the method AStructure1->Connect (AStructure2, TypeOfConnection) if - the set of all ancestors of <AStructure1> contains <AStructure1> and if the TypeOfConnection == TOC_DESCENDANT - the set of all descendants of <AStructure1> contains <AStructure2> and if the TypeOfConnection == TOC_ANCESTOR
Parameters: - AStructure1 (Handle_Graphic3d_Structure &) –
- AStructure2 (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
Return type:
-
Ancestors
()¶ - Returns the group of structures to which <self> is connected.
Parameters: SG (Graphic3d_MapOfStructure &) – Return type: None
-
CStructure
()¶ - Returns the low-level structure
Return type: Handle_Graphic3d_CStructure
-
CalculateBoundBox
()¶ - Computes axis-aligned bounding box of a structure. Category: Methods to modify the class definition
Return type: None
-
Clear
()¶ - if WithDestruction == Standard_True then suppress all the groups of primitives in the structure. and it is mandatory to create a new group in <self>. if WithDestruction == Standard_False then clears all the groups of primitives in the structure. and all the groups are conserved and empty. They will be erased at the next screen update. The structure itself is conserved. The transformation and the attributes of <self> are conserved. The childs of <self> are conserved.
Parameters: WithDestruction (bool) – default value is Standard_True Return type: void
-
Composition
()¶ - Returns the type of composition applied to matrices of transformation of <self>.
Return type: Graphic3d_TypeOfComposition
-
Compute
()¶ Return type: void - Returns the new Structure defined for the new visualization
Parameters: aProjector (Handle_Graphic3d_DataStructureManager &) – Return type: Handle_Graphic3d_Structure - Returns the new Structure defined for the new visualization
Parameters: - aProjector (Handle_Graphic3d_DataStructureManager &) –
- AMatrix (TColStd_Array2OfReal &) –
Return type: - Returns the new Structure defined for the new visualization
Parameters: - aProjector (Handle_Graphic3d_DataStructureManager &) –
- aStructure (Handle_Graphic3d_Structure &) –
Return type: void
- Returns the new Structure defined for the new visualization
Parameters: - aProjector (Handle_Graphic3d_DataStructureManager &) –
- AMatrix (TColStd_Array2OfReal &) –
- aStructure (Handle_Graphic3d_Structure &) –
Return type: void
-
ComputeVisual
()¶ Return type: Graphic3d_TypeOfStructure
-
Connect
()¶ - If Atype is TOC_DESCENDANT then add <AStructure> as a child structure of <self>. If Atype is TOC_ANCESTOR then add <AStructure> as a parent structure of <self>. The connection propagates Display, Highlight, Erase, Remove, and stacks the transformations. No connection if the graph of the structures contains a cycle and <WithCheck> is Standard_True;
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
- WithCheck (bool) – default value is Standard_False
Return type:
-
ContainsFacet
()¶ - Returns Standard_True if the structure <self> contains Polygons, Triangles or Quadrangles.
Return type: bool
-
Descendants
()¶ - Returns the group of structures connected to <self>.
Parameters: SG (Graphic3d_MapOfStructure &) – Return type: None
-
Destroy
()¶ - Suppresses the structure <self>. It will be erased at the next screen update.
Return type: void
-
Disconnect
()¶ - Suppress the connection between <AStructure> and <self>.
Parameters: AStructure (Handle_Graphic3d_Structure &) – Return type: None
-
DisconnectAll
()¶ - If Atype is TOC_DESCENDANT then suppress all the connections with the child structures of <self>. If Atype is TOC_ANCESTOR then suppress all the connections with the parent structures of <self>.
Parameters: AType (Graphic3d_TypeOfConnection) – Return type: None
-
Display
()¶ - Displays the structure <self> in all the views of the visualiser.
Return type: void
-
Erase
()¶ - Erases the structure <self> in all the views of the visualiser.
Return type: void
-
FillArea3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectFillArea3d
-
GetClipPlanes
()¶ - Get clip planes slicing the structure on rendering. returns set of clip planes.
Return type: Graphic3d_SequenceOfHClipPlane
-
GetHandle
()¶
-
GetZLayer
()¶ - Get Z layer ID of displayed structure. The method returns -1 if the structure has no ID (deleted from graphic driver).
Return type: Graphic3d_ZLayerId
-
GraphicHighlight
()¶ - Highlights the structure <self>.
Parameters: Method (Aspect_TypeOfHighlightMethod) – Return type: None
-
Groups
()¶ - Returns the groups sequence included in the structure <self> (internal storage).
Return type: Graphic3d_SequenceOfGroup
-
Highlight
()¶ - Highlights the structure <self> in all the views of the visualiser, using the following methods: TOHM_COLOR = drawn in the highlight color TOHM_BOUNDBOX = enclosed by the boundary box
Parameters: - theMethod (Aspect_TypeOfHighlightMethod) –
- theColor (Quantity_Color &) –
- theToUpdateMgr (bool) – default value is Standard_True
Return type:
-
HighlightColor
()¶ - Returns the highlight color for the Highlight method with the highlight method TOHM_COLOR or TOHM_BOUNDBOX.
Return type: Quantity_Color
-
IsDeleted
()¶ - Returns Standard_True if the structure <self> is deleted. <self> is deleted after the call Remove (me).
Return type: bool
-
IsEmpty
()¶ - Returns Standard_True if the structure <self> is empty. Warning: A structure is empty if : it do not have group or all the groups are empties and it do not have descendant or all the descendants are empties.
Return type: bool
-
IsMutable
()¶ - Returns true if structure has mutable nature (content or location are be changed regularly). Mutable structure will be managed in different way than static onces.
Return type: bool
-
IsRotated
()¶ - Returns Standard_True if the structure <self> is rotated. <=> The transformation != Identity, != Scale, != Translation.
Return type: bool
-
IsTransformed
()¶ - Returns Standard_True if the structure <self> is transformed. <=> The transformation != Identity.
Return type: bool
-
Line3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectLine3d
-
Marker3dAspect
()¶ - Returns the current group of graphic attributes used for 3d marker primitives.
Return type: Handle_Graphic3d_AspectMarker3d
-
MinMaxValues
()¶ - Returns the coordinates of the boundary box of the structure <self>. If <theToIgnoreInfiniteFlag> is True, the method returns actual graphical boundaries of the Graphic3d_Group components. Otherwise, the method returns boundaries taking into account infinite state of the structure. This approach generally used for application specific fit operation (e.g. fitting the model into screen, not taking into accout infinite helper elements). Warning: If the structure <self> is empty then the empty box is returned, If the structure <self> is infinite then the whole box is returned.
Parameters: theToIgnoreInfiniteFlag (bool) – default value is Standard_False Return type: Bnd_Box
-
static
Network
()¶ - Returns <ASet> the group of structures : - directly or indirectly connected to <AStructure> if the TypeOfConnection == TOC_DESCENDANT - to which <AStructure> is directly or indirectly connected if the TypeOfConnection == TOC_ANCESTOR
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
- ASet (Graphic3d_MapOfStructure &) –
Return type: void
-
NewGroup
()¶ - Append new group to this structure.
Return type: Handle_Graphic3d_Group
-
Owner
()¶ Return type: Standard_Address
-
PrimitivesAspect
()¶ - Returns the current values of the default attributes.
Parameters: - CTXL (Handle_Graphic3d_AspectLine3d &) –
- CTXT (Handle_Graphic3d_AspectText3d &) –
- CTXM (Handle_Graphic3d_AspectMarker3d &) –
- CTXF (Handle_Graphic3d_AspectFillArea3d &) –
Return type:
-
static
PrintNetwork
()¶ - Prints informations about the network associated with the structure <AStructure>.
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
Return type: void
-
ReCompute
()¶ - Forces a new construction of the structure <self> if <self> is displayed and TOS_COMPUTED.
Return type: None - Forces a new construction of the structure <self> if <self> is displayed in <aProjetor> and TOS_COMPUTED.
Parameters: aProjector (Handle_Graphic3d_DataStructureManager &) – Return type: None
-
Remove
()¶ - Suppress the structure <self>. It will be erased at the next screen update. Warning: No more graphic operations in <self> after this call. Category: Methods to modify the class definition
Return type: None - Suppress the adress <APtr> in the list of descendants or in the list of ancestors.
Parameters: - APtr (Standard_Address) –
- AType (Graphic3d_TypeOfConnection) –
Return type:
-
ResetDisplayPriority
()¶ - Reset the current priority of the structure to the previous priority. Category: Methods to modify the class definition Warning: If <self> is displayed then the SetDisplayPriority method erase <self> and display <self> with the previous priority.
Return type: None
-
SetClipPlanes
()¶ - Changes a sequence of clip planes slicing the structure on rendering. @param thePlanes [in] the set of clip planes.
Parameters: thePlanes (Graphic3d_SequenceOfHClipPlane &) – Return type: None
-
SetDisplayPriority
()¶ - Modifies the order of displaying the structure. Values are between 0 and 10. Structures are drawn according to their display priorities in ascending order. A structure of priority 10 is displayed the last and appears over the others. The default value is 5. Category: Methods to modify the class definition Warning: If <self> is displayed then the SetDisplayPriority method erase <self> and display <self> with the new priority. Raises PriorityDefinitionError if <Priority> is greater than 10 or a negative value.
Parameters: Priority (int) – Return type: None
-
SetInfiniteState
()¶ - If <theToSet> is Standard_True then <self> is infinite and the MinMaxValues method method return : theXMin = theYMin = theZMin = RealFirst(). theXMax = theYMax = theZMax = RealLast(). By default, <self> is not infinite but empty.
Parameters: theToSet (bool) – Return type: None
-
SetIsForHighlight
()¶ - marks the structure <self> representing wired structure needed for highlight only so it won’t be added to BVH tree. Category: Methods to modify the class definition
Parameters: isForHighlight (bool) – Return type: None
-
SetMutable
()¶ - Sets if the structure location has mutable nature (content or location will be changed regularly).
Parameters: theIsMutable (bool) – Return type: None
-
SetPrimitivesAspect
()¶ - Modifies the default attributes for lines in the structure <self>.
Parameters: CTX (Handle_Graphic3d_AspectLine3d &) – Return type: None - Modifies the default attributes for faces in the structure <self>.
Parameters: CTX (Handle_Graphic3d_AspectFillArea3d &) – Return type: None - Modifies the default attributes for text in the structure <self>.
Parameters: CTX (Handle_Graphic3d_AspectText3d &) – Return type: None - Modifies the default attributes for markers in the structure <self>.
Parameters: CTX (Handle_Graphic3d_AspectMarker3d &) – Return type: None
-
SetTransform
()¶ - Modifies the current local modelling transformation in the structure <self>. //! It is defined as a 4*4 real matrix. //! ——————- | a11 a12 a13 t1 | | a21 a22 a23 t2 | | a31 a32 a33 t3 | | 0 0 0 1 | ——————- //! TypeOfComposition : TOC_REPLACE TOC_POSTCONCATENATE //! Then the modified Local Modelling Transformation is composed with the current Global Modelling Transformation to create a new Composite Modelling Transformation. //! The compose type specifies the role of the current local modelling transformation (L) in composing the new value for the current local modelling transformation (L’), which is then combined with the current global modelling transforma- tion (G) to calculate the new composite modelling transfor- mation (C). //! TOC_REPLACE The transformation matrix (T) replaces the value of current local modelling transformation (L). //! L’ <- T C <- G x L’ //! TOC_POSTCONCATENATE The current local modelling transformation (L) is multiplied by the transformation matrix (T): //! L’ <- T x L C <- G x L’ //! Category: Methods to manage the structure transformation Warning: Raises TransformError if the matrix is not a 4x4 matrix.
Parameters: - AMatrix (TColStd_Array2OfReal &) –
- AType (Graphic3d_TypeOfComposition) –
Return type:
-
SetTransformPersistence
()¶ - Modifies the current modelling transform persistence (pan, zoom or rotate)
Parameters: - AFlag (Graphic3d_TransModeFlags &) –
- APoint (gp_Pnt) –
- AFlag –
Return type: Return type:
-
SetVisible
()¶ - Modifies the visibility indicator to Standard_True or Standard_False for the structure <self>. The default value at the definition of <self> is Standard_True.
Parameters: AValue (bool) – Return type: None
-
SetVisual
()¶ - Modifies the visualisation mode for the structure <self>.
Parameters: AVisual (Graphic3d_TypeOfStructure) – Return type: void
-
SetZLayer
()¶ - Set Z layer ID for the structure. The Z layer mechanism allows to display structures presented in higher layers in overlay of structures in lower layers by switching off z buffer depth test between layers
Parameters: theLayerId (Graphic3d_ZLayerId) – Return type: None
-
SetZoomLimit
()¶ - Modifies the minimum and maximum zoom coefficients for the structure <self>. The default value at the definition of <self> is unlimited. Category: Methods to modify the class definition Warning: Raises StructureDefinitionError if <LimitInf> is greater than <LimitSup> or if <LimitInf> or <LimitSup> is a negative value.
Parameters: Return type:
-
Text3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectText3d
-
Transform
()¶ - Returns the transformation associated with the structure <self>.
Parameters: AMatrix (TColStd_Array2OfReal &) – Return type: None
-
TransformPersistenceMode
()¶ - Get the current modelling transform persistence (pan, zoom or rotate)
Return type: Graphic3d_TransModeFlags
-
TransformPersistencePoint
()¶ - Get the current point of relative modelling transform persistence
Return type: gp_Pnt
-
static
Transforms
(*args) → OCC.Graphic3d.Graphic3d_Vertex¶ - Transforms <X>, <Y>, <Z> with the transformation <ATrsf>.
Parameters: Return type: void
- Transforms <Coord> with the transformation <ATrsf>.
Parameters: - ATrsf (TColStd_Array2OfReal &) –
- Coord (Graphic3d_Vector &) –
Return type: - Transforms <Coord> with the transformation <ATrsf>.
Parameters: - ATrsf (TColStd_Array2OfReal &) –
- Coord (Graphic3d_Vertex &) –
Return type:
-
UnHighlight
()¶ - Suppresses the highlight for the structure <self> in all the views of the visualiser.
Return type: None
-
Visual
()¶ - Returns the visualisation mode for the structure <self>.
Return type: Graphic3d_TypeOfStructure
-
thisown
¶ The membership flag
-
class
Graphic3d_StructureManager
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
AddZLayer
()¶ - Add a new top-level Z layer and get its ID as <theLayerId> value. The method returns Standard_False if the layer can not be created. The z layer mechanism allows to display structures in higher layers in overlay of structures in lower layers.
Parameters: theLayerId (Graphic3d_ZLayerId &) – Return type: bool
-
ChangeDisplayPriority
()¶ - Changes the display priority of the structure <AStructure>.
Parameters: Return type: void
-
ChangeZLayer
()¶ - Change Z layer for structure. The z layer mechanism allows to display structures in higher layers in overlay of structures in lower layers.
Parameters: - theStructure (Handle_Graphic3d_Structure &) –
- theLayerId (Graphic3d_ZLayerId) –
Return type: void
-
Clear
()¶ - Clears the structure <AStructure>.
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- WithDestruction (bool) –
Return type: void
-
Connect
()¶ - Connects the structures <AMother> and <ADaughter>.
Parameters: - AMother (Handle_Graphic3d_Structure &) –
- ADaughter (Handle_Graphic3d_Structure &) –
Return type: void
-
Destroy
()¶ - Deletes the manager <self>.
Return type: void
-
Disconnect
()¶ - Disconnects the structures <AMother> and <ADaughter>.
Parameters: - AMother (Handle_Graphic3d_Structure &) –
- ADaughter (Handle_Graphic3d_Structure &) –
Return type: void
-
Display
()¶ - Display the structure <AStructure>.
Parameters: AStructure (Handle_Graphic3d_Structure &) – Return type: void
-
DisplayedStructures
()¶ - Returns the set of structures displayed in visualiser <self>.
Parameters: SG (Graphic3d_MapOfStructure &) – Return type: None
-
Erase
()¶ - Erases the structure <AStructure>.
Parameters: AStructure (Handle_Graphic3d_Structure &) – Return type: void
-
FillArea3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectFillArea3d
-
GetAllZLayers
()¶ - Return all Z layer ids in sequence ordered by level from lowest layer to highest. The first layer ID in sequence is the default layer that can’t be removed.
Parameters: theLayerSeq (TColStd_SequenceOfInteger &) – Return type: void
-
GetHandle
()¶
-
GraphicDriver
()¶ - Returns the graphic driver of <self>.
Return type: Handle_Graphic3d_GraphicDriver
-
Highlight
()¶ - Highlights the structure <AStructure>.
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AMethod (Aspect_TypeOfHighlightMethod) –
Return type: void
-
HighlightedStructures
()¶ - Returns the set of highlighted structures in a visualiser <self>.
Parameters: SG (Graphic3d_MapOfStructure &) – Return type: None
-
Identification
()¶ - Returns the identification number of the manager.
Return type: int - Returns the structure with the identification number <AId>.
Parameters: AId (int) – Return type: Handle_Graphic3d_Structure
-
Line3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectLine3d
-
Marker3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectMarker3d
-
NewIdentification
()¶ - Returns a new identification number for a new structure in the manager.
Return type: int
-
ObjectAffinity
()¶ Parameters: theObject (Handle_Standard_Transient &) – Return type: Handle_Graphic3d_ViewAffinity
-
PrimitivesAspect
()¶ - Returns the values of the current default attributes.
Parameters: - CTXL (Handle_Graphic3d_AspectLine3d &) –
- CTXT (Handle_Graphic3d_AspectText3d &) –
- CTXM (Handle_Graphic3d_AspectMarker3d &) –
- CTXF (Handle_Graphic3d_AspectFillArea3d &) –
Return type:
-
ReCompute
()¶ - Forces a new construction of the structure <AStructure> if <AStructure> is displayed and TOS_COMPUTED.
Parameters: AStructure (Handle_Graphic3d_Structure &) – Return type: void - 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: void
-
RecomputeStructures
()¶ Return type: None - Recomputes all structures from theStructures.
Parameters: theStructures (Graphic3d_MapOfStructure &) – Return type: None
-
RegisterObject
()¶ Parameters: theObject (Handle_Standard_Transient &) – Return type: Handle_Graphic3d_ViewAffinity
-
RemoveZLayer
()¶ - Remove Z layer with ID <theLayerId>. Method returns Standard_False if the layer can not be removed or doesn’t exists. By default, there is always a default bottom-level layer that can’t be removed.
Parameters: theLayerId (Graphic3d_ZLayerId) – Return type: bool
-
SetPrimitivesAspect
()¶ - Modifies the default attributes for lines in the visualiser.
Parameters: CTX (Handle_Graphic3d_AspectLine3d &) – Return type: None - Modifies the default attributes for faces in the visualiser.
Parameters: CTX (Handle_Graphic3d_AspectFillArea3d &) – Return type: None - Modifies the default attributes for text in the visualiser.
Parameters: CTX (Handle_Graphic3d_AspectText3d &) – Return type: None - Modifies the default attributes for markers in the visualiser.
Parameters: CTX (Handle_Graphic3d_AspectMarker3d &) – Return type: None
-
SetTransform
()¶ - Transforms the structure <AStructure>.
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- ATrsf (TColStd_Array2OfReal &) –
Return type: void
-
SetUpdateMode
()¶ - Modifies the screen update mode. //! TOU_ASAP as soon as possible TOU_WAIT on demand (with the Update function) Note : Dynamic Operations and Update Mode Use SetUpdateMode to control when changes to the display are made. Use one of the following functions to update one or more views: - Update all views of the viewer: Visual3d_ViewManager::Update () - Update one view of the viewer: Visual3d_View::Update () Use one of the following functions to update the entire display: - Redraw all structures in all views: Visual3d_ViewManager::Redraw () - Redraw all structures in one view: Visual3d_View::Redraw () Update)
Parameters: AType (Aspect_TypeOfUpdate) – Return type: None
-
SetZLayerSettings
()¶ - Sets the settings for a single Z layer for all managed views.
Parameters: - theLayerId (Graphic3d_ZLayerId) –
- theSettings (Graphic3d_ZLayerSettings &) –
Return type: void
-
Text3dAspect
()¶ - Returns the values of the current default attributes.
Return type: Handle_Graphic3d_AspectText3d
-
UnHighlight
()¶ - Suppresses the highlighting on all the structures in <self>.
Return type: void - Suppress the highlighting on the structure <AStructure>.
Parameters: AStructure (Handle_Graphic3d_Structure &) – Return type: void
-
Update
()¶ - Updates screen in function of modifications of the structures. Warning: Not necessary if the update mode is TOU_ASAP.
Return type: void
-
UpdateMode
()¶ - Returns the screen update mode. //! TOU_ASAP as soon as possible TOU_WAIT on demand (Update)
Return type: Aspect_TypeOfUpdate
-
ZLayerSettings
()¶ - Returns the settings of a single Z layer.
Parameters: theLayerId (Graphic3d_ZLayerId) – Return type: Graphic3d_ZLayerSettings
-
thisown
¶ The membership flag
-
-
Graphic3d_Structure_AcceptConnection
()¶ - Returns Standard_True if the connection is possible between <AStructure1> and <AStructure2> without a creation of a cycle. //! It’s not possible to call the method AStructure1->Connect (AStructure2, TypeOfConnection) if - the set of all ancestors of <AStructure1> contains <AStructure1> and if the TypeOfConnection == TOC_DESCENDANT - the set of all descendants of <AStructure1> contains <AStructure2> and if the TypeOfConnection == TOC_ANCESTOR
Parameters: - AStructure1 (Handle_Graphic3d_Structure &) –
- AStructure2 (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
Return type:
-
Graphic3d_Structure_Network
()¶ - Returns <ASet> the group of structures : - directly or indirectly connected to <AStructure> if the TypeOfConnection == TOC_DESCENDANT - to which <AStructure> is directly or indirectly connected if the TypeOfConnection == TOC_ANCESTOR
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
- ASet (Graphic3d_MapOfStructure &) –
Return type: void
-
Graphic3d_Structure_PrintNetwork
()¶ - Prints informations about the network associated with the structure <AStructure>.
Parameters: - AStructure (Handle_Graphic3d_Structure &) –
- AType (Graphic3d_TypeOfConnection) –
Return type: void
-
Graphic3d_Structure_Transforms
(*args) → OCC.Graphic3d.Graphic3d_Vertex¶ - Transforms <X>, <Y>, <Z> with the transformation <ATrsf>.
Parameters: Return type: void
- Transforms <Coord> with the transformation <ATrsf>.
Parameters: - ATrsf (TColStd_Array2OfReal &) –
- Coord (Graphic3d_Vector &) –
Return type: - Transforms <Coord> with the transformation <ATrsf>.
Parameters: - ATrsf (TColStd_Array2OfReal &) –
- Coord (Graphic3d_Vertex &) –
Return type:
-
class
Graphic3d_Texture1D
(*args, **kwargs)¶ Bases:
OCC.Graphic3d.Graphic3d_TextureMap
-
GetHandle
()¶
-
Name
()¶ - Returns the name of the predefined textures or NOT_1D_UNKNOWN when the name is given as a filename.
Return type: Graphic3d_NameOfTexture1D
-
static
TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: aRank (int) – Return type: TCollection_AsciiString
-
thisown
¶ The membership flag
-
-
Graphic3d_Texture1D_TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: aRank (int) – Return type: TCollection_AsciiString
-
class
Graphic3d_Texture1Dmanual
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_Texture1D
- Creates a texture from the file FileName.
Parameters: theFileName (TCollection_AsciiString &) – Return type: None - Create a texture from a predefined texture name set.
Parameters: theNOT (Graphic3d_NameOfTexture1D) – Return type: None - Creates a texture from the pixmap.
Parameters: thePixMap (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_Texture1Dsegment
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_Texture1D
- Creates a texture from a file
Parameters: theFileName (TCollection_AsciiString &) – Return type: None - Creates a texture from a predefined texture name set.
Parameters: theNOT (Graphic3d_NameOfTexture1D) – Return type: None - Creates a texture from the pixmap.
Parameters: thePixMap (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
Segment
()¶ - Returns the values of the current segment X1, Y1, Z1 , X2, Y2, Z2.
Parameters: - theX1 (Standard_ShortReal &) –
- theY1 (Standard_ShortReal &) –
- theZ1 (Standard_ShortReal &) –
- theX2 (Standard_ShortReal &) –
- theY2 (Standard_ShortReal &) –
- theZ2 (Standard_ShortReal &) –
Return type:
-
SetSegment
()¶ - Sets the texture application bounds. Defines the way the texture is stretched across facets. Default values are <0.0, 0.0, 0.0> , <0.0, 0.0, 1.0>
Parameters: - theX1 (Standard_ShortReal) –
- theY1 (Standard_ShortReal) –
- theZ1 (Standard_ShortReal) –
- theX2 (Standard_ShortReal) –
- theY2 (Standard_ShortReal) –
- theZ2 (Standard_ShortReal) –
Return type:
-
thisown
¶ The membership flag
-
class
Graphic3d_Texture2D
(*args, **kwargs)¶ Bases:
OCC.Graphic3d.Graphic3d_TextureMap
-
GetHandle
()¶
-
Name
()¶ - Returns the name of the predefined textures or NOT_2D_UNKNOWN when the name is given as a filename.
Return type: Graphic3d_NameOfTexture2D
-
static
TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: theRank (int) – Return type: TCollection_AsciiString
-
thisown
¶ The membership flag
-
-
Graphic3d_Texture2D_TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: theRank (int) – Return type: TCollection_AsciiString
-
class
Graphic3d_Texture2Dmanual
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_Texture2D
- Creates a texture from a file
Parameters: theFileName (TCollection_AsciiString &) – Return type: None - Creates a texture from a predefined texture name set.
Parameters: theNOT (Graphic3d_NameOfTexture2D) – Return type: None - Creates a texture from the pixmap.
Parameters: thePixMap (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
thisown
¶ The membership flag
-
class
Graphic3d_Texture2Dplane
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_Texture2D
- Creates a texture from a file
Parameters: theFileName (TCollection_AsciiString &) – Return type: None - Creates a texture from a predefined texture name set.
Parameters: theNOT (Graphic3d_NameOfTexture2D) – Return type: None - Creates a texture from the pixmap.
Parameters: thePixMap (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
Plane
()¶ - Returns the current texture plane name or NOTP_UNKNOWN when the plane is user defined.
Return type: Graphic3d_NameOfTexturePlane
-
PlaneS
()¶ - Returns the current texture plane S equation
Parameters: - A (Standard_ShortReal &) –
- B (Standard_ShortReal &) –
- C (Standard_ShortReal &) –
- D (Standard_ShortReal &) –
Return type:
-
PlaneT
()¶ - Returns the current texture plane T equation
Parameters: - A (Standard_ShortReal &) –
- B (Standard_ShortReal &) –
- C (Standard_ShortReal &) –
- D (Standard_ShortReal &) –
Return type:
-
Rotation
()¶ - Returns the current texture rotation angle
Parameters: theVal (Standard_ShortReal &) – Return type: None
-
ScaleS
()¶ - Returns the current texture S scale value
Parameters: theVal (Standard_ShortReal &) – Return type: None
-
ScaleT
()¶ - Returns the current texture T scale value
Parameters: theVal (Standard_ShortReal &) – Return type: None
-
SetPlane
()¶ - Defines the texture projection plane for both S and T texture coordinate default is NOTP_XY meaning: <1.0, 0.0, 0.0, 0.0> for S and <0.0, 1.0, 0.0, 0.0> for T
Parameters: thePlane (Graphic3d_NameOfTexturePlane) – Return type: None
-
SetPlaneS
()¶ - Defines the texture projection plane for texture coordinate S default is <1.0, 0.0, 0.0, 0.0>
Parameters: - A (Standard_ShortReal) –
- B (Standard_ShortReal) –
- C (Standard_ShortReal) –
- D (Standard_ShortReal) –
Return type:
-
SetPlaneT
()¶ - Defines the texture projection plane for texture coordinate T default is <0.0, 1.0, 0.0, 0.0>
Parameters: - A (Standard_ShortReal) –
- B (Standard_ShortReal) –
- C (Standard_ShortReal) –
- D (Standard_ShortReal) –
Return type:
-
SetRotation
()¶ - Sets the rotation angle of the whole texture. the same result might be achieved by recomputing the S and T plane equation but it’s not the easiest way… the angle is expressed in degrees default is 0.0
Parameters: theVal (Standard_ShortReal) – Return type: None
-
SetScaleS
()¶ - Defines the texture scale for the S texture coordinate much easier than recomputing the S plane equation but the result is the same default to 1.0
Parameters: theVal (Standard_ShortReal) – Return type: None
-
SetScaleT
()¶ - Defines the texture scale for the T texture coordinate much easier than recompution the T plane equation but the result is the same default to 1.0
Parameters: theVal (Standard_ShortReal) – Return type: None
-
SetTranslateS
()¶ - Defines the texture translation for the S texture coordinate you can obtain the same effect by modifying the S plane equation but its not easier. default to 0.0
Parameters: theVal (Standard_ShortReal) – Return type: None
-
SetTranslateT
()¶ - Defines the texture translation for the T texture coordinate you can obtain the same effect by modifying the T plane equation but its not easier. default to 0.0
Parameters: theVal (Standard_ShortReal) – Return type: None
-
TranslateS
()¶ - Returns the current texture S translation value
Parameters: theVal (Standard_ShortReal &) – Return type: None
-
TranslateT
()¶ - Returns the current texture T translation value
Parameters: theVal (Standard_ShortReal &) – Return type: None
-
thisown
¶ The membership flag
-
class
Graphic3d_TextureEnv
(*args)¶ Bases:
OCC.Graphic3d.Graphic3d_TextureRoot
- Creates an environment texture from a file.
Parameters: theFileName (TCollection_AsciiString &) – Return type: None - Creates an environment texture from a predefined texture name set.
Parameters: theName (Graphic3d_NameOfTextureEnv) – Return type: None - Creates an environment texture from the pixmap.
Parameters: thePixMap (Image_PixMap_Handle &) – Return type: None -
GetHandle
()¶
-
Name
()¶ - Returns the name of the predefined textures or NOT_ENV_UNKNOWN when the name is given as a filename.
Return type: Graphic3d_NameOfTextureEnv
-
static
TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: theRank (int) – Return type: TCollection_AsciiString
-
thisown
¶ The membership flag
-
Graphic3d_TextureEnv_TextureName
()¶ - Returns the name of the predefined texture of rank <aRank>
Parameters: theRank (int) – Return type: TCollection_AsciiString
-
class
Graphic3d_TextureMap
(*args, **kwargs)¶ Bases:
OCC.Graphic3d.Graphic3d_TextureRoot
-
AnisoFilter
()¶ - returns level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.
Return type: Graphic3d_LevelOfTextureAnisotropy
-
DisableModulate
()¶ - disable texture modulate mode. the image is directly decal on the surface.
Return type: None
-
DisableRepeat
()¶ - use this methods if you want to disable texture repetition on your objects.
Return type: None
-
EnableModulate
()¶ - enable texture modulate mode. the image is modulate with the shading of the surface.
Return type: None
-
EnableRepeat
()¶ - use this methods if you want to enable texture repetition on your objects.
Return type: None
-
GetHandle
()¶
-
SetAnisoFilter
()¶ - @param theLevel level of anisontropy texture filter.
Parameters: theLevel (Graphic3d_LevelOfTextureAnisotropy) – Return type: None
-
thisown
¶ The membership flag
-
-
class
Graphic3d_TextureParams
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Default constructor.
Return type: None -
AnisoFilter
()¶ - returns level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.
Return type: Graphic3d_LevelOfTextureAnisotropy
-
Filter
()¶ - returns texture interpolation filter. Default value is Graphic3d_TOTF_NEAREST.
Return type: Graphic3d_TypeOfTextureFilter
-
GenMode
()¶ - returns texture coordinates generation mode. Default value is Graphic3d_TOTM_MANUAL.
Return type: Graphic3d_TypeOfTextureMode
-
GenPlaneS
()¶ - returns texture coordinates generation plane S.
Return type: Graphic3d_Vec4
-
GenPlaneT
()¶ - returns texture coordinates generation plane T.
Return type: Graphic3d_Vec4
-
GetHandle
()¶
-
Rotation
()¶ - returns rotation angle in degrees Default value is 0.
Return type: Standard_ShortReal
-
Scale
()¶ - returns scale factor Default value is no scaling (1.0; 1.0).
Return type: Graphic3d_Vec2
-
SetAnisoFilter
()¶ - @param theLevel level of anisontropy texture filter.
Parameters: theLevel (Graphic3d_LevelOfTextureAnisotropy) – Return type: None
-
SetFilter
()¶ - @param theFilter texture interpolation filter.
Parameters: theFilter (Graphic3d_TypeOfTextureFilter) – Return type: None
-
SetGenMode
()¶ - Setup texture coordinates generation mode.
Parameters: - theMode (Graphic3d_TypeOfTextureMode) –
- thePlaneS (Graphic3d_Vec4) –
- thePlaneT (Graphic3d_Vec4) –
Return type:
-
SetModulate
()¶ - @param theToModulate turn modulation on/off.
Parameters: theToModulate (bool) – Return type: None
-
SetRepeat
()¶ - @param theToRepeat turn texture repeat mode ON or OFF (clamping).
Parameters: theToRepeat (bool) – Return type: None
-
SetRotation
()¶ - @param theAngleDegrees rotation angle.
Parameters: theAngleDegrees (Standard_ShortReal) – Return type: None
-
SetTranslation
()¶ - @param theVec translation vector.
Parameters: theVec (Graphic3d_Vec2) – Return type: None
-
Translation
()¶ - returns translation vector Default value is no translation (0.0; 0.0).
Return type: Graphic3d_Vec2
-
thisown
¶ The membership flag
-
class
Graphic3d_TextureRoot
(*args, **kwargs)¶ Bases:
OCC.MMgt.MMgt_TShared
-
GetHandle
()¶
-
GetId
()¶ - This ID will be used to manage resource in graphic driver. //! Default implementation generates unique ID although inheritors may re-initialize it. //! Multiple Graphic3d_TextureRoot instancies with same ID will be treated as single texture with different parameters to optimize memory usage though this will be more natural to use same instance of Graphic3d_TextureRoot when possible. //! Notice that inheritor may set this ID to empty string. In this case independent graphical resource will be created for each instance of Graphic3d_AspectFillArea3d where texture will be used. //! returns texture identifier.
Return type: TCollection_AsciiString
-
GetImage
()¶ - This method will be called by graphic driver each time when texture resource should be created. Default constructors allow defining the texture source as path to texture image or directly as pixmap. If the source is defined as path, then the image will be dynamically loaded when this method is called (and no copy will be preserved in this class instance). Inheritors may dynamically generate the image. Notice, image data should be in Bottom-Up order (see Image_PixMap::IsTopDown())! returns the image for texture.
Return type: Image_PixMap_Handle
-
GetParams
()¶ - returns low-level texture parameters
Return type: Handle_Graphic3d_TextureParams
-
IsDone
()¶ - Checks if a texture class is valid or not. returns true if the construction of the class is correct
Return type: bool
-
Path
()¶ - Returns the full path of the defined texture. It could be empty path if GetImage() is overridden to load image not from file.
Return type: OSD_Path
-
static
TexturesFolder
()¶ - The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. returns the root folder with default textures.
Return type: TCollection_AsciiString
-
Type
()¶ - returns the texture type.
Return type: Graphic3d_TypeOfTexture
-
thisown
¶ The membership flag
-
-
Graphic3d_TextureRoot_TexturesFolder
()¶ - The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. returns the root folder with default textures.
Return type: TCollection_AsciiString
-
class
Graphic3d_ValueInterface
(*args, **kwargs)¶ Bases:
object
-
TypeID
()¶ - Returns unique identifier of value type.
Return type: Standard_Size
-
thisown
¶ The membership flag
-
-
class
Graphic3d_Vector
(*args)¶ Bases:
object
- Creates a vector with 1.0, 0.0, 0.0 coordinates.
Return type: None - Creates a vector with <AX>, <AY>, <AZ> coordinates.
Parameters: Return type: - Creates a vector from 2 points <APoint1> and <APoint2>.
Parameters: - APoint1 (Graphic3d_Vertex &) –
- APoint2 (Graphic3d_Vertex &) –
Return type: -
Coord
()¶ - Returns the coordinates of the vector <self>.
Parameters: - AX (float &) –
- AY (float &) –
- AZ (float &) –
Return type:
-
static
IsParallel
()¶ - Returns Standard_True if the vector <AV1> and <AV2> are parallel.
Parameters: - AV1 (Graphic3d_Vector &) –
- AV2 (Graphic3d_Vector &) –
Return type:
-
Normalize
()¶ - Normalises <self>. Category: Methods to modify the class definition Warning: Raises VectorError if <self> is null.
Return type: None
-
static
NormeOf
()¶ - Returns the norm of the vector <AX>, <AY>, <AZ>.
Parameters: Return type: - Returns the norm of the vector <AVector>.
Parameters: AVector (Graphic3d_Vector &) – Return type: float
-
SetCoord
()¶ - Modifies the coordinates of the vector <self>.
Parameters: Return type:
-
SetXCoord
()¶ - Modifies the X coordinate of the vector <self>.
Parameters: Xnew (float) – Return type: None
-
SetYCoord
()¶ - Modifies the Y coordinate of the vector <self>.
Parameters: Ynew (float) – Return type: None
-
SetZCoord
()¶ - Modifies the Z coordinate of the vector <self>.
Parameters: Znew (float) – Return type: None
-
thisown
¶ The membership flag
-
Graphic3d_Vector_IsParallel
()¶ - Returns Standard_True if the vector <AV1> and <AV2> are parallel.
Parameters: - AV1 (Graphic3d_Vector &) –
- AV2 (Graphic3d_Vector &) –
Return type:
-
Graphic3d_Vector_NormeOf
()¶ - Returns the norm of the vector <AX>, <AY>, <AZ>.
Parameters: Return type: - Returns the norm of the vector <AVector>.
Parameters: AVector (Graphic3d_Vector &) – Return type: float
-
class
Graphic3d_Vertex
(*args)¶ Bases:
object
- Creates a point with 0.0, 0.0, 0.0 coordinates.
Return type: None - Creates a point with coordinates identical to thePoint.
Parameters: thePoint (Graphic3d_Vertex &) – Return type: None - Creates a point with theX, theY and theZ coordinates.
Parameters: - theX (Standard_ShortReal) –
- theY (Standard_ShortReal) –
- theZ (Standard_ShortReal) –
Return type: - Creates a point with theX, theY and theZ coordinates.
Parameters: Return type: -
Coord
()¶ - Returns the coordinates.
Parameters: - theX (Standard_ShortReal &) –
- theY (Standard_ShortReal &) –
- theZ (Standard_ShortReal &) –
Return type: - Returns the coordinates.
Parameters: - theX (float &) –
- theY (float &) –
- theZ (float &) –
Return type:
-
Distance
()¶ - Returns the distance between two points.
Parameters: theOther (Graphic3d_Vertex &) – Return type: Standard_ShortReal
-
SetCoord
()¶ - Modifies the coordinates.
Parameters: - theX (Standard_ShortReal) –
- theY (Standard_ShortReal) –
- theZ (Standard_ShortReal) –
Return type: - Modifies the coordinates.
Parameters: Return type:
-
X
()¶ - Returns the X coordinates.
Return type: Standard_ShortReal
-
Y
()¶ - Returns the Y coordinate.
Return type: Standard_ShortReal
-
Z
()¶ - Returns the Z coordinate.
Return type: Standard_ShortReal
-
thisown
¶ The membership flag
-
class
Graphic3d_ViewAffinity
(*args)¶ Bases:
OCC.Standard.Standard_Transient
- Empty constructor.
Return type: None -
GetHandle
()¶
-
SetVisible
()¶ - Setup visibility flag.
Parameters: Return type:
-
thisown
¶ The membership flag
-
class
Graphic3d_ZLayerSettings
(*args)¶ Bases:
object
- Default settings.
Return type: None -
DepthOffsetFactor
¶
-
DepthOffsetUnits
¶
-
DisableSetting
()¶ - Disables theSetting
Parameters: theSetting (Graphic3d_ZLayerSetting) – Return type: None
-
EnableSetting
()¶ - Enables theSetting
Parameters: theSetting (Graphic3d_ZLayerSetting) – Return type: None
-
Flags
¶
-
IsImmediate
¶
-
IsSettingEnabled
()¶ - Returns true if theSetting is enabled.
Parameters: theSetting (Graphic3d_ZLayerSetting) – Return type: bool
-
SetDepthOffsetNegative
()¶ - Sets minimal possible negative depth offset. Access DepthOffsetFactor and DepthOffsetUnits values for manual offset control.
Return type: None
-
SetDepthOffsetPositive
()¶ - Sets minimal possible positive depth offset. Access DepthOffsetFactor and DepthOffsetUnits values for manual offset control.
Return type: None
-
thisown
¶ The membership flag
-
class
Handle_Graphic3d_ArrayOfPoints
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfPolygons
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfPolylines
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfPrimitives
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfQuadrangleStrips
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfQuadrangles
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfSegments
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfTriangleFans
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfTriangleStrips
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ArrayOfTriangles
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_ArrayOfPrimitives
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_AspectFillArea3d
(*args)¶ Bases:
OCC.Aspect.Handle_Aspect_AspectFillArea
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_AspectLine3d
(*args)¶ Bases:
OCC.Aspect.Handle_Aspect_AspectLine
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_AspectMarker3d
(*args)¶ Bases:
OCC.Aspect.Handle_Aspect_AspectMarker
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_AspectText3d
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_BoundBuffer
(*args)¶ Bases:
object
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_CStructure
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Camera
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ClipPlane
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_DataStructureManager
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_GraphicDriver
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Group
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_HSequenceOfStructure
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ListNodeOfListOfShortReal
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_MarkerImage
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_SequenceNodeOfSequenceOfStructure
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_SeqNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ShaderObject
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ShaderProgram
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ShaderVariable
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Structure
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_StructureManager
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture1D
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_TextureMap
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture1Dmanual
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_Texture1D
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture1Dsegment
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_Texture1D
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture2D
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_TextureMap
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture2Dmanual
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_Texture2D
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_Texture2Dplane
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_Texture2D
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_TextureEnv
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_TextureRoot
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_TextureMap
(*args)¶ Bases:
OCC.Graphic3d.Handle_Graphic3d_TextureRoot
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_TextureParams
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_TextureRoot
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_Graphic3d_ViewAffinity
(*args)¶ Bases:
OCC.Standard.Handle_Standard_Transient
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
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