Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescription
setPointerInternal use.
Cobject#freefreeDestroys the object.
getNameGets object name.
setNameSets object name.
isMeshChecks whether the object is a mesh.
isInstanceChecks whether the object is an instance.
getInstancedGets instance's parent.
isRFRKChecks whether the object is a RFRK object.
getRFRKParametersGets ReaFlow RenderKit parameters.
setRFRKParametersSets RealFlow ReaFlow RenderKit  parameters.
getReferencedScenePathGets the scene file referenced by this object.
setReferencedScenePathSets the scene file referenced by this object.
getReferencedSceneMaterialGets the material of an specific object inside the referenced scene.
setReferencedSceneMaterialSets the material of an specific object inside the referenced scene.
getReferencedOverrideFlagsGet the override policy for visibility flags.
setReferencedOverrideFlagsSet the override policy for visibility flags.
mergeMeshesMerges an array of meshes into a single mesh. Target object must not be included.
getParentGets the parent object in the hierarchy.
setParentSets the parent object in the hierarchy.
getUuidUnique user ID that can be used for custom purposes.
setUuidSets the unique user ID.
getMaterialGets the material applied.
setMaterialSets the object material.
setPropertiesSets the caustics properties of the object.

getDependencies

Gets all the extern dependencies of the object (rfrk files, etc).
Geometry
getNumVertexesGets number of vertexes of the object.
getNumTrianglesGets number of triangles of the object.
getNumNormalsGets number of the normals of the object.
getNumPositionsPerVertexGets number of positions per vertex of the object.
getNumChannelsUVWGets number of UVW channels of the object.
addChannelUVWAdds an UVW channel to the object.
generateSphericalUVWGenerates spherical UVW coordinates.
generateCylindricalUVWGenerates cylindrical UVW coordinates.
generateCubicUVWGenerates cubic UVW coordinates.
generatePlanarUVWGenerates planar UVW coordinates.
getVertexGets vertex by index.
setVertexSets vertex by index.
getNormalGets normal by index.
setNormalSets normal by index.
getTriangleGets triangle (vertexes and normals) by index.
setTriangleSets triangle (vertexes and normals) by index.
getTriangleGroupGets triangle group by index.
setTriangleGroupSets triangle group.
getTriangleUVWGets triangle UVW coordinates.
setTriangleUVWSets triangle UVW coordinantes.
getTriangleMaterialGets triangle material.
setTriangleMaterialSets triangle material.
getGroupMaterialGets material of a group of triangles.
setGroupMaterialSets material of a group of triangles.
getBaseAndPivotGets base and pivot axes of the object.
setBaseAndPivotSets base and pivot axes of the object.
getWorldTransformReturn the world transform of the object.
getTransformSubstepsCountReturn the number of substeps used for defining Base and Pivot motion blur.
getTransfrormStepInfoByIndexReturn transform information( base, pivot and time) for the given index.
getPositionUsed by Maxwell Studio (not needed for rendering).
setPositionUsed by Maxwell Studio (not needed for rendering).
getRotationUsed by Maxwell Studio (not needed for rendering).
setRotationUsed by Maxwell Studio (not needed for rendering).
getScaleUsed by Maxwell Studio (not needed for rendering).
setScaleUsed by Maxwell Studio (not needed for rendering).
getShearUsed by Maxwell Studio (not needed for rendering).
setShearUsed by Maxwell Studio (not needed for rendering).
getPivotPositionUsed by Maxwell Studio (not needed for rendering).
setPivotPositionUsed by Maxwell Studio (not needed for rendering).
getPivotRotationUsed by Maxwell Studio (not needed for rendering).
setPivotRotationUsed by Maxwell Studio (not needed for rendering).
isPosRotScaleInitializedChecks if the methods above have been used for the given object.
cleanGeometryOptional routine that removes degenerated triangles, repeated/unused vertex and normals.
Display
getHideGets "hide" status of the object.
setHideSets "hide" status of the object.
getHideToCameraGets "hide to camera" status of the object.
setHideToCameraSets "hide to camera" status of the object.
getHideToReflectionsRefractionsGets "hide to reflections and refractions" status of the object.
setHideToReflectionsRefractionsSets "hide to reflections and refractions" status of the object.
getHideToGIGets "hide to global illumination" status of the object.
setHideToGIGets "hide to global illumination" status of the object.
isExcludedOfCutPlanesGets "excluded of cut planes" status of the object.
excludeOfCutPlanesSets "excluded of cut planes" status of the object.
getProxyDisplayPointsgetReferenceDisplayPointsThis function is useful to display a mesh on a viewport.
setColorIDSets the color used by this object in the Object ID render channel.
getColorIDGets the color used by this object in the Object ID render channel.
setSubdivisionLevelSets the subdivision level of the mesh.
getSubdivisionLevelGets the subdivision level of the mesh.
setGeometryDirtySet the geometry "dirty".
getUserDataInternal use.
setUserDataInternal use.
getVertexesBufferInternal use.
getNormalsBufferInternal use.
getTrianglesBufferInternal use.
initializeMeshClean the mesh and allocates memory for vertexes, normals, triangles and motion blur.
resizeMeshReinitializes all the basic geometry and UV arrays.
generateCustomUVW 
getUVWChannelProperties Gets UVW channel properties.
getGlobalXform 
getGlobalNormalsXform 
getInverseGlobalXform 
getInverseGlobalNormalsXform 
isGeometryLoaderChecks if the object was created by a geometry loader extension.
isGeometryProceduralChecks if the object was created by a procedural geometry extension.
hasGeometryModifiers applyGeometryModifierExtension--TODO--Checks if the object has geometry modifiers (extensions).
applyGeometryModifierExtension 
cleanAllGeometryModifierExtensionsClean all geometry modifier extensions applyed to the object.
getGeometryLoaderExtensionParams--TODO-- 
getGeometryProceturalExtensionParams--TODO--
getGeometryModifierExtensionNumber 
getGeometryModifierExtensionParamsAtIndex--TODO-- 
getGeometryModifierExtensionsNumberGets the number of geometry modifier extensions applied to the object.
getGeometryModifierExtensionParamsAtIndex 

Inherited methods

isNull.

Anchor
free
free

free

Destroys the object.

...

LanguageSyntax
C++Cmaxwell::Cobject getInstanced()
PythonCmaxwellObject getInstanced()

Return value

Cmaxwell::Cobject reference to the instanced object. Null object if the object is not an instance, (Cmaxwell::Cobject::isNull() == true).

Anchor
isrfrk
isrfrk

...

LanguageSyntax
C++byte getReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial& material )
PythonCmaxwellMaterial getReferencedSceneMaterial( str objectName )

...

LanguageSyntax
C++byte setReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial  material )
Pythonint setReferencedSceneMaterial( str objectName, Cmaterial CmaxwellMaterial  material )

Return value

0 = Error setting reference scene file.

1 = Success.

Anchor
mergemeshesgetreferencedoverrideflagsmergemeshes
getreferencedoverrideflags

mergeMeshes

...

getReferencedOverrideFlags

Gets the override policy for visibility flags. Flags are described in OVERRIDE_REFERENCE_FLAGS in maxwellenums.h.

mergeMeshes( const Cobject* pMeshes, dword nMeshes int mergeMeshes( CmaxwellObject[] meshes
LanguageSyntax
C++byte
getReferencedOverrideFlags( byte& flags )
Python
(int flags, int success) getReferencedOverrideFlags()

Return value

C++

0 = Error

...

1 = Success

...

Examples

...

...

languagejavascript
titlePython

...

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(); 

...

getParent

Gets the parent object in the hierarchy.

...

Python

Tuple containing the "override reference" flags of the object, and the function success value.

Anchor
setreferencedoverrideflags
setreferencedoverrideflags

setReferencedOverrideFlags

Sets the override policy for visibility flags. Flags are described in OVERRIDE_REFERENCE_FLAGS in maxwellenums.h.

LanguageSyntax
C++byte getParent( Cmaxwell::Cobject& parent setReferencedOverrideFlags( byte& flags )
PythonCmaxwellObject getParentint setReferencedOverrideFlags( int flags )

Return value

C++

0 = Error

...

1 = Success

...

Python

Anchor

...

anchor
mergemeshes
mergemeshessetparentsetparent

setParent

...

mergeMeshes

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.

LanguageSyntax
C++byte setParentmergeMeshes( const Cmaxwell::Cobject parent * pMeshes, dword nMeshes )
Pythonint setParentmergeMeshes( CmaxwellObject parent [] meshes )

Return value

0 = Error setting parent objectreference scene file.

1 = Success.anchor

Examples

...

Code Block

...

language

getUuid

Unique user ID that can be used for custom purposes.

LanguageSyntax
C++const char* getUuid()
Pythonstr getUuid()

...

setUuid

Sets the unique user ID.

LanguageSyntax
C++byte setUuid( const char* pUuid )
Pythonint setUuid( str uuid )

Return value

0 = Error setting unique user ID.

1 = Success.

...

getMaterial

Gets the material applied.

LanguageSyntax
C++byte getMaterial( Cmaxwell::Cmaterial& parent )
PythonCmaxwellMaterial getMaterial()

Return value

C++

0 = Error getting object material.

1 = Success.

Python

Object material.

...

setMaterial

...

javascript
titlePython
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
getparent

getParent

Gets the parent object in the hierarchy.

LanguageSyntax
C++byte setMaterialgetParent( Cmaxwell::Cmaterial material Cobject& parent )
Pythonint setMaterialCmaxwellObject getParent( CmaxwellMaterial material )

Return value

C++

0 = Error

...

getting parent object

...

.

1 = Success.

Python

Parent object.

Anchor
setpropertiessetparentsetproperties
setparent

...

setParent

Sets the caustics properties of the object. 1 enables, 0 disables.parent object in the hierarchy.

LanguageSyntax
C++byte setProperties( int doDirectCausticsReflection, int doDirectCausticsRefraction, int doIndirectCausticsReflection, int doIndirectCausticsRefraction setParent( Cmaxwell::Cobject parent )
Pythonint setProperties( byte doDirectCausticsReflection, byte doDirectCausticsRefraction, byte doIndirectCausticsReflection, byte doIndirectCausticsRefraction setParent( CmaxwellObject parent )

Return value

0 = Error setting parent object material.

1 = Success.

Anchor
getdependenciesgetuuidgetdependencies
getuuid

getDependencies

...

getUuid

Unique user ID that can be used for custom purposes.

LanguageSyntax
C++byte getDependencies( dword& numDependencies, char** & paths, const bool& searchInsideProxy = true const char* getUuid()
Pythonstr [] getDependencies( bool searchInsideProxy = true getUuid()

...

Anchor

...

setuuid

...

setuuid

...

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.

...

getNumVertexes

...

setUuid

Sets the unique user ID.

LanguageSyntax
C++byte setUuid( const char* pUuid )
Pythonint setUuid( str uuid )

Return value

0 = Error setting unique user ID.

1 = Success.

Anchor
getmaterial
getmaterial

getMaterial

Gets the material applied.

LanguageSyntax
C++byte getNumVertexes( dword& nVertexes getMaterial( Cmaxwell::Cmaterial& parent )
Pythonint getNumVertexesCmaxwellMaterial  getMaterial()

Return value

C++

0 = Error getting number of vertexesobject material.

1 = Success.

Python

Number of vertexesObject material.

Anchor
getnumtrianglessetmaterialgetnumtriangles
setmaterial

getNumTriangles

...

setMaterial

Sets the object material.

LanguageSyntax
C++byte getNumTriangles( dword& nTriangles setMaterial( Cmaxwell::Cmaterial material )
Pythonint getNumTrianglessetMaterial( CmaxwellMaterial  material )

Return value

C++

...

0 = Error

...

setting object material.

1 = Success

...

Python

...

.

Anchor
getnumnormalssetpropertiesgetnumnormals
setproperties

getNumNormals

...

setProperties

Sets the caustics properties of the object. 1 enables, 0 disables.

LanguageSyntax
C++byte getNumNormals( dword& nNormals )
Pythonint getNumNormals()

Return value

C++

...

setProperties( int doDirectCausticsReflection, int doDirectCausticsRefraction, int doIndirectCausticsReflection, int doIndirectCausticsRefraction )
Pythonint setProperties( byte doDirectCausticsReflection, byte doDirectCausticsRefraction, byte doIndirectCausticsReflection, byte doIndirectCausticsRefraction )

Return value

0 = Error setting object material.

1 = Success.

...

Python

...

Anchor
getnumpositionspervertexgetdependenciesgetnumpositionspervertex
getdependencies

getNumPositionsPerVertex

...

getDependencies

Returns an array of strings with all the extern dependencies of the object (rfrk files, etc).

LanguageSyntax
C++byte getNumPositionsPerVertexgetDependencies( dword& nPositions & numDependencies, char** & paths, const bool& searchInsideProxy = true )
Pythonint getNumPositionsPerVertex(str[] getDependencies( bool searchInsideProxy = true )

Return value

C++

0 = Error getting number of positions per vertex.

1 = Success.

Python

Number of positions per vertex.

...

getNumChannelsUVW

Gets number of UVW channels of the object.

LanguageSyntax
C++byte getNumChannelsUVW( dword& nChannelsUVW )
Pythonint getNumChannelsUVW()

Return value

C++

...

Parameters

TypeNameIn/OutDescription
dword&numDependenciesout(C++ only) Number of dependencies returned.
char**&pathsout(C++ onlu) String array (size = numDependencies) containing all the dependencies requested.
const bool&searchIndideProxyin

If true, the function search for dependencies also in the referenced proxy objects if exists. searchInsideProxy is true by default.

Return value

C++

0 = Error getting dependency paths.

1 = Success.

Python

Number of UVW channelsList of str containing the dependency paths.

Anchor
addchanneluvwgetnumvertexesaddchanneluvw
getnumvertexes

addChannelUVW

...

getNumVertexes

Gets number of vertexes of the object.

LanguageSyntax
C++byte addChannelUVWgetNumVertexes( dword& index, byte id = 0xFF )nVertexes )
Pythonint addChannelUVWgetNumVertexes( byte id = 0xFF )

Return value

C++

0 = Error adding UVW channelgetting number of vertexes.

1 = Success.

Python

Index Number of the new channelvertexes.

Anchor
generatesphericaluvwgetnumtrianglesgeneratesphericaluvw
getnumtriangles

generateSphericalUVW

...

getNumTriangles

Gets number of triangles of the object.

LanguageSyntax
C++byte generateSphericalUVWgetNumTriangles( dword& iChannel, Cbase& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude nTriangles )
Pythonint generateSphericalUVW( int iChannel, Cbase projectorBase, float startLatitude, float endLatitude, float startLongitude, float endLongitude getNumTriangles()

Return value

C++

0 = Error

...

getting number of triangles.

1 = Success.

Python

Number of triangles.

Anchor
generatecylindricaluvwgetnumnormalsgeneratecylindricaluvw
getnumnormals

generateCylindricalUVW

...

getNumNormals

Gets number of normals of the object.

LanguageSyntax
C++byte generateCylindricalUVWgetNumNormals( dword& iChannel, Cbase& projectorBase, real& startAngle, real& endAngle nNormals )
Pythonint generateCylindricalUVW( int iChannel, Cbase projectorBase, float startAngle, float endAngle getNumNormals()

Return value

C++

0 = Error

...

getting number of normals.

1 = Success.

...

generateCubicUVW

Generates cubic UVW coordinates.

...

Python

Number of normals.

Anchor
getnumpositionspervertex
getnumpositionspervertex

getNumPositionsPerVertex

Gets number of positions per vertex of the object.

LanguageSyntax
C++byte generateCubicUVWgetNumPositionsPerVertex( dword& iChannel, Cbase& projectorBase, bool mirrorBackFaces = false nPositions )
Pythonint generateCubicUVW( int iChannel, Cbase projectorBase, bool mirrorBackFaces = False getNumPositionsPerVertex()

Return value

C++

0 = Error

...

getting number of positions per vertex.

1 = Success.

Python

Number of positions per vertex.

Anchor
generateplanaruvwgetnumchannelsuvwgenerateplanaruvw
getnumchannelsuvw

generatePlanarUVW

...

getNumChannelsUVW

Gets number of UVW channels of the object.

LanguageSyntax
C++byte generatePlanarUVWgetNumChannelsUVW( dword& iChannel, Cbase& projectorBase nChannelsUVW )
Pythonint generatePlanarUVW( int iChannel, Cbase projectorBase )

...

getNumChannelsUVW()

Return value

C++

0 = Error

...

getting number UVW

...

channels.

1 = Success.

Python

Number of UVW channels.

Anchor
getvertexaddchanneluvwgetvertex
addchanneluvw

getVertex

...

addChannelUVW

Adds an UVW channel to the object.

LanguageSyntax
C++byte getVertexaddChannelUVW( dword iVertex, dword iPosition, Cpoint& point & index, byte id = 0xFF )
PythonCvector getVertex( int iVertex, int iPosition int addChannelUVW( byte id = 0xFF )

Return value

C++

0 = Error getting the vertexadding UVW channel.

1 = Success.

Python

Cvector containing the vertex requestedIndex of the new channel.

Anchor
setvertexgeneratesphericaluvwsetvertex
generatesphericaluvw

setVertex

...

generateSphericalUVW

Generates spherical UVW coordinates.

LanguageSyntax
C++byte setVertexgenerateSphericalUVW( dword iVertex, dword iPosition, const Cpoint& point & iChannel, CbaseT& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude )
Pythonint setVertexgenerateSphericalUVW( int iVertex, int iPosition, Cvector point iChannel, Cbase projectorBase, float startLatitude, float endLatitude, float startLongitude, float endLongitude )

Return value

0 = Error setting the vertexgenerating spherical UVW coordinaltes.

1 = Success.

Anchor
getnormalgeneratecylindricaluvwgetnormal
generatecylindricaluvw

getNormal

...

generateCylindricalUVW

Generates cylindrical UVW coordinates.

LanguageSyntax
C++byte getNormalgenerateCylindricalUVW( dword iVertex, dword iPosition, Cvector &normal )& iChannel,  Cbase& projectorBase, real& startAngle, real& endAngle )
PythonCvector getNormalint generateCylindricalUVW( int iVertex, int iPosition iChannel,  Cbase projectorBase, float startAngle, float endAngle )

Return value

...

C++

0 = Error

...

generating cylindrical UVW coordinaltes.

1 = Success.

...

Python

...

Anchor
setnormalgeneratecubicuvwsetnormal
generatecubicuvw

setNormal

...

generateCubicUVW

Generates cubic UVW coordinates.

LanguageSyntax
C++byte setNormalgenerateCubicUVW( dword iNormal, dword iPosition, const Cvector& normal & iChannel,  Cbase& projectorBase, bool mirrorBackFaces = false )
Pythonint setNormalgenerateCubicUVW( int iNormal, int iPosition, Cvector normal iChannel,  Cbase projectorBase, bool mirrorBackFaces = False )

Return value

0 = Error setting the normalgenerating cubic UVW coordinaltes.

1 = Success.

Anchor
gettrianglegenerateplanaruvwgettriangle
generateplanaruvw

getTriangle

...

generatePlanarUVW

Generates planar UVW coordinates.

LanguageSyntax
C++byte getTrianglegeneratePlanarUVW( dword iTriangle, dword& iVertex1iChannel, dword &iVertex2, dword &iVertex3, dword &iNormal1, dword &iNormal2, dword &iNormal3  Cbase& projectorBase )
Pythondict getTriangleint generatePlanarUVW( int iTriangle iChannel,  Cbase projectorBase )

Return value

C++

...

0 = Error

...

generating planar UVW coordinaltes.

1 = Success.

Python

Dictionary containing the triangle data ("iVertex1", "iVertex2", "iVertex3", "iNormal1", "iNormal2", "iNormal3").

...

setTriangle

Sets triangle (vertexes and normals)

Anchor
getvertex
getvertex

getVertex

Gets vertex by index.

LanguageSyntax
C++byte setTrianglegetVertex( dword iTriangleiVertex, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3 iPosition, Cpoint& point )
Pythonint setTriangleCvector getVertex( int iTriangleiVertex, int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3 iPosition )

Return value

C++

0 = Error

...

getting the

...

vertex.

1 = Success.

Python

 Cvector containing the vertex requested.

Anchor
gettrianglegroupsetvertexgettrianglegroup
setvertex

getTriangleGroup

...

setVertex

Sets vertex by index.

LanguageSyntax
C++byte getTriangleGroupsetVertex( dword iTriangleiVertex, dword iPosition, const Cpoint& idGroup point )
Pythonint getTriangleGroupsetVertex( int iTriangle iVertex, int iPosition, Cvector point )

Return value

C++

...

0 = Error

...

setting the

...

vertex.

1 = Success.

...

Python

...

Anchor
settrianglegroupgetnormalsettrianglegroup
getnormal

setTriangleGroup

...

getNormal

Gets normal by index.

LanguageSyntax
C++byte setTriangleGroupgetNormal( dword iTriangleiVertex, dword idGroup iPosition, Cvector&normal )
Pythonint setTriangleGroup( int iTriangleCvector getNormal( int iVertex, int idGroup iPosition )

Return value

C++

0 = Error

...

getting the

...

normal.

1 = Success.

Python

Cvector containing the normal requested.

Anchor
gettriangleuvwsetnormalgettriangleuvw
setnormal

getTriangleUVW

...

setNormal

Sets normal by index.

LanguageSyntax
C++byte getTriangleUVWsetNormal( dword iTriangleiNormal, dword iChannelIDiPosition, float& u1, float& v1, float& w1, float& u2, float& v2, float& w2, float& u3, float& v3, float& w3 const Cvector& normal )
Pythondict getTriangleUVWint setNormal( int iTriangleiNormal, int iChannelID iPosition, Cvector normal )

Return value

...

C++

0 = Error

...

setting the

...

normal.

1 = Success.

Python

Dictionary containing the triangle UVW coordinates ('u1','v1,'w1,'u2','v2','w2','u2','v2','w3').

...

setTriangleUVW

Sets triangle UVW coordinantes.

LanguageSyntax
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 )
Pythonint 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.

...

getTriangleMaterial

Gets triangle material

Anchor
gettriangle
gettriangle

getTriangle

Gets triangle (vertexes and normals) by index.

LanguageSyntax
C++

byte getTriangle( dword iTriangle, dword &iVertex1, dword &iVertex2, dword &iVertex3, dword &iNormal1, dword &iNormal2, dword &iNormal3 )

Python

(int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3) getTriangle( int iTriangle )

Return value

C++

0 = Error getting the triangle.

1 = Success.

Python

Tuple containing the triangle data.

Anchor
settriangle
settriangle

setTriangle

Sets triangle (vertexes and normals) by index.

LanguageSyntax
C++byte setTriangle( dword iTriangle, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3 )
Pythonint 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
gettrianglegroup

getTriangleGroup

Gets triangle group by index.

LanguageSyntax
C++

byte getTriangleGroup( dword iTriangle, dword& idGroup )

Pythonint getTriangleGroup( int iTriangle )

Return value

C++

0 = Error getting the triangle group.

1 = Success.

Python

Triangle group ID.

Anchor
settrianglegroup
settrianglegroup

setTriangleGroup

Sets group that's the triangle belongs to.

LanguageSyntax
C++byte setTriangleGroup( dword iTriangle, dword idGroup )
Pythonint setTriangleGroup( int iTriangle, int idGroup )

Return value

0 = Error setting the triangle group.

1 = Success.

Anchor
gettriangleuvw
gettriangleuvw

getTriangleUVW

Gets triangle UVW coordinates.

LanguageSyntax
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

(float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3) getTriangleUVW( int iTriangle, int iChannelID )

Return value

C++

0 = Error getting the triangle UVW coordinates.

1 = Success.

Python

Tuple containing the triangle UVW coordinates.

Anchor
settriangleuvw
settriangleuvw

setTriangleUVW

Sets triangle UVW coordinantes.

LanguageSyntax
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 )
Pythonint 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
gettrianglematerial

getTriangleMaterial

Gets triangle material.

LanguageSyntax
C++byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material )
PythonCmaxwellMaterial getTriangleMaterial( int iTriangle )

Return value

C++

0 = Error getting triangle material.

1 = Success.

Python

Triangle material.

Anchor
settrianglematerial
settrianglematerial

setTriangleMaterial

Sets the triangle material.

LanguageSyntax
C++byte setTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial material )
Pythonint setTriangleMaterial( int iTriangle, CmaxwellMaterial material )

Return value

0 = Error setting triangle material.

1 = Success.

Anchor
getgroupmaterial
getgroupmaterial

getGroupMaterial

Gets material of a group of triangles.

LanguageSyntax
C++byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material )
PythonCmaxwellMaterial getGroupMaterial( int iGroup )

Return value

C++

0 = Error getting triangle group material.

1 = Success.

Python

Triangle group material.

Anchor
setgroupmaterial
setgroupmaterial

setGroupMaterial

Sets material of a group of triangles.

LanguageSyntax
C++byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material )
Pythonint setGroupMaterial( int iGroup, CmaxwellMaterial material )

Return value

0 = Error setting triangle group material.

1 = Success.

Anchor
setbaseandpivot
setbaseandpivot

setBaseAndPivot

Sets base and pivot axes of the object.

LanguageSyntax
C++

byte setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 )

Pythonint setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 )

Return value

0 = Error setting object base and pivot.

1 = Success.

Anchor
getbaseandpivot
getbaseandpivot

getBaseAndPivot

Gets base and pivot axes of the object.

LanguageSyntax
C++byte getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 )
Python(Cbase base, Cbase pivot) getBaseAndPivot( float substepTime = 0.0 )

Return value

C++

0 = Error getting object base and pivot.

1 = Success.

Python

Tuple containing Cbase base and Cbase pivot axes (base,pivot).

Anchor
getworldtransform
getworldtransform

getWorldTransform

Returns the world transform of the object taking into account base and pivot of all its parents..

LanguageSyntax
C++byte getWorldTransform( Cbase& base )
PythonCbase getWorldTransform()

Return value

C++

0 = Error getting world transform of the object.

1 = Success.

Python

Object world transform.

Anchor
gettransformsubstepscount
gettransformsubstepscount

getTransfromSubstepsCount

Return the number of substeps used for defining Base and Pivot motion blur.

LanguageSyntax
C++dword getTransformSubstepsCount()
Pythonint getTransformSubstepsCount()

Anchor
gettransformstepinfobyindex
gettransformstepinfobyindex

getTransformStepInfoByIndex

Return transform information( base, pivot and time) for the given index.

LanguageSyntax
C++byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index )
Python(Cbase base, Cbase pivot, float time) getTransformStepInfoByIndex( int index )

Return value

C++

0 = Error getting transform information of the object.

1 = Success.

Python

Tuple containing transform information.

 

Anchor
isposrotscaleinitialized
isposrotscaleinitialized

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.

LanguageSyntax
C++byte isPosRotScaleInitialized( bool& init )
Pythonbool 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
cleangeometry

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.

LanguageSyntax
C++byte cleanGeometry()
Pythonint cleanGeometry()

Return value

0 = Error cleaning geometry.

1 = Success.

Anchor
gethide
gethide

getHide

Gets "hide" status of the object.

LanguageSyntax
C++byte getHide( bool& hide )
Pythonbool getHide()

Return value

C++

0 = Error getting "hide" status.

1 = Success.

Python

True = object is hidden.

False = object is not hidden.

Anchor
sethide
sethide

setHide

Sets "hide" status of the object.

LanguageSyntax
C++byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material setHide( bool hide )
PythonCmaxwellMaterial getTriangleMaterial( int iTriangle int setHide( bool hide )

Return value

C++

...

0 = Error

...

setting "hide" state.

1 = Success

...

Python

...

.

Anchor
settrianglematerialgethidetocamerasettrianglematerial
gethidetocamera

setTriangleMaterial

...

getHideToCamera

Gets "hide to camera" status of the object.

LanguageSyntax
C++byte setTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial material getHideToCamera( bool& hide )
Pythonint setTriangleMaterial( int iTriangle, CmaxwellMaterial material bool getHide()

Return value

C++

0 = Error

...

getting "hide to camera" status.

1 = Success.

Python

True = object is hidden to camera.

False = object is not hidden to camera.

Anchor
getgroupmaterialsethidetocameragetgroupmaterial
sethidetocamera

getGroupMaterial

...

setHideToCamera

Sets "hide to camera" status of the object.

LanguageSyntax
C++byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material setHideToCamera( bool hide )
PythonCmaxwellMaterial getGroupMaterial( int iGroup int setHideToCamera( bool hide )

Return value

C++

...

0 = Error setting "hide to camera" state.

1 = Success.

Python

Triangle group material.

Anchor
setgroupmaterialgethidetoreflectionsrefractionssetgroupmaterial
gethidetoreflectionsrefractions

setGroupMaterial

...

getHideToReflectionsRefractions

Gets "hide to reflections and refractions" status of the object.

LanguageSyntax
C++byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material getHideToReflectionsRefractions( bool& hide )
Pythonint setGroupMaterial( int iGroup, CmaxwellMaterial material bool getHideToReflectionsRefractions()

Return value

C++

0 = Error

...

getting "hide to reflections and refractions" status.

1 = Success.

Python

True = object is hidden to reflections and refractions.

False = object is not hidden to reflections and refractions.

Anchor
setbaseandpivotsethidetoreflectionsrefractionssetbaseandpivot
sethidetoreflectionsrefractions

...

setHideToReflectionsRefractions

Sets base and pivot axes "hide to reflections and refractions" status of the object.

LanguageSyntax
C++byte setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 setHideToReflectionsRefractions( bool hide )
Pythonint setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 setHideToReflectionsRefractions( bool hide )

Return value

0 = Error setting object base and pivot"hide to reflections and refractions" state.

1 = Success.

Anchor
getbaseandpivotgethidetogigetbaseandpivot
gethidetogi

...

getHideToGI

Gets base and pivot axes "hide to global illumination" status of the object.

LanguageSyntax
C++byte getBaseAndPivotgetHideToGI( Cbase& base, Cbase& pivot, const real substepTime = 0.0 bool& hide )
Pythontuple getBaseAndPivot( float substepTime = 0.0 bool getHideToGI()

Return value

C++

0 = Error getting object base and pivot"hide to global illumination" status.

1 = Success.

Python

Object base and pivot axesTrue = object is hidden to global illumination.

False = object is not hidden to global illumination.

Anchor
getworldtransformsethidetogigetworldtransform
sethidetogi

getWorldTransform

...

setHideToGI

Sets "hide to global Illumination" status of the object.

LanguageSyntax
C++byte getWorldTransform( Cbase& base setHideToGI( bool hide )
PythonCbase getWorldTransformint setHideToGI( bool hide )

Return value

C++

...

0 = Error

...

setting "hide to global illumination" state.

1 = Success.

Python

Object world transform.

...

getTransfromSubstepsCount

Return the number of substeps used for defining Base and Pivot motion blur.

LanguageSyntax
C++dword getTransformSubstepsCount()
Pythonint getTransformSubstepsCount()

...

getTransformStepInfoByIndex

Return transform information( base, pivot and time) for the given index

Anchor
isexcludedofcutplanes
isexcludedofcutplanes

isExcludedOfCutPlanes

Gets "excluded of cut planes" status of the object.

LanguageSyntax
C++byte isExcludedOfCutPlanes( bool& excluded )
Pythonbool isExcludedOfCutPlanes()

Return value

C++

0 = Error getting "excluded of cut planes" status.

1 = Success.

Python

True = object is excluded to cut planes.

False = object is not excluded of cut planes.

Anchor
excludeofcutplanes
excludeofcutplanes

excludeOfCutPlanes

Sets "excluded of cut planes" status of the object.

LanguageSyntax
C++byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index excludeOfCutPlanes( bool exclude )
Pythondict getTransformStepInfoByIndex( int index int excludeOfCutPlanes( bool exclude )

Return value

C++

...

0 = Error

...

1 = Success.

Python

Dictionary containing transform information ('base','pivot','time').

 

...

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.

...

setting "excluded of cut planes" state.

1 = Success.

Anchor
getreferencedisplaypoints
getreferencedisplaypoints

getReferenceDisplayPoints

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.

LanguageSyntax
C++float* getReferenceDisplayPoints( const dword& percent, const dword& maxPoints, dword& nPoints )
Pythonarray getReferenceDisplayPoints( int percent, int maxPoints )

Parameters

TypeNameIn/OutDescription
const dword&percentinPercent of points of the mesh that will be returned.
const dword&maxPointsin

Maximum number of points that will be in the returned array (-1 means there is not a maximum fixed)

dword&nPointsoutNumber of points returned.

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 renderingArray of nPoints * 3 containing the proxy points requested.

Python

NumPy array containing  the proxy points requested. Shape is (nPoints,3).

Anchor
cleangeometrysetcoloridcleangeometry
setcolorid

cleanGeometry

...

setColorID

Sets the color used by this object in the Object ID render channel. RGB values must always be in the 0-1 range.

LanguageSyntax
C++byte cleanGeometrysetColorID( const Crgb& color )
Pythonint cleanGeometry setColorID( Crgb  color )

Return value

0 = Error cleaning geometrysetting color ID.

1 = Success.

Anchor
gethidegetcoloridgethide
getcolorid

getHide

...

getColorID

Gets the color used by this object in the Object ID render channel.

LanguageSyntax
C++byte getHidegetColorID( bool Crgb & hide color )
Pythonbool getHideCrgb  getColorID()

Return value

C++

0 = Error getting "hide" statusthe color ID.

1 = Success.

Python

True = object is hidden.

False = object is not hidden.

...

setHide

...

Crgb containing the color ID.

Anchor
setsubdivisionlevel
setsubdivisionlevel

setSubdivisionLevel

Sets the subdivision level of the mesh.

setHide( bool hide setHide bool hide
LanguageSyntax
C++byte
setSubdivisionLevel( const dword& level )
Pythonint
setSubdivisionLevel(
int level )

Return value

0 = Error setting "hide" state.

1 = Success.

Anchor
gethidetocameragetsubdivisionlevelgethidetocamera
getsubdivisionlevel

...

getSubdivisionLevel

Gets "hide to camera" status the subdivision level of the objectmesh.

LanguageSyntax
C++byte getHideToCameragetSubdivisionLevel( booldword& hide level )
Pythonbool getHide(int level, int success) getSubdivisionLevel()

Return value

C++

0 = Error getting "hide to camera" status.

1 = Success.

Python

True = object is hidden to camera.

False = object is not hidden to cameraError

1 = Success

Python

Tuple containing the subdivision level of the mesh and the success value of the method.

Anchor
sethidetocamerasetgeometrydirtysethidetocamera
setgeometrydirty

setHideToCamera

...

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.

LanguageSyntax
C++byte setHideToCamerasetGeometryDirty( bool hide )
Pythonint setHideToCamerasetGeometryDirty( bool hide )

Return value

0 = Error setting "hide to camera" stategeometry dirty.

1 = Success.

Anchor
gethidetoreflectionsrefractionsinitializemeshgethidetoreflectionsrefractions
initializemesh

getHideToReflectionsRefractions

...

initializeMesh

Clean the mesh and allocates memory for vertexes, normals, triangles and motion blur.

LanguageSyntax
C++byte getHideToReflectionsRefractions( bool& hide initializeMesh( dword nVertex, dword nNormals, dword nFaces, dword positionsPerVertex )
Pythonbool getHideToReflectionsRefractions()

Return value

C++

0 = Error getting "hide to reflections and refractions" status.

1 = Success.

Python

True = object is hidden to reflections and refractions.

False = object is not hidden to reflections and refractions.

...

setHideToReflectionsRefractions

...

int initializeMesh( int nVertex, int nNormals, int nFaces, int positionsPerVertex )

Return value

0 = Error initializing mesh.

1 = Success.

Anchor
resizemesh
resizemesh

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.

LanguageSyntax
C++byte setHideToReflectionsRefractions( bool hide resizeMesh( dword newNVertex, dword newNNormals, dword newNFaces, dword newNpositionsPerVertex )
Pythonint setHideToReflectionsRefractions( bool hide resizeMesh( int newNVertex, int newNNormals, int newNFaces, int newNpositionsPerVertex )

Return value

0 = Error setting "hide to reflections and refractions" stateresizing mesh.

1 = Success.

Anchor
gethidetogigeneratecustomuvwgethidetogi
generatecustomuvw

getHideToGI

...

generateCustomUVW

--TODO--.

LanguageSyntax
C++byte getHideToGI( bool& hide generateCustomUVW( dword iChannel, dword iGeneratorType )
Pythonbool getHideToGI(int generateCustomUVW( int iChannel, int iGeneratorType )

Return value

C++

...

0 = Error generating custom UVW coordinates.

1 = Success.

Python

True = object is hidden to global illumination.

False = object is not hidden to global illumination.

...

setHideToGI

Sets "hide to global Illumination" status of the object.

LanguageSyntax
C++byte setHideToGI( bool hide )
Pythonint setHideToGI( bool hide )

Return value

0 = Error setting "hide to global illumination" state.

1 = Success.

...

isExcludedOfCutPlanes

Gets "excluded of cut planes" status of the object

Anchor
getuvwchannelproperties
getuvwchannelproperties

getUVWChannelProperties

--TODO--.

LanguageSyntax
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

(int projType, bool custumProj, Cbase projectorBase, float startLatitude, float endLatutide, float startLongitude, float endLongitude, float startAngle, float endAngle, bool mirrorBackFaces) getUVWChannelProperties( int iChannel )

Return value

C++

0 = Error getting UVW channel properties.

1 = Success.

Python

Tuple containing the UVW channel properties.

Anchor
getglobalxform
getglobalxform

getGlobalXform

--TODO--.

LanguageSyntax
C++byte isExcludedOfCutPlanesgetGlobalXform( bool Cbase& excluded xForm )
Pythonbool isExcludedOfCutPlanesCbase getGlobalXform()

Return value

C++

0 = Error getting "excluded of cut planes" status. --TODO--

1 = Success.

Python

True = object is excluded to cut planes.

False = object is not excluded of cut planes.

...

excludeOfCutPlanes

...

Cbase containing --TODO--

Anchor
getglobalnormalsxform
getglobalnormalsxform

getGlobalNormalsXform

--TODO--.

LanguageSyntax
C++byte excludeOfCutPlanes( bool exclude getGlobalNormalsXform( Cbase& xForm )
Pythonint excludeOfCutPlanesCbase getGlobalNormalsXform( bool exclude )

Return value

C++

0 = Error

...

getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

Anchor
getproxydisplaypointsgetinverseglobalxformgetproxydisplaypoints
getinverseglobalxform

getProxyDisplayPoints

...

getInverseGlobalXform

--TODO--.

LanguageSyntax
C++float* getProxyDisplayPoints( const dword& percent, const dword& maxPoints, dword& nPoints byte getInverseGlobalXform( Cbase& ixForm )
Pythonarray getProxyDisplayPoints( int percent, int maxPoints )

Parameters

TypeNameIn/OutDescription
const dword&percentinPercent of points of the mesh that will be returned.
const dword&maxPointsin

Maximum number of points that will be in the returned array (-1 means there is not a maximum fixed)

dword&nPointsoutNumber of points returned.
Cbase getInverseGlobalXform()

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

Anchor
getinverseglobalnormalxform
getinverseglobalnormalxform

getInverseGlobalNormalXform

--TODO--.

LanguageSyntax
C++byte getInverseGlobalNormalXform( Cbase& ixForm )
PythonCbase getInverseGlobalNormalXform()

Return value

C++

Array of nPoints * 3 containing the proxy points requested0 = Error getting  --TODO--

1 = Success.

Python

NumPy array containing  the proxy points requested. Shape is (nPoints,3).Cbase containing --TODO--

Anchor
setcoloridisgeometryloadersetcolorid
isgeometryloader

...

isGeometryLoader

Sets the color used by this object in the Object ID render channel. RGB values must always be in the 0-1 range.Checks if the object was created by a geometry loader extension.

LanguageSyntax
C++byte setColorIDisGeometryLoader( const Crgbbool& color isGeomExtension )
Pythonint setColorIDbool isGeometryLoader( Crgb color )

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
getcoloridisgeometryproceduralgetcolorid
isgeometryprocedural

getColorID

...

isGeometryProcedural

Checks if the object was created by a procedural geometry extension.

LanguageSyntax
C++byte getColorIDisGeometryProcedural( Crgbbool& color isGeomProceduralExtension )
PythonCrgb getColorIDbool isGeometryProcedural()

Return value

C++

0 = Error getting the color IDchecking object was created from a procedural geometry extension.

1 = Success.

Python

Crgb containing the color IDTrue = the object was created by a procedural geometry extension.

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

Anchor
setgeometrydirtysetgeometrydirty

setGeometryDirty

hasgeometrymodifiers
hasgeometrymodifiers

hasGeometryModifiers

Checks if the object has geometry modifiers (extensions).

LanguageSyntax
C++byte setGeometryDirtyhasGeometryModifiers( bool& isGeomModifiersExtension )
Pythonint setGeometryDirtybool hasGeometryModifiers()

Return value

C++

0 = Error

...

checking object have geometry modifiers (extensions).

1 = Success.

Python

True = the object have geometry modifiers (extensions).

Anchor
initializemeshcleanallgeometrymodifierextensionsinitializemesh
cleanallgeometrymodifierextensions

initializeMesh

...

cleanAllGeometryModifierExtensions

Clean all geometry modifier extensions applyed to the object.

LanguageSyntax
C++byte initializeMesh( dword nVertex, dword nNormals, dword nFaces, dword positionsPerVertex cleanAllGeometryModifierExtensions()
Pythonint initializeMesh( int nVertex, int nNormals, int nFaces, int positionsPerVertex cleanAllGeometryModifierExtensions()

Return value

0 = Error initializing meshcleaning geometry modifier extensions.

1 = Success.

Anchor
resizemeshgetgeometrymodifierextensionsnumberresizemesh
getgeometrymodifierextensionsnumber

resizeMesh

...

getGeometryModifierExtensionsNumber

Gets the number of geometry modifier extensions applied to the object.

LanguageSyntax
C++byte resizeMeshgetGeometryModifierExtensionsNumber( dword newNVertex, dword newNNormals, dword newNFaces, dword newNpositionsPerVertex & numModifierExtensions )
Pythonint resizeMesh( int newNVertex, int newNNormals, int newNFaces, int newNpositionsPerVertex 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.