OCC.Core.Graphic3d module¶

Graphic3d module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_graphic3d.html

class Graphic3d_Array1OfAttribute(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfIndexedMapOfStructure(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfPoints(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of points (Graphic3d_TOPA_POINTS). The array must be filled using the AddVertex(Point) method. @param theMaxVertexs maximum number of points @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of points (Graphic3d_TOPA_POINTS). The array must be filled using the AddVertex(Point) method. @param theMaxVertexs maximum number of points @param theHasVColors when True, AddVertex(Point,Color) should be used for specifying vertex color @param theHasVNormals when True, AddVertex(Point,Normal) should be used for specifying vertex normal

param theMaxVertexs

type theMaxVertexs

int

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfPolygons(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of polygons (Graphic3d_TOPA_POLYGONS), a polygon can be filled as: 1) Creating a single polygon defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfPolygons (7); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x7, y7, z7); @endcode 2) Creating separate polygons defined with a predefined number of bounds and the number of vertex per bound, i.e: @code 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); @endcode 3) Creating a single indexed polygon defined with his vertex ans edges, i.e: @code 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); @endcode 4) Creating separate polygons defined with a predefined number of bounds and the number of edges per bound, i.e: @code 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); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxBounds defines the maximum allowed bound number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxBounds

type theMaxBounds

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of polygons (Graphic3d_TOPA_POLYGONS): @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxBounds defines the maximum allowed bound number in the array @param theMaxEdges defines the maximum allowed edge number in the array

param theMaxVertexs

type theMaxVertexs

int

param theMaxBounds

default value is 0

type theMaxBounds

int

param theMaxEdges

default value is 0

type theMaxEdges

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasBColors

default value is Standard_False

type theHasBColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfPolylines(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of polylines (Graphic3d_TOPA_POLYLINES), a polyline can be filled as: 1) Creating a single polyline defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfPolylines (7); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x7, y7, z7); @endcode 2) Creating separate polylines defined with a predefined number of bounds and the number of vertex per bound, i.e: @code 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); @endcode 3) Creating a single indexed polyline defined with his vertex and edges, i.e: @code 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); @endcode 4) creating separate polylines defined with a predefined number of bounds and the number of edges per bound, i.e: @code 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); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxBounds defines the maximum allowed bound number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxBounds

type theMaxBounds

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of polylines (Graphic3d_TOPA_POLYLINES). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxBounds defines the maximum allowed bound number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theHasVColors when True AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify per-vertex color values @param theHasBColors when True AddBound(number,Color) should be used to specify sub-group color

param theMaxVertexs

type theMaxVertexs

int

param theMaxBounds

default value is 0

type theMaxBounds

int

param theMaxEdges

default value is 0

type theMaxEdges

int

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasBColors

default value is Standard_False

type theHasBColors

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfPrimitives(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

AddBound()¶

Adds a bound of length theEdgeNumber in the bound array returns the actual bounds number

param theEdgeNumber

type theEdgeNumber

int

rtype

int* Adds a bound of length theEdgeNumber and bound color theBColor in the bound array. Warning: theBColor is ignored when the hasBColors constructor parameter is False returns the actual bounds number

param theEdgeNumber

type theEdgeNumber

int

param theBColor

type theBColor

Quantity_Color

rtype

int* Adds a bound of length theEdgeNumber and bound color coordinates in the bound array. Warning: <theR,theG,theB> are ignored when the hasBColors constructor parameter is False returns the actual bounds number

param theEdgeNumber

type theEdgeNumber

int

param theR

type theR

float

param theG

type theG

float

param theB

type theB

float

rtype

int

AddEdge()¶

Adds an edge in the range [1,VertexNumber()] in the array. returns the actual edges number

param theVertexIndex

type theVertexIndex

int

rtype

int

AddEdges()¶

Convenience method, adds two vertex indices (a segment) in the range [1,VertexNumber()] in the array. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

rtype

int* Convenience method, adds three vertex indices (a triangle) in the range [1,VertexNumber()] in the array. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

param theVertexIndex3

type theVertexIndex3

int

rtype

int* Convenience method, adds four vertex indices (a quad) in the range [1,VertexNumber()] in the array. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

param theVertexIndex3

type theVertexIndex3

int

param theVertexIndex4

type theVertexIndex4

int

rtype

int

AddPolylineEdges()¶

Add line strip (polyline) into indexed segments array. N-1 segments are added from N input nodes (or N with closed flag). Raises exception if array is not of type Graphic3d_TOPA_SEGMENTS. @param theVertexLower [in] index of first node defining line strip fun (center) @param theVertexUpper [in] index of last node defining triangle fun @param theToClose [in] close triangle fan (connect first and last points)

param theVertexLower

type theVertexLower

int

param theVertexUpper

type theVertexUpper

int

param theToClose

type theToClose

bool

rtype

None

AddQuadEdges()¶

Convenience method, adds four vertex indices (a quad) in the range [1,VertexNumber()] in the array of quads. Raises exception if array is not of type Graphic3d_TOPA_QUADRANGLES. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

param theVertexIndex3

type theVertexIndex3

int

param theVertexIndex4

type theVertexIndex4

int

rtype

int

AddQuadTriangleEdges()¶

Convenience method, adds quad indices in the range [1,VertexNumber()] into array or triangles as two triangles. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

param theVertexIndex3

type theVertexIndex3

int

param theVertexIndex4

type theVertexIndex4

int

rtype

int* Convenience method, adds quad indices in the range [1,VertexNumber()] into array or triangles as two triangles. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. returns the actual edges number

param theIndexes

type theIndexes

Graphic3d_Vec4i

rtype

int

AddSegmentEdges()¶

Convenience method, adds two vertex indices (a segment) in the range [1,VertexNumber()] in the array of segments (Graphic3d_TOPA_SEGMENTS). Raises exception if array is not of type Graphic3d_TOPA_SEGMENTS. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

rtype

int

AddTriangleEdges()¶

Convenience method, adds three vertex indices of triangle in the range [1,VertexNumber()] in the array of triangles. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. returns the actual edges number

param theVertexIndex1

type theVertexIndex1

int

param theVertexIndex2

type theVertexIndex2

int

param theVertexIndex3

type theVertexIndex3

int

rtype

int* Convenience method, adds three vertex indices of triangle in the range [1,VertexNumber()] in the array of triangles. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. returns the actual edges number

param theIndexes

type theIndexes

Graphic3d_Vec3i

rtype

int* Convenience method, adds three vertex indices (4th component is ignored) of triangle in the range [1,VertexNumber()] in the array of triangles. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. returns the actual edges number

param theIndexes

type theIndexes

Graphic3d_Vec4i

rtype

int

AddTriangleFanEdges()¶

Add triangle fan into indexed triangulation array. N-2 triangles are added from N input nodes (or N-1 with closed flag). Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. @param theVertexLower [in] index of first node defining triangle fun (center) @param theVertexUpper [in] index of last node defining triangle fun @param theToClose [in] close triangle fan (connect first and last points)

param theVertexLower

type theVertexLower

int

param theVertexUpper

type theVertexUpper

int

param theToClose

type theToClose

bool

rtype

None

AddTriangleStripEdges()¶

Add triangle strip into indexed triangulation array. N-2 triangles are added from N input nodes. Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. @param theVertexLower [in] index of first node defining triangle strip @param theVertexUpper [in] index of last node defining triangle strip

param theVertexLower

type theVertexLower

int

param theVertexUpper

type theVertexUpper

int

rtype

None

AddVertex()¶

Adds a vertice in the array. returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

rtype

int* Adds a vertice in the array. returns the actual vertex number

param theVertex

type theVertex

Graphic3d_Vec3

rtype

int* Adds a vertice in the array. returns the actual vertex number

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

int* Adds a vertice in the array. returns the actual vertex number.

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

rtype

int* Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is False returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theColor

type theColor

Quantity_Color

rtype

int* Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is False @code theColor32 = Alpha << 24 + Blue << 16 + Green << 8 + Red @endcode returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theColor32

type theColor32

int

rtype

int* Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is False returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theColor

type theColor

Graphic3d_Vec4ub

rtype

int* Adds a vertice and vertex normal in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is False. returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theNormal

type theNormal

gp_Dir

rtype

int* Adds a vertice and vertex normal in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is False. returns the actual vertex number

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

param theNX

type theNX

float

param theNY

type theNY

float

param theNZ

type theNZ

float

rtype

int* Adds a vertice and vertex normal in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is False. returns the actual vertex number

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

param theNX

type theNX

Standard_ShortReal

param theNY

type theNY

Standard_ShortReal

param theNZ

type theNZ

Standard_ShortReal

rtype

int* Adds a vertice,vertex normal and color in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is False and theColor is ignored when the hasVColors constructor parameter is False. returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theNormal

type theNormal

gp_Dir

param theColor

type theColor

Quantity_Color

rtype

int* Adds a vertice,vertex normal and color in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is False and theColor is ignored when the hasVColors constructor parameter is False. @code theColor32 = Alpha << 24 + Blue << 16 + Green << 8 + Red @endcode returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theNormal

type theNormal

gp_Dir

param theColor32

type theColor32

int

rtype

int* Adds a vertice and vertex texture in the vertex array. theTexel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theTexel

type theTexel

gp_Pnt2d

rtype

int* Adds a vertice and vertex texture coordinates in the vertex array. Texel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

param theTX

type theTX

float

param theTY

type theTY

float

rtype

int* Adds a vertice and vertex texture coordinates in the vertex array. Texel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

param theTX

type theTX

Standard_ShortReal

param theTY

type theTY

Standard_ShortReal

rtype

int* Adds a vertice,vertex normal and texture in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is False and theTexel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theVertex

type theVertex

gp_Pnt

param theNormal

type theNormal

gp_Dir

param theTexel

type theTexel

gp_Pnt2d

rtype

int* Adds a vertice,vertex normal and texture in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is False and Texel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

param theNX

type theNX

float

param theNY

type theNY

float

param theNZ

type theNZ

float

param theTX

type theTX

float

param theTY

type theTY

float

rtype

int* Adds a vertice,vertex normal and texture in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is False and Texel is ignored when the hasVTexels constructor parameter is False. returns the actual vertex number

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

param theNX

type theNX

Standard_ShortReal

param theNY

type theNY

Standard_ShortReal

param theNZ

type theNZ

Standard_ShortReal

param theTX

type theTX

Standard_ShortReal

param theTY

type theTY

Standard_ShortReal

rtype

int

Attributes()¶

Returns vertex attributes buffer (colors, normals, texture coordinates).

rtype

opencascade::handle<Graphic3d_Buffer>

Bound()¶

Returns the edge number at rank theRank.

param theRank

type theRank

int

rtype

int

BoundColor()¶

Returns the bound color at rank theRank from the bound table if defined.

param theRank

type theRank

int

rtype

Quantity_Color* Returns the bound color values at rank theRank from the bound table if defined.

param theRank

type theRank

int

param theR

type theR

float

param theG

type theG

float

param theB

type theB

float

rtype

None

BoundNumber()¶

Returns the number of defined bounds

rtype

int

BoundNumberAllocated()¶

Returns the number of allocated bounds

rtype

int

Bounds()¶

@name optional array of Bounds/Subgroups within primitive array (e.g. restarting primitives / assigning colors) Returns optional bounds buffer.

rtype

opencascade::handle<Graphic3d_BoundBuffer>

static CreateArray()¶

Create an array of specified type.

param theType

type theType

Graphic3d_TypeOfPrimitiveArray

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

opencascade::handle<Graphic3d_ArrayOfPrimitives>* Create an array of specified type.

param theType

type theType

Graphic3d_TypeOfPrimitiveArray

param theMaxVertexs

type theMaxVertexs

int

param theMaxBounds

type theMaxBounds

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

opencascade::handle<Graphic3d_ArrayOfPrimitives>

static DownCast(t)¶

Edge()¶

Returns the vertex index at rank theRank in the range [1,EdgeNumber()]

param theRank

type theRank

int

rtype

int

EdgeNumber()¶

Returns the number of defined edges

rtype

int

EdgeNumberAllocated()¶

Returns the number of allocated edges

rtype

int

HasBoundColors()¶

Returns True when bound colors array is defined.

rtype

bool

HasVertexColors()¶

Returns True when vertex colors array is defined.

rtype

bool

HasVertexNormals()¶

Returns True when vertex normals array is defined.

rtype

bool

HasVertexTexels()¶

Returns True when vertex texels array is defined.

rtype

bool

Indices()¶

@name optional array of Indices/Edges for using shared Vertex data Returns optional index buffer.

rtype

opencascade::handle<Graphic3d_IndexBuffer>

IsValid()¶

Returns True only when the contains of this array is available.

rtype

bool

ItemNumber()¶

Returns the number of total items according to the array type.

rtype

int

SetBoundColor()¶

Change the bound color of rank theIndex in the array.

param theIndex

type theIndex

int

param theColor

type theColor

Quantity_Color

rtype

None* Change the bound color of rank theIndex in the array.

param theIndex

type theIndex

int

param theR

type theR

float

param theG

type theG

float

param theB

type theB

float

rtype

None

SetVertexColor()¶

Change the vertex color of rank theIndex in the array.

param theIndex

type theIndex

int

param theColor

type theColor

Quantity_Color

rtype

None* Change the vertex color of rank theIndex in the array.

param theIndex

type theIndex

int

param theR

type theR

float

param theG

type theG

float

param theB

type theB

float

rtype

None* Change the vertex color of rank theIndex in the array.

param theIndex

type theIndex

int

param theColor

type theColor

Graphic3d_Vec4ub

rtype

None* Change the vertex color of rank theIndex> in the array. @code theColor32 = Alpha << 24 + Blue << 16 + Green << 8 + Red @endcode

param theIndex

type theIndex

int

param theColor32

type theColor32

int

rtype

None

SetVertexNormal()¶

Change the vertex normal of rank theIndex in the array.

param theIndex

type theIndex

int

param theNormal

type theNormal

gp_Dir

rtype

None* Change the vertex normal of rank theIndex in the array.

param theIndex

type theIndex

int

param theNX

type theNX

float

param theNY

type theNY

float

param theNZ

type theNZ

float

rtype

None

SetVertexTexel()¶

Change the vertex texel of rank theIndex in the array.

param theIndex

type theIndex

int

param theTexel

type theTexel

gp_Pnt2d

rtype

None* Change the vertex texel of rank theIndex in the array.

param theIndex

type theIndex

int

param theTX

type theTX

float

param theTY

type theTY

float

rtype

None

SetVertice()¶

Change the vertice of rank theIndex in the array.

param theIndex

type theIndex

int

param theVertex

type theVertex

gp_Pnt

rtype

None* Change the vertice of rank theIndex in the array.

param theIndex

type theIndex

int

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

rtype

None

StringType()¶

Returns the string type of this primitive

rtype

char *

Type()¶

Returns the type of this primitive

rtype

Graphic3d_TypeOfPrimitiveArray

VertexColor()¶

Returns the vertex color at rank theRank from the vertex table if defined.

param theRank

type theRank

int

rtype

Quantity_Color* Returns the vertex color at rank theIndex from the vertex table if defined.

param theIndex

type theIndex

int

param theColor

type theColor

Graphic3d_Vec4ub

rtype

None* Returns the vertex color values at rank theRank from the vertex table if defined.

param theRank

type theRank

int

param theR

type theR

float

param theG

type theG

float

param theB

type theB

float

rtype

None* Returns the vertex color values at rank theRank from the vertex table if defined.

param theRank

type theRank

int

param theColor

type theColor

int

rtype

None

VertexNormal()¶

Returns the vertex normal at rank theRank from the vertex table if defined.

param theRank

type theRank

int

rtype

gp_Dir* Returns the vertex normal coordinates at rank theRank from the vertex table if defined.

param theRank

type theRank

int

param theNX

type theNX

float

param theNY

type theNY

float

param theNZ

type theNZ

float

rtype

None

VertexNumber()¶

Returns the number of defined vertex

rtype

int

VertexNumberAllocated()¶

Returns the number of allocated vertex

rtype

int

VertexTexel()¶

Returns the vertex texture at rank theRank from the vertex table if defined.

param theRank

type theRank

int

rtype

gp_Pnt2d* Returns the vertex texture coordinates at rank theRank from the vertex table if defined.

param theRank

type theRank

int

param theTX

type theTX

float

param theTY

type theTY

float

rtype

None

Vertice()¶

Returns the vertice at rank theRank from the vertex table if defined.

param theRank

type theRank

int

rtype

gp_Pnt* Returns the vertice coordinates at rank theRank from the vertex table if defined.

param theRank

type theRank

int

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

property thisown¶: The membership flag

class Graphic3d_ArrayOfQuadrangleStrips(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of quadrangle strips (Graphic3d_TOPA_QUADRANGLESTRIPS), a polygon can be filled as: 1) Creating a single strip defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfQuadrangleStrips (7); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x7, y7, z7); @endcode 2) Creating separate strips defined with a predefined number of strips and the number of vertex per strip, i.e: @code 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); @endcode The number of quadrangle really drawn is: VertexNumber()/2 - Min(1, BoundNumber()). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxStrips defines the maximum allowed strip number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxStrips

type theMaxStrips

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of quadrangle strips (Graphic3d_TOPA_QUADRANGLESTRIPS). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxStrips defines the maximum allowed strip number in the array

param theMaxVertexs

type theMaxVertexs

int

param theMaxStrips

default value is 0

type theMaxStrips

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasSColors

default value is Standard_False

type theHasSColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfQuadrangles(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of quadrangles (Graphic3d_TOPA_QUADRANGLES), a quadrangle can be filled as: 1) Creating a set of quadrangles defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfQuadrangles (8); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x8, y8, z8); @endcode 2) Creating a set of indexed quadrangles defined with his vertex ans edges, i.e: @code myArray = Graphic3d_ArrayOfQuadrangles (6, 8); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x6, y6, z6); myArray->AddEdges (1, 2, 3, 4); myArray->AddEdges (3, 4, 5, 6); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array (for indexed array) @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of quadrangles (Graphic3d_TOPA_QUADRANGLES). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array (for indexed array)

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

default value is 0

type theMaxEdges

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfSegments(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of segments (Graphic3d_TOPA_SEGMENTS), a segment can be filled as: 1) Creating a set of segments defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfSegments (4); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x4, y4, z4); @endcode 2) Creating a set of indexed segments defined with his vertex and edges, i.e: @code myArray = Graphic3d_ArrayOfSegments (4, 8); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x4, y4, z4); myArray->AddEdges (1, 2); myArray->AddEdges (3, 4); myArray->AddEdges (2, 4); myArray->AddEdges (1, 3); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of segments (Graphic3d_TOPA_SEGMENTS). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theHasVColors when True, AddVertex(Point,Color) should be used for specifying vertex color

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

default value is 0

type theMaxEdges

int

param theHasVColors

default value is Standard_False

type theHasVColors

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfTriangleFans(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of triangle fans (Graphic3d_TOPA_TRIANGLEFANS), a polygon can be filled as: 1) Creating a single fan defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfTriangleFans (7); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x7, y7, z7); @endcode 2) creating separate fans defined with a predefined number of fans and the number of vertex per fan, i.e: @code 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); @endcode The number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber()) @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxFans defines the maximum allowed fan number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxFans

type theMaxFans

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of triangle fans (Graphic3d_TOPA_TRIANGLEFANS). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxFans defines the maximum allowed fan number in the array

param theMaxVertexs

type theMaxVertexs

int

param theMaxFans

default value is 0

type theMaxFans

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasBColors

default value is Standard_False

type theHasBColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfTriangleStrips(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of triangle strips (Graphic3d_TOPA_TRIANGLESTRIPS), a polygon can be filled as: 1) Creating a single strip defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfTriangleStrips (7); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x7, y7, z7); @endcode 2) Creating separate strips defined with a predefined number of strips and the number of vertex per strip, i.e: @code 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); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxStrips defines the maximum allowed strip number in the array; the number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber()) @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxStrips

type theMaxStrips

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of triangle strips (Graphic3d_TOPA_TRIANGLESTRIPS). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxStrips defines the maximum allowed strip number in the array; the number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber()) @param theHasVNormals when True, AddVertex(Point,Normal), AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) should be used to specify vertex normal; vertex normals should be specified coherent to triangle orientation (defined by order of vertexes within triangle) for proper rendering @param theHasVColors when True, AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify vertex color @param theHasBColors when True, AddBound(number,Color) should be used to specify sub-group color @param theHasVTexels when True, AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) should be used to specify vertex UV coordinates

param theMaxVertexs

type theMaxVertexs

int

param theMaxStrips

default value is 0

type theMaxStrips

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasBColors

default value is Standard_False

type theHasBColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_ArrayOfTriangles(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_ArrayOfPrimitives

Creates an array of triangles (Graphic3d_TOPA_TRIANGLES), a triangle can be filled as: 1) Creating a set of triangles defined with his vertexes, i.e: @code myArray = Graphic3d_ArrayOfTriangles (6); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x6, y6, z6); @endcode 3) Creating a set of indexed triangles defined with his vertex and edges, i.e: @code myArray = Graphic3d_ArrayOfTriangles (4, 6); myArray->AddVertex (x1, y1, z1); …. myArray->AddVertex (x4, y4, z4); myArray->AddEdges (1, 2, 3); myArray->AddEdges (2, 3, 4); @endcode @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theArrayFlags array flags

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

type theMaxEdges

int

param theArrayFlags

type theArrayFlags

int

rtype

None* Creates an array of triangles (Graphic3d_TOPA_TRIANGLES). @param theMaxVertexs defines the maximum allowed vertex number in the array @param theMaxEdges defines the maximum allowed edge number in the array @param theHasVNormals when True, AddVertex(Point,Normal), AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) should be used to specify vertex normal; vertex normals should be specified coherent to triangle orientation (defined by order of vertexes within triangle) for proper rendering @param theHasVColors when True, AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify vertex color @param theHasVTexels when True, AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) should be used to specify vertex UV coordinates

param theMaxVertexs

type theMaxVertexs

int

param theMaxEdges

default value is 0

type theMaxEdges

int

param theHasVNormals

default value is Standard_False

type theHasVNormals

bool

param theHasVColors

default value is Standard_False

type theHasVColors

bool

param theHasVTexels

default value is Standard_False

type theHasVTexels

bool

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_AspectFillArea3d(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Aspects

Creates a context table for fill area primitives defined with the following default values: //! InteriorStyleAspect_IS_EMPTY InteriorColorQuantity_NOC_CYAN1 EdgeColorQuantity_NOC_WHITE EdgeLineTypeAspect_TOL_SOLID EdgeWidth1.0 FrontMaterialNOM_BRASS BackMaterialNOM_BRASS HatchStyleAspect_HS_SOLID //! 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.

rtype

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.

param theInterior

type theInterior

Aspect_InteriorStyle

param theInteriorColor

type theInteriorColor

Quantity_Color

param theEdgeColor

type theEdgeColor

Quantity_Color

param theEdgeLineType

type theEdgeLineType

Aspect_TypeOfLine

param theEdgeWidth

type theEdgeWidth

float

param theFrontMaterial

type theFrontMaterial

Graphic3d_MaterialAspect

param theBackMaterial

type theBackMaterial

Graphic3d_MaterialAspect

rtype

None

static DownCast(t)¶

Edge()¶

Return type: bool

property thisown¶: The membership flag

class Graphic3d_AspectLine3d(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Aspects

Creates a context table for line primitives defined with the following default values: //! Color = Quantity_NOC_YELLOW; Type = Aspect_TOL_SOLID; Width = 1.0;

rtype

None* Creates a context table for line primitives defined with the specified values. Warning: theWidth 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.

param theColor

type theColor

Quantity_Color

param theType

type theType

Aspect_TypeOfLine

param theWidth

type theWidth

float

rtype

None

static DownCast(t)¶

SetType()¶

Modifies the type of line.

param theType

type theType

Aspect_TypeOfLine

rtype

None

SetWidth()¶

Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value.

param theWidth

type theWidth

float

rtype

None* Modifies the line thickness. Warning: Raises Standard_OutOfRange if the width is a negative value.

param theWidth

type theWidth

Standard_ShortReal

rtype

None

Type()¶

Return line type.

rtype

Aspect_TypeOfLine

Width()¶

Return line width.

rtype

Standard_ShortReal

property thisown¶: The membership flag

class Graphic3d_AspectMarker3d(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Aspects

Creates a context table for marker primitives defined with the following default values: //! Marker typeTOM_X ColorYELLOW Scale factor: 1.0

rtype

None:param theType:

type theType

Aspect_TypeOfMarker

param theColor

type theColor

Quantity_Color

param theScale

type theScale

float

rtype

None* Creates a context table for marker primitives defined with the specified values.

param theColor

type theColor

Quantity_Color

param theWidth

type theWidth

int

param theHeight

type theHeight

int

param theTextureBitmap

type theTextureBitmap

TColStd_HArray1OfByte

rtype

None* Creates a context table for marker primitives defined with the specified values.

param theTextureImage

type theTextureImage

Image_PixMap

rtype

None

static DownCast(t)¶

GetMarkerImage()¶

Returns marker’s image texture. Could be null handle if marker aspect has been initialized as default type of marker.

rtype

opencascade::handle<Graphic3d_MarkerImage>

GetTextureSize()¶

Returns marker’s texture size.

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

None

Scale()¶

Return scale factor.

rtype

Standard_ShortReal

SetBitMap()¶

Parameters

theWidth –

type theWidth: int
param theHeight
type theHeight: int
param theTexture
type theTexture: TColStd_HArray1OfByte
rtype: None

SetScale()¶

Modifies the scale factor. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises Standard_OutOfRange if the scale is a negative value.

param theScale

type theScale

Standard_ShortReal

rtype

None* Assign scale factor.

param theScale

type theScale

float

rtype

None

SetType()¶

Modifies the type of marker.

param theType

type theType

Aspect_TypeOfMarker

rtype

None

Type()¶

Return marker type.

rtype

Aspect_TypeOfMarker

property thisown¶: The membership flag

class Graphic3d_AspectText3d(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Aspects

Creates a context table for text primitives defined with the following default values: ColorQuantity_NOC_YELLOW FontFont_NOF_ASCII_MONO The styleAspect_TOST_NORMAL The display typeAspect_TODT_NORMAL

rtype

None* Creates a context table for text primitives defined with the specified values. @param theColor [in] text color @param theFont [in] font family name or alias like Font_NOF_ASCII_MONO @param theExpansionFactor [in] deprecated parameter, has no effect @param theSpace [in] deprecated parameter, has no effect @param theStyle [in] font style @param theDisplayType [in] display mode

param theColor

type theColor

Quantity_Color

param theFont

type theFont

char *

param theExpansionFactor

type theExpansionFactor

float

param theSpace

type theSpace

float

param theStyle

default value is Aspect_TOST_NORMAL

type theStyle

Aspect_TypeOfStyleText

param theDisplayType

default value is Aspect_TODT_NORMAL

type theDisplayType

Aspect_TypeOfDisplayText

rtype

None

Color()¶

Return the text color.

rtype

Quantity_Color

ColorRGBA()¶

Return the text color.

rtype

Quantity_ColorRGBA

DisplayType()¶

Return display type.

rtype

Aspect_TypeOfDisplayText

static DownCast(t)¶

Font()¶

Return the font.

rtype

TCollection_AsciiString

GetTextAngle()¶

Returns Angle of degree

rtype

Standard_ShortReal

GetTextFontAspect()¶

Returns text FontAspect

rtype

Font_FontAspect

GetTextZoomable()¶

Returns True when the Text Zoomable is on.

rtype

bool

SetColor()¶

Modifies the color.

param theColor

type theColor

Quantity_Color

rtype

None* Modifies the color.

param theColor

type theColor

Quantity_ColorRGBA

rtype

None

SetDisplayType()¶

Define the display type of the text.

param theDisplayType

type theDisplayType

Aspect_TypeOfDisplayText

rtype

None

SetFont()¶

Modifies the font.

param theFont

type theFont

TCollection_AsciiString

rtype

None* Modifies the font.

param theFont

type theFont

char *

rtype

None

SetStyle()¶

Modifies the style of the text.

param theStyle

type theStyle

Aspect_TypeOfStyleText

rtype

None

SetTextAngle()¶

Turns usage of text rotated

param theAngle

type theAngle

float

rtype

None

Style()¶

Return the text style.

rtype

Aspect_TypeOfStyleText

property thisown¶: The membership flag

class Graphic3d_Aspects(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates a context table for drawing primitives defined with the following default values:

rtype

None

AllowBackFace()¶

Allows the display of back-facing filled polygons.

rtype

None

AlphaCutoff()¶

Returns alpha cutoff threshold, for discarding fragments within Graphic3d_AlphaMode_Mask mode (0.5 by default). If the alpha value is greater than or equal to this value then it is rendered as fully opaque, otherwise, it is rendered as fully transparent.

rtype

Standard_ShortReal

AlphaMode()¶

Returns the way how alpha value should be treated (Graphic3d_AlphaMode_BlendAuto by default, for backward compatibility).

rtype

Graphic3d_AlphaMode

BackFace()¶

Returns true if back faces should be suppressed (true by default).

rtype

bool

BackInteriorColor()¶

Return back interior color.

rtype

Quantity_Color

BackInteriorColorRGBA()¶

Return back interior color.

rtype

Quantity_ColorRGBA

BackMaterial()¶

Returns the surface material of internal faces

rtype

Graphic3d_MaterialAspect

ChangeBackMaterial()¶

Returns the surface material of internal faces

rtype

Graphic3d_MaterialAspect

ChangeFrontMaterial()¶

Returns the surface material of external faces

rtype

Graphic3d_MaterialAspect

Color()¶

Return the color.

rtype

Quantity_Color

ColorRGBA()¶

Return color

rtype

Quantity_ColorRGBA

ColorSubTitle()¶

Return text background/shadow color; equals to EdgeColor() property.

rtype

Quantity_Color

ColorSubTitleRGBA()¶

Returns text background/shadow color; equals to EdgeColor() property.

rtype

Quantity_ColorRGBA

Distinguish()¶

Returns true if material properties should be distinguished for back and front faces (false by default).

rtype

bool

static DownCast(t)¶

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

EdgeColor()¶

Return color of edges.

rtype

Quantity_Color

EdgeColorRGBA()¶

Return color of edges.

rtype

Quantity_ColorRGBA

EdgeLineType()¶

Return edges line type (same as LineType()).

rtype

Aspect_TypeOfLine

EdgeWidth()¶

Return width for edges in pixels (same as LineWidth()).

rtype

Standard_ShortReal

FrontMaterial()¶

Returns the surface material of external faces

rtype

Graphic3d_MaterialAspect

HatchStyle()¶

Returns the hatch type used when InteriorStyle is IS_HATCH

rtype

opencascade::handle<Graphic3d_HatchStyle>

InteriorColor()¶

Return interior color.

rtype

Quantity_Color

InteriorColorRGBA()¶

Return interior color.

rtype

Quantity_ColorRGBA

InteriorStyle()¶

Return interior rendering style; Aspect_IS_SOLID by default.

rtype

Aspect_InteriorStyle

IsEqual()¶

Check for equality with another aspects.

param theOther

type theOther

Graphic3d_Aspects

rtype

bool

IsMarkerSprite()¶

Returns True if marker should be drawn using marker sprite (either user-provided or generated).

rtype

bool

IsTextZoomable()¶

Returns True when the Text Zoomable is on.

rtype

bool

LineType()¶

@name parameters specific to Line primitive rendering Return line type; Aspect_TOL_SOLID by default.

rtype

Aspect_TypeOfLine

LineWidth()¶

Return width for edges in pixels; 1.0 by default.

rtype

Standard_ShortReal

MarkerImage()¶

Returns marker’s image texture. Could be null handle if marker aspect has been initialized as default type of marker.

rtype

opencascade::handle<Graphic3d_MarkerImage>

MarkerScale()¶

Return marker scale factor; 1.0 by default.

rtype

Standard_ShortReal

MarkerType()¶

@name parameters specific to Point (Marker) primitive rendering Return marker type; Aspect_TOM_POINT by default.

rtype

Aspect_TypeOfMarker

PolygonOffset()¶

Returns current polygon offsets settings.

rtype

Graphic3d_PolygonOffset

PolygonOffsets()¶

Returns current polygon offsets settings.

param theMode

type theMode

int

param theFactor

type theFactor

Standard_ShortReal

param theUnits

type theUnits

Standard_ShortReal

rtype

None

SetAlphaMode()¶

Defines the way how alpha value should be treated.

param theMode

type theMode

Graphic3d_AlphaMode

param theAlphaCutoff

default value is 0.5f

type theAlphaCutoff

Standard_ShortReal

rtype

None

SetBackInteriorColor()¶

Modifies the color of the interior of the back face

param theColor

type theColor

Quantity_Color

rtype

None* Modifies the color of the interior of the back face

param theColor

type theColor

Quantity_ColorRGBA

rtype

None

SetBackMaterial()¶

Modifies the surface material of internal faces

param theMaterial

type theMaterial

Graphic3d_MaterialAspect

rtype

None

SetColor()¶

Modifies the color.

param theColor

type theColor

Quantity_Color

rtype

None

SetColorSubTitle()¶

Modifies text background/shadow color; equals to EdgeColor() property.

param theColor

type theColor

Quantity_Color

rtype

None* Modifies text background/shadow color; equals to EdgeColor() property.

param theColor

type theColor

Quantity_ColorRGBA

rtype

None

SetDistinguish()¶

Set material distinction between front and back faces.

param toDistinguish

type toDistinguish

bool

rtype

None

SetDistinguishOff()¶

Forbids material distinction between front and back faces.

rtype

None

SetDistinguishOn()¶

Allows material distinction between front and back faces.

rtype

None

SetDrawEdges()¶

Set if mesh edges should be drawn or not.

param theToDraw

type theToDraw

bool

rtype

None

SetDrawSilhouette()¶

Enables/disables drawing silhouette (outline).

param theToDraw

type theToDraw

bool

rtype

None

SetEdgeColor()¶

Modifies the color of the edge of the face

param theColor

type theColor

Quantity_Color

rtype

None* Modifies the color of the edge of the face

param theColor

type theColor

Quantity_ColorRGBA

rtype

None

SetEdgeLineType()¶

Modifies the edge line type (same as SetLineType())

param theType

type theType

Aspect_TypeOfLine

rtype

None

SetEdgeOff()¶

The edges of FillAreas are not drawn.

rtype

None

SetEdgeOn()¶

The edges of FillAreas are drawn.

rtype

None

SetEdgeWidth()¶

Modifies the edge thickness (same as SetLineWidth())

param theWidth

type theWidth

float

rtype

None

SetFrontMaterial()¶

Modifies the surface material of external faces

param theMaterial

type theMaterial

Graphic3d_MaterialAspect

rtype

None

SetHatchStyle()¶

Modifies the hatch type used when InteriorStyle is IS_HATCH

param theStyle

type theStyle

Graphic3d_HatchStyle

rtype

None* Modifies the hatch type used when InteriorStyle is IS_HATCH @warning This method always creates a new handle for a given hatch style

param theStyle

type theStyle

Aspect_HatchStyle

rtype

None

SetInteriorColor()¶

Modifies the color of the interior of the face

param theColor

type theColor

Quantity_Color

rtype

None* Modifies the color of the interior of the face

param theColor

type theColor

Quantity_ColorRGBA

rtype

None

SetInteriorStyle()¶

Modifies the interior type used for rendering

param theStyle

type theStyle

Aspect_InteriorStyle

rtype

None

SetLineType()¶

Modifies the line type

param theType

type theType

Aspect_TypeOfLine

rtype

None

SetLineWidth()¶

Modifies the line thickness Warning: Raises Standard_OutOfRange if the width is a negative value.

param theWidth

type theWidth

Standard_ShortReal

rtype

None

SetMarkerImage()¶

Set marker’s image texture.

param theImage

type theImage

Graphic3d_MarkerImage

rtype

None

SetMarkerScale()¶

Modifies the scale factor. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises Standard_OutOfRange if the scale is a negative value.

param theScale

type theScale

Standard_ShortReal

rtype

None

SetMarkerType()¶

Modifies the type of marker.

param theType

type theType

Aspect_TypeOfMarker

rtype

None

SetPolygonOffset()¶

Sets polygon offsets settings.

param theOffset

type theOffset

Graphic3d_PolygonOffset

rtype

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) //! Default 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).

param theMode

type theMode

int

param theFactor

default value is 1.0f

type theFactor

Standard_ShortReal

param theUnits

default value is 0.0f

type theUnits

Standard_ShortReal

rtype

None

SetShaderProgram()¶

Sets up OpenGL/GLSL shader program.

param theProgram

type theProgram

Graphic3d_ShaderProgram

rtype

None

SetShadingModel()¶

Sets shading model

param theShadingModel

type theShadingModel

Graphic3d_TypeOfShadingModel

rtype

None

SetSkipFirstEdge()¶

Set skip first triangle edge flag for drawing wireframe presentation of quads array split into triangles.

param theToSkipFirstEdge

type theToSkipFirstEdge

bool

rtype

None

SetSuppressBackFaces()¶

Assign back faces culling flag.

param theToSuppress

type theToSuppress

bool

rtype

None

SetTextAngle()¶

Turns usage of text rotated

param theAngle

type theAngle

Standard_ShortReal

rtype

None

SetTextDisplayType()¶

Sets display type.

param theType

type theType

Aspect_TypeOfDisplayText

rtype

None

SetTextFont()¶

Modifies the font.

param theFont

type theFont

TCollection_HAsciiString

rtype

None

SetTextFontAspect()¶

Turns usage of Aspect text

param theFontAspect

type theFontAspect

Font_FontAspect

rtype

None

SetTextStyle()¶

Modifies the style of the text.

param theStyle

type theStyle

Aspect_TypeOfStyleText

rtype

None

SetTextZoomable()¶

Turns usage of text zoomable on/off

param theFlag

type theFlag

bool

rtype

None

SetTextureMap()¶

Assign texture to be mapped. See also SetTextureMapOn() to actually activate texture mapping. ////Standard_DEPRECATED(‘Deprecated method, SetTextureSet() should be used instead’)

param theTexture

type theTexture

Graphic3d_TextureMap

rtype

None

SetTextureMapOff()¶

Disable texture mapping.

rtype

None

SetTextureMapOn()¶

Enable or disable texture mapping (has no effect if texture is not set).

param theToMap

type theToMap

bool

rtype

None* Enable texture mapping (has no effect if texture is not set).

rtype

None

SetTextureSet()¶

Setup texture array to be mapped.

param theTextures

type theTextures

Graphic3d_TextureSet

rtype

None

ShaderProgram()¶

Return shader program.

rtype

opencascade::handle<Graphic3d_ShaderProgram>

ShadingModel()¶

Returns shading model; Graphic3d_TOSM_DEFAULT by default. Graphic3d_TOSM_DEFAULT means that Shading Model set as default for entire Viewer will be used.

rtype

Graphic3d_TypeOfShadingModel

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.

rtype

None

TextAngle()¶

Returns Angle of degree

rtype

Standard_ShortReal

TextDisplayType()¶

Returns display type; Aspect_TODT_NORMAL by default.

rtype

Aspect_TypeOfDisplayText

TextFont()¶

@name parameters specific to text rendering Returns the font; NULL string by default.

rtype

opencascade::handle<TCollection_HAsciiString>

TextFontAspect()¶

Returns text FontAspect

rtype

Font_FontAspect

TextStyle()¶

Returns the text style; Aspect_TOST_NORMAL by default.

rtype

Aspect_TypeOfStyleText

TextureMap()¶

Return texture to be mapped. ////Standard_DEPRECATED(‘Deprecated method, TextureSet() should be used instead’)

rtype

opencascade::handle<Graphic3d_TextureMap>

TextureMapState()¶

Return true if texture mapping is enabled (false by default).

rtype

bool

TextureSet()¶

Return texture array to be mapped.

rtype

opencascade::handle<Graphic3d_TextureSet>

ToDrawEdges()¶

@name parameters specific to Mesh Edges (of triangulation primitive) rendering Returns true if mesh edges should be drawn (false by default).

rtype

bool

ToDrawSilhouette()¶

Returns True if silhouette (outline) should be drawn (with edge color and width); False by default.

rtype

bool

ToMapTexture()¶

Return true if texture mapping is enabled (false by default).

rtype

bool

ToSkipFirstEdge()¶

Returns True if drawing element edges should discard first edge in triangle; False by default. Graphics hardware works mostly with triangles, so that wireframe presentation will draw triangle edges by default. This flag allows rendering wireframe presentation of quad-only array split into triangles. For this, quads should be split in specific order, so that the quad diagonal (to be NOT rendered) goes first: 1——2 / / Triangle #1: 2-0-1; Triangle #2: 0-2-3 0——3

rtype

bool

ToSuppressBackFaces()¶

Returns true if back faces should be suppressed (true by default).

rtype

bool

property thisown¶: The membership flag

class Graphic3d_AttribBuffer(*args)¶

Bases: object

Empty constructor.

param theAlloc

type theAlloc

NCollection_BaseAllocator

rtype

None

Init()¶

Allocates new empty array

param theNbElems

type theNbElems

int

param theAttribs

type theAttribs

Graphic3d_Attribute *

param theNbAttribs

type theNbAttribs

int

rtype

bool* Allocates new empty array

param theNbElems

type theNbElems

int

param theAttribs

type theAttribs

Graphic3d_Array1OfAttribute

rtype

bool

Invalidate()¶

Invalidate the entire buffer data.

rtype

void* Invalidate the entire attribute data.

param theAttributeIndex

type theAttributeIndex

int

rtype

None* Invalidate attribute data within specified sub-range (starting from 0).

param theAttributeIndex

type theAttributeIndex

int

param theVertexLower

type theVertexLower

int

param theVertexUpper

type theVertexUpper

int

rtype

None* Invalidate all attribute data within specified vertex sub-range (starting from 0).

param theVertexLower

type theVertexLower

int

param theVertexUpper

type theVertexUpper

int

rtype

None

InvalidatedRange()¶

Return invalidated range.

rtype

Graphic3d_BufferRange

IsInterleaved()¶

Return True for interleaved array; True by default.

rtype

bool

IsMutable()¶

Return True if data can be invalidated; False by default.

rtype

bool

SetInterleaved()¶

Setup interleaved/non-interleaved array. WARNING! Filling non-interleaved buffer should be implemented on user side without Graphic3d_Buffer auxiliary methods designed for interleaved data.

param theIsInterleaved

type theIsInterleaved

bool

rtype

None

SetMutable()¶

Set if data can be invalidated.

param theMutable

type theMutable

bool

rtype

None

Validate()¶

Reset invalidated range.

rtype

None

invalidate()¶

Invalidate specified sub-range of data (as byte offsets).

param theRange

type theRange

Graphic3d_BufferRange

rtype

None

property thisown¶: The membership flag

class Graphic3d_Attribute¶

Bases: object

property DataType¶

property Id¶

static Stride()¶

//!< vec2,vec3,vec4,vec4ub

rtype

int* returns size of attribute of specified data type

param theType

type theType

Graphic3d_TypeOfData

rtype

int

property thisown¶: The membership flag

class Graphic3d_AxisAspect(*args)¶

Bases: object

Parameters: theName – default value is :type theName: TCollection_ExtendedString :param theNameColor: default value is Quantity_NOC_BLACK :type theNameColor: Quantity_Color :param theColor: default value is Quantity_NOC_BLACK :type theColor: Quantity_Color :param theValuesOffset: default value is 10 :type theValuesOffset: int :param theNameOffset: default value is 30 :type theNameOffset: int :param theTickmarksNumber: default value is 5 :type theTickmarksNumber: int :param theTickmarksLength: default value is 10 :type theTickmarksLength: int :param theToDrawName: default value is Standard_True :type theToDrawName: bool :param theToDrawValues: default value is Standard_True :type theToDrawValues: bool :param theToDrawTickmarks: default value is Standard_True :type theToDrawTickmarks: bool :rtype: None

Color()¶

Color of axis and values

rtype

Quantity_Color

Name()¶

Return type: TCollection_ExtendedString

NameColor()¶

Return type: Quantity_Color

NameOffset()¶

Return type: int

SetColor()¶

Sets color of axis and values

param theColor

type theColor

Quantity_Color

rtype

None

SetDrawName()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetDrawTickmarks()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetDrawValues()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetName()¶

Parameters

theName –

type theName: TCollection_ExtendedString
rtype: None

SetNameColor()¶

Parameters

theColor –

type theColor: Quantity_Color
rtype: None

SetNameOffset()¶

Parameters

theValue –

type theValue: int
rtype: None

SetTickmarksLength()¶

Parameters

theValue –

type theValue: int
rtype: None

SetTickmarksNumber()¶

Parameters

theValue –

type theValue: int
rtype: None

SetValuesOffset()¶

Parameters

theValue –

type theValue: int
rtype: None

TickmarksLength()¶

Return type: int

TickmarksNumber()¶

Return type: int

ToDrawName()¶

Return type: bool

ToDrawTickmarks()¶

Return type: bool

ToDrawValues()¶

Return type: bool

ValuesOffset()¶

Return type: int

property thisown¶: The membership flag

class Graphic3d_BSDF(*args)¶

Bases: object

Creates uninitialized BSDF.

rtype

None

property Absorption¶

static CreateDiffuse()¶

Creates BSDF describing diffuse (Lambertian) surface.

param theWeight

type theWeight

Graphic3d_Vec3

rtype

Graphic3d_BSDF

static CreateGlass()¶

Creates BSDF describing glass-like object. Glass-like BSDF mixes refraction and reflection effects at grazing angles using physically-based Fresnel dielectric model.

param theWeight

type theWeight

Graphic3d_Vec3

param theAbsorptionColor

type theAbsorptionColor

Graphic3d_Vec3

param theAbsorptionCoeff

type theAbsorptionCoeff

Standard_ShortReal

param theRefractionIndex

type theRefractionIndex

Standard_ShortReal

rtype

Graphic3d_BSDF

static CreateMetallic()¶

Creates BSDF describing polished metallic-like surface.

param theWeight

type theWeight

Graphic3d_Vec3

param theFresnel

type theFresnel

Graphic3d_Fresnel

param theRoughness

type theRoughness

Standard_ShortReal

rtype

Graphic3d_BSDF

static CreateTransparent()¶

Creates BSDF describing transparent object. Transparent BSDF models simple transparency without refraction (the ray passes straight through the surface).

param theWeight

type theWeight

Graphic3d_Vec3

param theAbsorptionColor

type theAbsorptionColor

Graphic3d_Vec3

param theAbsorptionCoeff

type theAbsorptionCoeff

Standard_ShortReal

rtype

Graphic3d_BSDF

property FresnelBase¶

property FresnelCoat¶

property Kc¶

property Kd¶

property Ks¶

property Kt¶

property Le¶

Normalize()¶

Normalizes BSDF components.

rtype

None

property thisown¶: The membership flag

class Graphic3d_BndBox3d(*args)¶

Bases: object

Add()¶

Area()¶

Center()¶

Clear()¶

Combine()¶

Contains()¶

CornerMax()¶

CornerMin()¶

DumpJson()¶

IsOut()¶

IsValid()¶

Size()¶

property thisown¶: The membership flag

class Graphic3d_BndBox4d(*args)¶

Bases: object

Add()¶

Area()¶

Center()¶

Clear()¶

Combine()¶

Contains()¶

CornerMax()¶

CornerMin()¶

DumpJson()¶

IsOut()¶

IsValid()¶

Size()¶

property thisown¶: The membership flag

class Graphic3d_BndBox4f(*args)¶

Bases: object

Add()¶

Area()¶

Center()¶

Clear()¶

Combine()¶

Contains()¶

CornerMax()¶

CornerMin()¶

DumpJson()¶

IsOut()¶

IsValid()¶

Size()¶

property thisown¶: The membership flag

class Graphic3d_BoundBuffer(*args)¶

Bases: object

Empty constructor.

param theAlloc

type theAlloc

NCollection_BaseAllocator

rtype

None

property Bounds¶

property Colors¶

static DownCast(t)¶

Init()¶

Allocates new empty array

param theNbBounds

type theNbBounds

int

param theHasColors

type theHasColors

bool

rtype

bool

property NbBounds¶

property NbMaxBounds¶

property thisown¶: The membership flag

class Graphic3d_BufferRange(*args)¶

Bases: object

//!< number of elements within the range Empty constructor.

rtype

None* Constructor.

param theStart

type theStart

int

param theLength

type theLength

int

rtype

None

Clear()¶

Clear the range.

rtype

None

IsEmpty()¶

Return True if range is empty.

rtype

bool

property Length¶

property Start¶

Unite()¶

Add another range to this one.

param theRange

type theRange

Graphic3d_BufferRange

rtype

None

Upper()¶

Return the Upper element within the range

rtype

int

property thisown¶: The membership flag

class Graphic3d_BvhCStructureSet(*args, **kwargs)¶

Bases: object

Box()¶

Returns AABB of the structure.

param theIdx

type theIdx

int

rtype

Graphic3d_BndBox3d

Center()¶

Calculates center of the AABB along given axis.

param theIdx

type theIdx

int

param theAxis

type theAxis

int

rtype

float

Size()¶

Returns total number of structures.

rtype

int

Structures()¶

Access directly a collection of structures.

rtype

NCollection_IndexedMap< Graphic3d_CStructure *>

Swap()¶

Swaps structures with the given indices.

param theIdx1

type theIdx1

int

param theIdx2

type theIdx2

int

rtype

None

property thisown¶: The membership flag

class Graphic3d_CLight(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor, which should be followed by light source properties configuration.

param theType

type theType

Graphic3d_TypeOfLightSource

rtype

None

Angle()¶

@name spotlight additional definition parameters Returns an angle in radians of the cone created by the spot; 30 degrees by default.

rtype

Standard_ShortReal

Attenuation()¶

Returns the attenuation factors.

param theConstAttenuation

type theConstAttenuation

float

param theLinearAttenuation

type theLinearAttenuation

float

rtype

None

Color()¶

Returns the color of the light source; WHITE by default.

rtype

Quantity_Color

Concentration()¶

Returns intensity distribution of the spot light, within [0.0, 1.0] range; 1.0 by default. This coefficient should be converted into spotlight exponent within [0.0, 128.0] range: @code float aSpotExponent = Concentration() * 128.0; anAttenuation *= pow (aCosA, aSpotExponent);’ @endcode The concentration factor determines the dispersion of the light on the surface, the default value (1.0) corresponds to a minimum of dispersion.

rtype

Standard_ShortReal

ConstAttenuation()¶

Returns constant attenuation factor of positional/spot light source; 1.0f by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position: @code float anAttenuation = 1.0 / (ConstAttenuation() + LinearAttenuation() * theDistance + QuadraticAttenuation() * theDistance * theDistance); @endcode

rtype

Standard_ShortReal

Direction()¶

@name directional/spot light additional properties Returns direction of directional/spot light.

rtype

gp_Dir* Returns the theVx, theVy, theVz direction of the light source.

param theVx

type theVx

float

param theVy

type theVy

float

param theVz

type theVz

float

rtype

None

static DownCast(t)¶

GetId()¶

@name low-level access methods returns light resource identifier string

rtype

TCollection_AsciiString

Headlight()¶

Alias for IsHeadlight().

rtype

bool

Intensity()¶

@name Ray-Tracing / Path-Tracing light properties Returns the intensity of light source; 1.0 by default.

rtype

Standard_ShortReal

IsEnabled()¶

Check that the light source is turned on; True by default. This flag affects all occurrences of light sources, where it was registered and activated; so that it is possible defining an active light in View which is actually in disabled state.

rtype

bool

IsHeadlight()¶

Returns true if the light is a headlight; False by default. Headlight flag means that light position/direction are defined not in a World coordinate system, but relative to the camera orientation.

rtype

bool

LinearAttenuation()¶

Returns linear attenuation factor of positional/spot light source; 0.0 by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position: @code float anAttenuation = 1.0 / (ConstAttenuation() + LinearAttenuation() * theDistance + QuadraticAttenuation() * theDistance * theDistance); @endcode

rtype

Standard_ShortReal

Name()¶

Returns light source name; empty string by default.

rtype

TCollection_AsciiString

PackedColor()¶

Returns the color of the light source with dummy Alpha component, which should be ignored.

rtype

Graphic3d_Vec4

PackedDirection()¶

Returns direction of directional/spot light.

rtype

Graphic3d_Vec4

PackedParams()¶

Packed light parameters.

rtype

Graphic3d_Vec4

Position()¶

@name positional/spot light properties Returns location of positional/spot light; (0, 0, 0) by default.

rtype

gp_Pnt* Returns location of positional/spot light.

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

Revision()¶

returns modification counter

rtype

Standard_Size

SetAngle()¶

Angle in radians of the cone created by the spot, should be within range (0.0, M_PI).

param theAngle

type theAngle

Standard_ShortReal

rtype

None

SetAttenuation()¶

Defines the coefficients of attenuation; values should be >= 0.0 and their summ should not be equal to 0.

param theConstAttenuation

type theConstAttenuation

Standard_ShortReal

param theLinearAttenuation

type theLinearAttenuation

Standard_ShortReal

rtype

None

SetColor()¶

Defines the color of a light source by giving the basic color.

param theColor

type theColor

Quantity_Color

rtype

None

SetConcentration()¶

Defines the coefficient of concentration; value should be within range [0.0, 1.0].

param theConcentration

type theConcentration

Standard_ShortReal

rtype

None

SetDirection()¶

Sets direction of directional/spot light.

param theDir

type theDir

gp_Dir

rtype

None* Sets direction of directional/spot light.

param theVx

type theVx

float

param theVy

type theVy

float

param theVz

type theVz

float

rtype

None

SetEnabled()¶

Change enabled state of the light state. This call does not remove or deactivate light source in Views/Viewers; instead it turns it OFF so that it just have no effect.

param theIsOn

type theIsOn

bool

rtype

None

SetHeadlight()¶

Setup headlight flag.

param theValue

type theValue

bool

rtype

None

SetIntensity()¶

Modifies the intensity of light source, which should be > 0.0.

param theValue

type theValue

Standard_ShortReal

rtype

None

SetName()¶

Sets light source name.

param theName

type theName

TCollection_AsciiString

rtype

None

SetPosition()¶

Setup location of positional/spot light.

param thePosition

type thePosition

gp_Pnt

rtype

None* Setup location of positional/spot light.

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

SetSmoothAngle()¶

Modifies the smoothing angle (in radians) of directional light source; should be within range [0.0, M_PI/2].

param theValue

type theValue

Standard_ShortReal

rtype

None

SetSmoothRadius()¶

Modifies the smoothing radius of positional/spot light; should be >= 0.0.

param theValue

type theValue

Standard_ShortReal

rtype

None

Smoothness()¶

Returns the smoothness of light source (either smoothing angle for directional light or smoothing radius in case of positional light); 0.0 by default.

rtype

Standard_ShortReal

Type()¶

Returns the Type of the Light, cannot be changed after object construction.

rtype

Graphic3d_TypeOfLightSource

property thisown¶: The membership flag

class Graphic3d_CStructure(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

BndBoxClipCheck()¶

Returns whether check of object’s bounding box clipping is enabled before drawing of object; True by default.

rtype

bool

BoundingBox()¶

returns bounding box of this presentation

rtype

Graphic3d_BndBox3d

ChangeBoundingBox()¶

returns bounding box of this presentation without transformation matrix applied

rtype

Graphic3d_BndBox3d

Clear()¶

Clear graphic data

rtype

None

ClipPlanes()¶

returns associated clip planes

rtype

opencascade::handle<Graphic3d_SequenceOfHClipPlane>

Connect()¶

Connect other structure to this one

param theStructure

type theStructure

Graphic3d_CStructure

rtype

None

property ContainsFacet¶

Disconnect()¶

Disconnect other structure to this one

param theStructure

type theStructure

Graphic3d_CStructure

rtype

None

static DownCast(t)¶

GraphicDriver()¶

returns graphic driver created this structure

rtype

opencascade::handle<Graphic3d_GraphicDriver>

GraphicHighlight()¶

Highlights structure with the given style

param theStyle

type theStyle

Graphic3d_PresentationAttributes

rtype

None

GraphicUnhighlight()¶

Unhighlights the structure and invalidates pointer to structure’s highlight style

rtype

None

Groups()¶

returns graphic groups

rtype

Graphic3d_SequenceOfGroup

property HLRValidation¶

HighlightStyle()¶

Returns valid handle to highlight style of the structure in case if highlight flag is set to true

rtype

opencascade::handle<Graphic3d_PresentationAttributes>

property Id¶

property Is2dText¶

IsAlwaysRendered()¶

Checks if the structure should be included into BVH tree or not.

rtype

bool

IsCulled()¶

Returns False if the structure hits the current view volume, otherwise returns True.

rtype

bool

property IsForHighlight¶

property IsInfinite¶

property IsMutable¶

IsVisible()¶

Return structure visibility flag

rtype

bool* Return structure visibility considering both View Affinity and global visibility state.

param theViewId

type theViewId

int

rtype

bool

MarkAsNotCulled()¶

Marks structure as overlapping the current view volume one. The method is called during traverse of BVH tree.

rtype

None

NewGroup()¶

Create new group within this structure

param theStruct

type theStruct

Graphic3d_Structure

rtype

opencascade::handle<Graphic3d_Group>

OnVisibilityChanged()¶

Update structure visibility state

rtype

None

property PreviousPriority¶

property Priority¶

RemoveGroup()¶

Remove group from this structure

param theGroup

type theGroup

Graphic3d_Group

rtype

None

SetBndBoxClipCheck()¶

Enable/disable check of object’s bounding box clipping before drawing of object.

param theBndBoxClipCheck

type theBndBoxClipCheck

bool

rtype

None

SetClipPlanes()¶

Pass clip planes to the associated graphic driver structure

param thePlanes

type thePlanes

Graphic3d_SequenceOfHClipPlane

rtype

None

SetCulled()¶

Marks structure as culled/not culled - note that IsAlwaysRendered() is ignored here!

param theIsCulled

type theIsCulled

bool

rtype

None

SetTransformPersistence()¶

Set transformation persistence.

param theTrsfPers

type theTrsfPers

Graphic3d_TransformPers

rtype

None

SetTransformation()¶

Assign transformation.

param theTrsf

type theTrsf

Geom_Transformation

rtype

None

SetZLayer()¶

Set z layer ID to display the structure in specified layer

param theLayerIndex

type theLayerIndex

int

rtype

None

ShadowLink()¶

Create shadow link to this structure

param theManager

type theManager

Graphic3d_StructureManager

rtype

opencascade::handle<Graphic3d_CStructure>

TransformPersistence()¶

Return transformation persistence.

rtype

opencascade::handle<Graphic3d_TransformPers>

Transformation()¶

Return transformation.

rtype

opencascade::handle<Geom_Transformation>

property ViewAffinity¶

ZLayer()¶

Get z layer ID

rtype

Graphic3d_ZLayerId

property highlight¶

property myZLayer¶

property stick¶

property thisown¶: The membership flag

updateLayerTransformation()¶

Update render transformation matrix.

rtype

None

property visible¶

class Graphic3d_CTexture(*args)¶

Bases: object

Return type: None

property TextureMap¶

property doTextureMap¶

property thisown¶: The membership flag

class Graphic3d_CView(*args, **kwargs)¶

Bases: OCC.Core.Graphic3d.Graphic3d_DataStructureManager

Empty constructor

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

Activate()¶

Activates the view. Maps presentations defined within structure manager onto this view.

rtype

void

BackfacingModel()¶

Return backfacing model used for the view.

rtype

Graphic3d_TypeOfBackfacingModel

Background()¶

Returns background fill color.

rtype

Aspect_Background

BackgroundCubeMap()¶

Returns cubemap being setted last time on background.

rtype

opencascade::handle<Graphic3d_CubeMap>

BackgroundImage()¶

Returns background image texture file path.

rtype

TCollection_AsciiString

BackgroundImageStyle()¶

Returns background image fill style.

rtype

Aspect_FillMethod

BufferDump()¶

Dump active rendering buffer into specified memory buffer.

param theImage

type theImage

Image_PixMap

param theBufferType

type theBufferType

Graphic3d_BufferType

rtype

bool

Camera()¶

Returns camera object of the view.

rtype

opencascade::handle<Graphic3d_Camera>

ChangeHiddenObjects()¶

Returns map of objects hidden within this specific view (not viewer-wise).

rtype

opencascade::handle<Graphic3d_NMapOfTransient>

ChangeRenderingParams()¶

Returns reference to current rendering parameters and effect settings.

rtype

Graphic3d_RenderingParams

ClipPlanes()¶

Returns list of clip planes set for the view.

rtype

opencascade::handle<Graphic3d_SequenceOfHClipPlane>

Compute()¶

Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED.

rtype

None

ComputedMode()¶

Returns the computed HLR mode state

rtype

bool

ConsiderZoomPersistenceObjects()¶

Returns zoom-scale factor.

rtype

float

ContainsFacet()¶

Returns Standard_True if one of the structures displayed in the view contains Polygons, Triangles or Quadrangles.

rtype

bool* Returns Standard_True if one of the structures in the set contains Polygons, Triangles or Quadrangles.

param theSet

type theSet

Graphic3d_MapOfStructure

rtype

bool

CopySettings()¶

Copy visualization settings from another view. Method is used for cloning views in viewer when its required to create view with same view properties.

param theOther

type theOther

Graphic3d_CView

rtype

void

Deactivate()¶

Deactivates the view. Unmaps presentations defined within structure manager. The view in deactivated state will ignore actions on structures such as Display().

rtype

void

DiagnosticInformation()¶

Fill in the dictionary with diagnostic info. Should be called within rendering thread. //! This API should be used only for user output or for creating automated reports. The format of returned information (e.g. key-value layout) is NOT part of this API and can be changed at any time. Thus application should not parse returned information to weed out specific parameters.

param theDict

type theDict

TColStd_IndexedDataMapOfStringString

param theFlags

type theFlags

Graphic3d_DiagnosticInfo

rtype

None

DisplayedStructures()¶

Returns the set of structures displayed in this view.

param theStructures

type theStructures

Graphic3d_MapOfStructure

rtype

None

static DownCast(t)¶

FBO()¶

Returns pointer to an assigned framebuffer object.

rtype

opencascade::handle<Standard_Transient>

FBOChangeViewport()¶

Change offscreen FBO viewport.

param theFbo

type theFbo

Standard_Transient

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

None

FBOCreate()¶

Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL.

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

opencascade::handle<Standard_Transient>

FBOGetDimensions()¶

Read offscreen FBO configuration.

param theFbo

type theFbo

Standard_Transient

param theWidth

type theWidth

int

param theHeight

type theHeight

int

param theWidthMax

type theWidthMax

int

param theHeightMax

type theHeightMax

int

rtype

None

FBORelease()¶

Remove offscreen FBO from the graphic library

param theFbo

type theFbo

Standard_Transient

rtype

None

GetGraduatedTrihedron()¶

@name obsolete Graduated Trihedron functionality Returns data of a graduated trihedron

rtype

Graphic3d_GraduatedTrihedron

GradientBackground()¶

Returns gradient background fill colors.

rtype

Aspect_GradientBackground

GraduatedTrihedronDisplay()¶

Displays Graduated Trihedron.

param theTrihedronData

type theTrihedronData

Graphic3d_GraduatedTrihedron

rtype

None

GraduatedTrihedronErase()¶

Erases Graduated Trihedron.

rtype

None

GraduatedTrihedronMinMaxValues()¶

Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. @param theMin [in] the minimum point of scene. @param theMax [in] the maximum point of scene.

param theMin

type theMin

Graphic3d_Vec3

param theMax

type theMax

Graphic3d_Vec3

rtype

None

HiddenObjects()¶

Returns map of objects hidden within this specific view (not viewer-wise).

rtype

opencascade::handle<Graphic3d_NMapOfTransient>

Identification()¶

Returns the identification number of the view.

rtype

int

InsertLayerAfter()¶

Add a layer to the view. @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). @param theSettings [in] new layer settings @param theLayerBefore [in] id of layer to append new layer after

param theNewLayerId

type theNewLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

param theLayerBefore

type theLayerBefore

int

rtype

None

InsertLayerBefore()¶

Add a layer to the view. @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). @param theSettings [in] new layer settings @param theLayerAfter [in] id of layer to append new layer before

param theNewLayerId

type theNewLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

param theLayerAfter

type theLayerAfter

int

rtype

None

Invalidate()¶

Invalidates content of the view but does not redraw it.

rtype

None

InvalidateBVHData()¶

Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.

param theLayerId

type theLayerId

int

rtype

None

InvalidateZLayerBoundingBox()¶

Returns the bounding box of all structures displayed in the Z layer.

param theLayerId

type theLayerId

int

rtype

void

IsActive()¶

Returns the activity flag of the view.

rtype

bool

IsComputed()¶

Returns Standard_True in case if the structure with the given <theStructId> is in list of structures to be computed and stores computed struct to <theComputedStruct>.

param theStructId

type theStructId

int

param theComputedStruct

type theComputedStruct

Graphic3d_Structure

rtype

bool

IsDefined()¶

Returns True if the window associated to the view is defined.

rtype

bool

IsInvalidated()¶

Return true if view content cache has been invalidated.

rtype

bool

IsRemoved()¶

Returns true if the view was removed.

rtype

bool

Layer()¶

Returns layer with given ID or NULL if undefined.

param theLayerId

type theLayerId

int

rtype

opencascade::handle<Graphic3d_Layer>

Layers()¶

Returns the list of layers.

rtype

NCollection_List<opencascade::handle<Graphic3d_Layer> >

Lights()¶

Returns list of lights of the view.

rtype

opencascade::handle<Graphic3d_LightSet>

MinMaxValues()¶

Returns the bounding box of all structures displayed in the view. If theToIncludeAuxiliary is True, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite and other auxiliary structures. @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) returns computed bounding box

param theToIncludeAuxiliary

default value is Standard_False

type theToIncludeAuxiliary

bool

rtype

Bnd_Box* Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is True, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures.

param theSet

type theSet

Graphic3d_MapOfStructure

param theToIncludeAuxiliary

default value is Standard_False

type theToIncludeAuxiliary

bool

rtype

Bnd_Box

NumberOfDisplayedStructures()¶

Returns number of displayed structures in the view.

rtype

int

ReCompute()¶

Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED.

param theStructure

type theStructure

Graphic3d_Structure

rtype

None

Redraw()¶

Redraw content of the view.

rtype

None

RedrawImmediate()¶

Redraw immediate content of the view.

rtype

None

Remove()¶

Erases the view and removes from graphic driver. No more graphic operations are allowed in this view after the call.

rtype

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 (…).

param theLayerId

type theLayerId

int

rtype

None

RenderingParams()¶

Returns current rendering parameters and effect settings.

rtype

Graphic3d_RenderingParams

Resized()¶

Handle changing size of the rendering window.

rtype

None

SetBackfacingModel()¶

Sets backfacing model for the view.

param theModel

type theModel

Graphic3d_TypeOfBackfacingModel

rtype

None

SetBackground()¶

Sets background fill color.

param theBackground

type theBackground

Aspect_Background

rtype

None

SetBackgroundCubeMap()¶

Sets environment cubemap as background.

param theCubeMap

type theCubeMap

Graphic3d_CubeMap

rtype

None

SetBackgroundImage()¶

Sets background image texture file path.

param theFilePath

type theFilePath

TCollection_AsciiString

rtype

None

SetBackgroundImageStyle()¶

Sets background image fill style.

param theFillStyle

type theFillStyle

Aspect_FillMethod

rtype

None

SetCamera()¶

Sets camera used by the view.

param theCamera

type theCamera

Graphic3d_Camera

rtype

None

SetClipPlanes()¶

Sets list of clip planes for the view.

param thePlanes

type thePlanes

Graphic3d_SequenceOfHClipPlane

rtype

None

SetComputedMode()¶

Switches computed HLR mode in the view

param theMode

type theMode

bool

rtype

None

SetFBO()¶

Sets framebuffer object for offscreen rendering.

param theFbo

type theFbo

Standard_Transient

rtype

None

SetGradientBackground()¶

Sets gradient background fill colors.

param theBackground

type theBackground

Aspect_GradientBackground

rtype

None

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.

param theDrawToFrontBuffer

type theDrawToFrontBuffer

bool

rtype

bool

SetLights()¶

Sets list of lights for the view.

param theLights

type theLights

Graphic3d_LightSet

rtype

None

SetShadingModel()¶

Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TOSM_DEFAULT.

param theModel

type theModel

Graphic3d_TypeOfShadingModel

rtype

None

SetTextureEnv()¶

Sets environment texture for the view.

param theTextureEnv

type theTextureEnv

Graphic3d_TextureEnv

rtype

None

SetVisualizationType()¶

Sets visualization type of the view.

param theType

type theType

Graphic3d_TypeOfVisualization

rtype

None

SetWindow()¶

Creates and maps rendering window to the view. @param theWindow [in] the window. @param theContext [in] the rendering context. If NULL the context will be created internally.

param theWindow

type theWindow

Aspect_Window

param theContext

default value is NULL

type theContext

Aspect_RenderingContext

rtype

None

SetZLayerSettings()¶

Sets the settings for a single Z layer of specified view.

param theLayerId

type theLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

rtype

None

ShadingModel()¶

Returns default Shading Model of the view; Graphic3d_TOSM_FRAGMENT by default.

rtype

Graphic3d_TypeOfShadingModel

StatisticInformation()¶

Returns string with statistic performance info.

rtype

TCollection_AsciiString* Fills in the dictionary with statistic performance info.

param theDict

type theDict

TColStd_IndexedDataMapOfStringString

rtype

None

StructureManager()¶

Returns the structure manager handle which manage structures associated with this view.

rtype

opencascade::handle<Graphic3d_StructureManager>

TextureEnv()¶

Returns environment texture set for the view.

rtype

opencascade::handle<Graphic3d_TextureEnv>

Update()¶

Invalidates bounding box of specified ZLayerId.

param theLayerId

default value is Graphic3d_ZLayerId_UNKNOWN

type theLayerId

int

rtype

None

VisualizationType()¶

Returns visualization type of the view.

rtype

Graphic3d_TypeOfVisualization

Window()¶

Returns the window associated to the view.

rtype

opencascade::handle<Aspect_Window>

ZLayerMax()¶

Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().

rtype

int

property thisown¶: The membership flag

class Graphic3d_Camera(*args)¶

Bases: OCC.Core.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)

rtype

None* Copy constructor. @param theOther [in] the camera to copy from.

param theOther

type theOther

Graphic3d_Camera

rtype

None

Aspect()¶

Get camera display ratio. returns display ratio.

rtype

float

AxialScale()¶

Get camera axial scale. returns Camera’s axial scale.

rtype

gp_XYZ

Center()¶

Get Center of the camera, e.g. the point where camera looks at. This point is computed as Eye() translated along Direction() at Distance(). returns the point where the camera looks at.

rtype

gp_Pnt

ConvertProj2View()¶

Convert point from projection coordinate space to view coordinate space. @param thePnt [in] the point in NDC. returns point in VCS.

param thePnt

type thePnt

gp_Pnt

rtype

gp_Pnt

ConvertView2Proj()¶

Convert point from view coordinate space to projection coordinate space. @param thePnt [in] the point in VCS. returns point in NDC.

param thePnt

type thePnt

gp_Pnt

rtype

gp_Pnt

ConvertView2World()¶

Convert point from view coordinate space to world coordinates. @param thePnt [in] the 3D point in VCS. returns point in WCS.

param thePnt

type thePnt

gp_Pnt

rtype

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.

param thePnt

type thePnt

gp_Pnt

rtype

gp_Pnt

Copy()¶

Copy properties of another camera. @param theOther [in] the camera to copy from.

param theOther

type theOther

Graphic3d_Camera

rtype

None

CopyMappingData()¶

Initialize mapping related parameters from other camera handle.

param theOtherCamera

type theOtherCamera

Graphic3d_Camera

rtype

None

CopyOrientationData()¶

Initialize orientation related parameters from other camera handle.

param theOtherCamera

type theOtherCamera

Graphic3d_Camera

rtype

None

Direction()¶

@name Public camera properties Get camera look direction. returns camera look direction.

rtype

gp_Dir

Distance()¶

Get distance of Eye from camera Center. returns the distance.

rtype

float

static DownCast(t)¶

Eye()¶

Get camera Eye position. returns camera eye location.

rtype

gp_Pnt

FOVy()¶

Get Field Of View (FOV) in y axis. returns the FOV value in degrees.

rtype

float

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.

param theLeft

type theLeft

gp_Pln

param theRight

type theRight

gp_Pln

param theBottom

type theBottom

gp_Pln

param theTop

type theTop

gp_Pln

param theNear

type theNear

gp_Pln

param theFar

type theFar

gp_Pln

rtype

None

FrustumPoints()¶

Fill array of current view frustum corners. The size of this array is equal to FrustumVerticesNB. The order of vertices is as defined in FrustumVert_* enumeration.

param thePoints

type thePoints

NCollection_Array1<Graphic3d_Vec3d>

rtype

None

FrustumVert_LeftBottomFar = 1¶

FrustumVert_LeftBottomNear = 0¶

FrustumVert_LeftTopFar = 3¶

FrustumVert_LeftTopNear = 2¶

FrustumVert_RightBottomFar = 5¶

FrustumVert_RightBottomNear = 4¶

FrustumVert_RightTopFar = 7¶

FrustumVert_RightTopNear = 6¶

FrustumVerticesNB = 8¶

GetIODType()¶

Get Intraocular distance definition type. returns definition type used for Intraocular distance.

rtype

IODType

IOD()¶

Get Intraocular distance value. returns absolute or relative IOD value depending on its definition type.

rtype

float

IODType_Absolute = 0¶

IODType_Relative = 1¶

InvalidateOrientation()¶

Invalidate orientation matrix. The matrix will be updated on request.

rtype

None

InvalidateProjection()¶

Invalidate state of projection matrix. The matrix will be updated on request.

rtype

None

IsOrthographic()¶

Check that the camera projection is orthographic. returns boolean flag that indicates whether the camera’s projection is orthographic or not.

rtype

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.

rtype

bool

MoveEyeTo()¶

Sets camera Eye position. Unlike SetEye(), this method only changes Eye point and preserves camera direction. @param theEye [in] the location of camera’s Eye. @sa SetEye()

param theEye

type theEye

gp_Pnt

rtype

None

OrientationMatrix()¶

@name Lazily-computed orientation and projection matrices derived from camera parameters Get orientation matrix. returns camera orientation matrix.

rtype

Graphic3d_Mat4d

OrientationMatrixF()¶

Get orientation matrix of Standard_ShortReal precision. returns camera orientation matrix.

rtype

Graphic3d_Mat4

OrthogonalizeUp()¶

Orthogonalize up direction vector.

rtype

None

OrthogonalizedUp()¶

Return a copy of orthogonalized up direction vector.

rtype

gp_Dir

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.

param thePnt

type thePnt

gp_Pnt

rtype

gp_Pnt

ProjectionMatrix()¶

Get monographic or middle point projection matrix used for monographic rendering and for point projection / unprojection. returns monographic projection matrix.

rtype

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.

rtype

Graphic3d_Mat4

ProjectionState()¶

Returns modification state of camera projection matrix

rtype

Standard_Size

ProjectionStereoLeft()¶

returns stereographic matrix computed for left eye. Please note that this method is used for rendering for Projection_Stereo.

rtype

Graphic3d_Mat4d

ProjectionStereoLeftF()¶

returns stereographic matrix of Standard_ShortReal precision computed for left eye. Please note that this method is used for rendering for Projection_Stereo.

rtype

Graphic3d_Mat4

ProjectionStereoRight()¶

returns stereographic matrix computed for right eye. Please note that this method is used for rendering for Projection_Stereo.

rtype

Graphic3d_Mat4d

ProjectionStereoRightF()¶

returns stereographic matrix of Standard_ShortReal precision computed for right eye. Please note that this method is used for rendering for Projection_Stereo.

rtype

Graphic3d_Mat4

ProjectionType()¶

returns camera projection type.

rtype

Projection

Projection_MonoLeftEye = 3¶

Projection_MonoRightEye = 4¶

Projection_Orthographic = 0¶

Projection_Perspective = 1¶

Projection_Stereo = 2¶

Scale()¶

Get camera scale. returns camera scale factor.

rtype

float

SetAspect()¶

Changes width / height display ratio. @param theAspect [in] the display ratio.

param theAspect

type theAspect

float

rtype

None

SetAxialScale()¶

Set camera axial scale. @param theAxialScale [in] the axial scale vector.

param theAxialScale

type theAxialScale

gp_XYZ

rtype

None

SetCenter()¶

Sets Center of the camera, e.g. the point where camera looks at. This methods changes camera direction, so that the new direction is computed from current Eye position to specified Center position. @param theCenter [in] the point where the camera looks at.

param theCenter

type theCenter

gp_Pnt

rtype

None

SetDirection()¶

Sets camera look direction and computes the new Eye position relative to current Center. WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction. @param theDir [in] the direction.

param theDir

type theDir

gp_Dir

rtype

None

SetDirectionFromEye()¶

Sets camera look direction preserving the current Eye() position. WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction. @param theDir [in] the direction.

param theDir

type theDir

gp_Dir

rtype

None

SetDistance()¶

Set distance of Eye from camera Center. @param theDistance [in] the distance.

param theDistance

type theDistance

float

rtype

None

SetEye()¶

Sets camera Eye position. WARNING! For backward compatibility reasons, this method also changes view direction, so that the new direction is computed from new Eye position to old Center position. @param theEye [in] the location of camera’s Eye. @sa MoveEyeTo(), SetEyeAndCenter()

param theEye

type theEye

gp_Pnt

rtype

None

SetEyeAndCenter()¶

Sets camera Eye and Center positions. @param theEye [in] the location of camera’s Eye @param theCenter [in] the location of camera’s Center

param theEye

type theEye

gp_Pnt

param theCenter

type theCenter

gp_Pnt

rtype

None

SetFOVy()¶

Set Field Of View (FOV) in y axis for perspective projection. @param theFOVy [in] the FOV in degrees.

param theFOVy

type theFOVy

float

rtype

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.

param theType

type theType

IODType

param theIOD

type theIOD

float

rtype

None

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.

param theProjection

type theProjection

Projection

rtype

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.

param theScale

type theScale

float

rtype

None

SetTile()¶

Sets the Tile defining the drawing sub-area within View. Note that tile defining a region outside the view boundaries is also valid - use method Graphic3d_CameraTile::Cropped() to assign a cropped copy. @param theTile tile definition

param theTile

type theTile

Graphic3d_CameraTile

rtype

None

SetUp()¶

Sets camera Up direction vector, orthogonal to camera direction. WARNING! This method does NOT verify that the new Up vector is orthogonal to the current Direction(). @param theUp [in] the Up direction vector. @sa OrthogonalizeUp().

param theUp

type theUp

gp_Dir

rtype

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.

param theType

type theType

FocusType

param theZFocus

type theZFocus

float

rtype

None

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.

param theZNear

type theZNear

float

param theZFar

type theZFar

float

rtype

None

Tile()¶

Get current tile.

rtype

Graphic3d_CameraTile

Transform()¶

@name Basic camera operations Transform orientation components of the camera: Eye, Up and Center points. @param theTrsf [in] the transformation to apply.

param theTrsf

type theTrsf

gp_Trsf

rtype

None

UnProject()¶

Unproject point from normalized device coordinates to world coordinate space. @param thePnt [in] the NDC point. returns 3D point in WCS.

param thePnt

type thePnt

gp_Pnt

rtype

gp_Pnt

Up()¶

Get camera Up direction vector. returns Camera’s Up direction vector.

rtype

gp_Dir

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).

rtype

gp_XYZ* Calculate view plane size at center point with specified Z offset and distance between ZFar and ZNear planes. @param theZValue [in] the distance from the eye in eye-to-center direction returns values in form of gp_Pnt (Width, Height, Depth).

param theZValue

type theZValue

float

rtype

gp_XYZ

WorldViewProjState()¶

@name Camera modification state returns projection modification state of the camera.

rtype

Graphic3d_WorldViewProjState

WorldViewState()¶

Returns modification state of camera world view transformation matrix.

rtype

Standard_Size

ZFar()¶

Get the Far Z-clipping plane position. returns the distance of the plane from the Eye.

rtype

float

ZFitAll()¶

Estimate 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).

param theScaleFactor

type theScaleFactor

float

param theMinMax

type theMinMax

Bnd_Box

param theGraphicBB

type theGraphicBB

Bnd_Box

param theZNear

type theZNear

float

param theZFar

type theZFar

float

rtype

bool* Change Z-min and Z-max planes of projection volume to match the displayed objects.

param theScaleFactor

type theScaleFactor

float

param theMinMax

type theMinMax

Bnd_Box

param theGraphicBB

type theGraphicBB

Bnd_Box

rtype

None

ZFocus()¶

Get stereographic focus value. returns absolute or relative stereographic focus value depending on its definition type.

rtype

float

ZFocusType()¶

Get stereographic focus definition type. returns definition type used for stereographic focus.

rtype

FocusType

ZNear()¶

Get the Near Z-clipping plane position. returns the distance of the plane from the Eye.

rtype

float

property thisown¶: The membership flag

class Graphic3d_CameraLerp(*args)¶

Bases: object

Init()¶

Interpolate()¶

property thisown¶: The membership flag

class Graphic3d_CameraTile(*args)¶

Bases: object

//!< indicate the offset coordinate system - lower-left (default) or top-down Default constructor. Initializes the empty Tile of zero size and lower-left offset orientation. Such Tile is considered uninitialized (invalid).

rtype

None

Cropped()¶

Return the copy cropped by total size

rtype

Graphic3d_CameraTile

property IsTopDown¶

IsValid()¶

Return true if Tile has been defined.

rtype

bool

property Offset¶

OffsetLowerLeft()¶

Return offset position from lower-left corner.

rtype

Graphic3d_Vec2i

property TileSize¶

property TotalSize¶

property thisown¶: The membership flag

class Graphic3d_ClipPlane(*args)¶

Bases: OCC.Core.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)

rtype

None* Copy constructor. @param theOther [in] the copied plane.

param theOther

type theOther

Graphic3d_ClipPlane

rtype

None* Construct clip plane for the passed equation. By default the plane is on, capping is turned off. @param theEquation [in] the plane equation.

param theEquation

type theEquation

Graphic3d_Vec4d

rtype

None* Construct clip plane from the passed geometrical definition. By default the plane is on, capping is turned off. @param thePlane [in] the plane.

param thePlane

type thePlane

gp_Pln

rtype

None

CappingAspect()¶

Return capping aspect. returns capping surface rendering aspect.

rtype

opencascade::handle<Graphic3d_AspectFillArea3d>

CappingColor()¶

Return color for rendering capping surface.

rtype

Quantity_Color

CappingCustomHatch()¶

returns hatching style.

rtype

opencascade::handle<Graphic3d_HatchStyle>

CappingHatch()¶

returns hatching style.

rtype

Aspect_HatchStyle

CappingMaterial()¶

returns capping material.

rtype

Graphic3d_MaterialAspect

CappingTexture()¶

returns capping texture map.

rtype

opencascade::handle<Graphic3d_TextureMap>

ChainNextPlane()¶

Return the next plane in a Chain of Planes defining logical AND operation, or NULL if there is no chain or it is a last element in chain.

rtype

opencascade::handle<Graphic3d_ClipPlane>

ChainPreviousPlane()¶

Return the previous plane in a Chain of Planes defining logical AND operation, or NULL if there is no Chain or it is a first element in Chain. When clipping is defined by a Chain of Planes, it cuts a space only in case if check fails for all Planes in Chain.

rtype

opencascade::handle<Graphic3d_ClipPlane>

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.

rtype

opencascade::handle<Graphic3d_ClipPlane>

static DownCast(t)¶

GetEquation()¶

Get 4-component equation vector for clipping plane. returns clipping plane equation vector.

rtype

Graphic3d_Vec4d

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.

rtype

TCollection_AsciiString

IsBoxFullInHalfspace()¶

Check if the given bounding box is fully inside (or touches from inside) the half-space (e.g. NOT discarded by clipping plane).

param theBox

type theBox

Graphic3d_BndBox3d

rtype

bool

IsBoxFullOutHalfspace()¶

Check if the given bounding box is fully outside of the half-space (e.g. should be discarded by clipping plane).

param theBox

type theBox

Graphic3d_BndBox3d

rtype

bool

IsCapping()¶

Check state of capping surface rendering. returns true (turned on) or false depending on the state.

rtype

bool

IsChain()¶

Return True if this item defines a conjunction (logical AND) between a set of Planes. Graphic3d_ClipPlane item defines either a Clipping halfspace (single Clipping Plane) or a Clipping volume defined by a logical AND (conjunction) operation between a set of Planes defined as a Chain (so that the volume cuts a space only in case if check fails for ALL Planes in the Chain). //! Note that Graphic3d_ClipPlane item cannot: - Define a Chain with logical OR (disjunction) operation; this should be done through Graphic3d_SequenceOfHClipPlane. - Define nested Chains. - Disable Chain items; only entire Chain can be disabled (by disabled a head of Chain). //! The head of a Chain defines all visual properties of the Chain, so that Graphic3d_ClipPlane of next items in a Chain merely defines only geometrical definition of the plane.

rtype

bool

IsHatchOn()¶

returns True if hatching mask is turned on.

rtype

bool

IsOn()¶

Check that the clipping plane is turned on. returns boolean flag indicating whether the plane is in on or off state.

rtype

bool

IsPointOutHalfspace()¶

Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).

param thePoint

type thePoint

Graphic3d_Vec4d

rtype

bool

MCountAspect()¶

returns modification counter for aspect.

rtype

unsigned int

MCountEquation()¶

returns modification counter for equation.

rtype

unsigned int

NbChainNextPlanes()¶

Return the number of chains in forward direction (including this item, so it is always >= 1). For a head of Chain - returns the length of entire Chain.

rtype

int

ProbeBox()¶

Check if the given bounding box is fully outside / fully inside.

param theBox

type theBox

Graphic3d_BndBox3d

rtype

Graphic3d_ClipState

ProbeBoxHalfspace()¶

Check if the given bounding box is fully outside / fully inside the half-space.

param theBox

type theBox

Graphic3d_BndBox3d

rtype

Graphic3d_ClipState

ProbeBoxMaxPointHalfspace()¶

Check if the given bounding box is fully outside of the half-space (e.g. should be discarded by clipping plane).

param theBox

type theBox

Graphic3d_BndBox3d

rtype

Graphic3d_ClipState

ProbeBoxTouch()¶

Check if the given bounding box is In and touch the clipping planes

param theBox

type theBox

Graphic3d_BndBox3d

rtype

bool

ProbePoint()¶

Check if the given point is outside / inside / on section.

param thePoint

type thePoint

Graphic3d_Vec4d

rtype

Graphic3d_ClipState

ProbePointHalfspace()¶

Check if the given point is outside of the half-space (e.g. should be discarded by clipping plane).

param thePoint

type thePoint

Graphic3d_Vec4d

rtype

Graphic3d_ClipState

ReversedEquation()¶

Get 4-component equation vector for clipping plane. returns clipping plane equation vector.

rtype

Graphic3d_Vec4d

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.

param theIsOn

type theIsOn

bool

rtype

None

SetCappingAspect()¶

Assign capping aspect.

param theAspect

type theAspect

Graphic3d_AspectFillArea3d

rtype

None

SetCappingColor()¶

Set color for rendering capping surface.

param theColor

type theColor

Quantity_Color

rtype

None

SetCappingCustomHatch()¶

Set custom hatch style (stipple) and turn hatching on. @param theStyle [in] the hatch pattern.

param theStyle

type theStyle

Graphic3d_HatchStyle

rtype

None

SetCappingHatch()¶

Set hatch style (stipple) and turn hatching on. @param theStyle [in] the hatch style.

param theStyle

type theStyle

Aspect_HatchStyle

rtype

None

SetCappingHatchOff()¶

Turn off hatching.

rtype

None

SetCappingHatchOn()¶

Turn on hatching.

rtype

None

SetCappingMaterial()¶

Set material for rendering capping surface. @param theMat [in] the material.

param theMat

type theMat

Graphic3d_MaterialAspect

rtype

None

SetCappingTexture()¶

Set texture to be applied on capping surface. @param theTexture [in] the texture.

param theTexture

type theTexture

Graphic3d_TextureMap

rtype

None

SetChainNextPlane()¶

Set the next plane in a Chain of Planes. This operation also updates relationship between chains (Previous/Next items), so that the previously set Next plane is cut off.

param thePlane

type thePlane

Graphic3d_ClipPlane

rtype

None

SetEquation()¶

Set plane equation by its geometrical definition. The equation is specified in ‘world’ coordinate system. @param thePlane [in] the plane.

param thePlane

type thePlane

gp_Pln

rtype

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.

param theEquation

type theEquation

Graphic3d_Vec4d

rtype

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.

param theIsOn

type theIsOn

bool

rtype

None

SetUseObjectMaterial()¶

Set flag for controlling the source of capping plane material.

param theToUse

type theToUse

bool

rtype

None

SetUseObjectShader()¶

Set flag for controlling the source of capping plane shader program.

param theToUse

type theToUse

bool

rtype

None

SetUseObjectTexture()¶

Set flag for controlling the source of capping plane texture.

param theToUse

type theToUse

bool

rtype

None

ToPlane()¶

Get geometrical definition. returns geometrical definition of clipping plane

rtype

gp_Pln

ToUseObjectMaterial()¶

Flag indicating whether material for capping plane should be taken from object. Default value: False (use dedicated capping plane material).

rtype

bool

ToUseObjectProperties()¶

Return true if some fill area aspect properties should be taken from object.

rtype

bool

ToUseObjectShader()¶

Flag indicating whether shader program for capping plane should be taken from object. Default value: False.

rtype

bool

ToUseObjectTexture()¶

Flag indicating whether texture for capping plane should be taken from object. Default value: False.

rtype

bool

property thisown¶: The membership flag

class Graphic3d_CubeMap(*args, **kwargs)¶

Bases: OCC.Core.Graphic3d.Graphic3d_TextureMap

Empty constructor

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

CurrentSide()¶

Returns current cubemap side (iterator state).

rtype

Graphic3d_CubeMapSide

static DownCast(t)¶

IsTopDown()¶

Returns whether row’s memory layout is top-down.

rtype

bool

More()¶

Returns whether the iterator has reached the end (true if it hasn’t).

rtype

bool

Next()¶

Moves iterator to the next cubemap side. Uses OpenGL cubemap sides order +X -> -X -> +Y -> -Y -> +Z -> -Z.

rtype

None

Reset()¶

Sets iterator state to +X cubemap side.

rtype

Graphic3d_CubeMap

SetZInversion()¶

Sets Z axis inversion (vertical flipping).

param theZIsInverted

type theZIsInverted

bool

rtype

None

Value()¶

Returns PixMap containing current side of cubemap. Returns null handle if current side is invalid.

rtype

opencascade::handle<Image_PixMap>

ZIsInverted()¶

Returns whether Z axis is inverted.

rtype

bool

property thisown¶: The membership flag

class Graphic3d_CubeMapSeparate(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_CubeMap

Initializes cubemap to be loaded from file. @thePaths - array of paths to separate image files (has to have size equal 6).

param thePaths

type thePaths

NCollection_Array1<TCollection_AsciiString>

rtype

None* Initializes cubemap to be setted directly from PixMaps. @theImages - array if PixMaps (has to have size equal 6).

param theImages

type theImages

Image_PixMap

rtype

None

static DownCast(t)¶

Value()¶

Returns current side of cubemap as PixMap. Returns null handle if current side or whole cubemap is invalid. All origin images have to have the same sizes, format and quad shapes to form valid cubemap.

rtype

opencascade::handle<Image_PixMap>

property thisown¶: The membership flag

class Graphic3d_CullingTool(*args)¶

Bases: object

Creates an empty selector object with parallel projection type by default.

rtype

None

CacheClipPtsProjections()¶

Caches view volume’s vertices projections along its normals and AABBs dimensions. Must be called at the beginning of each BVH tree traverse loop.

rtype

None

Camera()¶

Return the camera definition.

rtype

opencascade::handle<Graphic3d_Camera>

IsCulled()¶

Checks whether given AABB should be entirely culled or not. @param theCtx [in] culling properties @param theMinPt [in] maximum point of AABB @param theMaxPt [in] minimum point of AABB returns Standard_True, if AABB is in viewing area, Standard_False otherwise

param theCtx

type theCtx

CullingContext

param theMinPt

type theMinPt

Graphic3d_Vec3d

param theMaxPt

type theMaxPt

Graphic3d_Vec3d

rtype

bool

ProjectionMatrix()¶

Returns current projection matrix.

rtype

Graphic3d_Mat4d

SetCullingDistance()¶

Setup distance culling.

param theCtx

type theCtx

CullingContext

param theDistance

type theDistance

float

rtype

None

SetCullingSize()¶

Setup size culling.

param theCtx

type theCtx

CullingContext

param theSize

type theSize

float

rtype

None

SetViewVolume()¶

Retrieves view volume’s planes equations and its vertices from projection and world-view matrices.

param theCamera

type theCamera

Graphic3d_Camera

rtype

None

SetViewportSize()¶

Parameters

theViewportWidth –

type theViewportWidth: int
param theViewportHeight
type theViewportHeight: int
param theResolutionRatio
type theResolutionRatio: float
rtype: None

ViewportHeight()¶

Return type: int

ViewportWidth()¶

Return type: int

WorldViewMatrix()¶

Returns current world view transformation matrix.

rtype

Graphic3d_Mat4d

WorldViewProjState()¶

Returns state of current world view projection transformation matrices.

rtype

Graphic3d_WorldViewProjState

property thisown¶: The membership flag

class Graphic3d_DataStructureManager(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_FrameStats(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

ActiveDataFrame()¶

Returns currently filling data frame for modification, should be called between ::FrameStart() and ::FrameEnd() calls.

rtype

Graphic3d_FrameStatsDataTmp

ChangeCounter()¶

Returns value of specified counter for modification, should be called between ::FrameStart() and ::FrameEnd() calls.

param theCounter

type theCounter

Graphic3d_FrameStatsCounter

rtype

Standard_Size

ChangeDataFrames()¶

Returns data frames.

rtype

NCollection_Array1<Graphic3d_FrameStatsData>

CounterValue()¶

Returns value of specified counter, cached between stats updates. Should NOT be called between ::FrameStart() and ::FrameEnd() calls.

param theCounter

type theCounter

Graphic3d_FrameStatsCounter

rtype

Standard_Size

DataFrames()¶

Returns data frames.

rtype

NCollection_Array1<Graphic3d_FrameStatsData>

static DownCast(t)¶

FormatStats()¶

Returns formatted string.

param theFlags

type theFlags

Graphic3d_RenderingParams::PerfCounters

rtype

TCollection_AsciiString* Fill in the dictionary with formatted statistic info.

param theDict

type theDict

TColStd_IndexedDataMapOfStringString

param theFlags

type theFlags

Graphic3d_RenderingParams::PerfCounters

rtype

void

FrameDuration()¶

Returns duration of the last frame in seconds.

rtype

float

FrameEnd()¶

Frame redraw finished.

param theView

type theView

Graphic3d_CView

param theIsImmediateOnly

type theIsImmediateOnly

bool

rtype

void

FrameRate()¶

Returns FPS (frames per seconds, elapsed time). This number indicates an actual frame rate averaged for several frames within UpdateInterval() duration, basing on a real elapsed time between updates.

rtype

float

FrameRateCpu()¶

Returns CPU FPS (frames per seconds, CPU time). This number indicates a PREDICTED frame rate, basing on CPU elapsed time between updates and NOT real elapsed time (which might include periods of CPU inactivity). Number is expected to be greater then actual frame rate returned by FrameRate(). Values significantly greater actual frame rate indicate that rendering is limited by GPU performance (CPU is stalled in-between), while values around actual frame rate indicate rendering being limited by CPU performance (GPU is stalled in-between).

rtype

float

FrameStart()¶

Frame redraw started.

param theView

type theView

Graphic3d_CView

param theIsImmediateOnly

type theIsImmediateOnly

bool

rtype

void

GetChangeTimer(Graphic3d_FrameStats self, Graphic3d_FrameStatsTimer theTimer) → Standard_Real¶

HasCulledLayers()¶

Returns True if some Layers have been culled.

rtype

bool

HasCulledStructs()¶

Returns True if some structures have been culled.

rtype

bool

IsLongLineFormat()¶

Prefer longer lines over more greater of lines.

rtype

bool

LastDataFrame()¶

Returns last data frame, cached between stats updates. Should NOT be called between ::FrameStart() and ::FrameEnd() calls.

rtype

Graphic3d_FrameStatsData

LastDataFrameIndex()¶

Returns last data frame index.

rtype

int

SetChangeTimer(Graphic3d_FrameStats self, Graphic3d_FrameStatsTimer theTimer, Standard_Real value)¶

SetLongLineFormat()¶

Set if format should prefer longer lines over greater number of lines.

param theValue

type theValue

bool

rtype

None

SetUpdateInterval()¶

Sets interval in seconds for updating values.

param theInterval

type theInterval

float

rtype

None

TimerValue()¶

Returns value of specified timer for modification, should be called between ::FrameStart() and ::FrameEnd() calls. Should NOT be called between ::FrameStart() and ::FrameEnd() calls.

param theTimer

type theTimer

Graphic3d_FrameStatsTimer

rtype

float

UpdateInterval()¶

Returns interval in seconds for updating meters across several frames; 1 second by default.

rtype

float

property thisown¶: The membership flag

class Graphic3d_FrameStatsData(*args)¶

Bases: object

Empty constructor.

rtype

None

CounterValue()¶

Get counter value.

param theIndex

type theIndex

Graphic3d_FrameStatsCounter

rtype

Standard_Size

FillMax()¶

Fill with maximum values.

param theOther

type theOther

Graphic3d_FrameStatsData

rtype

None

FrameRate()¶

Returns FPS (frames per seconds, elapsed time). This number indicates an actual frame rate averaged for several frames within UpdateInterval() duration, basing on a real elapsed time between updates.

rtype

float

FrameRateCpu()¶

Returns CPU FPS (frames per seconds, CPU time). This number indicates a PREDICTED frame rate, basing on CPU elapsed time between updates and NOT real elapsed time (which might include periods of CPU inactivity). Number is expected to be greater then actual frame rate returned by FrameRate(). Values significantly greater actual frame rate indicate that rendering is limited by GPU performance (CPU is stalled in-between), while values around actual frame rate indicate rendering being limited by CPU performance (GPU is stalled in-between).

rtype

float

Reset()¶

Reset data.

rtype

None

Set()¶

Assignment operator.

param theOther

type theOther

Graphic3d_FrameStatsData

rtype

Graphic3d_FrameStatsData

TimerValue()¶

Get timer value.

param theIndex

type theIndex

Graphic3d_FrameStatsTimer

rtype

float

property thisown¶: The membership flag

class Graphic3d_FrameStatsDataTmp(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_FrameStatsData

Empty constructor.

rtype

None

ChangeCounterValue()¶

Get counter value.

param theIndex

type theIndex

Graphic3d_FrameStatsCounter

rtype

Standard_Size

ChangeTimer()¶

Return a timer object for time measurements.

param theTimer

type theTimer

Graphic3d_FrameStatsTimer

rtype

OSD_Timer

FlushTimers()¶

Compute average data considering the amount of rendered frames.

param theNbFrames

type theNbFrames

Standard_Size

param theIsFinal

type theIsFinal

bool

rtype

None

GetChangeFrameRate(Graphic3d_FrameStatsDataTmp self) → Standard_Real¶

GetChangeFrameRateCpu(Graphic3d_FrameStatsDataTmp self) → Standard_Real¶

GetChangeTimerValue(Graphic3d_FrameStatsDataTmp self, Graphic3d_FrameStatsTimer theIndex) → Standard_Real¶

Reset()¶

Reset data.

rtype

None

Set()¶

Assignment operator (skip copying irrelevant properties).

param theOther

type theOther

Graphic3d_FrameStatsData

rtype

None

SetChangeFrameRate(Graphic3d_FrameStatsDataTmp self, Standard_Real value)¶

SetChangeFrameRateCpu(Graphic3d_FrameStatsDataTmp self, Standard_Real value)¶

SetChangeTimerValue(Graphic3d_FrameStatsDataTmp self, Graphic3d_FrameStatsTimer theIndex, Standard_Real value)¶

property thisown¶: The membership flag

class Graphic3d_Fresnel(*args)¶

Bases: object

Creates uninitialized Fresnel factor.

rtype

None

static CreateConductor()¶

Creates Fresnel factor for physical-based conductor model.

param theRefractionIndex

type theRefractionIndex

Standard_ShortReal

param theAbsorptionIndex

type theAbsorptionIndex

Standard_ShortReal

rtype

Graphic3d_Fresnel* Creates Fresnel factor for physical-based conductor model (spectral version).

param theRefractionIndex

type theRefractionIndex

Graphic3d_Vec3

param theAbsorptionIndex

type theAbsorptionIndex

Graphic3d_Vec3

rtype

Graphic3d_Fresnel

static CreateConstant()¶

Creates Fresnel factor for constant reflection.

param theReflection

type theReflection

Standard_ShortReal

rtype

Graphic3d_Fresnel

static CreateDielectric()¶

Creates Fresnel factor for physical-based dielectric model.

param theRefractionIndex

type theRefractionIndex

Standard_ShortReal

rtype

Graphic3d_Fresnel

static CreateSchlick()¶

Creates Schlick’s approximation of Fresnel factor.

param theSpecularColor

type theSpecularColor

Graphic3d_Vec3

rtype

Graphic3d_Fresnel

FresnelType()¶

Returns type of Fresnel.

rtype

Graphic3d_FresnelModel

Serialize()¶

Returns serialized representation of Fresnel factor.

rtype

Graphic3d_Vec4

property 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

param theNamesFont

default value is ‘Arial’

type theNamesFont

TCollection_AsciiString

param theNamesStyle

default value is Font_FA_Bold

type theNamesStyle

Font_FontAspect

param theNamesSize

default value is 12

type theNamesSize

int

param theValuesFont

default value is ‘Arial’

type theValuesFont

TCollection_AsciiString

param theValuesStyle

default value is Font_FA_Regular

type theValuesStyle

Font_FontAspect

param theValuesSize

default value is 12

type theValuesSize

int

param theArrowsLength

default value is 30.0f

type theArrowsLength

Standard_ShortReal

param theGridColor

default value is Quantity_NOC_WHITE

type theGridColor

Quantity_Color

param theToDrawGrid

default value is Standard_True

type theToDrawGrid

bool

param theToDrawAxes

default value is Standard_True

type theToDrawAxes

bool

rtype

None

ArrowsLength()¶

Return type: Standard_ShortReal

AxisAspect()¶

Parameters

theIndex –

type theIndex: int
rtype: Graphic3d_AxisAspect

ChangeAxisAspect()¶

Parameters

theIndex –

type theIndex: int
rtype: 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

NamesSize()¶

Return type: int

property PtrView¶

SetArrowsLength()¶

Parameters

theValue –

type theValue: Standard_ShortReal
rtype: None

SetDrawAxes()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetDrawGrid()¶

Parameters

theToDraw –

type theToDraw: bool
rtype: None

SetGridColor()¶

Parameters

theColor –

type theColor: Quantity_Color
rtype: None

SetNamesFont()¶

Parameters

theFont –

type theFont: TCollection_AsciiString
rtype: None

SetNamesFontAspect()¶

Parameters

theAspect –

type theAspect: Font_FontAspect
rtype: None

SetNamesSize()¶

Parameters

theValue –

type theValue: int
rtype: None

SetValuesFont()¶

Parameters

theFont –

type theFont: TCollection_AsciiString
rtype: None

SetValuesFontAspect()¶

Parameters

theAspect –

type theAspect: Font_FontAspect
rtype: None

SetValuesSize()¶

Parameters

theValue –

type theValue: int
rtype: None

ToDrawAxes()¶

Return type: bool

ToDrawGrid()¶

Return type: bool

ValuesFont()¶

Return type: TCollection_AsciiString

ValuesFontAspect()¶

Return type: Font_FontAspect

ValuesSize()¶

Return type: int

XAxisAspect()¶

Return type: Graphic3d_AxisAspect

YAxisAspect()¶

Return type: Graphic3d_AxisAspect

ZAxisAspect()¶

Return type: Graphic3d_AxisAspect

property thisown¶: The membership flag

class Graphic3d_GraphicDriver(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

CreateStructure()¶

Creates new empty graphic structure

param theManager

type theManager

Graphic3d_StructureManager

rtype

opencascade::handle<Graphic3d_CStructure>

CreateView()¶

Creates new view for this graphic driver.

param theMgr

type theMgr

Graphic3d_StructureManager

rtype

opencascade::handle<Graphic3d_CView>

DefaultTextHeight()¶

Return type: Standard_ShortReal

static DownCast(t)¶

EnableVBO()¶

enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays

param status

type status

bool

rtype

None

GetDisplayConnection()¶

returns Handle to display connection

rtype

opencascade::handle<Aspect_DisplayConnection>

InquireLightLimit()¶

Request maximum number of active light sources supported by driver and hardware.

rtype

int

InquireLimit()¶

Request limit of graphic resource of specific type.

param theType

type theType

Graphic3d_TypeOfLimit

rtype

int

InquirePlaneLimit()¶

Request maximum number of active clipping planes supported by driver and hardware.

rtype

int

InquireViewLimit()¶

Request maximum number of views supported by driver.

rtype

int

InsertLayerAfter()¶

Adds a layer to all views. @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). @param theSettings [in] new layer settings @param theLayerBefore [in] id of layer to append new layer after

param theNewLayerId

type theNewLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

param theLayerBefore

type theLayerBefore

int

rtype

void

InsertLayerBefore()¶

Adds a layer to all views. To add a structure to desired layer on display it is necessary to set the layer ID for the structure. @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). @param theSettings [in] new layer settings @param theLayerAfter [in] id of layer to append new layer before

param theNewLayerId

type theNewLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

param theLayerAfter

type theLayerAfter

int

rtype

void

MemoryInfo()¶

Returns information about GPU memory usage.

param theFreeBytes

type theFreeBytes

Standard_Size

param theInfo

type theInfo

TCollection_AsciiString

rtype

bool

NewIdentification()¶

Returns a new identification number for a new structure.

rtype

int

RemoveIdentification()¶

Frees the identifier of a structure.

param theId

type theId

int

rtype

None

RemoveStructure()¶

Removes structure from graphic driver and releases its resources.

param theCStructure

type theCStructure

Graphic3d_CStructure

rtype

None

RemoveView()¶

Removes view from graphic driver and releases its resources.

param theView

type theView

Graphic3d_CView

rtype

None

RemoveZLayer()¶

Removes Z layer. All structures displayed at the moment in layer will be displayed in default layer (the bottom-level z layer). By default, there are always default bottom-level layer that can’t be removed. The passed theLayerId should be not less than 0 (reserved for default layers that can not be removed).

param theLayerId

type theLayerId

int

rtype

void

SetZLayerSettings()¶

Sets the settings for a single Z layer.

param theLayerId

type theLayerId

int

param theSettings

type theSettings

Graphic3d_ZLayerSettings

rtype

void

TextSize()¶

Computes text width.

param theView

type theView

Graphic3d_CView

param theText

type theText

char *

param theHeight

type theHeight

Standard_ShortReal

param theWidth

type theWidth

Standard_ShortReal

param theAscent

type theAscent

Standard_ShortReal

param theDescent

type theDescent

Standard_ShortReal

rtype

None

ViewExists()¶

Returns view associated with the window if it is exists and is activated. Returns Standard_True if the view associated to the window exists.

param theWindow

type theWindow

Aspect_Window

param theView

type theView

Graphic3d_CView

rtype

bool

ZLayerSettings()¶

Returns the settings of a single Z layer.

param theLayerId

type theLayerId

int

rtype

Graphic3d_ZLayerSettings

ZLayers()¶

Returns list of Z layers defined for the graphical driver.

param theLayerSeq

type theLayerSeq

TColStd_SequenceOfInteger

rtype

void

property thisown¶: The membership flag

class Graphic3d_Group(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

AddPrimitiveArray()¶

Adds an array of primitives for display

param theType

type theType

Graphic3d_TypeOfPrimitiveArray

param theIndices

type theIndices

Graphic3d_IndexBuffer

param theAttribs

type theAttribs

Graphic3d_Buffer

param theBounds

type theBounds

Graphic3d_BoundBuffer

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

rtype

void* Adds an array of primitives for display

param thePrim

type thePrim

Graphic3d_ArrayOfPrimitives

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

rtype

None

AddText()¶

Adds a text for display

param theTextParams

type theTextParams

Graphic3d_Text

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

rtype

void

Aspects()¶

Return fill area aspect.

rtype

opencascade::handle<Graphic3d_Aspects>

BoundingBox()¶

Returns boundary box of the group <self> without transformation applied,

rtype

Graphic3d_BndBox4f

ChangeBoundingBox()¶

Returns non-const boundary box of the group <self> without transformation applied,

rtype

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);

param theUpdateStructureMgr

default value is Standard_True

type theUpdateStructureMgr

bool

rtype

void

ContainsFacet()¶

Returns true if the group contains Polygons, Triangles or Quadrangles.

rtype

bool

static DownCast(t)¶

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

IsClosed()¶

Return true if primitive arrays within this graphic group form closed volume (do no contain open shells).

rtype

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.

rtype

bool

IsEmpty()¶

Returns Standard_True if the group <self> is empty.

rtype

bool

Marker()¶

Creates a primitive array with single marker using AddPrimitiveArray().

param thePoint

type thePoint

Graphic3d_Vertex

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

rtype

None

MinMaxValues()¶

Returns the coordinates of the boundary box of the group.

param theXMin

type theXMin

float

param theYMin

type theYMin

float

param theZMin

type theZMin

float

param theXMax

type theXMax

float

param theYMax

type theYMax

float

param theZMax

type theZMax

float

rtype

None

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)

rtype

None

ReplaceAspects()¶

Replace aspects specified in the replacement map.

param theMap

type theMap

Graphic3d_MapOfAspectsToAspects

rtype

None

SetClosed()¶

Changes property shown that primitive arrays within this group form closed volume (do no contain open shells).

param theIsClosed

type theIsClosed

bool

rtype

None

SetFlippingOptions()¶

sets the flipping to theIsEnabled state.

param theIsEnabled

type theIsEnabled

bool

param theRefPlane

type theRefPlane

gp_Ax2

rtype

void

SetMinMaxValues()¶

Sets the coordinates of the boundary box of the group.

param theXMin

type theXMin

float

param theYMin

type theYMin

float

param theZMin

type theZMin

float

param theXMax

type theXMax

float

param theYMax

type theYMax

float

param theZMax

type theZMax

float

rtype

None

SetPrimitivesAspect()¶

Modifies the current context of the group to give another aspect for all the primitives created after this call in the group.

param theAspect

type theAspect

Graphic3d_Aspects

rtype

None

SetStencilTestOptions()¶

sets the stencil test to theIsEnabled state;

param theIsEnabled

type theIsEnabled

bool

rtype

void

Structure()¶

Returns the structure containing the group <self>.

rtype

opencascade::handle<Graphic3d_Structure>

SynchronizeAspects()¶

Update presentation aspects after their modification.

rtype

None

Text()¶

@name obsolete methods 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. AHeightHeight of text. (Relative to the Normalized Projection Coordinates (NPC) Space). AAngleOrientation of the text (with respect to the horizontal).

param AText

type AText

char *

param APoint

type APoint

Graphic3d_Vertex

param AHeight

type AHeight

float

param AAngle

type AAngle

float

param ATp

type ATp

Graphic3d_TextPath

param AHta

type AHta

Graphic3d_HorizontalTextAlignment

param AVta

type AVta

Graphic3d_VerticalTextAlignment

param EvalMinMax

default value is Standard_True

type EvalMinMax

bool

rtype

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

param AText

type AText

char *

param APoint

type APoint

Graphic3d_Vertex

param AHeight

type AHeight

float

param EvalMinMax

default value is Standard_True

type EvalMinMax

bool

rtype

None* 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).

param AText

type AText

TCollection_ExtendedString

param APoint

type APoint

Graphic3d_Vertex

param AHeight

type AHeight

float

param AAngle

type AAngle

float

param ATp

type ATp

Graphic3d_TextPath

param AHta

type AHta

Graphic3d_HorizontalTextAlignment

param AVta

type AVta

Graphic3d_VerticalTextAlignment

param EvalMinMax

default value is Standard_True

type EvalMinMax

bool

rtype

None* 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

param AText

type AText

TCollection_ExtendedString

param APoint

type APoint

Graphic3d_Vertex

param AHeight

type AHeight

float

param EvalMinMax

default value is Standard_True

type EvalMinMax

bool

rtype

None* Creates the string <theText> at orientation <theOrientation> in 3D space.

param theTextUtf

type theTextUtf

char *

param theOrientation

type theOrientation

gp_Ax2

param theHeight

type theHeight

float

param theAngle

type theAngle

float

param theTp

type theTp

Graphic3d_TextPath

param theHTA

type theHTA

Graphic3d_HorizontalTextAlignment

param theVTA

type theVTA

Graphic3d_VerticalTextAlignment

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

param theHasOwnAnchor

default value is Standard_True

type theHasOwnAnchor

bool

rtype

void* Creates the string <theText> at orientation <theOrientation> in 3D space.

param theText

type theText

TCollection_ExtendedString

param theOrientation

type theOrientation

gp_Ax2

param theHeight

type theHeight

float

param theAngle

type theAngle

float

param theTp

type theTp

Graphic3d_TextPath

param theHTA

type theHTA

Graphic3d_HorizontalTextAlignment

param theVTA

type theVTA

Graphic3d_VerticalTextAlignment

param theToEvalMinMax

default value is Standard_True

type theToEvalMinMax

bool

param theHasOwnAnchor

default value is Standard_True

type theHasOwnAnchor

bool

rtype

void

property thisown¶: The membership flag

class Graphic3d_HatchStyle(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates a new custom hatch style with the given pattern and unique style id @warning Raises a program error if given pattern image is not a valid 32*32 bitmap

param thePattern

type thePattern

Image_PixMap

rtype

None* Creates a new predefined hatch style with the given id in Aspect_HatchStyle enum. GPU memory for the pattern will not be allocated.

param theType

type theType

Aspect_HatchStyle

rtype

None

static DownCast(t)¶

HatchType()¶

In case if predefined OCCT style is used, returns index in Aspect_HatchStyle enumeration. If the style is custom, returns unique index of the style

rtype

int

Pattern()¶

Returns the pattern of custom hatch style

rtype

Standard_Byte *

property thisown¶: The membership flag

class Graphic3d_IndexedMapOfStructure(*args)¶

Bases: object

Add()¶

Assign()¶

Clear()¶

Contains()¶

Exchange()¶

FindIndex()¶

FindKey()¶

ReSize()¶

RemoveFromIndex()¶

RemoveKey()¶

RemoveLast()¶

Set()¶

Size()¶

Substitute()¶

Swap()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class Graphic3d_IndexedMapOfView(*args)¶

Bases: object

Add()¶

Assign()¶

Clear()¶

Contains()¶

Exchange()¶

FindIndex()¶

FindKey()¶

ReSize()¶

RemoveFromIndex()¶

RemoveKey()¶

RemoveLast()¶

Set()¶

Size()¶

Substitute()¶

Swap()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class Graphic3d_Layer(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

Add()¶

Parameters

theStruct –

type theStruct: Graphic3d_CStructure *
param thePriority
type thePriority: int
param isForChangePriority: default value is Standard_False
type isForChangePriority: bool
rtype: None

Append()¶

Append layer of acceptable type (with similar number of priorities or less). Returns Standard_False if the list can not be accepted.

param theOther

type theOther

Graphic3d_Layer

rtype

bool

ArrayOfStructures()¶

Returns array of structures.

rtype

Graphic3d_ArrayOfIndexedMapOfStructure

BoundingBox()¶

Returns layer bounding box. @param theViewId view index to consider View Affinity in structure @param theCamera camera definition @param theWindowWidth viewport width (for applying transformation-persistence) @param theWindowHeight viewport height (for applying transformation-persistence) @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) returns computed bounding box

param theViewId

type theViewId

int

param theCamera

type theCamera

Graphic3d_Camera

param theWindowWidth

type theWindowWidth

int

param theWindowHeight

type theWindowHeight

int

param theToIncludeAuxiliary

type theToIncludeAuxiliary

bool

rtype

Bnd_Box

CullableStructuresBVH()¶

Returns set of Graphic3d_CStructures structures for building BVH tree.

rtype

Graphic3d_BvhCStructureSet

CullableTrsfPersStructuresBVH()¶

Returns set of transform persistent Graphic3d_CStructures for building BVH tree.

rtype

Graphic3d_BvhCStructureSetTrsfPers

static DownCast(t)¶

InvalidateBVHData()¶

Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.

rtype

None

InvalidateBoundingBox()¶

Marks cached bounding box as obsolete.

rtype

None

IsCulled()¶

Returns True if layer is empty or has been discarded entirely by culling test.

rtype

bool

IsImmediate()¶

Return true if layer was marked with immediate flag.

rtype

bool

LayerId()¶

Return layer id.

rtype

Graphic3d_ZLayerId

LayerSettings()¶

Returns settings of the layer object.

rtype

Graphic3d_ZLayerSettings

NbOfTransformPersistenceObjects()¶

Returns number of transform persistence objects.

rtype

int

NbPriorities()¶

Returns the number of available priority levels

rtype

int

NbStructures()¶

returns the number of structures

rtype

int

NbStructuresNotCulled()¶

Number of NOT culled structures in the layer.

rtype

int

NonCullableStructures()¶

Returns indexed map of always rendered structures.

rtype

NCollection_IndexedMap< Graphic3d_CStructure *>

Remove()¶

Remove structure and returns its priority, if the structure is not found, method returns negative value

param theStruct

type theStruct

Graphic3d_CStructure *

param thePriority

type thePriority

int

param isForChangePriority

default value is Standard_False

type isForChangePriority

bool

rtype

bool

SetLayerSettings()¶

Sets settings of the layer object.

param theSettings

type theSettings

Graphic3d_ZLayerSettings

rtype

None

UpdateCulling()¶

Update culling state - should be called before rendering. Traverses through BVH tree to determine which structures are in view volume.

param theViewId

type theViewId

int

param theSelector

type theSelector

Graphic3d_CullingTool

param theFrustumCullingState

type theFrustumCullingState

Graphic3d_RenderingParams::FrustumCulling

rtype

None

considerZoomPersistenceObjects()¶

Returns zoom-scale factor.

param theViewId

type theViewId

int

param theCamera

type theCamera

Graphic3d_Camera

param theWindowWidth

type theWindowWidth

int

param theWindowHeight

type theWindowHeight

int

rtype

float

property thisown¶: The membership flag

class Graphic3d_LightSet(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor.

rtype

None

Add()¶

Append new light source.

param theLight

type theLight

Graphic3d_CLight

rtype

bool

AmbientColor()¶

Returns cumulative ambient color, which is computed as sum of all enabled ambient light sources. Values are NOT clamped (can be greater than 1.0f) and alpha component is fixed to 1.0f. @sa UpdateRevision()

rtype

Graphic3d_Vec4

Contains()¶

Return True if light source is defined in this set.

param theLight

type theLight

Graphic3d_CLight

rtype

bool

static DownCast(t)¶

Extent()¶

Return number of light sources.

rtype

int

IsEmpty()¶

Return True if lights list is empty.

rtype

bool

IterationFilter_ExcludeAmbient = 2¶

IterationFilter_ExcludeDisabled = 4¶

IterationFilter_ExcludeDisabledAndAmbient = 6¶

IterationFilter_None = 0¶

KeyEnabledLong()¶

Returns a string defining a list of enabled light sources as concatenation of letters ‘d’ (Directional), ‘p’ (Point), ‘s’ (Spot) depending on the type of light source in the list. Example: ‘dppp’. @sa UpdateRevision()

rtype

TCollection_AsciiString

KeyEnabledShort()¶

Returns a string defining a list of enabled light sources as concatenation of letters ‘d’ (Directional), ‘p’ (Point), ‘s’ (Spot) depending on the type of light source in the list, specified only once. Example: ‘dp’. @sa UpdateRevision()

rtype

TCollection_AsciiString

Lower()¶

Return lower light index.

rtype

int

NbEnabled()¶

Returns total amount of enabled lights EXCLUDING ambient. @sa UpdateRevision()

rtype

int

NbEnabledLightsOfType()¶

Returns total amount of enabled lights of specified type. @sa UpdateRevision()

param theType

type theType

Graphic3d_TypeOfLightSource

rtype

int

NbLightsOfType()¶

Returns total amount of lights of specified type.

param theType

type theType

Graphic3d_TypeOfLightSource

rtype

int

Remove()¶

Remove light source.

param theLight

type theLight

Graphic3d_CLight

rtype

bool

Revision()¶

Return light sources revision. @sa UpdateRevision()

rtype

Standard_Size

UpdateRevision()¶

@name cached state of lights set updated by UpdateRevision() Update light sources revision.

rtype

Standard_Size

Upper()¶

Return upper light index.

rtype

int

Value()¶

Return the light source for specified index within range [Lower(), Upper()].

param theIndex

type theIndex

int

rtype

opencascade::handle<Graphic3d_CLight>

property thisown¶: The membership flag

class Graphic3d_MapOfAspectsToAspects(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_MapOfStructure(*args)¶

Bases: object

Add()¶

Added()¶

Assign()¶

Clear()¶

Contains()¶

Differ()¶

Difference()¶

Exchange()¶

HasIntersection()¶

Intersect()¶

Intersection()¶

IsEqual()¶

ReSize()¶

Remove()¶

Set()¶

Size()¶

Subtract()¶

Subtraction()¶

Union()¶

Unite()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class Graphic3d_MapOfZLayerSettings(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_MarkerImage(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

@param theImage - source image

param theImage

type theImage

Image_PixMap

rtype

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

param theBitMap

type theBitMap

TColStd_HArray1OfByte

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

None

static DownCast(t)¶

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.

param theAlphaValue

default value is 0.5

type theAlphaValue

float

rtype

opencascade::handle<TColStd_HArray1OfByte>

GetImage()¶

returns marker image. If an instance of the class has been initialized with a bitmap, it will be converted to image.

rtype

opencascade::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()

rtype

opencascade::handle<Image_PixMap>

GetImageAlphaId()¶

returns an unique ID. This ID will be used to manage resource in graphic driver.

rtype

TCollection_AsciiString

GetImageId()¶

returns an unique ID. This ID will be used to manage resource in graphic driver.

rtype

TCollection_AsciiString

GetTextureSize()¶

returns texture size

param theWidth

type theWidth

int

param theHeight

type theHeight

int

rtype

None

property thisown¶: The membership flag

class Graphic3d_Mat4¶

Bases: object

ChangeData()¶

ChangeValue()¶

static Cols()¶

GetColumn()¶

GetData()¶

GetDiagonal()¶

GetRow()¶

GetValue()¶

InitIdentity()¶

Inverted()¶

IsEqual()¶

IsIdentity()¶

static Map()¶

Multiplied()¶

Multiply()¶

static Rows()¶

SetColumn()¶

SetDiagonal()¶

SetRow()¶

SetValue()¶

Translate()¶

Transpose()¶

Transposed()¶

property thisown¶: The membership flag

class Graphic3d_Mat4d¶

Bases: object

ChangeData()¶

ChangeValue()¶

static Cols()¶

GetColumn()¶

GetData()¶

GetDiagonal()¶

GetRow()¶

GetValue()¶

InitIdentity()¶

Inverted()¶

IsEqual()¶

IsIdentity()¶

static Map()¶

Multiplied()¶

Multiply()¶

static Rows()¶

SetColumn()¶

SetDiagonal()¶

SetRow()¶

SetValue()¶

Translate()¶

Transpose()¶

Transposed()¶

property thisown¶: The membership flag

class Graphic3d_MaterialAspect(*args)¶

Bases: object

Creates a material from default values.

rtype

None* Creates a generic material.

param theName

type theName

Graphic3d_NameOfMaterial

rtype

None

Alpha()¶

Returns the alpha coefficient of the surface (1.0 - Transparency); 1.0 means opaque.

rtype

Standard_ShortReal

AmbientColor()¶

Returns the ambient color of the surface.

rtype

Quantity_Color

BSDF()¶

Returns BSDF (bidirectional scattering distribution function).

rtype

Graphic3d_BSDF

Color()¶

Returns the diffuse color of the surface. WARNING! This method does NOT return color for Graphic3d_MATERIAL_ASPECT material (color is defined by Graphic3d_Aspects::InteriorColor()).

rtype

Quantity_Color

DiffuseColor()¶

Returns the diffuse color of the surface.

rtype

Quantity_Color

EmissiveColor()¶

Returns the emissive color of the surface.

rtype

Quantity_Color

IncreaseShine()¶

Increases or decreases the luminosity. @param theDelta a signed percentage

param theDelta

type theDelta

Standard_ShortReal

rtype

None

IsDifferent()¶

Returns True if this material differs from specified one.

param theOther

type theOther

Graphic3d_MaterialAspect

rtype

bool

IsEqual()¶

Returns True if this material is identical to specified one.

param theOther

type theOther

Graphic3d_MaterialAspect

rtype

bool

static MaterialFromName()¶

Finds the material for specified name. @param theName [in] name to find @param theMat [out] found material returns False if name was unrecognized

param theName

type theName

char *

param theMat

type theMat

Graphic3d_NameOfMaterial

rtype

bool* Returns the material for specified name or Graphic3d_NOM_DEFAULT if name is unknown.

param theName

type theName

char *

rtype

Graphic3d_NameOfMaterial

MaterialName()¶

Returns the name of the predefined material of specified rank within range [1, NumberOfMaterials()].

param theRank

type theRank

int

rtype

char ** Returns the given name of this material. This might be:

rtype

char *

MaterialType()¶

Returns the type of the predefined material of specified rank within range [1, NumberOfMaterials()].

param theRank

type theRank

int

rtype

Graphic3d_TypeOfMaterial* Returns material type.

rtype

Graphic3d_TypeOfMaterial* Returns True if type of this material is equal to specified type.

param theType

type theType

Graphic3d_TypeOfMaterial

rtype

bool

Name()¶

Returns the material name (within predefined enumeration).

rtype

Graphic3d_NameOfMaterial

static NumberOfMaterials()¶

Returns the number of predefined textures.

rtype

int

ReflectionMode()¶

Returns True if the reflection mode is active, False otherwise.

param theType

type theType

Graphic3d_TypeOfReflection

rtype

bool

RefractionIndex()¶

Returns the refraction index of the material

rtype

Standard_ShortReal

RequestedName()¶

Returns the material name within predefined enumeration which has been requested (before modifications).

rtype

Graphic3d_NameOfMaterial

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.

rtype

None

SetAlpha()¶

Modifies the alpha coefficient of the surface, where 1.0 is opaque and 0.0 is fully transparent.

param theValue

type theValue

Standard_ShortReal

rtype

None

SetAmbientColor()¶

Modifies the ambient color of the surface.

param theColor

type theColor

Quantity_Color

rtype

None

SetBSDF()¶

Modifies the BSDF (bidirectional scattering distribution function).

param theBSDF

type theBSDF

Graphic3d_BSDF

rtype

None

SetColor()¶

Modifies the ambient and diffuse color of the surface. WARNING! Has no effect for Graphic3d_MATERIAL_ASPECT material (color should be set to Graphic3d_Aspects::SetInteriorColor()).

param theColor

type theColor

Quantity_Color

rtype

None

SetDiffuseColor()¶

Modifies the diffuse color of the surface.

param theColor

type theColor

Quantity_Color

rtype

None

SetEmissiveColor()¶

Modifies the emissive color of the surface.

param theColor

type theColor

Quantity_Color

rtype

None

SetMaterialName()¶

The current material become a ‘UserDefined’ material. Set the name of the ‘UserDefined’ material.

param theName

type theName

TCollection_AsciiString

rtype

None

SetMaterialType()¶

Set material type.

param theType

type theType

Graphic3d_TypeOfMaterial

rtype

None

SetReflectionModeOff()¶

Deactivates the reflective properties of the surface with specified reflection type.

param theType

type theType

Graphic3d_TypeOfReflection

rtype

None

SetRefractionIndex()¶

Modifies the refraction index of the material. Warning: Raises MaterialDefinitionError if given value is a lesser than 1.0.

param theValue

type theValue

Standard_ShortReal

rtype

None

SetShininess()¶

Modifies the luminosity of the surface. Warning: Raises MaterialDefinitionError if given value is a negative value or greater than 1.0.

param theValue

type theValue

Standard_ShortReal

rtype

None

SetSpecularColor()¶

Modifies the specular color of the surface.

param theColor

type theColor

Quantity_Color

rtype

None

SetTransparency()¶

Modifies the transparency coefficient of the surface, where 0 is opaque and 1 is fully 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. //! Warning: Raises MaterialDefinitionError if given value is a negative value or greater than 1.0.

param theValue

type theValue

Standard_ShortReal

rtype

None

Shininess()¶

Returns the luminosity of the surface.

rtype

Standard_ShortReal

SpecularColor()¶

Returns the specular color of the surface.

rtype

Quantity_Color

StringName()¶

Returns the given name of this material. This might be: - given name set by method ::SetMaterialName() - standard name for a material within enumeration - ‘UserDefined’ for non-standard material without name specified externally.

rtype

TCollection_AsciiString

Transparency()¶

Returns the transparency coefficient of the surface (1.0 - Alpha); 0.0 means opaque.

rtype

Standard_ShortReal

property thisown¶: The membership flag

class Graphic3d_MediaTexture(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Texture2D

Main constructor.

param theMutex

type theMutex

Media_HMutex

param thePlane

default value is -1

type thePlane

int

rtype

None

static DownCast(t)¶

Frame()¶

Return the frame.

rtype

opencascade::handle<Media_Frame>

GenerateNewId()¶

Regenerate a new texture id

rtype

None

SetFrame()¶

Set the frame.

param theFrame

type theFrame

Media_Frame

rtype

None

property thisown¶: The membership flag

class Graphic3d_MediaTextureSet(*args)¶

Bases: object

Empty constructor.

rtype

None

static DownCast(t)¶

Duration()¶

Return duration in seconds.

rtype

double

FrameSize()¶

Return front frame dimensions.

rtype

Graphic3d_Vec2i

Input()¶

Return input media.

rtype

TCollection_AsciiString

IsFullRangeYUV()¶

Return True if YUV range is full.

rtype

bool

IsPlanarYUV()¶

Return True if texture set defined 3 YUV planes.

rtype

bool

Notify()¶

Call callback.

rtype

None

OpenInput()¶

Open specified file. Passing an empty path would close current input.

param thePath

type thePath

TCollection_AsciiString

param theToWait

type theToWait

bool

rtype

None

PlayerContext()¶

Return player context; it can be NULL until first OpenInput().

rtype

opencascade::handle<Media_PlayerContext>

Progress()¶

Return playback progress in seconds.

rtype

double

ShaderProgram()¶

Return shader program for displaying texture set.

rtype

opencascade::handle<Graphic3d_ShaderProgram>

SwapFrames()¶

Swap front/back frames.

rtype

bool

property thisown¶: The membership flag

class Graphic3d_MutableIndexBuffer(*args)¶

Bases: object

Empty constructor.

param theAlloc

type theAlloc

NCollection_BaseAllocator

rtype

None

Invalidate()¶

Invalidate the entire buffer data.

rtype

None* Invalidate the given indexes (starting from 0)

param theIndexLower

type theIndexLower

int

param theIndexUpper

type theIndexUpper

int

rtype

None

InvalidatedRange()¶

Return invalidated range.

rtype

Graphic3d_BufferRange

IsMutable()¶

Return True if data can be invalidated.

rtype

bool

Validate()¶

Reset invalidated range.

rtype

None

invalidate()¶

Invalidate specified sub-range of data (as byte offsets).

param theRange

type theRange

Graphic3d_BufferRange

rtype

None

property thisown¶: The membership flag

class Graphic3d_PolygonOffset(*args)¶

Bases: object

Empty constructor.

rtype

None

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

property Factor¶

property Mode¶

property Units¶

property thisown¶: The membership flag

class Graphic3d_PresentationAttributes(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor.

rtype

None

BasicFillAreaAspect()¶

Return basic presentation fill area aspect, NULL by default. When set, might be used instead of Color() property.

rtype

opencascade::handle<Graphic3d_AspectFillArea3d>

Color()¶

Returns basic presentation color, Quantity_NOC_WHITE by default.

rtype

Quantity_Color

ColorRGBA()¶

Returns basic presentation color (including alpha channel).

rtype

Quantity_ColorRGBA

DisplayMode()¶

Returns display mode, 0 by default. -1 means undefined (main display mode of presentation to be used).

rtype

int

static DownCast(t)¶

Method()¶

Returns highlight method, Aspect_TOHM_COLOR by default.

rtype

Aspect_TypeOfHighlightMethod

SetBasicFillAreaAspect()¶

Sets basic presentation fill area aspect.

param theAspect

type theAspect

Graphic3d_AspectFillArea3d

rtype

None

SetColor()¶

Sets basic presentation color (RGB components, does not modifies transparency).

param theColor

type theColor

Quantity_Color

rtype

None

SetDisplayMode()¶

Sets display mode.

param theMode

type theMode

int

rtype

None

SetMethod()¶

Changes highlight method to the given one.

param theMethod

type theMethod

Aspect_TypeOfHighlightMethod

rtype

None

SetTransparency()¶

Sets basic presentation transparency (0 - opaque, 1 - fully transparent).

param theTranspCoef

type theTranspCoef

Standard_ShortReal

rtype

None

SetZLayer()¶

Sets presentation Zlayer.

param theLayer

type theLayer

int

rtype

None

Transparency()¶

Returns basic presentation transparency (0 - opaque, 1 - fully transparent), 0 by default (opaque).

rtype

Standard_ShortReal

ZLayer()¶

Returns presentation Zlayer, Graphic3d_ZLayerId_Default by default. Graphic3d_ZLayerId_UNKNOWN means undefined (a layer of main presentation to be used).

rtype

Graphic3d_ZLayerId

property thisown¶: The membership flag

class Graphic3d_RenderingParams(*args)¶

Bases: object

Creates default rendering parameters.

rtype

None

property AdaptiveScreenSampling¶

property AdaptiveScreenSamplingAtomic¶

property AnaglyphFilter¶

property AnaglyphLeft¶

property AnaglyphRight¶

Anaglyph_GreenMagenta_Simple = 4¶

Anaglyph_RedCyan_Optimized = 1¶

Anaglyph_RedCyan_Simple = 0¶

Anaglyph_UserDefined = 5¶

Anaglyph_YellowBlue_Optimized = 3¶

Anaglyph_YellowBlue_Simple = 2¶

property CameraApertureRadius¶

property CameraFocalPlaneDist¶

property ChartPosition¶

property ChartSize¶

property CoherentPathTracingMode¶

property CollectedStats¶

property Exposure¶

property FrustumCullingState¶

FrustumCulling_NoUpdate = 2¶

FrustumCulling_Off = 0¶

FrustumCulling_On = 1¶

property IsAntialiasingEnabled¶

property IsGlobalIlluminationEnabled¶

property IsReflectionEnabled¶

property IsShadowEnabled¶

property IsTransparentShadowEnabled¶

property LineFeather¶

property Method¶

property NbMsaaSamples¶

property NbRayTracingTiles¶

property OitDepthFactor¶

PerfCounters_All = 2047¶

PerfCounters_Basic = 15¶

PerfCounters_CPU = 2¶

PerfCounters_EstimMem = 256¶

PerfCounters_Extended = 511¶

PerfCounters_FrameRate = 1¶

PerfCounters_FrameTime = 512¶

PerfCounters_FrameTimeMax = 1024¶

PerfCounters_GroupArrays = 32¶

PerfCounters_Groups = 16¶

PerfCounters_Layers = 4¶

PerfCounters_NONE = 0¶

PerfCounters_Points = 128¶

PerfCounters_SkipImmediate = 2048¶

PerfCounters_Structures = 8¶

PerfCounters_Triangles = 64¶

property RadianceClampingValue¶

property RayTracingTileSize¶

property RaytracingDepth¶

property RebuildRayTracingShaders¶

property RenderResolutionScale¶

property Resolution¶

ResolutionRatio()¶

Returns resolution ratio.

rtype

Standard_ShortReal

property SamplesPerPixel¶

property ShowSamplingTiles¶

property StatsMaxChartTime¶

property StatsNbFrames¶

property StatsPosition¶

property StatsTextAspect¶

property StatsTextHeight¶

property StatsUpdateInterval¶

property StereoMode¶

property ToEnableAlphaToCoverage¶

property ToEnableDepthPrepass¶

property ToReverseStereo¶

property ToShowStats¶

property ToneMappingMethod¶

property TransparencyMethod¶

property TwoSidedBsdfModels¶

property UseEnvironmentMapBackground¶

property WhitePoint¶

property thisown¶: The membership flag

class Graphic3d_SequenceOfGroup(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_SequenceOfHClipPlane(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor.

rtype

None

Append()¶

Append a plane. returns True if new item has been added (False if item already existed)

param theItem

type theItem

Graphic3d_ClipPlane

rtype

bool

Clear()¶

Clear the items out.

rtype

None

static DownCast(t)¶

First()¶

Return the first item in sequence.

rtype

opencascade::handle<Graphic3d_ClipPlane>

IsEmpty()¶

Return True if sequence is empty.

rtype

bool

Remove()¶

Remove a plane. returns True if item has been found and removed

param theItem

type theItem

Graphic3d_ClipPlane

rtype

bool* Remove a plane.

param theItem

type theItem

Iterator

rtype

None

SetOverrideGlobal()¶

Setup flag defining if local properties should override global properties.

param theToOverride

type theToOverride

bool

rtype

None

Size()¶

Return the number of items in sequence.

rtype

int

ToOverrideGlobal()¶

Return true if local properties should override global properties.

rtype

bool

property thisown¶: The membership flag

class Graphic3d_SequenceOfStructure(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_ShaderAttribute(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates new attribute.

param theName

type theName

TCollection_AsciiString

param theLocation

type theLocation

int

rtype

None

static DownCast(t)¶

Location()¶

Returns attribute location to be bound on GLSL program linkage stage.

rtype

int

Name()¶

Returns name of shader variable.

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class Graphic3d_ShaderAttributeList(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_ShaderObject(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

static CreateFromFile()¶

Creates new shader object from specified file.

param theType

type theType

Graphic3d_TypeOfShaderObject

param thePath

type thePath

TCollection_AsciiString

rtype

opencascade::handle<Graphic3d_ShaderObject>

static CreateFromSource()¶

Creates new shader object from specified source.

param theType

type theType

Graphic3d_TypeOfShaderObject

param theSource

type theSource

TCollection_AsciiString

rtype

opencascade::handle<Graphic3d_ShaderObject>

static DownCast(t)¶

GetId()¶

Returns unique ID used to manage resource in graphic driver.

rtype

TCollection_AsciiString

IsDone()¶

Checks if the shader object is valid or not.

rtype

bool

Path()¶

Returns the full path to the shader source.

rtype

OSD_Path

Source()¶

Returns the source code of the shader object.

rtype

TCollection_AsciiString

Type()¶

Returns type of the shader object.

rtype

Graphic3d_TypeOfShaderObject

property thisown¶: The membership flag

class Graphic3d_ShaderObjectList(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_ShaderProgram(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates new empty program object.

rtype

None

AppendToHeader()¶

Append line to GLSL header.

param theHeaderLine

type theHeaderLine

TCollection_AsciiString

rtype

None

AttachShader()¶

Attaches shader object to the program object.

param theShader

type theShader

Graphic3d_ShaderObject

rtype

bool

ClearVariables()¶

Removes all custom uniform variables from the program.

rtype

None

DetachShader()¶

Detaches shader object from the program object.

param theShader

type theShader

Graphic3d_ShaderObject

rtype

bool

static DownCast(t)¶

GetId()¶

Returns unique ID used to manage resource in graphic driver.

rtype

TCollection_AsciiString

HasAlphaTest()¶

Return true if Fragment Shader should perform alpha test; False by default.

rtype

bool

HasDefaultSampler()¶

Return True if standard program header should define default texture sampler occSampler0; True by default for compatibility.

rtype

bool

HasWeightOitOutput()¶

Return true if Fragment Shader color should output the weighted OIT coverage; False by default.

rtype

bool

Header()¶

Returns GLSL header (version code and extensions).

rtype

TCollection_AsciiString

IsDone()¶

Checks if the program object is valid or not.

rtype

bool

NbClipPlanesMax()¶

Return the length of array of clipping planes (THE_MAX_CLIP_PLANES), to be used for initialization occClipPlaneEquations. Default value is THE_MAX_CLIP_PLANES_DEFAULT.

rtype

int

NbFragmentOutputs()¶

Returns the number (1+) of Fragment Shader outputs to be written to (more than 1 can be in case of multiple draw buffers); 1 by default.

rtype

int

NbLightsMax()¶

Return the length of array of light sources (THE_MAX_LIGHTS), to be used for initialization occLightSources. Default value is THE_MAX_LIGHTS_DEFAULT.

rtype

int

PushVariableFloat()¶

Pushes float uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

float

rtype

bool

PushVariableInt()¶

Pushes int uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

int

rtype

bool

PushVariableVec2()¶

Pushes vec2 uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec2

rtype

bool

PushVariableVec2i()¶

Pushes vec2i uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec2i

rtype

bool

PushVariableVec3()¶

Pushes vec3 uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec3

rtype

bool

PushVariableVec3i()¶

Pushes vec3i uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec3i

rtype

bool

PushVariableVec4()¶

Pushes vec4 uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec4

rtype

bool

PushVariableVec4i()¶

Pushes vec4i uniform.

param theName

type theName

TCollection_AsciiString

param theValue

type theValue

Graphic3d_Vec4i

rtype

bool

SetAlphaTest()¶

Set if Fragment Shader should perform alpha test. Note that this flag is designed for usage with - custom shader program may discard fragment regardless this flag.

param theAlphaTest

type theAlphaTest

bool

rtype

None

SetDefaultSampler()¶

Set if standard program header should define default texture sampler occSampler0.

param theHasDefSampler

type theHasDefSampler

bool

rtype

None

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_texturerequire @endcode

param theHeader

type theHeader

TCollection_AsciiString

rtype

None

SetId()¶

Sets unique ID used to manage resource in graphic driver. WARNING! Graphic3d_ShaderProgram constructor generates a unique id for proper resource management; however if application overrides it, it is responsibility of application to avoid name collisions.

param theId

type theId

TCollection_AsciiString

rtype

None

SetNbClipPlanesMax()¶

Specify the length of array of clipping planes (THE_MAX_CLIP_PLANES).

param theNbPlanes

type theNbPlanes

int

rtype

None

SetNbFragmentOutputs()¶

Sets the number of Fragment Shader outputs to be written to. Should be done before GLSL program initialization.

param theNbOutputs

type theNbOutputs

int

rtype

None

SetNbLightsMax()¶

Specify the length of array of light sources (THE_MAX_LIGHTS).

param theNbLights

type theNbLights

int

rtype

None

SetVertexAttributes()¶

Assign the list of custom vertex attributes. Should be done before GLSL program initialization.

param theAttributes

type theAttributes

Graphic3d_ShaderAttributeList

rtype

None

SetWeightOitOutput()¶

Set if Fragment Shader color should output the weighted OIT coverage. Note that weighted OIT also requires at least 2 Fragment Outputs (color + coverage).

param theOutput

type theOutput

bool

rtype

None

ShaderObjects()¶

Returns list of attached shader objects.

rtype

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.

rtype

TCollection_AsciiString

Variables()¶

The list of currently pushed but not applied custom uniform variables. This list is automatically cleared after applying to GLSL program.

rtype

Graphic3d_ShaderVariableList

VertexAttributes()¶

Return the list of custom vertex attributes.

rtype

Graphic3d_ShaderAttributeList

property thisown¶: The membership flag

class Graphic3d_ShaderVariable(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

static DownCast(t)¶

IsDone()¶

Checks if the shader variable is valid or not.

rtype

bool

Name()¶

Returns name of shader variable.

rtype

TCollection_AsciiString

Value()¶

Returns interface of shader variable value.

rtype

Graphic3d_ValueInterface *

property thisown¶: The membership flag

class Graphic3d_ShaderVariableList(*args)¶

Bases: object

Append()¶

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

Clear()¶

Exchange()¶

First()¶

InsertAfter()¶

InsertBefore()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Prepend()¶

Remove()¶

Reverse()¶

Set()¶

SetValue()¶

Size()¶

Split()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

static delNode()¶

end()¶

property thisown¶: The membership flag

class Graphic3d_Structure(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates a graphic object in the manager theManager. It will appear in all the views of the visualiser. The structure is not displayed when it is created. @param theManager structure manager holding this structure @param theLinkPrs another structure for creating a shadow (linked) structure

param theManager

type theManager

Graphic3d_StructureManager

param theLinkPrs

default value is opencascade::handle<Graphic3d_Structure>()

type theLinkPrs

Graphic3d_Structure

rtype

None

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

param theStructure1

type theStructure1

Graphic3d_Structure *

param theStructure2

type theStructure2

Graphic3d_Structure *

param theType

type theType

Graphic3d_TypeOfConnection

rtype

bool

Ancestors()¶

Returns the group of structures to which <self> is connected.

param SG

type SG

Graphic3d_MapOfStructure

rtype

None

CStructure()¶

Returns the low-level structure

rtype

opencascade::handle<Graphic3d_CStructure>

CalculateBoundBox()¶

Computes axis-aligned bounding box of a structure.

rtype

void

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.

param WithDestruction

default value is Standard_True

type WithDestruction

bool

rtype

void

ClipPlanes()¶

Get clip planes slicing the structure on rendering. returns set of clip planes.

rtype

opencascade::handle<Graphic3d_SequenceOfHClipPlane>

Compute()¶

Return type: None* Returns the new Structure defined for the new visualization :param theProjector: :type theProjector: Graphic3d_DataStructureManager :rtype: opencascade::handle<Graphic3d_Structure>* Returns the new Structure defined for the new visualization :param theProjector: :type theProjector: Graphic3d_DataStructureManager :param theTrsf: :type theTrsf: Geom_Transformation :rtype: opencascade::handle<Graphic3d_Structure>* Returns the new Structure defined for the new visualization :param theProjector: :type theProjector: Graphic3d_DataStructureManager :param theStructure: :type theStructure: Graphic3d_Structure :rtype: None* Returns the new Structure defined for the new visualization :param theProjector: :type theProjector: Graphic3d_DataStructureManager :param theTrsf: :type theTrsf: Geom_Transformation :param theStructure: :type theStructure: Graphic3d_Structure :rtype: None

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;

param theStructure

type theStructure

Graphic3d_Structure *

param theType

type theType

Graphic3d_TypeOfConnection

param theWithCheck

default value is Standard_False

type theWithCheck

bool

rtype

None:param thePrs:

type thePrs

Graphic3d_Structure

rtype

None

ContainsFacet()¶

Returns Standard_True if the structure <self> contains Polygons, Triangles or Quadrangles.

rtype

bool

CurrentGroup()¶

Returns the last created group or creates new one if list is empty.

rtype

opencascade::handle<Graphic3d_Group>

Descendants()¶

Returns the group of structures connected to <self>.

param SG

type SG

Graphic3d_MapOfStructure

rtype

None

Disconnect()¶

Suppress the connection between <AStructure> and <self>.

param theStructure

type theStructure

Graphic3d_Structure *

rtype

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>.

param AType

type AType

Graphic3d_TypeOfConnection

rtype

None

Display()¶

Displays the structure <self> in all the views of the visualiser.

rtype

void

DisplayPriority()¶

Returns the current display priority for this structure.

rtype

int

static DownCast(t)¶

Erase()¶

Erases the structure <self> in all the views of the visualiser.

rtype

void

GetZLayer()¶

Get Z layer ID of displayed structure. The method returns -1 if the structure has no ID (deleted from graphic driver).

rtype

Graphic3d_ZLayerId

GraphicClear()¶

Clears the structure <self>.

param WithDestruction

type WithDestruction

bool

rtype

None

GraphicConnect()¶

Parameters

theDaughter –

type theDaughter: Graphic3d_Structure
rtype: None

GraphicDisconnect()¶

Parameters

theDaughter –

type theDaughter: Graphic3d_Structure
rtype: None

GraphicTransform()¶

Internal method which sets new transformation without calling graphic manager callbacks.

param theTrsf

type theTrsf

Geom_Transformation

rtype

None

Groups()¶

Returns the groups sequence included in this structure.

rtype

Graphic3d_SequenceOfGroup

HLRValidation()¶

Hidden parts stored in this structure are valid if: 1) the owner is defined. 2) they are not invalid.

rtype

bool

Highlight()¶

Highlights the structure in all the views with the given style @param theStyle [in] the style (type of highlighting: box/color, color and opacity) @param theToUpdateMgr [in] defines whether related computed structures will be highlighted via structure manager or not

param theStyle

type theStyle

Graphic3d_PresentationAttributes

param theToUpdateMgr

default value is Standard_True

type theToUpdateMgr

bool

rtype

None

HighlightStyle()¶

Returns the highlight attributes.

rtype

opencascade::handle<Graphic3d_PresentationAttributes>

Identification()¶

Returns the identification number of this structure.

rtype

int

IsDeleted()¶

Returns True if this structure is deleted (after Remove() call).

rtype

bool

IsDisplayed()¶

Returns the display indicator for this structure.

rtype

bool

IsEmpty()¶

Returns Standard_True if the structure <self> is empty. Warning: A structure is empty ifit do not have group or all the groups are empties and it do not have descendant or all the descendants are empties.

rtype

bool

IsHighlighted()¶

Returns the highlight indicator for this structure.

rtype

bool

IsInfinite()¶

Returns Standard_True if the structure <self> is infinite.

rtype

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.

rtype

bool

IsTransformed()¶

Returns True if the structure is transformed.

rtype

bool

IsVisible()¶

Returns the visibility indicator for this structure.

rtype

bool

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.

param theToIgnoreInfiniteFlag

default value is Standard_False

type theToIgnoreInfiniteFlag

bool

rtype

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

param theStructure

type theStructure

Graphic3d_Structure *

param theType

type theType

Graphic3d_TypeOfConnection

param theSet

type theSet

NCollection_Map<Graphic3d_Structure *>

rtype

void

NewGroup()¶

Append new group to this structure.

rtype

opencascade::handle<Graphic3d_Group>

NumberOfGroups()¶

Returns the current number of groups in this structure.

rtype

int

Owner()¶

Return type: Standard_Address

static PrintNetwork()¶

Prints informations about the network associated with the structure <AStructure>.

param AStructure

type AStructure

Graphic3d_Structure

param AType

type AType

Graphic3d_TypeOfConnection

rtype

void

ReCompute()¶

Forces a new construction of the structure <self> if <self> is displayed and TOS_COMPUTED.

rtype

None* Forces a new construction of the structure <self> if <self> is displayed in <aProjetor> and TOS_COMPUTED.

param aProjector

type aProjector

Graphic3d_DataStructureManager

rtype

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

rtype

None:param thePrs:

type thePrs

Graphic3d_Structure

rtype

None* Suppress the structure in the list of descendants or in the list of ancestors.

param thePtr

type thePtr

Graphic3d_Structure *

param theType

type theType

Graphic3d_TypeOfConnection

rtype

None

RemoveAll()¶

Return type: None

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.

rtype

None

SetClipPlanes()¶

Changes a sequence of clip planes slicing the structure on rendering. @param thePlanes [in] the set of clip planes.

param thePlanes

type thePlanes

Graphic3d_SequenceOfHClipPlane

rtype

None

SetComputeVisual()¶

Parameters

theVisual –

type theVisual: Graphic3d_TypeOfStructure
rtype: 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.

param Priority

type Priority

int

rtype

None

SetHLRValidation()¶

Parameters

theFlag –

type theFlag: bool
rtype: None

SetInfiniteState()¶

Sets infinite flag. When True, the MinMaxValues method returns: theXMin = theYMin = theZMin = RealFirst(). theXMax = theYMax = theZMax = RealLast(). By default, structure is created not infinite but empty.

param theToSet

type theToSet

bool

rtype

None

SetIsForHighlight()¶

Marks the structure <self> representing wired structure needed for highlight only so it won’t be added to BVH tree.

param isForHighlight

type isForHighlight

bool

rtype

None

SetMutable()¶

Sets if the structure location has mutable nature (content or location will be changed regularly).

param theIsMutable

type theIsMutable

bool

rtype

None

SetOwner()¶

Parameters

theOwner –

type theOwner: Standard_Address
rtype: None

SetTransformPersistence()¶

Modifies the current transform persistence (pan, zoom or rotate)

param theTrsfPers

type theTrsfPers

Graphic3d_TransformPers

rtype

None

SetTransformation()¶

Modifies the current local transformation

param theTrsf

type theTrsf

Geom_Transformation

rtype

None

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.

param AValue

type AValue

bool

rtype

None

SetVisual()¶

Modifies the visualisation mode for the structure <self>.

param AVisual

type AVisual

Graphic3d_TypeOfStructure

rtype

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

param theLayerId

type theLayerId

int

rtype

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.

param LimitInf

type LimitInf

float

param LimitSup

type LimitSup

float

rtype

None

Transform()¶

Parameters

theTrsf –

type theTrsf: Geom_Transformation
rtype: None

TransformPersistence()¶

returns transform persistence of the presentable object.

rtype

opencascade::handle<Graphic3d_TransformPers>

Transformation()¶

Return local transformation.

rtype

opencascade::handle<Geom_Transformation>

static Transforms()¶

Transforms theX, theY, theZ with the transformation theTrsf.

param theTrsf

type theTrsf

gp_Trsf

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

param theNewX

type theNewX

float

param theNewY

type theNewY

float

param theNewZ

type theNewZ

float

rtype

void

UnHighlight()¶

Suppresses the highlight for the structure <self> in all the views of the visualiser.

rtype

None

Visual()¶

Returns the visualisation mode for the structure <self>.

rtype

Graphic3d_TypeOfStructure

property thisown¶: The membership flag

class Graphic3d_StructureManager(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Initializes the ViewManager. Currently creating of more than 100 viewer instances is not supported and leads to InitializationError and initialization failure. This limitation might be addressed in some future OCCT releases. Warning: Raises InitialisationError if the initialization of the ViewManager failed.

param theDriver

type theDriver

Graphic3d_GraphicDriver

rtype

None

ChangeDisplayPriority()¶

Changes the display priority of the structure <AStructure>.

param theStructure

type theStructure

Graphic3d_Structure

param theOldPriority

type theOldPriority

int

param theNewPriority

type theNewPriority

int

rtype

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.

param theStructure

type theStructure

Graphic3d_Structure

param theLayerId

type theLayerId

int

rtype

void

Clear()¶

Clears the structure.

param theStructure

type theStructure

Graphic3d_Structure *

param theWithDestruction

type theWithDestruction

bool

rtype

void

Connect()¶

Connects the structures.

param theMother

type theMother

Graphic3d_Structure *

param theDaughter

type theDaughter

Graphic3d_Structure *

rtype

void

DefinedViews()¶

Returns the group of views defined in the structure manager.

rtype

Graphic3d_IndexedMapOfView

Disconnect()¶

Disconnects the structures.

param theMother

type theMother

Graphic3d_Structure *

param theDaughter

type theDaughter

Graphic3d_Structure *

rtype

void

Display()¶

Display the structure.

param theStructure

type theStructure

Graphic3d_Structure

rtype

void

DisplayedStructures()¶

Returns the set of structures displayed in visualiser <self>.

param SG

type SG

Graphic3d_MapOfStructure

rtype

None

static DownCast(t)¶

Erase()¶

Erases all the structures.

rtype

void* Erases the structure.

param theStructure

type theStructure

Graphic3d_Structure

rtype

void

GraphicDriver()¶

Returns the graphic driver of <self>.

rtype

opencascade::handle<Graphic3d_GraphicDriver>

Highlight()¶

Highlights the structure.

param theStructure

type theStructure

Graphic3d_Structure

rtype

void

HighlightedStructures()¶

Returns the set of highlighted structures in a visualiser <self>.

param SG

type SG

Graphic3d_MapOfStructure

rtype

None

Identification()¶

Attaches the view to this structure manager and sets its identification number within the manager.

param theView

type theView

Graphic3d_CView *

rtype

int* Returns the structure with the identification number <AId>.

param AId

type AId

int

rtype

opencascade::handle<Graphic3d_Structure>

IsDeviceLost()¶

Returns True if Device Lost flag has been set and presentation data should be reuploaded onto graphics driver.

rtype

bool

MaxNumOfViews()¶

Returns the theoretical maximum number of definable views in the manager. Warning: It’s not possible to accept an infinite number of definable views because each view must have an identification and we have different managers.

rtype

int

ObjectAffinity()¶

Parameters

theObject –

type theObject: Standard_Transient
rtype: opencascade::handle<Graphic3d_ViewAffinity>

ReCompute()¶

Forces a new construction of the structure. if <theStructure> is displayed and TOS_COMPUTED.

param theStructure

type theStructure

Graphic3d_Structure

rtype

void* Forces a new construction of the structure. if <theStructure> is displayed in <theProjector> and TOS_COMPUTED.

param theStructure

type theStructure

Graphic3d_Structure

param theProjector

type theProjector

Graphic3d_DataStructureManager

rtype

void

RecomputeStructures()¶

Recomputes all structures in the manager. Resets Device Lost flag.

rtype

None* Recomputes all structures from theStructures.

param theStructures

type theStructures

NCollection_Map<Graphic3d_Structure *>

rtype

None

RegisterObject()¶

Parameters

theObject –

type theObject: Standard_Transient
rtype: opencascade::handle<Graphic3d_ViewAffinity>

Remove()¶

Deletes and erases the 3D structure manager.

rtype

void

SetDeviceLost()¶

Sets Device Lost flag.

rtype

None

SetTransform()¶

Transforms the structure.

param theStructure

type theStructure

Graphic3d_Structure

param theTrsf

type theTrsf

Geom_Transformation

rtype

void

UnHighlight()¶

Suppress the highlighting on the structure <AStructure>.

param AStructure

type AStructure

Graphic3d_Structure

rtype

void* Suppresses the highlighting on all the structures in <self>.

rtype

void

UnIdentification()¶

Detach the view from this structure manager and release its identification.

param theView

type theView

Graphic3d_CView *

rtype

None

UnregisterObject()¶

Parameters

theObject –

type theObject: Standard_Transient
rtype: None

Update()¶

Invalidates bounding box of specified ZLayerId.

param theLayerId

default value is Graphic3d_ZLayerId_UNKNOWN

type theLayerId

int

rtype

void

property thisown¶: The membership flag

class Graphic3d_Text(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates default text parameters.

param theHeight

type theHeight

Standard_ShortReal

rtype

None

static DownCast(t)¶

HasOwnAnchorPoint()¶

Returns true if the text has an anchor point

rtype

bool

HasPlane()¶

Returns true if the text is filled by a point

rtype

bool

Height()¶

Sets height of text. (Relative to the Normalized Projection Coordinates (NPC) Space).

rtype

Standard_ShortReal

HorizontalAlignment()¶

Returns horizontal alignment of text.

rtype

Graphic3d_HorizontalTextAlignment

Orientation()¶

Returns text orientation in 3D space.

rtype

gp_Ax2

Position()¶

The 3D point of attachment is projected. If the orientation is defined, the text is written in the plane of projection.

rtype

gp_Pnt

ResetOrientation()¶

Reset text orientation in 3D space.

rtype

None

SetHeight()¶

Returns height of text

param theHeight

type theHeight

Standard_ShortReal

rtype

None

SetHorizontalAlignment()¶

Sets horizontal alignment of text.

param theJustification

type theJustification

Graphic3d_HorizontalTextAlignment

rtype

None

SetOrientation()¶

Sets text orientation in 3D space.

param theOrientation

type theOrientation

gp_Ax2

rtype

None

SetOwnAnchorPoint()¶

Returns true if the text has an anchor point

param theHasOwnAnchor

type theHasOwnAnchor

bool

rtype

None

SetPosition()¶

Sets text point.

param thePoint

type thePoint

gp_Pnt

rtype

None

SetText()¶

Sets text value.

param theText

type theText

NCollection_String

rtype

None* Sets text value.

param theText

type theText

TCollection_AsciiString

rtype

None* Sets text value.

param theText

type theText

char *

rtype

None

SetVerticalAlignment()¶

Sets vertical alignment of text.

param theJustification

type theJustification

Graphic3d_VerticalTextAlignment

rtype

None

Text()¶

Returns text value.

rtype

NCollection_String

VerticalAlignment()¶

Returns vertical alignment of text.

rtype

Graphic3d_VerticalTextAlignment

property thisown¶: The membership flag

class Graphic3d_Texture1D(*args, **kwargs)¶

Bases: OCC.Core.Graphic3d.Graphic3d_TextureMap

Empty constructor

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

static DownCast(t)¶

Name()¶

Returns the name of the predefined textures or NOT_1D_UNKNOWN when the name is given as a filename.

rtype

Graphic3d_NameOfTexture1D

static NumberOfTextures()¶

Returns the number of predefined textures.

rtype

int

static TextureName()¶

Returns the name of the predefined texture of rank <aRank>

param aRank

type aRank

int

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class Graphic3d_Texture1Dmanual(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Texture1D

Creates a texture from the file FileName.

param theFileName

type theFileName

TCollection_AsciiString

rtype

None* Create a texture from a predefined texture name set.

param theNOT

type theNOT

Graphic3d_NameOfTexture1D

rtype

None* Creates a texture from the pixmap.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_Texture1Dsegment(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Texture1D

Creates a texture from a file

param theFileName

type theFileName

TCollection_AsciiString

rtype

None* Creates a texture from a predefined texture name set.

param theNOT

type theNOT

Graphic3d_NameOfTexture1D

rtype

None* Creates a texture from the pixmap.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

static DownCast(t)¶

Segment()¶

Returns the values of the current segment X1, Y1, Z1 , X2, Y2, Z2.

param theX1

type theX1

Standard_ShortReal

param theY1

type theY1

Standard_ShortReal

param theZ1

type theZ1

Standard_ShortReal

param theX2

type theX2

Standard_ShortReal

param theY2

type theY2

Standard_ShortReal

param theZ2

type theZ2

Standard_ShortReal

rtype

None

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>

param theX1

type theX1

Standard_ShortReal

param theY1

type theY1

Standard_ShortReal

param theZ1

type theZ1

Standard_ShortReal

param theX2

type theX2

Standard_ShortReal

param theY2

type theY2

Standard_ShortReal

param theZ2

type theZ2

Standard_ShortReal

rtype

None

property thisown¶: The membership flag

class Graphic3d_Texture2D(*args, **kwargs)¶

Bases: OCC.Core.Graphic3d.Graphic3d_TextureMap

Empty constructor

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

static DownCast(t)¶

HasMipMaps()¶

Return true if mip-maps should be used.

rtype

bool

Name()¶

Returns the name of the predefined textures or NOT_2D_UNKNOWN when the name is given as a filename.

rtype

Graphic3d_NameOfTexture2D

static NumberOfTextures()¶

Returns the number of predefined textures.

rtype

int

SetImage()¶

Assign new image to the texture. Note that this method does not invalidate already uploaded resources - consider calling ::UpdateRevision() if needed.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

SetMipMaps()¶

Set if mip-maps should be used (generated if needed). Note that this method should be called before loading / using the texture.

param theToUse

type theToUse

bool

rtype

None

static TextureName()¶

Returns the name of the predefined texture of rank <aRank>

param theRank

type theRank

int

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class Graphic3d_Texture2Dmanual(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Texture2D

Creates a texture from a file. MipMaps levels will be automatically generated if needed.

param theFileName

type theFileName

TCollection_AsciiString

rtype

None* Creates a texture from a predefined texture name set. MipMaps levels will be automatically generated if needed.

param theNOT

type theNOT

Graphic3d_NameOfTexture2D

rtype

None* Creates a texture from the pixmap. MipMaps levels will be automatically generated if needed.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class Graphic3d_Texture2Dplane(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_Texture2D

Creates a texture from a file

param theFileName

type theFileName

TCollection_AsciiString

rtype

None* Creates a texture from a predefined texture name set.

param theNOT

type theNOT

Graphic3d_NameOfTexture2D

rtype

None* Creates a texture from the pixmap.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

static DownCast(t)¶

Plane()¶

Returns the current texture plane name or NOTP_UNKNOWN when the plane is user defined.

rtype

Graphic3d_NameOfTexturePlane

PlaneS()¶

Returns the current texture plane S equation

param A

type A

Standard_ShortReal

param B

type B

Standard_ShortReal

param C

type C

Standard_ShortReal

param D

type D

Standard_ShortReal

rtype

None

PlaneT()¶

Returns the current texture plane T equation

param A

type A

Standard_ShortReal

param B

type B

Standard_ShortReal

param C

type C

Standard_ShortReal

param D

type D

Standard_ShortReal

rtype

None

Rotation()¶

Returns the current texture rotation angle

param theVal

type theVal

Standard_ShortReal

rtype

None

ScaleS()¶

Returns the current texture S scale value

param theVal

type theVal

Standard_ShortReal

rtype

None

ScaleT()¶

Returns the current texture T scale value

param theVal

type theVal

Standard_ShortReal

rtype

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

param thePlane

type thePlane

Graphic3d_NameOfTexturePlane

rtype

None

SetPlaneS()¶

Defines the texture projection plane for texture coordinate S default is <1.0, 0.0, 0.0, 0.0>

param A

type A

Standard_ShortReal

param B

type B

Standard_ShortReal

param C

type C

Standard_ShortReal

param D

type D

Standard_ShortReal

rtype

None

SetPlaneT()¶

Defines the texture projection plane for texture coordinate T default is <0.0, 1.0, 0.0, 0.0>

param A

type A

Standard_ShortReal

param B

type B

Standard_ShortReal

param C

type C

Standard_ShortReal

param D

type D

Standard_ShortReal

rtype

None

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

param theVal

type theVal

Standard_ShortReal

rtype

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

param theVal

type theVal

Standard_ShortReal

rtype

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

param theVal

type theVal

Standard_ShortReal

rtype

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

param theVal

type theVal

Standard_ShortReal

rtype

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

param theVal

type theVal

Standard_ShortReal

rtype

None

TranslateS()¶

Returns the current texture S translation value

param theVal

type theVal

Standard_ShortReal

rtype

None

TranslateT()¶

Returns the current texture T translation value

param theVal

type theVal

Standard_ShortReal

rtype

None

property thisown¶: The membership flag

class Graphic3d_TextureEnv(*args)¶

Bases: OCC.Core.Graphic3d.Graphic3d_TextureRoot

Creates an environment texture from a file.

param theFileName

type theFileName

TCollection_AsciiString

rtype

None* Creates an environment texture from a predefined texture name set.

param theName

type theName

Graphic3d_NameOfTextureEnv

rtype

None* Creates an environment texture from the pixmap.

param thePixMap

type thePixMap

Image_PixMap

rtype

None

static DownCast(t)¶

Name()¶

Returns the name of the predefined textures or NOT_ENV_UNKNOWN when the name is given as a filename.

rtype

Graphic3d_NameOfTextureEnv

static NumberOfTextures()¶

Returns the number of predefined textures.

rtype

int

static TextureName()¶

Returns the name of the predefined texture of rank <aRank>

param theRank

type theRank

int

rtype

TCollection_AsciiString

property thisown¶: The membership flag

class Graphic3d_TextureMap(*args, **kwargs)¶

Bases: OCC.Core.Graphic3d.Graphic3d_TextureRoot

Empty constructor

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

AnisoFilter()¶

returns level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.

rtype

Graphic3d_LevelOfTextureAnisotropy

DisableModulate()¶

disable texture modulate mode. the image is directly decal on the surface.

rtype

None

DisableRepeat()¶

use this methods if you want to disable texture repetition on your objects.

rtype

None

DisableSmooth()¶

disable texture smoothing

rtype

None

static DownCast(t)¶

EnableModulate()¶

enable texture modulate mode. the image is modulate with the shading of the surface.

rtype

None

EnableRepeat()¶

use this methods if you want to enable texture repetition on your objects.

rtype

None

EnableSmooth()¶

enable texture smoothing

rtype

None

IsModulate()¶

Returns True if the texture is modulate.

rtype

bool

IsRepeat()¶

Returns True if the texture repeat is enable.

rtype

bool

IsSmoothed()¶

Returns True if the texture is smoothed.

rtype

bool

SetAnisoFilter()¶

@param theLevel level of anisontropy texture filter.

param theLevel

type theLevel

Graphic3d_LevelOfTextureAnisotropy

rtype

None

property thisown¶: The membership flag

class Graphic3d_TextureParams(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Default constructor.

rtype

None

AnisoFilter()¶

returns level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.

rtype

Graphic3d_LevelOfTextureAnisotropy

static DownCast(t)¶

Filter()¶

returns texture interpolation filter. Default value is Graphic3d_TOTF_NEAREST.

rtype

Graphic3d_TypeOfTextureFilter

GenMode()¶

returns texture coordinates generation mode. Default value is Graphic3d_TOTM_MANUAL.

rtype

Graphic3d_TypeOfTextureMode

GenPlaneS()¶

returns texture coordinates generation plane S.

rtype

Graphic3d_Vec4

GenPlaneT()¶

returns texture coordinates generation plane T.

rtype

Graphic3d_Vec4

IsModulate()¶

returns True if the texture is modulate. Default value is False.

rtype

bool

IsRepeat()¶

returns True if the texture repeat is enabled. Default value is False.

rtype

bool

Rotation()¶

returns rotation angle in degrees Default value is 0.

rtype

Standard_ShortReal

SamplerRevision()¶

Return modification counter of parameters related to sampler state.

rtype

unsigned int

Scale()¶

returns scale factor Default value is no scaling (1.0; 1.0).

rtype

Graphic3d_Vec2

SetAnisoFilter()¶

@param theLevel level of anisontropy texture filter.

param theLevel

type theLevel

Graphic3d_LevelOfTextureAnisotropy

rtype

None

SetFilter()¶

@param theFilter texture interpolation filter.

param theFilter

type theFilter

Graphic3d_TypeOfTextureFilter

rtype

None

SetGenMode()¶

Setup texture coordinates generation mode.

param theMode

type theMode

Graphic3d_TypeOfTextureMode

param thePlaneS

type thePlaneS

Graphic3d_Vec4

param thePlaneT

type thePlaneT

Graphic3d_Vec4

rtype

None

SetModulate()¶

@param theToModulate turn modulation on/off.

param theToModulate

type theToModulate

bool

rtype

None

SetRepeat()¶

@param theToRepeat turn texture repeat mode ON or OFF (clamping).

param theToRepeat

type theToRepeat

bool

rtype

None

SetRotation()¶

@param theAngleDegrees rotation angle.

param theAngleDegrees

type theAngleDegrees

Standard_ShortReal

rtype

None

SetScale()¶

@param theScale scale factor.

param theScale

type theScale

Graphic3d_Vec2

rtype

None

SetTextureUnit()¶

Setup default texture unit.

param theUnit

type theUnit

Graphic3d_TextureUnit

rtype

None

SetTranslation()¶

@param theVec translation vector.

param theVec

type theVec

Graphic3d_Vec2

rtype

None

TextureUnit()¶

Default texture unit to be used, default is Graphic3d_TextureUnit_BaseColor.

rtype

Graphic3d_TextureUnit

Translation()¶

returns translation vector Default value is no translation (0.0; 0.0).

rtype

Graphic3d_Vec2

property thisown¶: The membership flag

class Graphic3d_TextureRoot(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

static DownCast(t)¶

GetId()¶

This ID will be used to manage resource in graphic driver. //! Default implementation generates unique ID within constructor; inheritors may re-initialize it within their constructor, but should never modify it afterwards. //! Multiple Graphic3d_TextureRoot instances 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. //! If this ID is set to empty string by inheritor, then independent graphical resource will be created for each instance of Graphic3d_AspectFillArea3d where texture will be used. //! returns texture identifier.

rtype

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.

rtype

opencascade::handle<Image_PixMap>

GetParams()¶

returns low-level texture parameters

rtype

opencascade::handle<Graphic3d_TextureParams>

IsDone()¶

Checks if a texture class is valid or not. returns true if the construction of the class is correct

rtype

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.

rtype

OSD_Path

Revision()¶

Return image revision.

rtype

Standard_Size

static TexturesFolder()¶

The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. returns the root folder with default textures.

rtype

TCollection_AsciiString

Type()¶

returns the texture type.

rtype

Graphic3d_TypeOfTexture

UpdateRevision()¶

Update image revision. Can be used for signaling changes in the texture source (e.g. file update, pixmap update) without re-creating texture source itself (since unique id should be never modified).

rtype

None

property thisown¶: The membership flag

class Graphic3d_ValidatedCubeMapOrder(*args, **kwargs)¶

Bases: object

property thisown¶: The membership flag

class Graphic3d_ValueInterface(*args, **kwargs)¶

Bases: object

TypeID()¶

Returns unique identifier of value type.

rtype

Standard_Size

property thisown¶: The membership flag

class Graphic3d_Vec2(*args)¶

Bases: object

ChangeData()¶

static DX()¶

static DY()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

SetValues()¶

SquareModulus()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

maxComp()¶

minComp()¶

property thisown¶: The membership flag

x()¶

xy()¶

y()¶

yx()¶

class Graphic3d_Vec2b(*args)¶

Bases: object

ChangeData()¶

static DX()¶

static DY()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

SetValues()¶

SquareModulus()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

maxComp()¶

minComp()¶

property thisown¶: The membership flag

x()¶

xy()¶

y()¶

yx()¶

class Graphic3d_Vec2d(*args)¶

Bases: object

ChangeData()¶

static DX()¶

static DY()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

SetValues()¶

SquareModulus()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

maxComp()¶

minComp()¶

property thisown¶: The membership flag

x()¶

xy()¶

y()¶

yx()¶

class Graphic3d_Vec2i(*args)¶

Bases: object

ChangeData()¶

static DX()¶

static DY()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

SetValues()¶

SquareModulus()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

maxComp()¶

minComp()¶

property thisown¶: The membership flag

x()¶

xy()¶

y()¶

yx()¶

class Graphic3d_Vec2ub(*args)¶

Bases: object

ChangeData()¶

static DX()¶

static DY()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

SetValues()¶

SquareModulus()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

maxComp()¶

minComp()¶

property thisown¶: The membership flag

x()¶

xy()¶

y()¶

yx()¶

class Graphic3d_Vec3(*args)¶

Bases: object

ChangeData()¶

static Cross()¶

static DX()¶

static DY()¶

static DZ()¶

Dot()¶

GetData()¶

static GetLERP()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

Normalize()¶

Normalized()¶

SetValues()¶

SquareModulus()¶

b()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

maxComp()¶

minComp()¶

r()¶

property thisown¶: The membership flag

x()¶

xy()¶

xyz()¶

xz()¶

xzy()¶

y()¶

yx()¶

yxz()¶

yz()¶

yzx()¶

z()¶

zx()¶

zxy()¶

zy()¶

zyx()¶

class Graphic3d_Vec3b(*args)¶

Bases: object

ChangeData()¶

static Cross()¶

static DX()¶

static DY()¶

static DZ()¶

Dot()¶

GetData()¶

static GetLERP()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

Normalize()¶

Normalized()¶

SetValues()¶

SquareModulus()¶

b()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

maxComp()¶

minComp()¶

r()¶

property thisown¶: The membership flag

x()¶

xy()¶

xyz()¶

xz()¶

xzy()¶

y()¶

yx()¶

yxz()¶

yz()¶

yzx()¶

z()¶

zx()¶

zxy()¶

zy()¶

zyx()¶

class Graphic3d_Vec3d(*args)¶

Bases: object

ChangeData()¶

static Cross()¶

static DX()¶

static DY()¶

static DZ()¶

Dot()¶

GetData()¶

static GetLERP()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

Normalize()¶

Normalized()¶

SetValues()¶

SquareModulus()¶

b()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

maxComp()¶

minComp()¶

r()¶

property thisown¶: The membership flag

x()¶

xy()¶

xyz()¶

xz()¶

xzy()¶

y()¶

yx()¶

yxz()¶

yz()¶

yzx()¶

z()¶

zx()¶

zxy()¶

zy()¶

zyx()¶

class Graphic3d_Vec3i(*args)¶

Bases: object

ChangeData()¶

static Cross()¶

static DX()¶

static DY()¶

static DZ()¶

Dot()¶

GetData()¶

static GetLERP()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

Normalize()¶

Normalized()¶

SetValues()¶

SquareModulus()¶

b()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

maxComp()¶

minComp()¶

r()¶

property thisown¶: The membership flag

x()¶

xy()¶

xyz()¶

xz()¶

xzy()¶

y()¶

yx()¶

yxz()¶

yz()¶

yzx()¶

z()¶

zx()¶

zxy()¶

zy()¶

zyx()¶

class Graphic3d_Vec3ub(*args)¶

Bases: object

ChangeData()¶

static Cross()¶

static DX()¶

static DY()¶

static DZ()¶

Dot()¶

GetData()¶

static GetLERP()¶

IsEqual()¶

static Length()¶

Modulus()¶

Multiplied()¶

Multiply()¶

Normalize()¶

Normalized()¶

SetValues()¶

SquareModulus()¶

b()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

maxComp()¶

minComp()¶

r()¶

property thisown¶: The membership flag

x()¶

xy()¶

xyz()¶

xz()¶

xzy()¶

y()¶

yx()¶

yxz()¶

yz()¶

yzx()¶

z()¶

zx()¶

zxy()¶

zy()¶

zyx()¶

class Graphic3d_Vec4(*args)¶

Bases: object

ChangeData()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Multiplied()¶

Multiply()¶

SetValues()¶

a()¶

b()¶

bgr()¶

brg()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

gbr()¶

grb()¶

maxComp()¶

minComp()¶

r()¶

rbg()¶

rgb()¶

property thisown¶: The membership flag

w()¶

wx()¶

wxy()¶

wxz()¶

wy()¶

wyx()¶

wyz()¶

wz()¶

wzx()¶

wzy()¶

x()¶

xw()¶

xwy()¶

xwz()¶

xy()¶

xyw()¶

xyz()¶

xz()¶

xzw()¶

xzy()¶

y()¶

yw()¶

ywx()¶

ywz()¶

yx()¶

yxw()¶

yxz()¶

yz()¶

yzw()¶

yzx()¶

z()¶

zw()¶

zwx()¶

zwy()¶

zx()¶

zxw()¶

zxy()¶

zy()¶

zyw()¶

zyx()¶

class Graphic3d_Vec4b(*args)¶

Bases: object

ChangeData()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Multiplied()¶

Multiply()¶

SetValues()¶

a()¶

b()¶

bgr()¶

brg()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

gbr()¶

grb()¶

maxComp()¶

minComp()¶

r()¶

rbg()¶

rgb()¶

property thisown¶: The membership flag

w()¶

wx()¶

wxy()¶

wxz()¶

wy()¶

wyx()¶

wyz()¶

wz()¶

wzx()¶

wzy()¶

x()¶

xw()¶

xwy()¶

xwz()¶

xy()¶

xyw()¶

xyz()¶

xz()¶

xzw()¶

xzy()¶

y()¶

yw()¶

ywx()¶

ywz()¶

yx()¶

yxw()¶

yxz()¶

yz()¶

yzw()¶

yzx()¶

z()¶

zw()¶

zwx()¶

zwy()¶

zx()¶

zxw()¶

zxy()¶

zy()¶

zyw()¶

zyx()¶

class Graphic3d_Vec4d(*args)¶

Bases: object

ChangeData()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Multiplied()¶

Multiply()¶

SetValues()¶

a()¶

b()¶

bgr()¶

brg()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

gbr()¶

grb()¶

maxComp()¶

minComp()¶

r()¶

rbg()¶

rgb()¶

property thisown¶: The membership flag

w()¶

wx()¶

wxy()¶

wxz()¶

wy()¶

wyx()¶

wyz()¶

wz()¶

wzx()¶

wzy()¶

x()¶

xw()¶

xwy()¶

xwz()¶

xy()¶

xyw()¶

xyz()¶

xz()¶

xzw()¶

xzy()¶

y()¶

yw()¶

ywx()¶

ywz()¶

yx()¶

yxw()¶

yxz()¶

yz()¶

yzw()¶

yzx()¶

z()¶

zw()¶

zwx()¶

zwy()¶

zx()¶

zxw()¶

zxy()¶

zy()¶

zyw()¶

zyx()¶

class Graphic3d_Vec4i(*args)¶

Bases: object

ChangeData()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Multiplied()¶

Multiply()¶

SetValues()¶

a()¶

b()¶

bgr()¶

brg()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

gbr()¶

grb()¶

maxComp()¶

minComp()¶

r()¶

rbg()¶

rgb()¶

property thisown¶: The membership flag

w()¶

wx()¶

wxy()¶

wxz()¶

wy()¶

wyx()¶

wyz()¶

wz()¶

wzx()¶

wzy()¶

x()¶

xw()¶

xwy()¶

xwz()¶

xy()¶

xyw()¶

xyz()¶

xz()¶

xzw()¶

xzy()¶

y()¶

yw()¶

ywx()¶

ywz()¶

yx()¶

yxw()¶

yxz()¶

yz()¶

yzw()¶

yzx()¶

z()¶

zw()¶

zwx()¶

zwy()¶

zx()¶

zxw()¶

zxy()¶

zy()¶

zyw()¶

zyx()¶

class Graphic3d_Vec4ub(*args)¶

Bases: object

ChangeData()¶

Dot()¶

GetData()¶

IsEqual()¶

static Length()¶

Multiplied()¶

Multiply()¶

SetValues()¶

a()¶

b()¶

bgr()¶

brg()¶

cwiseAbs()¶

cwiseMax()¶

cwiseMin()¶

g()¶

gbr()¶

grb()¶

maxComp()¶

minComp()¶

r()¶

rbg()¶

rgb()¶

property thisown¶: The membership flag

w()¶

wx()¶

wxy()¶

wxz()¶

wy()¶

wyx()¶

wyz()¶

wz()¶

wzx()¶

wzy()¶

x()¶

xw()¶

xwy()¶

xwz()¶

xy()¶

xyw()¶

xyz()¶

xz()¶

xzw()¶

xzy()¶

y()¶

yw()¶

ywx()¶

ywz()¶

yx()¶

yxw()¶

yxz()¶

yz()¶

yzw()¶

yzx()¶

z()¶

zw()¶

zwx()¶

zwy()¶

zx()¶

zxw()¶

zxy()¶

zy()¶

zyw()¶

zyx()¶

class Graphic3d_Vertex(*args)¶

Bases: object

Creates a point with 0.0, 0.0, 0.0 coordinates.

rtype

None* Creates a point with coordinates identical to thePoint.

param thePoint

type thePoint

Graphic3d_Vertex

rtype

None* Creates a point with theX, theY and theZ coordinates.

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

rtype

None* Creates a point with theX, theY and theZ coordinates.

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

Coord()¶

Returns the coordinates.

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

rtype

None* Returns the coordinates.

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

Distance()¶

Returns the distance between two points.

param theOther

type theOther

Graphic3d_Vertex

rtype

Standard_ShortReal

SetCoord()¶

Modifies the coordinates.

param theX

type theX

Standard_ShortReal

param theY

type theY

Standard_ShortReal

param theZ

type theZ

Standard_ShortReal

rtype

None* Modifies the coordinates.

param theX

type theX

float

param theY

type theY

float

param theZ

type theZ

float

rtype

None

X()¶

Returns the X coordinates.

rtype

Standard_ShortReal

Y()¶

Returns the Y coordinate.

rtype

Standard_ShortReal

Z()¶

Returns the Z coordinate.

rtype

Standard_ShortReal

property thisown¶: The membership flag

property xyz¶

class Graphic3d_ViewAffinity(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor.

rtype

None

static DownCast(t)¶

IsVisible()¶

Return visibility flag.

param theViewId

type theViewId

int

rtype

bool

SetVisible()¶

Setup visibility flag for all views.

param theIsVisible

type theIsVisible

bool

rtype

None* Setup visibility flag.

param theViewId

type theViewId

int

param theIsVisible

type theIsVisible

bool

rtype

None

property thisown¶: The membership flag

class Graphic3d_WorldViewProjState(*args)¶

Bases: object

Default constructor.

rtype

None* Constructor for custom projector type. @param theProjectionState [in] the projection state. @param theWorldViewState [in] the world view state. @param theCamera [in] the pointer to the class supplying projection and world view matrices (camera).

param theProjectionState

type theProjectionState

Standard_Size

param theWorldViewState

type theWorldViewState

Standard_Size

param theCamera

default value is NULL

type theCamera

Standard_Transient *

rtype

None

Initialize()¶

Initialize world view projection state.

param theProjectionState

type theProjectionState

Standard_Size

param theWorldViewState

type theWorldViewState

Standard_Size

param theCamera

default value is NULL

type theCamera

Standard_Transient *

rtype

None* Initialize world view projection state.

param theCamera

default value is NULL

type theCamera

Standard_Transient *

rtype

None

IsChanged()¶

Compare with other world view projection state. returns true when the projection of the given camera state differs from this one.

param theState

type theState

Graphic3d_WorldViewProjState

rtype

bool

IsProjectionChanged()¶

Compare projection with other state. returns true when the projection of the given camera state differs from this one.

param theState

type theState

Graphic3d_WorldViewProjState

rtype

bool

IsValid()¶

Check state validity. returns true if state is set.

rtype

bool

IsWorldViewChanged()¶

Compare world view transformation with other state. returns true when the orientation of the given camera state differs from this one.

param theState

type theState

Graphic3d_WorldViewProjState

rtype

bool

ProjectionState()¶

returns projection state counter.

rtype

Standard_Size

Reset()¶

Invalidate world view projection state.

rtype

None

Set()¶

Copy world view projection state.

param theOther

type theOther

Graphic3d_WorldViewProjState

rtype

None

WorldViewState()¶

returns world view state counter.

rtype

Standard_Size

property thisown¶: The membership flag

class Graphic3d_ZLayerSettings(*args)¶

Bases: object

Default settings.

rtype

None

ChangePolygonOffset()¶

Modify glPolygonOffset() arguments.

rtype

Graphic3d_PolygonOffset

CullingDistance()¶

Return the distance to discard drawing of distant objects (distance from camera Eye point); by default it is Infinite (distance culling is disabled). Since camera eye definition has no strong meaning within orthographic projection, option is considered only within perspective projection. Note also that this option has effect only when frustum culling is enabled.

rtype

float

CullingSize()¶

Return the size to discard drawing of small objects; by default it is Infinite (size culling is disabled). Current implementation checks the length of projected diagonal of bounding box in pixels for discarding. Note that this option has effect only when frustum culling is enabled.

rtype

float

DisableSetting()¶

Disables theSetting

param theSetting

type theSetting

Graphic3d_ZLayerSetting

rtype

None

EnableSetting()¶

Enables theSetting

param theSetting

type theSetting

Graphic3d_ZLayerSetting

rtype

None

HasCullingDistance()¶

Return True, if culling of distant objects (distance culling) should be performed; False by default. @sa CullingDistance()

rtype

bool

HasCullingSize()¶

Return True, if culling of small objects (size culling) should be performed; False by default. @sa CullingSize()

rtype

bool

IsImmediate()¶

Return true if this layer should be drawn after all normal (non-immediate) layers.

rtype

bool

IsRaytracable()¶

Returns True if layer should be processed by ray-tracing renderer; True by default. Note that this flag is IGNORED for layers with IsImmediate() flag.

rtype

bool

IsSettingEnabled()¶

Returns true if theSetting is enabled.

param theSetting

type theSetting

Graphic3d_ZLayerSetting

rtype

bool

Lights()¶

Return lights list to be used for rendering presentations within this Z-Layer; NULL by default. NULL list (but not empty list!) means that default lights assigned to the View should be used instead of per-layer lights.

rtype

opencascade::handle<Graphic3d_LightSet>

Name()¶

Return user-provided name.

rtype

TCollection_AsciiString

Origin()¶

Return the origin of all objects within the layer.

rtype

gp_XYZ

OriginTransformation()¶

Return the transformation to the origin.

rtype

opencascade::handle<Geom_Transformation>

PolygonOffset()¶

Return glPolygonOffset() arguments.

rtype

Graphic3d_PolygonOffset

SetClearDepth()¶

Set if depth values should be cleared before drawing the layer.

param theValue

type theValue

bool

rtype

None

SetCullingDistance()¶

Set the distance to discard drawing objects.

param theDistance

type theDistance

float

rtype

None

SetCullingSize()¶

Set the distance to discard drawing objects.

param theSize

type theSize

float

rtype

None

SetDepthOffsetNegative()¶

Sets minimal possible negative depth offset.

rtype

None

SetDepthOffsetPositive()¶

Sets minimal possible positive depth offset.

rtype

None

SetEnableDepthTest()¶

Set if depth test should be enabled.

param theValue

type theValue

bool

rtype

None

SetEnableDepthWrite()¶

Set if depth values should be written during rendering.

param theValue

type theValue

bool

rtype

None

SetEnvironmentTexture()¶

Set the flag to allow/prevent environment texture mapping usage for specific layer.

param theValue

type theValue

bool

rtype

None

SetImmediate()¶

Set the flag indicating the immediate layer, which should be drawn after all normal (non-immediate) layers.

param theValue

type theValue

bool

rtype

None

SetLights()¶

Assign lights list to be used.

param theLights

type theLights

Graphic3d_LightSet

rtype

None

SetName()¶

Set custom name.

param theName

type theName

TCollection_AsciiString

rtype

None

SetOrigin()¶

Set the origin of all objects within the layer.

param theOrigin

type theOrigin

gp_XYZ

rtype

None

SetPolygonOffset()¶

Setup glPolygonOffset() arguments.

param theParams

type theParams

Graphic3d_PolygonOffset

rtype

None

SetRaytracable()¶

Sets if layer should be processed by ray-tracing renderer.

param theToRaytrace

type theToRaytrace

bool

rtype

None

SetRenderInDepthPrepass()¶

Set if layer should be rendered within depth pre-pass.

param theToRender

type theToRender

bool

rtype

None

ToClearDepth()¶

Return true if depth values should be cleared before drawing the layer.

rtype

bool

ToEnableDepthTest()¶

Return true if depth test should be enabled.

rtype

bool

ToEnableDepthWrite()¶

Return true depth values should be written during rendering.

rtype

bool

ToRenderInDepthPrepass()¶

Return True if layer should be rendered within depth pre-pass; True by default.

rtype

bool

UseEnvironmentTexture()¶

Return flag to allow/prevent environment texture mapping usage for specific layer.

rtype

bool

property thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶