...
| 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 ReaFlow 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-- |
| getGeometryModifierExtensionsNumber | Gets the number of geometry modifier extensions applied to the object. |
| getGeometryModifierExtensionParamsAtIndex | --TODO-- |
...
| Language | Syntax |
|---|---|
| C++ | Cmaxwell::Cobject getInstanced() |
| Python | CmaxwellObject getInstanced() |
Return value
Cmaxwell::Cobject reference to the instanced object. Null object if the object is not an instance, (Cmaxwell::Cobject::isNull() == true).
| Anchor | ||||
|---|---|---|---|---|
|
...
| Language | Syntax |
|---|---|
| C++ | byte getReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial& material ) |
| Python | CmaxwellMaterial getReferencedSceneMaterial( str objectName ) |
...
| Language | Syntax |
|---|---|
| C++ | byte setReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial material ) |
| Python | int setReferencedSceneMaterial( str objectName, Cmaterial CmaxwellMaterial material ) |
Return value
0 = Error setting reference scene file.
...
| Language | Syntax |
|---|---|
| C++ | byte mergeMeshes( const Cmaxwell::Cobject* pMeshes, dword nMeshes ) |
| Python | int mergeMeshes( CmaxwellObject[] meshes ) |
...
| Language | Syntax |
|---|---|
| C++ | byte getMaterial( Cmaxwell::Cmaterial& parent ) |
| Python | CmaxwellMaterial getMaterial() |
Return value
...
| Language | Syntax |
|---|---|
| C++ | byte setMaterial( Cmaxwell::Cmaterial material ) |
| Python | int setMaterial( CmaxwellMaterial material ) |
Return value
0 = Error setting object material.
...
| Language | Syntax |
|---|---|
| C++ | byte generateSphericalUVW( dword& iChannel, Cbase CbaseT& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude ) |
| Python | int generateSphericalUVW( int iChannel, Cbase projectorBase, float startLatitude, float endLatitude, float startLongitude, float endLongitude ) |
...
| Language | Syntax |
|---|---|
| C++ | byte generateCylindricalUVW( dword& iChannel, Cbase& projectorBase, real& startAngle, real& endAngle ) |
| Python | int generateCylindricalUVW( int iChannel, Cbase projectorBase, float startAngle, float endAngle ) |
...
| Language | Syntax |
|---|---|
| C++ | byte generateCubicUVW( dword& iChannel, Cbase& projectorBase, bool mirrorBackFaces = false ) |
| Python | int generateCubicUVW( int iChannel, Cbase projectorBase, bool mirrorBackFaces = False ) |
...
| Language | Syntax |
|---|---|
| C++ | byte generatePlanarUVW( dword& iChannel, Cbase& projectorBase ) |
| Python | int generatePlanarUVW( int iChannel, Cbase projectorBase ) |
Return value
...
| Language | Syntax |
|---|---|
| C++ | byte getVertex( dword iVertex, dword iPosition, Cpoint& point ) |
| Python | Cvector getVertex( int iVertex, int iPosition ) |
...
0 = Error getting the vertex.
1 = Success.
Python
Cvector containing containing the vertex requested.
| Anchor | ||||
|---|---|---|---|---|
|
...
| 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.
...
| Language | Syntax |
|---|---|
| C++ | byte getNormal( dword iVertex, dword iPosition, Cvector&normal ) |
| Python | Cvector getNormal( int iVertex, int iPosition ) |
...
0 = Error getting the normal.
1 = Success.
Python
Cvector containing containing the normal requested.
| Anchor | ||||
|---|---|---|---|---|
|
...
| 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.
...
| Language | Syntax |
|---|---|
| C++ | byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material ) |
| Python | CmaxwellMaterial getTriangleMaterial( int iTriangle ) |
...
| Language | Syntax |
|---|---|
| C++ | byte setTriangleMaterial( dword iTriangle, Cmaxwell Cmaxwell::Cmaterial material ) |
| Python | int setTriangleMaterial( int iTriangle, CmaxwellMaterial CmaxwellMaterial material ) |
Return value
0 = Error setting triangle material.
...
| Language | Syntax |
|---|---|
| C++ | byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material ) |
| Python | CmaxwellMaterial getGroupMaterial( int iGroup ) |
...
| Language | Syntax |
|---|---|
| C++ | byte setGroupMaterial( dword iGroup, Cmaxwell Cmaxwell::Cmaterial material ) |
| Python | int setGroupMaterial( int iGroup, CmaxwellMaterial CmaxwellMaterial material ) |
Return value
0 = Error setting triangle group material.
...
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 ) |
...
| Language | Syntax |
|---|---|
| C++ | byte getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 ) |
| Python | tuple getBaseAndPivot( float substepTime = 0.0 ) |
...
0 = Error getting object base and pivot.
1 = Success.
Python
Object base and pivot axesTuple containing Cbase base and Cbase pivot axes (base,pivot).
| Anchor | ||||
|---|---|---|---|---|
|
...
Return value
...
| Language | Syntax |
|---|---|
| C++ | byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index ) |
| Python | dict getTransformStepInfoByIndex( int index ) |
...
Return value
0 = Error setting color ID.
...
Return value
C++
...
| Language | Syntax |
|---|---|
| C++ | byte getUVWChannelProperties( dword iChannel, byte& projType, bool& customProj, Cbase Crgb& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude, real& startAngle, real& endAngle, bool& mirrorBackFaces ) |
| Python | dict getUVWChannelProperties( int iChannel ) |
...
Dictionary containing the UVW channel properties ('projType', 'customProj', 'projectorBase', 'startLatitude', 'endLatutide', 'startLongitude', 'endLongitude', 'startAngle', 'endAngle', 'mirrorBackFaces').
| Anchor | ||||
|---|---|---|---|---|
|
...
Return value
...
Return value
...
Return value
...
| Language | Syntax |
|---|---|
| C++ | byte getInverseGlobalNormalXform( Cbase& ixForm ) |
| Python | Cbase getInverseGlobalNormalXform() |
...
Number of geometry modifier extensions applied to the object.
...
...