...
| 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 | 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 | This function is useful to display a mesh on a viewport. |
| setColorID | Sets the color used by this object in the Object ID render channel. |
| getColorID | Gets the color used by this object in the Object ID render channel. |
| setGeometryDirty | Set the geometry "dirty". |
| getUserData | Internal use. |
| setUserData | Internal use. |
| getVertexesBuffer | Internal use. |
| getNormalsBuffer | Internal use. |
| getTrianglesBuffer | Internal use. |
| initializeMesh | Clean the mesh and allocates memory for vertexes, normals, triangles and motion blur. |
| resizeMesh | Reinitializes all the basic geometry and UV arrays. |
| generateCustomUVW | |
| getUVWChannelProperties | |
| getGlobalXform | |
| getGlobalNormalsXform | |
| getInverseGlobalXform | |
| getInverseGlobalNormalsXform | |
| isGeometryLoader | |
| isGeometryProcedural | |
| hasGeometryModifiers | |
| applyGeometryModifierExtension | --TODO-- |
| cleanAllGeometryModifierExtensions | |
| getGeometryLoaderExtensionParams | --TODO-- |
| getGeometryProceturalExtensionParams | --TODO-- |
| getGeometryModifierExtensionNumber | |
| getGeometryModifierExtensionParamsAtIndex | --TODO-- |
| Anchor | ||||
|---|---|---|---|---|
|
free
Destroys the object.
...
| Anchor | ||||
|---|---|---|---|---|
|
...
getHideToGI
Gets "hide to global illumination" status of the object.
...
True = object is excluded to cut planes.
False = object is not excluded of cut planes.
...
excludeOfCutPlanes
Sets "excluded of cut planes" status of the object.
cut planes.
False = object is not excluded of cut planes.
| Anchor | ||||
|---|---|---|---|---|
|
excludeOfCutPlanes
Sets "excluded of cut planes" status of the object.
| Language | Syntax |
|---|---|
| C++ | byte excludeOfCutPlanes( bool exclude ) |
| Python | int excludeOfCutPlanes( bool exclude ) |
Return value
0 = Error setting "excluded of cut planes" state.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getProxyDisplayPoints
This function is useful to display a mesh on a viewport. Returns an array with the vertices of the object in object space. This function is not accurate but should be used for preview purposes only.
| Language | Syntax |
|---|---|
| C++ | float* getProxyDisplayPoints( const dword& percent, const dword& maxPoints, dword& nPoints ) |
| Python | array getProxyDisplayPoints( int percent, int maxPoints ) |
Parameters
| Type | Name | In/Out | Description |
|---|---|---|---|
| const dword& | percent | in | Percent of points of the mesh that will be returned. |
| const dword& | maxPoints | in | Maximum number of points that will be in the returned array (-1 means there is not a maximum fixed) |
| dword& | nPoints | out | Number of points returned. |
Return value
C++
Array of nPoints * 3 containing the proxy points requested.
Python
NumPy array containing the proxy points requested. Shape is (nPoints,3).
| Anchor | ||||
|---|---|---|---|---|
|
setColorID
Sets the color used by this object in the Object ID render channel. RGB values must always be in the 0-1 range.
| Language | Syntax |
|---|---|
| C++ | byte setColorID( const Crgb& color ) |
| Python | int setColorID( Crgb color ) |
Return value
0 = Error setting color ID.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getColorID
Gets the color used by this object in the Object ID render channel.
| Language | Syntax |
|---|---|
| C++ | byte getColorID( Crgb& color ) |
| Python | Crgb getColorID() |
Return value
C++
0 = Error getting the color ID.
1 = Success.
Python
Crgb containing the color ID.
| Anchor | ||||
|---|---|---|---|---|
|
setGeometryDirty
Method used to recalculate structures needed in interactive mode when the object changes. It is not needed to call it if the UVs or material change, but just should be called when the mesh or base change.
| Language | Syntax |
|---|---|
| C++ | byte setGeometryDirty() |
| Python | int setGeometryDirty() |
Return value
0 = Error setting geometry dirty.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
initializeMesh
Clean the mesh and allocates memory for vertexes, normals, triangles and motion blur.
| Language | Syntax |
|---|---|
| C++ | byte initializeMesh( dword nVertex, dword nNormals, dword nFaces, dword positionsPerVertex ) |
| Python | int initializeMesh( int nVertex, int nNormals, int nFaces, int positionsPerVertex ) |
Return value
0 = Error initializing mesh.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
resizeMesh
This function reinitializes all the basic geometry and UV arrays. The number of UV channels and their ids remain the same, but UV´s are zeroed. Motion blur vertices can be wiped (if there were) setting newNpositionsPerVertex = 1, or added (if there weren´t) setting newNpositionsPerVertex = 2.
| Language | Syntax |
|---|---|
| C++ | byte excludeOfCutPlanes( bool exclude resizeMesh( dword newNVertex, dword newNNormals, dword newNFaces, dword newNpositionsPerVertex ) |
| Python | int excludeOfCutPlanes( bool exclude resizeMesh( int newNVertex, int newNNormals, int newNFaces, int newNpositionsPerVertex ) |
Return value
0 = Error setting "excluded of cut planes" stateresizing mesh.
1 = Success.