OCC.Core.VrmlAPI module¶
VrmlAPI module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_vrmlapi.html
-
class
SwigPyIterator(*args, **kwargs)¶ Bases:
object-
advance()¶
-
copy()¶
-
decr()¶
-
distance()¶
-
equal()¶
-
incr()¶
-
next()¶
-
previous()¶
-
property
thisown¶ The membership flag
-
value()¶
-
-
class
VrmlAPI_Writer(*args)¶ Bases:
object- Creates a writer object with default parameters.
- rtype
None
-
Drawer()¶ - Returns drawer object
- rtype
opencascade::handle<VrmlConverter_Drawer>
-
GetFreeBoundsMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetFrontMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetLineMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetPointsMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetRepresentation()¶ - Returns the representation of the shape which is written to the VRML file. Types of representation are set through the VrmlAPI_RepresentationOfShape enumeration.
- rtype
VrmlAPI_RepresentationOfShape
-
GetUisoMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetUnfreeBoundsMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetVisoMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
GetWireMaterial()¶ - Return type
opencascade::handle<Vrml_Material>
-
ResetToDefaults()¶ - Resets all parameters (representation, deflection) to their default values..
- rtype
None
-
SetAmbientColorToMaterial()¶ - Parameters
aMaterial –
- type aMaterial
Vrml_Material
- param Color
- type Color
Quantity_HArray1OfColor
- rtype
None
-
SetDeflection()¶ - Sets the deflection aDef of the mesh algorithm which is used to compute the shaded representation of the translated shape. The default value is -1. When the deflection value is less than 0, the deflection is calculated from the relative size of the shaped.
- param aDef
- type aDef
float
- rtype
None
-
SetDiffuseColorToMaterial()¶ - Parameters
aMaterial –
- type aMaterial
Vrml_Material
- param Color
- type Color
Quantity_HArray1OfColor
- rtype
None
-
SetEmissiveColorToMaterial()¶ - Parameters
aMaterial –
- type aMaterial
Vrml_Material
- param Color
- type Color
Quantity_HArray1OfColor
- rtype
None
-
SetRepresentation()¶ - Sets the representation of the shape aRep which is written to the VRML file. The three options are- shaded - wireframe - both shaded and wireframe (default) defined through the VrmlAPI_RepresentationOfShape enumeration.
- param aRep
- type aRep
VrmlAPI_RepresentationOfShape
- rtype
None
-
SetShininessToMaterial()¶ - Parameters
aMaterial –
- type aMaterial
Vrml_Material
- param aShininess
- type aShininess
float
- rtype
None
-
SetSpecularColorToMaterial()¶ - Parameters
aMaterial –
- type aMaterial
Vrml_Material
- param Color
- type Color
Quantity_HArray1OfColor
- rtype
None
-
SetTransparencyToMaterial()¶ - Set transparency to given material
- param aMaterial
- type aMaterial
Vrml_Material
- param aTransparency
- type aTransparency
float
- rtype
None
-
Write()¶ - Converts the shape aShape to VRML format of the passed version and writes it to the file identified by aFile.
- param aShape
- type aShape
TopoDS_Shape
- param aFile
- type aFile
char *
- param aVersion
default value is 2
- type aVersion
int
- rtype
bool
-
WriteDoc()¶ - Converts the document to VRML format of the passed version and writes it to the file identified by aFile.
- param theDoc
- type theDoc
TDocStd_Document
- param theFile
- type theFile
char *
- param theScale
- type theScale
float
- rtype
bool
-
property
thisown¶ The membership flag
-
class
vrmlapi¶ Bases:
object-
static
Write()¶ - With help of this class user can change parameters of writing. Converts the shape aShape to VRML format of the passed version and writes it to the file identified by aFileName using default parameters.
- param aShape
- type aShape
TopoDS_Shape
- param aFileName
- type aFileName
char *
- param aVersion
default value is 2
- type aVersion
int
- rtype
bool
-
property
thisown¶ The membership flag
-
static