OCC.Core.VrmlData module¶

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

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class VrmlData_Appearance(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

rtype

None

static DownCast(t)¶

Material()¶

/** * Query the Material */

rtype

inline opencascade::handle<VrmlData_Material>

SetMaterial()¶

/** * Set the Material */

param theMat

type theMat

VrmlData_Material

rtype

inline void

SetTexture()¶

/** * Set the Texture */

param theTexture

type theTexture

VrmlData_Texture

rtype

inline void

SetTextureTransform()¶

/** * Set the Texture Transform */

param theTT

type theTT

VrmlData_TextureTransform

rtype

inline void

Texture()¶

/** * Query the Texture */

rtype

inline opencascade::handle<VrmlData_Texture>

TextureTransform()¶

/** * Query the TextureTransform */

rtype

inline opencascade::handle<VrmlData_TextureTransform>

property thisown¶: The membership flag

class VrmlData_Box(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Geometry

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param sizeX

default value is 2

type sizeX

float

param sizeY

default value is 2

type sizeY

float

param sizeZ

default value is 2

type sizeZ

float

rtype

None

static DownCast(t)¶

SetSize()¶

/** * Set the Box Size */

param theSize

type theSize

gp_XYZ

rtype

inline void

Size()¶

/** * Query the Box size */

rtype

inline gp_XYZ

property thisown¶: The membership flag

class VrmlData_Color(*args)¶

Bases: object

/** * Empty constructor. */

rtype

None* /** * Constructor. */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param nColors

default value is 0

type nColors

size_t

param arrColors

default value is 0L

type arrColors

gp_XYZ *

rtype

None

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified.<p> */

param theOther

type theOther

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

Color()¶

/** * Query one color * @param i * index in the array of colors [0 .. N-1] * returns * the color value for the index. If index irrelevant, returns (0., 0., 0.) */

param i

type i

int

rtype

inline Quantity_Color

static DownCast(t)¶

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

SetColors()¶

/** * Set the array data */

param nColors

type nColors

size_t

param arrColors

type arrColors

gp_XYZ *

rtype

inline void

Write()¶

/** * Write the Node to the Scene output. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_Cone(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Geometry

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param theBottomRadius

default value is 1

type theBottomRadius

float

param theHeight

default value is 2

type theHeight

float

rtype

None

BottomRadius()¶

/** * Query the Bottom Radius */

rtype

inline float

static DownCast(t)¶

HasBottom()¶

/** * Query if the bottom circle is included */

rtype

inline bool

HasSide()¶

/** * Query if the side surface is included */

rtype

inline bool

Height()¶

/** * Query the Height */

rtype

inline float

SetBottomRadius()¶

/** * Set the Bottom Radius */

param theRadius

type theRadius

float

rtype

inline void

SetFaces()¶

/** * Set which faces are included */

param hasBottom

type hasBottom

bool

param hasSide

type hasSide

bool

rtype

inline void

SetHeight()¶

/** * Set the Height */

param theHeight

type theHeight

float

rtype

inline void

property thisown¶: The membership flag

class VrmlData_Coordinate(*args)¶

Bases: object

/** * Empty Constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param nPoints

default value is 0

type nPoints

size_t

param arrPoints

default value is 0L

type arrPoints

gp_XYZ *

rtype

None

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified. */

param theOther

type theOther

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

Coordinate()¶

/** * Query one point * @param i * index in the array of points [0 .. N-1] * returns * the coordinate for the index. If index irrelevant, returns (0., 0., 0.) */

param i

type i

int

rtype

inline gp_XYZ

static DownCast(t)¶

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

Write()¶

/** * Write the Node to the Scene output. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_Cylinder(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Geometry

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param theRadius

default value is 1

type theRadius

float

param theHeight

default value is 2

type theHeight

float

rtype

None

static DownCast(t)¶

HasBottom()¶

/** * Query if the bottom circle is included */

rtype

inline bool

HasSide()¶

/** * Query if the side surface is included */

rtype

inline bool

HasTop()¶

/** * Query if the top surface is included */

rtype

inline bool

Height()¶

/** * Query the Height */

rtype

inline float

Radius()¶

/** * Query the Radius */

rtype

inline float

SetFaces()¶

/** * Set which faces are included */

param hasBottom

type hasBottom

bool

param hasSide

type hasSide

bool

param hasTop

type hasTop

bool

rtype

inline void

SetHeight()¶

/** * Set the Height */

param theHeight

type theHeight

float

rtype

inline void

SetRadius()¶

/** * Set the Radius */

param theRadius

type theRadius

float

rtype

inline void

property thisown¶: The membership flag

class VrmlData_DataMapOfShapeAppearance(*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 VrmlData_Geometry(*args, **kwargs)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

Empty constructor

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

static DownCast(t)¶

TShape()¶

/** * Query the shape. This method checks the flag myIsModified; if True it * should rebuild the shape presentation. */

rtype

opencascade::handle<TopoDS_TShape>

property thisown¶: The membership flag

class VrmlData_Group(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty constructor. * @param isTransform * True if the group of type Transform is defined * @param theAlloc * Allocator used for the list of children */

param isTransform

default value is Standard_False

type isTransform

bool

rtype

None* /** * Constructor. * @param theName * Name of the Group node * @param isTransform * True if the group of type Transform is defined * @param theAlloc * Allocator used for the list of children */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param isTransform

default value is Standard_False

type isTransform

bool

rtype

None

AddNode()¶

/** * Add one node to the Group. */

param theNode

type theNode

VrmlData_Node

rtype

inline opencascade::handle<VrmlData_Node>

Box()¶

/** * Query the bounding box. */

rtype

inline Bnd_B3f

static DownCast(t)¶

FindNode()¶

/** * Find a node by its name, inside this Group * @param theName * Name of the node to search for. * @param theLocation * Location of the found node with respect to this Group. */

param theName

type theName

char *

param theLocation

type theLocation

gp_Trsf

rtype

opencascade::handle<VrmlData_Node>

GetTransform()¶

/** * Query the transform value. * For group without transformation this always returns Identity */

rtype

inline gp_Trsf

IsTransform()¶

/** * Query if the node is Transform type. */

rtype

inline bool

NodeIterator()¶

/** * Create iterator on nodes belonging to the Group. */

rtype

inline Iterator

RemoveNode()¶

/** * Remove one node from the Group. * returns * True if the node was located and removed, False if none removed. */

param theNode

type theNode

VrmlData_Node

rtype

bool

SetBox()¶

/** * Set the bounding box. */

param theBox

type theBox

Bnd_B3f

rtype

inline void

SetTransform()¶

/** * Set the transformation. Returns True if the group is Transform type, * otherwise do nothing and return False. */

param theTrsf

type theTrsf

gp_Trsf

rtype

bool

Shape()¶

/** * Get the shape representing the group geometry. */

param theShape

type theShape

TopoDS_Shape

param pMapApp

type pMapApp

VrmlData_DataMapOfShapeAppearance *

rtype

None

property thisown¶: The membership flag

class VrmlData_ImageTexture(*args)¶

Bases: object

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param theURL

default value is 0L

type theURL

char *

param theRepS

default value is Standard_False

type theRepS

bool

param theRepT

default value is Standard_False

type theRepT

bool

rtype

None

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified. */

param theOther

type theOther

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

static DownCast(t)¶

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

URL()¶

/** * Query the associated URL. */

rtype

inline NCollection_List<TCollection_AsciiString>

Write()¶

/** * Write the Node to output stream. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_IndexedFaceSet(*args)¶

Bases: object

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param isCCW

default value is Standard_True

type isCCW

bool

param isSolid

default value is Standard_True

type isSolid

bool

param isConvex

default value is Standard_True

type isConvex

bool

param theCreaseAngle

default value is 0

type theCreaseAngle

float

rtype

None

ArrayColorInd()¶

/** * Query the array of color indice * @param arrColorInd * <tt>[out]</tt> array of colorIndex as it is described in VRML2.0 spec * returns * Number of integers in the array arrColorInd. */

param arrColorInd

type arrColorInd

int * *

rtype

inline size_t

ArrayNormalInd()¶

/** * Query the array of normal indice * @param arrNormalInd * <tt>[out]</tt> array of normalIndex as it is described in VRML2.0 spec * returns * Number of integers in the array arrNormalInd. */

param arrNormalInd

type arrNormalInd

int * *

rtype

inline size_t

ArrayTextureCoordInd()¶

/** * Query the array of texture coordinate indice * @param arrTextureCoordInd * <tt>[out]</tt> array of texCoordIndex as it is described in VRML2.0 spec * returns * Number of integers in the array texCoordIndex. */

param arrTextureCoordInd

type arrTextureCoordInd

int * *

rtype

inline size_t

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified. */

param theOther

type theOther

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

Colors()¶

/** * Query the Colors. */

rtype

inline opencascade::handle<VrmlData_Color>

Coordinates()¶

/** * Query the Coordinates. */

rtype

inline opencascade::handle<VrmlData_Coordinate>

static DownCast(t)¶

GetColor()¶

/** * Query a color for one node in the given element. The color is * interpreted according to fields myColors, myArrColorInd, * myColorPerVertex, as defined in VRML 2.0. * @param iFace * rank of the polygon [0 .. N-1] * @param iVertex * rank of the vertex in the polygon [0 .. M-1]. This parameter is ignored * if (myColorPerVertex == False) * returns * Color value (RGB); if the color is indefinite then returns (0., 0., 0.) */

param iFace

type iFace

int

param iVertex

type iVertex

int

rtype

Quantity_Color

IndiceNormals()¶

/** * Query normals indice for one face. This method should be called after * checking myArrNormalInd != NULL, otherwise exception will be thrown. * @param iFace * rank of the face [0 .. N-1] * @param outIndice * <tt>[out]</tt> array of normals indice * returns * number of indice in the array - the dimension of outIndice array */

param iFace

type iFace

int

param outIndice

type outIndice

int *

rtype

inline int

IsDefault()¶

/** * Returns True if the node is default, so that it should not be written. */

rtype

bool

Normals()¶

/** * Query the Normals. */

rtype

inline opencascade::handle<VrmlData_Normal>

Polygon()¶

/** * Query one polygon. * @param iFace * rank of the polygon [0 .. N-1] * @param outIndice * <tt>[out]</tt> array of vertex indice * returns * number of vertice in the polygon - the dimension of outIndice array */

param iFace

type iFace

int

param outIndice

type outIndice

int *

rtype

inline int

Polygons()¶

/** * Query the array of polygons */

param arrPolygons

type arrPolygons

int * *

rtype

inline size_t

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

SetColorInd()¶

/** * Set the colors array of indice */

param nIndice

type nIndice

Standard_Size

param theIndice

type theIndice

int * *

rtype

inline void

SetColorPerVertex()¶

/** * Set the boolean value ‘colorPerVertex’ */

param isColorPerVertex

type isColorPerVertex

bool

rtype

inline void

SetColors()¶

/** * Set the Color node */

param theColors

type theColors

VrmlData_Color

rtype

inline void

SetCoordinates()¶

/** * Set the nodes */

param theCoord

type theCoord

VrmlData_Coordinate

rtype

inline void

SetNormalInd()¶

/** * Set the normals array of indice */

param nIndice

type nIndice

Standard_Size

param theIndice

type theIndice

int * *

rtype

inline void

SetNormalPerVertex()¶

/** * Set the boolean value ‘normalPerVertex’ */

param isNormalPerVertex

type isNormalPerVertex

bool

rtype

inline void

SetNormals()¶

/** * Set the normals node */

param theNormals

type theNormals

VrmlData_Normal

rtype

inline void

SetPolygons()¶

/** * Set the polygons */

param nPolygons

type nPolygons

Standard_Size

param thePolygons

type thePolygons

int * *

rtype

inline void

SetTextureCoordInd()¶

/** * Set the TexCoordiante array of indice */

param nIndice

type nIndice

Standard_Size

param theIndice

type theIndice

int * *

rtype

inline void

SetTextureCoords()¶

/** * Set the Texture Coordinate node */

param tc

type tc

VrmlData_TextureCoordinate

rtype

inline void

TShape()¶

/** * Query the shape. This method checks the flag myIsModified; if True it * should rebuild the shape presentation. */

rtype

opencascade::handle<TopoDS_TShape>

TextureCoords()¶

/** * Query the Texture Coordinates. */

rtype

inline opencascade::handle<VrmlData_TextureCoordinate>

Write()¶

/** * Write the Node to output stream. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_IndexedLineSet(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Geometry

/** * Empty constructor. */

rtype

None* /** * Constructor. */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param isColorPerVertex

default value is Standard_True

type isColorPerVertex

bool

rtype

None

ArrayColorInd()¶

/** * Query the array of color indice * @param arrColorInd * <tt>[out]</tt> array of colorIndex as it is described in VRML2.0 spec * returns * Number of integers in the array arrColorInd. */

param arrColorInd

type arrColorInd

int * *

rtype

inline size_t

Colors()¶

/** * Query the Colors. */

rtype

inline opencascade::handle<VrmlData_Color>

Coordinates()¶

/** * Query the Coordinates. */

rtype

inline opencascade::handle<VrmlData_Coordinate>

static DownCast(t)¶

GetColor()¶

/** * Query a color for one node in the given element. The color is * interpreted according to fields myColors, myArrColorInd, * myColorPerVertex, as defined in VRML 2.0. * @param iFace * rank of the polygon [0 .. N-1] * @param iVertex * rank of the vertex in the polygon [0 .. M-1]. This parameter is ignored * if (myColorPerVertex == False) * returns * Color value (RGB); if the color is indefinite then returns (0., 0., 0.) */

param iFace

type iFace

int

param iVertex

type iVertex

int

rtype

Quantity_Color

Polygon()¶

/** * Query one polygon. * @param iPolygon * rank of the polygon [0 .. N-1] * @param outIndice * <tt>[out]</tt> array of vertex indice * returns * number of vertice in the polygon - the dimension of outIndice array */

param iPolygon

type iPolygon

int

param outIndice

type outIndice

int *

rtype

inline int

Polygons()¶

/** * Query the array of polygons */

param arrPolygons

type arrPolygons

int * *

rtype

inline size_t

SetColorInd()¶

/** * Set the colors array of indice */

param nIndice

type nIndice

Standard_Size

param theIndice

type theIndice

int * *

rtype

inline void

SetColorPerVertex()¶

/** * Set the boolean value ‘colorPerVertex’ */

param isColorPerVertex

type isColorPerVertex

bool

rtype

inline void

SetColors()¶

/** * Set the Color node */

param theColors

type theColors

VrmlData_Color

rtype

inline void

SetCoordinates()¶

/** * Set the nodes */

param theCoord

type theCoord

VrmlData_Coordinate

rtype

inline void

SetPolygons()¶

/** * Set the polygons */

param nPolygons

type nPolygons

Standard_Size

param thePolygons

type thePolygons

int * *

rtype

inline void

property thisown¶: The membership flag

class VrmlData_ListOfNode(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class VrmlData_MapOfNode(*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 VrmlData_Material(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param theAmbientIntensity

default value is -1

type theAmbientIntensity

float

param theShininess

default value is -1

type theShininess

float

param theTransparency

default value is -1

type theTransparency

float

rtype

None

AmbientIntensity()¶

/** * Query the Ambient Intensity value */

rtype

inline float

DiffuseColor()¶

/** * Query the Diffuse color */

rtype

inline Quantity_Color

static DownCast(t)¶

EmissiveColor()¶

/** * Query the Emissive color */

rtype

inline Quantity_Color

SetAmbientIntensity()¶

/** * Set the Ambient Intensity value */

param theAmbientIntensity

type theAmbientIntensity

float

rtype

inline void

SetDiffuseColor()¶

/** * Query the Diffuse color */

param theColor

type theColor

Quantity_Color

rtype

inline void

SetEmissiveColor()¶

/** * Query the Emissive color */

param theColor

type theColor

Quantity_Color

rtype

inline void

SetShininess()¶

/** * Set the Shininess value */

param theShininess

type theShininess

float

rtype

inline void

SetSpecularColor()¶

/** * Query the Specular color */

param theColor

type theColor

Quantity_Color

rtype

inline void

SetTransparency()¶

/** * Set the Transparency value */

param theTransparency

type theTransparency

float

rtype

inline void

Shininess()¶

/** * Query the Shininess value */

rtype

inline float

SpecularColor()¶

/** * Query the Specular color */

rtype

inline Quantity_Color

Transparency()¶

/** * Query the Transparency value */

rtype

inline float

property thisown¶: The membership flag

class VrmlData_Node(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

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

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified.<p> * This method nullifies the argument node if its member myScene differs * from that one of the current instance. */

param &

type &

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

static DownCast(t)¶

static GlobalIndent()¶

/** * Define the common Indent in spaces, for writing all nodes. */

rtype

inline int

IsDefault()¶

/** * Returns True if the node is default, then it would not be written. */

rtype

bool

Name()¶

/** * Query the name */

rtype

inline char *

static OK()¶

Parameters

theStat –

type theStat: VrmlData_ErrorStatus
rtype: inline bool:param outStat:
type outStat: VrmlData_ErrorStatus
param theStat
type theStat: VrmlData_ErrorStatus
rtype: inline bool

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

static ReadBoolean()¶

/** * Read one boolean value (True or False). */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theResult

type theResult

bool

rtype

VrmlData_ErrorStatus

static ReadInteger()¶

/** * Read one integer value. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theResult

type theResult

long

rtype

VrmlData_ErrorStatus

static ReadMultiString()¶

/** * Read one quoted string, the quotes are removed. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theRes

type theRes

NCollection_List<TCollection_AsciiString>

rtype

VrmlData_ErrorStatus

ReadNode()¶

/** * Read a complete node definition from VRML stream * @param theBuffer * Buffer receiving the input data. * @param theNode * <tt>[out]</tt> Node restored from the buffer data * @param Type * Node type to be checked. If it is NULL(default) no type checking is done. * Otherwise the created node is matched and an error is returned if * no match detected. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theNode

type theNode

VrmlData_Node

param Type

default value is NULL

type Type

Standard_Type

rtype

VrmlData_ErrorStatus

static ReadString()¶

/** * Read one quoted string, the quotes are removed. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theRes

type theRes

TCollection_AsciiString

rtype

VrmlData_ErrorStatus

Scene()¶

/** * Query the Scene that contains this Node */

rtype

inline VrmlData_Scene

Write()¶

/** * Write the Node to output stream. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

WriteClosing()¶

/** * Write the closing brace in the end of a node output. */

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_Normal(*args)¶

Bases: object

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param nVec

default value is 0

type nVec

size_t

param arrVec

default value is 0L

type arrVec

gp_XYZ *

rtype

None

Clone()¶

/** * Create a copy of this node. * If the parameter is null, a new copied node is created. Otherwise new node * is not created, but rather the given one is modified. */

param theOther

type theOther

VrmlData_Node

rtype

opencascade::handle<VrmlData_Node>

static DownCast(t)¶

Normal()¶

/** * Query one normal * @param i * index in the array of normals [0 .. N-1] * returns * the normal value for the index. If index irrelevant, returns (0., 0., 0.) */

param i

type i

int

rtype

inline gp_XYZ

Read()¶

/** * Read the Node from input stream. */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

Write()¶

/** * Write the Node to the Scene output. */

param thePrefix

type thePrefix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_Scene(*args)¶

Bases: object

/** * Constructor. */

param &

default value is 0L

type &

NCollection_IncAllocator

rtype

None

AddNode()¶

/** * Add a Node. If theN belongs to another Scene, it is cloned. * <p>VrmlData_WorldInfo cannot be added, in this case the method * returns a NULL handle. */

param theN

type theN

VrmlData_Node

param isTopLevel

default value is Standard_True

type isTopLevel

bool

rtype

opencascade::handle<VrmlData_Node>

Allocator()¶

/** * Allocator used by all nodes contained in the Scene. */

rtype

inline opencascade::handle<NCollection_IncAllocator>

DumpToString(VrmlData_Scene self) → std::string¶

FindNode()¶

/** * Find a node by its name. * @param theName * Name of the node to find. * @param theType * Type to match. If this value is NULL, the first found node with the * given name is returned. If theType is given, only the node that has * that type is returned. */

param theName

type theName

char *

param theType

default value is 0L

type theType

Standard_Type

rtype

opencascade::handle<VrmlData_Node>* /** * Find a node by its name. * @param theName * Name of the node to search for. * @param theLocation * Location of the found node with respect to the whole VRML shape. */

param theName

type theName

char *

param theLocation

type theLocation

gp_Trsf

rtype

opencascade::handle<VrmlData_Node>

GetIterator()¶

/** * Iterator of Nodes */

rtype

inline Iterator

GetLineError()¶

/** * Query the line where the error occurred (if the status is not OK) */

rtype

inline int

GetShape()¶

/** * Convert the scene to a Shape, with the information on materials defined * for each sub-shape. This method should be used instead of TopoDS_Shape * explicit conversion operator when you need to retrieve the material * aspect for each face or edge in the returned topological object. * @param M * Data Map that binds an Appearance instance to each created TFace or * TEdge if the Appearance node is defined in VRML scene for that geometry. * returns * TopoDS_Shape (Compound) holding all the scene, similar to the result of * explicit TopoDS_Shape conversion operator. */

param M

type M

VrmlData_DataMapOfShapeAppearance

rtype

TopoDS_Shape

IsDummyWrite()¶

/** * Query if the current write operation is dummy, i.e., for the purpose of * collecting information before the real write is commenced. */

rtype

inline bool

NamedNodesIterator()¶

/** * Get the iterator of named nodes. */

rtype

inline VrmlData_MapOfNode::Iterator

ReadArrIndex()¶

/** * Read an array of integer indices, for IndexedfaceSet and IndexedLineSet. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theArr

type theArr

int * *

param theNBl

type theNBl

Standard_Size

rtype

VrmlData_ErrorStatus

static ReadLine()¶

/** * Read a VRML line. Empty lines and comments are skipped. * The processing starts here from theBuffer.LinePtr; if there is at least * one non-empty character (neither space nor comment), this line is used * without reading the next one. * @param theLine * Buffer receiving the input line * @param theInput * Input stream * @param theLen * Length of the input buffer (maximal line length) */

param theBuffer

type theBuffer

VrmlData_InBuffer

rtype

VrmlData_ErrorStatus

ReadReal()¶

/** * Read one real value. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theResult

type theResult

float

param isApplyScale

type isApplyScale

bool

param isOnlyPositive

type isOnlyPositive

bool

rtype

VrmlData_ErrorStatus

static ReadWord()¶

/** * Read a singel word from the input stream, delimited by whitespace. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theStr

type theStr

TCollection_AsciiString

rtype

VrmlData_ErrorStatus

ReadXY()¶

/** * Read one doublet of real values. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theXYZ

type theXYZ

gp_XY

param isApplyScale

type isApplyScale

bool

param isOnlyPositive

type isOnlyPositive

bool

rtype

VrmlData_ErrorStatus

ReadXYZ()¶

/** * Read one triplet of real values. */

param theBuffer

type theBuffer

VrmlData_InBuffer

param theXYZ

type theXYZ

gp_XYZ

param isApplyScale

type isApplyScale

bool

param isOnlyPositive

type isOnlyPositive

bool

rtype

VrmlData_ErrorStatus

SetIndent()¶

/** * Store the indentation for VRML output. * @param nSpc * number of spaces to insert at every indentation level */

param nSpc

type nSpc

int

rtype

inline void

SetLinearScale()¶

/** * Set the scale factor that would be further used in methods * ReadReal, ReadXYZ and ReadXY. All coordinates, distances and sized are * multiplied by this factor during reading the data. */

param theScale

type theScale

float

rtype

inline void

SetVrmlDir()¶

/** * Add the given directory path to the list of VRML file search directories. * This method forms the list of directories ordered according to the * sequence of this method calls. When an Inline node is found, the URLs * in that node are matched with these directories. * The last (implicit) search directory is the current process directory * (‘.’). It takes effect if the list is empty or if there is no match with * exisiting directories. */

param &

type &

TCollection_ExtendedString

rtype

None

Status()¶

/** * Query the status of the previous operation. * Normally it should be equal to VrmlData_StatusOK (no error). */

rtype

inline VrmlData_ErrorStatus

VrmlDirIterator()¶

/** * Returns the directory iterator, to check the presence of requested VRML * file in each iterated directory. */

rtype

inline NCollection_List<TCollection_ExtendedString>::Iterator

WorldInfo()¶

/** * Query the WorldInfo member. */

rtype

opencascade::handle<VrmlData_WorldInfo>

WriteArrIndex()¶

/** * Write an array of integer indices, for IndexedFaceSet and IndexedLineSet. */

param thePrefix

type thePrefix

char *

param theArr

type theArr

int * *

param theNbBl

type theNbBl

Standard_Size

rtype

VrmlData_ErrorStatus

WriteLine()¶

/** * Write a string to the output stream respecting the indentation. The string * can be defined as two substrings that will be separated by a space. * Each of the substrings can be NULL, then it is ignored. If both * are NULL, then a single newline is output (without indent). * @param theLine0 * The first part of string to output * @param theLine1 * The second part of string to output * @param theIndent * - 0 value ignored. * - negative decreases the current indent and then outputs. * - positive outputs and then increases the current indent. * returns * Error status of the stream, or a special error if myOutput == NULL. */

param theLine0

type theLine0

char *

param theLine1

default value is 0L

type theLine1

char *

param theIndent

default value is 0

type theIndent

int

rtype

VrmlData_ErrorStatus

WriteNode()¶

/** * Write the given node to output stream ‘myOutput’. */

param thePrefix

type thePrefix

char *

param &

type &

VrmlData_Node

rtype

VrmlData_ErrorStatus

WriteXYZ()¶

/** * Write a triplet of real values on a separate line. * @param theXYZ * The value to be output. * @param isScale * If True, then each component is divided by myLinearScale. * @param thePostfix * Optional string that is added before the end of the line. */

param theXYZ

type theXYZ

gp_XYZ

param isScale

type isScale

bool

param thePostfix

default value is 0L

type thePostfix

char *

rtype

VrmlData_ErrorStatus

property thisown¶: The membership flag

class VrmlData_ShapeConvert(*args)¶

Bases: object

/** * Constructor. * @param theScene * Scene receiving all Vrml data. * @param theScale * Scale factor, considering that VRML standard specifies coordinates in * meters. So if your data are in mm, you should provide theScale=0.001 */

param theScene

type theScene

VrmlData_Scene

param theScale

default value is 1

type theScale

float

rtype

None

AddShape()¶

/** * Add one shape to the internal list, may be called several times with * different shapes. */

param theShape

type theShape

TopoDS_Shape

param theName

default value is 0L

type theName

char *

rtype

None

Convert()¶

/** * Convert all accumulated shapes and store them in myScene. * The internal data structures are cleared in the end of convertion. * @param theExtractFaces * If True, converter extracst faces from the shapes. * @param theExtractEdges * If True, converter extracts edges from the shapes. * @param theDeflection * Deflection for tessellation of geometrical lines/surfaces. Existing mesh * is used if its deflection is smaller than the one given by this * parameter. * @param theDeflAngle * Angular deflection for tessellation of geometrical lines. */

param theExtractFaces

type theExtractFaces

bool

param theExtractEdges

type theExtractEdges

bool

param theDeflection

default value is 0.01

type theDeflection

float

param theDeflAngle

default value is 20*M_PI/180

type theDeflAngle

float

rtype

None

ConvertDocument()¶

/** * Add all shapes start from given document with colors and names to the internal structure */

param theDoc

type theDoc

TDocStd_Document

rtype

None

property thisown¶: The membership flag

class VrmlData_ShapeNode(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

rtype

None

Appearance()¶

/** * Query the Appearance. */

rtype

inline opencascade::handle<VrmlData_Appearance>

static DownCast(t)¶

Geometry()¶

/** * Query the Geometry. */

rtype

inline opencascade::handle<VrmlData_Geometry>

SetAppearance()¶

/** * Set the Appearance */

param theAppear

type theAppear

VrmlData_Appearance

rtype

inline void

SetGeometry()¶

/** * Set the Geometry */

param theGeometry

type theGeometry

VrmlData_Geometry

rtype

inline void

property thisown¶: The membership flag

class VrmlData_Sphere(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Geometry

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param theRadius

default value is 1

type theRadius

float

rtype

None

static DownCast(t)¶

Radius()¶

/** * Query the sphere radius */

rtype

inline float

SetRadius()¶

/** * Set the spere radius */

param theRadius

type theRadius

float

rtype

inline void

property thisown¶: The membership flag

class VrmlData_TextureCoordinate(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty constructor */

rtype

None* /** * Constructor */

param theScene

type theScene

VrmlData_Scene

param theName

type theName

char *

param nPoints

default value is 0

type nPoints

size_t

param arrPoints

default value is 0L

type arrPoints

gp_XY *

rtype

None

AllocateValues()¶

/** * Create a data array and assign the field myArray. * returns * True if allocation was successful. */

param theLength

type theLength

Standard_Size

rtype

bool

static DownCast(t)¶

Length()¶

/** * Query the number of points */

rtype

inline size_t

Points()¶

/** * Query the points */

rtype

inline gp_XY *

SetPoints()¶

/** * Set the points array */

param nPoints

type nPoints

size_t

param arrPoints

type arrPoints

gp_XY *

rtype

inline void

property thisown¶: The membership flag

class VrmlData_UnknownNode(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty Constructor. */

rtype

None* /** * Constructor. */

param theScene

type theScene

VrmlData_Scene

param theName

default value is 0L

type theName

char *

param theTitle

default value is 0L

type theTitle

char *

rtype

None

static DownCast(t)¶

GetTitle()¶

/** * Query the title of the unknown node. */

rtype

inline TCollection_AsciiString

property thisown¶: The membership flag

class VrmlData_WorldInfo(*args)¶

Bases: OCC.Core.VrmlData.VrmlData_Node

/** * Empty Constructor. */

rtype

None* /** * Constructor. */

param theScene

type theScene

VrmlData_Scene

param theName

default value is 0L

type theName

char *

param theTitle

default value is 0L

type theTitle

char *

rtype

None

AddInfo()¶

/** * Add a string to the list of info strings. */

param theString

type theString

char *

rtype

None

static DownCast(t)¶

InfoIterator()¶

/** * Return the iterator of Info strings. */

rtype

inline NCollection_List< char *>::Iterator

SetTitle()¶

/** * Set or modify the title. */

param theString

type theString

char *

rtype

None

Title()¶

/** * Query the title string. */

rtype

inline char *

property thisown¶: The membership flag