...
| 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 | --TODO-- | |
| getUVWChannelProperties | Gets UVW channel properties. | |
| getGlobalXform | --TODO-- | |
| getGlobalNormalsXform | --TODO-- | |
| getInverseGlobalXform | --TODO-- | |
| getInverseGlobalNormalsXform | --TODO-- | |
| isGeometryLoader | Checks if the object was created by a geometry loader extension. | |
| isGeometryProcedural | Checks if the object was created by a procedural geometry extension. | |
| hasGeometryModifiers | Checks if the object has geometry modifiers (extensions). | |
| applyGeometryModifierExtension | --TODO-- | |
| cleanAllGeometryModifierExtensions | Clean all geometry modifier extensions applyed to the object. | |
| getGeometryLoaderExtensionParams | --TODO-- | |
| getGeometryProceturalExtensionParams | --TODO-- | |
| getGeometryModifierExtensionNumber | getGeometryModifierExtensionsNumber | Gets the number of geometry modifier extensions applied to the object. |
| getGeometryModifierExtensionParamsAtIndex | --TODO-- | |
Inherited methods
| Anchor | ||||
|---|---|---|---|---|
|
free
Destroys the object.
...
Return value
0 = Error resizing mesh.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
generateCustomUVW
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte generateCustomUVW( dword iChannel, dword iGeneratorType ) |
| Python | int generateCustomUVW( int iChannel, int iGeneratorType ) |
Return value
0 = Error generating custom UVW coordinates.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getUVWChannelProperties
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte getUVWChannelProperties( dword iChannel, byte& projType, bool& customProj, Cbase& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude, real& startAngle, real& endAngle, bool& mirrorBackFaces ) |
| Python | dict getUVWChannelProperties( int iChannel ) |
Return value
C++
0 = Error getting UVW channel properties.
1 = Success.
Python
Dictionary containing the UVW channel properties ('startLatitude', 'endLatutide', 'startLongitude', 'endLongitude', 'startAngle', 'endAngle', 'mirrorBackFaces')
| Anchor | ||||
|---|---|---|---|---|
|
getGlobalXform
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte getGlobalXform( Cbase& xForm ) |
| Python | Cbase getGlobalXform() |
Return value
C++
0 = Error getting --TODO--
1 = Success.
Python
Cbase containing --TODO--
| Anchor | ||||
|---|---|---|---|---|
|
getGlobalNormalsXform
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte getGlobalNormalsXform( Cbase& xForm ) |
| Python | Cbase getGlobalNormalsXform() |
Return value
C++
0 = Error getting --TODO--
1 = Success.
Python
Cbase containing --TODO--
| Anchor | ||||
|---|---|---|---|---|
|
getInverseGlobalXform
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte getInverseGlobalXform( Cbase& ixForm ) |
| Python | Cbase getInverseGlobalXform() |
Return value
C++
0 = Error getting --TODO--
1 = Success.
Python
Cbase containing --TODO--
| Anchor | ||||
|---|---|---|---|---|
|
getInverseGlobalNormalXform
--TODO--.
| Language | Syntax |
|---|---|
| C++ | byte getInverseGlobalNormalXform( Cbase& ixForm ) |
| Python | Cbase getInverseGlobalNormalXform() |
Return value
C++
0 = Error getting --TODO--
1 = Success.
Python
Cbase containing --TODO--
| Anchor | ||||
|---|---|---|---|---|
|
isGeometryLoader
Checks if the object was created by a geometry loader extension.
| Language | Syntax |
|---|---|
| C++ | byte isGeometryLoader( bool& isGeomExtension ) |
| Python | bool isGeometryLoader() |
Return value
C++
0 = Error checking object was created from a geometry loader extension.
1 = Success.
Python
True = the object was created by a geometry loader extension.
| Anchor | ||||
|---|---|---|---|---|
|
isGeometryProcedural
Checks if the object was created by a procedural geometry extension.
| Language | Syntax |
|---|---|
| C++ | byte isGeometryProcedural( bool& isGeomProceduralExtension ) |
| Python | bool isGeometryProcedural() |
Return value
C++
0 = Error checking object was created from a procedural geometry extension.
1 = Success.
Python
True = the object was created by a procedural geometry extension.
| Anchor | ||||
|---|---|---|---|---|
|
hasGeometryModifiers
Checks if the object has geometry modifiers (extensions).
| Language | Syntax |
|---|---|
| C++ | byte hasGeometryModifiers( bool& isGeomModifiersExtension ) |
| Python | bool hasGeometryModifiers() |
Return value
C++
0 = Error checking object have geometry modifiers (extensions).
1 = Success.
Python
True = the object have geometry modifiers (extensions).
| Anchor | ||||
|---|---|---|---|---|
|
cleanAllGeometryModifierExtensions
Clean all geometry modifier extensions applyed to the object.
| Language | Syntax |
|---|---|
| C++ | byte cleanAllGeometryModifierExtensions() |
| Python | int cleanAllGeometryModifierExtensions() |
Return value
0 = Error cleaning geometry modifier extensions.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getGeometryModifierExtensionsNumber
Gets the number of geometry modifier extensions applied to the object.
| Language | Syntax |
|---|---|
| C++ | byte getGeometryModifierExtensionsNumber( dword& numModifierExtensions ) |
| Python | int getGeometryModifierExtensionsNumber() |
Return value
C++
0 = Error getting the number of geometry modifier extensions applied to the object.
1 = Success.
Python
Number of geometry modifier extensions applied to the object.