...
| 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 | setTriangleGroup | 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 | |||
| setBaseAndPivot | |||
| getWorldTransform | |||
| getTransformSubstepsCount | |||
| getTransfrormStepInfoByIndex | |||
| getPosition | |||
| setPosition | |||
| getRotation | |||
| setRotation | |||
| getScale | |||
| setScale | |||
| getShear | |||
| setShear | |||
| getPivotPosition | |||
| setPivotPosition | |||
| getPivotRotation | |||
| setPivotRotation | |||
| isPosRotScaleInitialized | |||
| cleanGeometry | 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 | |||
| setHide | |||
| getHideToCamera | |||
| setHideToCamera | |||
| getHideToReflectionsRefractions | |||
| setHideToReflectionsRefractions | |||
| getHideToGI | |||
| setHideToGI | |||
| isExcludedOfCutPlanes | |||
| excludeOfCutPlanes | |||
| 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 | |||
...
| Type | Name | In/Out | Description |
|---|---|---|---|
| dword& | numDependencies | out | (C++ only) Number of dependencies returned. |
| char**& | paths | out | (C++ onlu) String array (size = numDependencies) containing all the dependencies requested. |
| const bool& | searchIndideProxy | in | If true, the function search for dependencies also in the referenced proxy object if exists. searchInsideProxy is true by default. |
Return value
C++
0 = Error getting dependency paths.
1 = Success.
Python
List of str containing the dependency paths.
...
by default. |
Return value
C++
0 = Error getting dependency paths.
1 = Success.
Python
List of str containing the dependency paths.
| Anchor | ||||
|---|---|---|---|---|
|
getNumVertexes
Gets number of vertexes of the object.
| Language | Syntax |
|---|---|
| C++ | byte getNumVertexes( dword& nVertexes ) |
| Python | int getNumVertexes() |
Return value
C++
0 = Error getting number of vertexes.
1 = Success.
Python
Number of vertexes.
| Anchor | ||||
|---|---|---|---|---|
|
getNumTriangles
Gets number of triangles of the object.
| Language | Syntax |
|---|---|
| C++ | byte getNumTriangles( dword& nTriangles ) |
| Python | int getNumTriangles() |
Return value
C++
0 = Error getting number of triangles.
1 = Success.
Python
Number of triangles.
| Anchor | ||||
|---|---|---|---|---|
|
getNumNormals
Gets number of normals of the object.
| Language | Syntax |
|---|---|
| C++ | byte getNumNormals( dword& nNormals ) |
| Python | int getNumNormals() |
Return value
C++
0 = Error getting number of normals.
1 = Success.
Python
Number of normals.
| Anchor | ||||
|---|---|---|---|---|
|
getNumPositionsPerVertex
Gets number of positions per vertex of the object.
| Language | Syntax |
|---|---|
| C++ | byte getNumPositionsPerVertex( dword& nPositions ) |
| Python | int getNumPositionsPerVertex() |
Return value
C++
0 = Error getting number of positions per vertex.
1 = Success.
Python
Number of positions per vertex.
| Anchor | ||||
|---|---|---|---|---|
|
getNumChannelsUVW
Gets number of UVW channels of the object.
| Language | Syntax |
|---|---|
| C++ | byte getNumChannelsUVW( dword& nChannelsUVW ) |
| Python | int getNumChannelsUVW() |
Return value
C++
0 = Error getting number UVW channels.
1 = Success.
Python
Number of UVW channels.
| Anchor | ||||
|---|---|---|---|---|
|
addChannelUVW
Adds an UVW channel to the object.
| Language | Syntax |
|---|---|
| C++ | byte addChannelUVW( dword& index, byte id = 0xFF ) |
| Python | int addChannelUVW( byte id = 0xFF ) |
Return value
C++
0 = Error adding UVW channel.
1 = Success.
Python
Index of the new channel.
| Anchor | ||||
|---|---|---|---|---|
|
generateSphericalUVW
Generates spherical UVW coordinates.
| Language | Syntax |
|---|---|
| C++ | byte generateSphericalUVW( dword& iChannel, Cbase& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude ) |
| Python | int generateSphericalUVW( int iChannel, Cbase projectorBase, float startLatitude, float endLatitude, float startLongitude, float endLongitude ) |
Return value
0 = Error generating spherical UVW coordinaltes.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
generateCylindricalUVW
Generates cylindrical UVW coordinates.
| Language | Syntax |
|---|---|
| C++ | byte generateCylindricalUVW( dword& iChannel, Cbase& projectorBase, real& startAngle, real& endAngle ) |
| Python | int generateCylindricalUVW( int iChannel, Cbase projectorBase, float startAngle, float endAngle ) |
Return value
0 = Error generating cylindrical UVW coordinaltes.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
generateCubicUVW
Generates cubic UVW coordinates.
| Language | Syntax |
|---|---|
| C++ | byte generateCubicUVW( dword& iChannel, Cbase& projectorBase, bool mirrorBackFaces = false ) |
| Python | int generateCubicUVW( int iChannel, Cbase projectorBase, bool mirrorBackFaces = False ) |
Return value
0 = Error generating cubic UVW coordinaltes.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
generatePlanarUVW
Generates planar UVW coordinates.
| Language | Syntax |
|---|---|
| C++ | byte generatePlanarUVW( dword& iChannel, Cbase& projectorBase ) |
| Python | int generatePlanarUVW( int iChannel, Cbase projectorBase ) |
Return value
0 = Error generating planar UVW coordinaltes.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getVertex
Gets vertex by index.
| Language | Syntax |
|---|---|
| C++ | byte getVertex( dword iVertex, dword iPosition, Cpoint& point ) |
| Python | Cvector getVertex( int iVertex, int iPosition ) |
Return value
C++
0 = Error getting the vertex.
1 = Success.
Python
Cvector containing the vertex requested.
| Anchor | ||||
|---|---|---|---|---|
|
setVertex
Sets vertex by index.
| Language | Syntax |
|---|---|
| C++ | byte setVertex( dword iVertex, dword iPosition, const Cpoint& point ) |
| Python | int setVertex( int iVertex, int iPosition, Cvector point ) |
Return value
0 = Error setting the vertex.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getNormal
Gets normal by index.
| Language | Syntax |
|---|---|
| C++ | byte getNormal( dword iVertex, dword iPosition, Cvector &normal ) |
| Python | Cvector getNormal( int iVertex, int iPosition ) |
Return value
C++
0 = Error getting the normal.
1 = Success.
Python
Cvector containing the normal requested.
| Anchor | ||||
|---|---|---|---|---|
|
setNormal
Sets normal by index.
| Language | Syntax |
|---|---|
| C++ | byte setNormal( dword iNormal, dword iPosition, const Cvector& normal ) |
| Python | int setNormal( int iNormal, int iPosition, Cvector normal ) |
Return value
0 = Error setting the normal.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getTriangle
Gets triangle (vertexes and normals) by index.
| Language | Syntax |
|---|---|
| C++ | byte getTriangle( dword iTriangle, dword &iVertex1, dword &iVertex2, dword &iVertex3, dword &iNormal1, dword &iNormal2, dword &iNormal3 ) |
| Python | dict getTriangle( int iTriangle ) |
Return value
C++
0 = Error getting the triangle.
1 = Success.
Python
Dictionary containing the triangle data ("iVertex1", "iVertex2", "iVertex3", "iNormal1", "iNormal2", "iNormal3").
| Anchor | ||||
|---|---|---|---|---|
|
setTriangle
Sets triangle (vertexes and normals) by index.
| Language | Syntax |
|---|---|
| C++ | byte setTriangle( dword iTriangle, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3 ) |
| Python | int setTriangle( int iTriangle, int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3 ) |
Return value
0 = Error setting the triangle.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getTriangleGroup
Gets triangle group by index.
| Language | Syntax |
|---|---|
| C++ | byte getTriangleGroup( dword iTriangle, dword& idGroup ) |
| Python | int getTriangleGroup( int iTriangle ) |
Return value
C++
0 = Error getting the triangle group.
1 = Success.
Python
Triangle group ID.
| Anchor | ||||
|---|---|---|---|---|
|
setTriangleGroup
Sets group that's the triangle belongs to.
| Language | Syntax |
|---|---|
| C++ | byte setTriangleGroup( dword iTriangle, dword idGroup ) |
| Python | int setTriangleGroup( int iTriangle, int idGroup ) |
Return value
0 = Error setting the triangle group.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getTriangleUVW
Gets triangle UVW coordinates.
| Language | Syntax |
|---|---|
| C++ | byte getTriangleUVW( dword iTriangle, dword iChannelID, float& u1, float& v1, float& w1, float& u2, float& v2, float& w2, float& u3, float& v3, float& w3 ) |
| Python | dict getTriangleUVW( int iTriangle, int iChannelID ) |
Return value
C++
0 = Error getting the triangle UVW coordinates.
1 = Success.
Python
Dictionary containing the triangle UVW coordinates ('u1','v1,'w1,'u2','v2','w2','u2','v2','w3').
| Anchor | ||||
|---|---|---|---|---|
|
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 cleanGeometry() |
| Python | int cleanGeometry() |
Return value
0 = Error cleaning geometry.
1 = Success.