...
| Name | Description |
|---|---|
| setPointer | Internal use. |
| Cobject#free | Destroys the object. |
| getName | Gets object name. |
| setName | Sets object name. |
| isMesh | Checks whether the object is a mesh. |
| isInstance | Checks whether the object is an instance. |
| getInstanced | Gets instance's parent. |
| isRFRK | Checks whether the object is a RFRK object. |
| getRFRKParameters | Gets ReaFlow RenderKit parameters. |
| setRFRKParameters | Sets RealFlow RenderKit parameters. |
| getReferencedScenePath | Gets the scene file referenced by this object. |
| setReferencedScenePath | Sets the scene file referenced by this object. |
| getReferencedSceneMaterial | Gets the material of an specific object inside the referenced scene. |
| setReferencedSceneMaterial | Sets the material of an specific object inside the referenced scene. |
| mergeMeshes | Merges an array of meshes into a single mesh. Target object must not be included. |
| getParent | Gets the parent object in the hierarchy. |
| setParent | Sets the parent object in the hierarchy. |
| getUuid | Unique user ID that can be used for custom purposes. |
| setUuid | Sets the unique user ID. |
| getMaterial | Gets the material applied. |
| setMaterial | Sets the object material. |
| setProperties | Sets the caustics properties of the object. |
| Gets all the extern dependencies of the object (rfrk files, etc). | |
| Geometry | |
| getNumVertexes | Gets number of vertexes of the object. |
| getNumTriangles | Gets number of triangles of the object. |
| getNumNormals | Gets number of the normals of the object. |
| getNumPositionsPerVertex | Gets number of positions per vertex of the object. |
| getNumChannelsUVW | Gets number of UVW channels of the object. |
| addChannelUVW | Adds an UVW channel to the object. |
| generateSphericalUVW | Generates spherical UVW coordinates. |
| generateCylindricalUVW | Generates cylindrical UVW coordinates. |
| generateCubicUVW | Generates cubic UVW coordinates. |
| generatePlanarUVW | Generates planar UVW coordinates. |
| getVertex | Gets vertex by index. |
| setVertex | Sets vertex by index. |
| getNormal | Gets normal by index. |
| setNormal | Sets normal by index. |
| getTriangle | Gets triangle (vertexes and normals) by index. |
| setTriangle | Sets triangle (vertexes and normals) by index. |
| getTriangleGroup | Gets triangle group by index. |
| setTriangleGroup | Sets triangle group. |
| getTriangleUVW | Gets triangle UVW coordinates. |
| setTriangleUVW | Sets triangle UVW coordinantes. |
| getTriangleMaterial | Gets triangle material. |
| setTriangleMaterial | Sets triangle material. |
| getGroupMaterial | Gets material of a group of triangles. |
| setGroupMaterial | Sets material of a group of triangles. |
| getBaseAndPivot | Gets base and pivot axes of the object. |
| setBaseAndPivot | Sets base and pivot axes of the object. |
| getWorldTransform | Return the world transform of the object. |
| getTransformSubstepsCount | Return the number of substeps used for defining Base and Pivot motion blur. |
| getTransfrormStepInfoByIndex | Return transform information( base, pivot and time) for the given index. |
| getPosition | Used by Maxwell Studio (not needed for rendering). |
| setPosition | Used by Maxwell Studio (not needed for rendering). |
| getRotation | Used by Maxwell Studio (not needed for rendering). |
| setRotation | Used by Maxwell Studio (not needed for rendering). |
| getScale | Used by Maxwell Studio (not needed for rendering). |
| setScale | Used by Maxwell Studio (not needed for rendering). |
| getShear | Used by Maxwell Studio (not needed for rendering). |
| setShear | Used by Maxwell Studio (not needed for rendering). |
| getPivotPosition | Used by Maxwell Studio (not needed for rendering). |
| setPivotPosition | Used by Maxwell Studio (not needed for rendering). |
| getPivotRotation | Used by Maxwell Studio (not needed for rendering). |
| setPivotRotation | Used by Maxwell Studio (not needed for rendering). |
| isPosRotScaleInitialized | Checks if the methods above have been used for the given object. |
| cleanGeometry | Optional routine that removes degenerated triangles, repeated/unused vertex and normals. |
| Display | |
| getHide | Gets "hide" status of the object. |
| setHide | Sets "hide" status of the object. |
| getHideToCamera | Gets "hide to camera" status of the object. |
| setHideToCamera | Sets "hide to camera" status of the object. |
| getHideToReflectionsRefractions | Gets "hide to reflections and refractions" status of the object. |
| setHideToReflectionsRefractions | |
| getHideToGI | |
| setHideToGI | |
| isExcludedOfCutPlanes | |
| excludeOfCutPlanes | Sets "hide to reflections and refractions" status of the object. |
| getHideToGI | Gets "hide to global illumination" status of the object. |
| setHideToGI | Gets "hide to global illumination" status of the object. |
| isExcludedOfCutPlanes | Gets "excluded of cut planes" status of the object. |
| excludeOfCutPlanes | Sets "excluded of cut planes" status of the object. |
| getProxyDisplayPoints | |
| setColorID | |
| getColorID | |
| setGeometryDirty | |
| getUserData | |
| setUserData | |
| getVertexesBuffer | |
| getNormalsBuffer | |
| getTrianglesBuffer | |
| initializeMesh | |
| resizeMesh | |
| generateCustomUVW | |
| getUVWChannelProperties | |
| getGlobalXform | |
| getGlobalNormalsXform | |
| getInverseGlobalXform | |
| getInverseGlobalNormalsXform | |
| isGeometryLoader | |
| isGeometryProcedural | |
| hasGeometryModifiers | |
| applyGeometryModifierExtension | |
| cleanAllGeometryModifierExtensions | |
| getGeometryLoaderExtensionParams | |
| getGeometryProceturalExtensionParams | |
| getGeometryModifierExtensionNumber | |
| getGeometryModifierExtensionParamsAtIndex | |
...
| Anchor | ||||
|---|---|---|---|---|
|
setTriangleUVW
Sets triangle UVW coordinantes
setTriangleUVW
Sets triangle UVW coordinantes.
| Language | Syntax |
|---|---|
| C++ | byte setTriangleUVW( dword iTriangle, dword iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3 ) |
| Python | int setTriangleUVW( int iTriangle, int iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u2, float v2, float w3 ) |
Return value
0 = Error setting the triangle UVW coordinates.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getTriangleMaterial
Gets triangle material.
| Language | Syntax |
|---|---|
| C++ | byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material ) |
| Python | CmaxwellMaterial getTriangleMaterial( int iTriangle ) |
Return value
C++
0 = Error getting triangle material.
1 = Success.
Python
Triangle material.
| Anchor | ||||
|---|---|---|---|---|
|
setTriangleMaterial
Sets the triangle material.
| Language | Syntax |
|---|---|
| C++ | byte setTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial material ) |
| Python | int setTriangleMaterial( int iTriangle, CmaxwellMaterial material ) |
Return value
0 = Error setting triangle material.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getGroupMaterial
Gets material of a group of triangles.
| Language | Syntax |
|---|---|
| C++ | byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material ) |
| Python | CmaxwellMaterial getGroupMaterial( int iGroup ) |
Return value
C++
0 = Error getting triangle group material.
1 = Success.
Python
Triangle group material.
| Anchor | ||||
|---|---|---|---|---|
|
setGroupMaterial
Sets material of a group of triangles.
| Language | Syntax |
|---|---|
| C++ | byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material ) |
| Python | int setGroupMaterial( int iGroup, CmaxwellMaterial material ) |
Return value
0 = Error setting triangle group material.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
setBaseAndPivot
Sets base and pivot axes of the object.
| Language | Syntax |
|---|---|
| C++ | byte setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 ) |
| Python | int setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 ) |
Return value
0 = Error setting object base and pivot.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getBaseAndPivot
Gets base and pivot axes of the object.
| Language | Syntax |
|---|---|
| C++ | byte getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 ) |
| Python | tuple getBaseAndPivot( float substepTime = 0.0 ) |
Return value
C++
0 = Error getting object base and pivot.
1 = Success.
Python
Object base and pivot axes.
| Anchor | ||||
|---|---|---|---|---|
|
getWorldTransform
Returns the world transform of the object taking into account base and pivot of all its parents..
| Language | Syntax |
|---|---|
| C++ | byte getWorldTransform( Cbase& base ) |
| Python | Cbase getWorldTransform() |
Return value
C++
0 = Error getting world transform of the object.
1 = Success.
Python
Object world transform.
| Anchor | ||||
|---|---|---|---|---|
|
getTransfromSubstepsCount
Return the number of substeps used for defining Base and Pivot motion blur.
| Language | Syntax |
|---|---|
| C++ | dword getTransformSubstepsCount() |
| Python | int getTransformSubstepsCount() |
| Anchor | ||||
|---|---|---|---|---|
|
getTransformStepInfoByIndex
Return transform information( base, pivot and time) for the given index.
| Language | Syntax |
|---|---|
| C++ | byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index ) |
| Python | dict getTransformStepInfoByIndex( int index ) |
Return value
C++
0 = Error getting transform information of the object.
1 = Success.
Python
Dictionary containing transform information ('base','pivot','time').
| Anchor | ||||
|---|---|---|---|---|
|
isPosRotScaleInitialized
Checks if any of the following methods have been used for the object: setPosition, setRotation, setScale, setShear, setPivotPosition and setPivotRotation. The correct way to transform the object is through the setBaseAndPivot method.
| Language | Syntax |
|---|---|
| C++ | byte isPosRotScaleInitialized( bool& init ) |
| Python | bool isPosRotScaleInitialized() |
Return value
C++
0 = Error getting object transformed for Maxwell Studio.
1 = Success.
Python
True = object initialized using setPosition, setRotation, setScale, setShear, setPivotPosition and/or setPivotRotation (methods used for Maxwell Studio, not for rendering.
| Anchor | ||||
|---|---|---|---|---|
|
cleanGeometry
Optional routine that removes degenerated triangles, repeated/unused vertex and normals. This function is automatically called inside the writeMXS method. It is not needed to call it except in scenarios like the interactive engine.
| Language | Syntax |
|---|---|
| C++ | byte setTriangleUVW( dword iTriangle, dword iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3 cleanGeometry() |
| Python | int setTriangleUVW( int iTriangle, int iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u2, float v2, float w3 cleanGeometry() |
Return value
0 = Error setting the triangle UVW coordinatescleaning geometry.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
...
getHide
Gets triangle material"hide" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material getHide( bool& hide ) |
| Python | CmaxwellMaterial getTriangleMaterialbool getHide( int iTriangle ) |
Return value
C++
0 = Error getting triangle material"hide" status.
1 = Success.
Python
Triangle materialTrue = object is hidden.
False = object is not hidden.
| Anchor | ||||
|---|---|---|---|---|
|
...
setHide
Sets the triangle material"hide" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte setTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial material setHide( bool hide ) |
| Python | int setTriangleMaterial( int iTriangle, CmaxwellMaterial material setHide( bool hide ) |
Return value
0 = Error setting triangle material"hide" state.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
...
getHideToCamera
Gets material of a group of triangles"hide to camera" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material getHideToCamera( bool& hide ) |
| Python | CmaxwellMaterial getGroupMaterialbool getHide( int iGroup ) |
Return value
C++
0 = Error getting triangle group material"hide to camera" status.
1 = Success.
Python
Triangle group materialTrue = object is hidden to camera.
False = object is not hidden to camera.
| Anchor | ||||
|---|---|---|---|---|
|
...
setHideToCamera
Sets material of a group of triangles"hide to camera" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material setHideToCamera( bool hide ) |
| Python | int setGroupMaterial( int iGroup, CmaxwellMaterial material setHideToCamera( bool hide ) |
Return value
0 = Error setting triangle group material"hide to camera" state.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
setBaseAndPivot
...
getHideToReflectionsRefractions
Gets "hide to reflections and refractions" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 getHideToReflectionsRefractions( bool& hide ) |
| Python | int setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 bool getHideToReflectionsRefractions() |
Return value
C++
0 = Error
...
getting "hide to reflections and refractions" status.
1 = Success.
Python
True = object is hidden to reflections and refractions.
False = object is not hidden to reflections and refractions.
| Anchor | ||||
|---|---|---|---|---|
|
getBaseAndPivot
...
setHideToReflectionsRefractions
Sets "hide to reflections and refractions" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 setHideToReflectionsRefractions( bool hide ) |
| Python | tuple getBaseAndPivot( float substepTime = 0.0 int setHideToReflectionsRefractions( bool hide ) |
Return value
...
C++
0 = Error
...
setting "hide to reflections and refractions" state.
1 = Success
...
Python
...
.
| Anchor | ||||
|---|---|---|---|---|
|
getWorldTransform
...
getHideToReflectionsRefractions
Gets "hide to global illumination" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte getWorldTransformgetHideToGI( Cbasebool& base hide ) |
| Python | Cbase getWorldTransformbool getHideToGI() |
Return value
C++
0 = Error getting world transform of the object"hide to global illumination" status.
1 = Success.
Python
Object world transform.
...
getTransfromSubstepsCount
Return the number of substeps used for defining Base and Pivot motion blur.
| Language | Syntax |
|---|---|
| C++ | dword getTransformSubstepsCount() |
| Python | int getTransformSubstepsCount() |
...
getTransformStepInfoByIndex
...
True = object is hidden to global illumination.
False = object is not hidden to global illumination.
| Anchor | ||||
|---|---|---|---|---|
|
setHideToGI
Sets "hide to global Illumination" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index setHideToGI( bool hide ) |
| Python | dict getTransformStepInfoByIndex( int index int setHideToGI( bool hide ) |
Return value
...
C++
0 = Error
...
setting "hide to global illumination" state.
1 = Success.
Python
Dictionary containing transform information ('base','pivot','time').
| Anchor | ||||
|---|---|---|---|---|
|
isPosRotScaleInitialized
...
isExcludedOfCutPlanes
Gets "excluded of cut planes" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte isPosRotScaleInitializedisExcludedOfCutPlanes( bool& init excluded ) |
| Python | bool isPosRotScaleInitialized isExcludedOfCutPlanes() |
Return value
C++
0 = Error getting object transformed for Maxwell Studio"excluded of cut planes" status.
1 = Success.
Python
True = object initialized using setPosition, setRotation, setScale, setShear, setPivotPosition and/or setPivotRotation (methods used for Maxwell Studio, not for renderingis excluded to cut planes.
False = object is not excluded of cut planes.
Optional routine that removes degenerated triangles, repeated/unused vertex and normals. This function is automatically called inside the writeMXS method. It is not needed to call it except in scenarios like the interactive engine
| Anchor | cleangeometry | cleangeometry |
|---|
cleanGeometry
|
excludeOfCutPlanes
Sets "excluded of cut planes" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte cleanGeometryexcludeOfCutPlanes( bool exclude ) |
| Python | int cleanGeometry excludeOfCutPlanes( bool exclude ) |
Return value
0 = Error cleaning geometrysetting "excluded of cut planes" state.
1 = Success.