...
| 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 | getProperties | 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 | |||
| getNumTriangles | |||
| getNumNormals | |||
| getNumPositionsPerVertex | |||
| getNumChannelsUVW | |||
| addChannelUVW | |||
| generateSphericalUVW | |||
| generateCylindricalUVW | |||
| generateCubicUVW | |||
| generatePlanarUVW | |||
| getVertex | |||
| setVertex | |||
| getNormal | |||
| setNormal | |||
| getTriangle | |||
| setTriangle | |||
| getTriangleGroup | |||
| setTriangleGroup | |||
| getTriangleUVW | |||
| setTriangleUVW | |||
| getTriangleMaterial | |||
| setTriangleMaterial | |||
| getGroupMaterial | |||
| setGroupMaterial | |||
| getBaseAndPivot | |||
| setBaseAndPivot | |||
| getWorldTransform | |||
| getTransformSubstepsCount | |||
| getTransfrormStepInfoByIndex | |||
| getPosition | |||
| setPosition | |||
| getRotation | |||
| setRotation | |||
| getScale | |||
| setScale | |||
| getShear | |||
| setShear | |||
| getPivotPosition | |||
| setPivotPosition | |||
| getPivotRotation | |||
| setPivotRotation | |||
| isPosRotScaleInitialized | |||
| cleanGeometry | |||
| 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 | |||
...
Merges an array of meshes into a single mesh. The original meshes are not removed (it can be done later calling Cmaxwell::Cobject::free() ). The target object must not be included in the mesh list, so target geometry (if exists) will be erased.
| Language | Syntax |
|---|---|
| C++ | byte mergeMeshes( const Cobject* pMeshes, dword nMeshes ) |
| Python | int mergeMeshes( CmaxwellObject list [] meshes ) |
Return value
0 = Error setting reference scene file.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
meshes = []
meshes.append( scene.getObject("sphere") );
meshes.append( scene.getObject("cube") );
scene.getObject("cubesphere").mergeMeshes( meshes ); // "cubesphere must exists"
scene.getObject("sphere").free();
scene.getObject("cube").free(); |
...
| Anchor | ||||
|---|---|---|---|---|
|
getParent
Gets the parent object in the hierarchy.
| Language | Syntax |
|---|---|
| C++ | byte getParent( Cmaxwell::Cobject& parent ) |
| Python | CmaxwellObject getParent() |
Return value
C++
0 = Error getting parent object.
1 = Success.
Python
Parent object.
| Anchor | ||||
|---|---|---|---|---|
|
setParent
Sets the parent object in the hierarchy.
| Language | Syntax |
|---|---|
| C++ | byte setParent( Cmaxwell::Cobject parent ) |
| Python | int setParent( CmaxwellObject parent ) |
Return value
0 = Error setting parent object.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getUuid
Unique user ID that can be used for custom purposes.
| Language | Syntax |
|---|---|
| C++ | const char* getUuid() |
| Python | str getUuid() |
| Anchor | ||||
|---|---|---|---|---|
|
setUuid
Sets the unique user ID.
| Language | Syntax |
|---|---|
| C++ | byte setUuid( const char* pUuid ) |
| Python | int setUuid( str uuid ) |
Return value
0 = Error setting unique user ID.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getMaterial
Gets the material applied.
| Language | Syntax |
|---|---|
| C++ | byte getMaterial( Cmaxwell::Cmaterial& parent ) |
| Python | CmaxwellMaterial getMaterial() |
Return value
C++
0 = Error getting object material.
1 = Success.
Python
Object material.
| Anchor | ||||
|---|---|---|---|---|
|
setMaterial
Sets the object material.
| Language | Syntax |
|---|---|
| C++ | byte setMaterial( Cmaxwell::Cmaterial material ) |
| Python | int setMaterial( CmaxwellMaterial material ) |
Return value
0 = Error setting object material.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
setProperties
Sets the caustics properties of the object. 1 enables, 0 disables.
| Language | Syntax |
|---|---|
| C++ | byte setProperties( int doDirectCausticsReflection, int doDirectCausticsRefraction, int doIndirectCausticsReflection, int doIndirectCausticsRefraction ) |
| Python | int setProperties( byte doDirectCausticsReflection, byte doDirectCausticsRefraction, byte doIndirectCausticsReflection, byte doIndirectCausticsRefraction ) |
Return value
0 = Error setting object material.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getDependencies
Returns an array of strings with all the extern dependencies of the object (rfrk files, etc).
| Language | Syntax |
|---|---|
| C++ | byte getDependencies( dword& numDependencies, char** & paths, const bool& searchInsideProxy = true ) |
| Python | str[] getDependencies( bool searchInsideProxy = true ) |
Parameters
| 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.