Page Comparison

...

Name	Description
setPointer	Internal use.
Cobject#free 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.
getReferencedOverrideFlags	Get the override policy for visibility flags.
setReferencedOverrideFlags	Set the override policy for visibility flags.
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.
getDependencies	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
setColorID
getColorID
setGeometryDirty
getUserData
setUserData
getVertexesBuffer
getNormalsBuffer
getTrianglesBuffer
initializeMesh
resizeMesh	getReferenceDisplayPoints	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.
setSubdivisionLevel	Sets the subdivision level of the mesh.
getSubdivisionLevel	Gets the subdivision level of the mesh.
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
getUVWChannelProperties	Gets UVW channel properties.
getGlobalXform
getGlobalNormalsXform
getInverseGlobalXform
getInverseGlobalNormalsXform
isGeometryLoader	Checks if the object was created by a geometry loader extension.
isGeometryProcedural		hasGeometryModifiers	Checks if the object was created by a procedural geometry extension.
hasGeometryModifiers	Checks if the object has geometry modifiers (extensions).
applyGeometryModifierExtension
cleanAllGeometryModifierExtensions	Clean all geometry modifier extensions applyed to the object.
getGeometryLoaderExtensionParams
getGeometryProceturalExtensionParams		getGeometryModifierExtensionNumber
getGeometryModifierExtensionsNumber	Gets the number of geometry modifier extensions applied to the object.
getGeometryModifierExtensionParamsAtIndex

Inherited methods

isNull.

Anchor

	free
	free

free

Destroys the object.

...

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

	isrfrk
	isrfrk

...

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.

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

Language	Syntax
C++	byte
getReferencedOverrideFlags( byte& flags )
Python
(int flags, int success) getReferencedOverrideFlags()

Return value

C++

0 = Error

...

1 = Success

...

Examples

...

language	javascript
title	Python

...

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

...

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.

Language	Syntax
C++	byte setReferencedOverrideFlags( byte& flags )
Python	int setReferencedOverrideFlags( int flags )

Return value

0 = Error

1 = Success

Anchor

	mergemeshes
	mergemeshes

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.

Language	Syntax
C++	byte mergeMeshes( const Cmaxwell::Cobject* pMeshes, dword nMeshes )
Python	int mergeMeshes( CmaxwellObject[] meshes )

Return value

0 = Error setting reference scene file.

1 = Success.

Examples

Code Block

language	javascript
title	Python

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.

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
	setparent

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
	getuuid

getUuid

Unique user ID that can be used for custom purposes.

Language	Syntax
C++	const char* getUuid()
Python	str getUuid()

Anchor

	setuuid
	setuuid

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
	getmaterial

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
	setmaterial

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
	setproperties

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
	getdependencies

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 objects 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.

Anchor

	getnumvertexes
	getnumvertexes

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
	getnumtriangles

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
	getnumnormals

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
	getnumpositionspervertex

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
	getnumchannelsuvw

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
	addchanneluvw

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
	generatesphericaluvw

generateSphericalUVW

Generates spherical UVW coordinates.

Language	Syntax
C++	byte generateSphericalUVW( dword& iChannel, 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 )

Return value

0 = Error generating spherical UVW coordinaltes.

1 = Success.

Anchor

	generatecylindricaluvw
	generatecylindricaluvw

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
	generatecubicuvw

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
	generateplanaruvw

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
	getvertex

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
	setvertex

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
	getnormal

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
	setnormal

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
	gettriangle

getTriangle

Gets triangle (vertexes and normals) by index.

CmaxwellObject getParent(

Language	Syntax
C++	byte getParent( Cmaxwell::Cobject& parent )	Python	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 parent objectthe triangle.

1 = Success.

Python

Parent objectTuple containing the triangle data.

Anchor

	setparentsettrianglesetparent
	settriangle

...

setTriangle

Sets the parent object in the hierarchytriangle (vertexes and normals) by index.

Language	Syntax
C++	byte setParent( Cmaxwell::Cobject parent setTriangle( dword iTriangle, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3 )
Python	int setParent( CmaxwellObject parent setTriangle( int iTriangle, int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3 )

Return value

0 = Error setting parent objectthe triangle.

1 = Success.

Anchor

	getuuidgettrianglegroupgetuuid
	gettrianglegroup

getUuid

...

getTriangleGroup

Gets triangle group by index.

Language	Syntax
C++	const char* getUuid( byte getTriangleGroup( dword iTriangle, dword& idGroup )
Python	str getUuidint getTriangleGroup( int iTriangle )

Return value

C++

0 = Error getting the triangle group.

1 = Success.

Python

Triangle group ID.

Anchor

	setuuidsettrianglegroupsetuuid
	settrianglegroup

...

setTriangleGroup

Sets the unique user IDgroup that's the triangle belongs to.

Language	Syntax
C++	byte setUuid( const char* pUuid setTriangleGroup( dword iTriangle, dword idGroup )
Python	int setUuid( str uuid setTriangleGroup( int iTriangle, int idGroup )

Return value

0 = Error setting unique user IDthe triangle group.

1 = Success.

Anchor

	getmaterialgettriangleuvwgetmaterial
	gettriangleuvw

...

getTriangleUVW

Gets the material appliedtriangle UVW coordinates.

CmaxwellMaterial getMaterial(

Language	Syntax
C++	byte getMaterial( Cmaxwell::Cmaterial& parent )	Python	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 object materialthe triangle UVW coordinates.

1 = Success.

Python

Object material.

...

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.

...

setProperties

...

Tuple containing the triangle UVW coordinates.

Anchor

	settriangleuvw
	settriangleuvw

setTriangleUVW

Sets triangle UVW coordinantes.

Language	Syntax
C++	byte setProperties( int doDirectCausticsReflection, int doDirectCausticsRefraction, int doIndirectCausticsReflection, int doIndirectCausticsRefraction 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 setProperties( byte doDirectCausticsReflection, byte doDirectCausticsRefraction, byte doIndirectCausticsReflection, byte doIndirectCausticsRefraction 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 object materialthe triangle UVW coordinates.

1 = Success.

Anchor
getdependencies	getdependencies

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

...

gettrianglematerial
	gettrianglematerial

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 dependency pathstriangle material.

1 = Success.

Python

List of str containing the dependency pathsTriangle material.

Anchor

	getnumvertexessettrianglematerialgetnumvertexes
	settrianglematerial

getNumVertexes

...

setTriangleMaterial

Sets the triangle material.

Language	Syntax
C++	byte getNumVertexessetTriangleMaterial( dword & nVertexes iTriangle, Cmaxwell::Cmaterial material )
Python	int getNumVertexes(setTriangleMaterial( int iTriangle, CmaxwellMaterial material )

Return value

C++

...

0 = Error

...

setting triangle material.

1 = Success

...

Python

...

.

Anchor

	getnumtrianglesgetgroupmaterialgetnumtriangles
	getgroupmaterial

...

getGroupMaterial

Gets number material of a group of triangles of the object.

Language	Syntax
C++	byte getNumTrianglesgetGroupMaterial( dword & nTriangles iGroup, Cmaxwell::Cmaterial& material )
Python	CmaxwellMaterial getGroupMaterial( int getNumTriangles( iGroup )

Return value

C++

0 = Error getting number of trianglestriangle group material.

1 = Success.

Python

Number of trianglesTriangle group material.

Anchor

	getnumnormalssetgroupmaterialgetnumnormals
	setgroupmaterial

...

setGroupMaterial

Gets number of normals of the objectSets material of a group of triangles.

Language	Syntax
C++	byte getNumNormalssetGroupMaterial( dword & nNormals iGroup, Cmaxwell::Cmaterial material )
Python	int getNumNormals(setGroupMaterial( int iGroup, CmaxwellMaterial material )

Return value

...

C++

0 = Error
...
setting triangle group material.
1 = Success.
...

Python

...

Anchor

	getnumpositionspervertexsetbaseandpivotgetnumpositionspervertex
	setbaseandpivot

getNumPositionsPerVertex

...

setBaseAndPivot

Sets base and pivot axes of the object.

Language

Syntax

C++

byte

getNumPositionsPerVertex( dword& nPositions

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

Python

int getNumPositionsPerVertex(setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 )

Return value

...

C++

0 = Error
...
setting object base and pivot.
1 = Success
...

Python

...

.

Anchor

	getnumchannelsuvwgetbaseandpivotgetnumchannelsuvw
	getbaseandpivot

...

getBaseAndPivot

Gets number of UVW channels base and pivot axes of the object.

Language	Syntax
C++	byte getNumChannelsUVW( dword& nChannelsUVW getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 )
Python	int getNumChannelsUVW((Cbase base, Cbase pivot) getBaseAndPivot( float substepTime = 0.0 )

Return value

C++

0 = Error getting number UVW channelsobject base and pivot.

1 = Success.

Python

Number of UVW channelsTuple containing Cbase base and Cbase pivot axes (base,pivot).

Anchor

	addchanneluvwgetworldtransformaddchanneluvw
	getworldtransform

addChannelUVW

...

getWorldTransform

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

Language	Syntax
C++	byte addChannelUVWgetWorldTransform( dword& index, byte id = 0xFF Cbase& base )
Python	int addChannelUVW( byte id = 0xFF Cbase getWorldTransform()

Return value

C++

0 = Error adding UVW channelgetting world transform of the object.

1 = Success.

Python

Index of the new channelObject world transform.

Anchor

	generatesphericaluvwgettransformsubstepscountgeneratesphericaluvw
	gettransformsubstepscount

generateSphericalUVW

...

getTransfromSubstepsCount

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

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.

...

generateCylindricalUVW

...

dword getTransformSubstepsCount()
Python	int getTransformSubstepsCount()

Anchor

	gettransformstepinfobyindex
	gettransformstepinfobyindex

getTransformStepInfoByIndex

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

Language	Syntax
C++	byte generateCylindricalUVWgetTransformStepInfoByIndex( dword Cbase& iChannelbase, Cbase& projectorBasepivot, real& startAngle, real& endAngle time, const dword index )
Python	int generateCylindricalUVW( int iChannelCbase base, Cbase projectorBase pivot, float startAngle, float endAngle time) getTransformStepInfoByIndex( int index )

Return value

C++

0 = Error

...

getting transform information of the object.

1 = Success.

Python

Tuple containing transform information.

Anchor

	generatecubicuvwisposrotscaleinitializedgeneratecubicuvw
	isposrotscaleinitialized

generateCubicUVW

...

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 generateCubicUVWisPosRotScaleInitialized( dword& iChannel, Cbase& projectorBase, bool mirrorBackFaces = false bool& init )
Pythonint generateCubicUVW( int iChannel, Cbase projectorBase, bool mirrorBackFaces = False	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
	cleangeometry	generateplanaruvw	generateplanaruvw

generatePlanarUVW

...

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 generatePlanarUVW( dword& iChannel, Cbase& projectorBase cleanGeometry()
Python	int generatePlanarUVWcleanGeometry( int iChannel, Cbase projectorBase )

Return value

0 = Error generating planar UVW coordinaltescleaning geometry.

1 = Success.

Anchor

	getvertexgethidegetvertex
	gethide

...

getHide

Gets vertex by index"hide" status of the object.

Language	Syntax
C++	byte getVertex( dword iVertex, dword iPosition, Cpoint& point getHide( bool& hide )
Python	Cvector getVertex( int iVertex, int iPosition bool getHide()

Return value

C++

0 = Error getting the vertex"hide" status.

1 = Success.

Python

Cvector containing the vertex requested.

Python

True = object is hidden.

False = object is not hidden.

Anchor

	setvertexsethidesetvertex
	sethide

...

setHide

Sets vertex by index"hide" status of the object.

Language	Syntax
C++	byte setVertex( dword iVertex, dword iPosition, const Cpoint& point setHide( bool hide )
Python	int setVertex( int iVertex, int iPosition, Cvector point setHide( bool hide )

Return value

0 = Error setting the vertex"hide" state.

1 = Success.

Anchor

	getnormalgethidetocameragetnormal
	gethidetocamera

...

getHideToCamera

Gets normal by index"hide to camera" status of the object.

Language	Syntax
C++	byte getNormal( dword iVertex, dword iPosition, Cvector &normal getHideToCamera( bool& hide )
Python	Cvector getNormal( int iVertex, int iPosition bool getHide()

Return value

C++

0 = Error getting the normal"hide to camera" status.

1 = Success.

Python

Cvector containing the normal requestedTrue = object is hidden to camera.

False = object is not hidden to camera.

Anchor

	setnormalsethidetocamerasetnormal
	sethidetocamera

...

setHideToCamera

Sets normal by index"hide to camera" status of the object.

Language	Syntax
C++	byte setNormal( dword iNormal, dword iPosition, const Cvector& normal setHideToCamera( bool hide )
Python	int setNormal( int iNormal, int iPosition, Cvector normal setHideToCamera( bool hide )

Return value

0 = Error setting the normalsetting "hide to camera" state.

1 = Success.

Anchor

	gettrianglegethidetoreflectionsrefractionsgettriangle
	gethidetoreflectionsrefractions

...

getHideToReflectionsRefractions

Gets triangle (vertexes and normals) by index"hide to reflections and refractions" status of the object.

Language	Syntax
C++	byte getTriangle( dword iTriangle, dword &iVertex1, dword &iVertex2, dword &iVertex3, dword &iNormal1, dword &iNormal2, dword &iNormal3 getHideToReflectionsRefractions( bool& hide )
Python	dict getTrianglebool getHideToReflectionsRefractions( int iTriangle )

Return value

C++

0 = Error getting the triangle.

1 = Success.

Python

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

...

setTriangle

...

"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

	sethidetoreflectionsrefractions
	sethidetoreflectionsrefractions

setHideToReflectionsRefractions

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

Language	Syntax
C++byte setTriangle( dword iTriangle, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3	byte setHideToReflectionsRefractions( bool hide )
Python	int setTriangle( int iTriangle, int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3 setHideToReflectionsRefractions( bool hide )

Return value

0 = Error setting the triangle"hide to reflections and refractions" state.

1 = Success.

Anchor

	gettrianglegroupgethidetogigettrianglegroup
	gethidetogi

...

getHideToGI

Gets triangle group by index"hide to global illumination" status of the object.

Language	Syntax
C++	byte getTriangleGroup( dword iTriangle, dword& idGroup getHideToGI( bool& hide )
Python	int getTriangleGroupbool getHideToGI( int iTriangle )

Return value

C++

0 = Error getting the triangle group"hide to global illumination" status.

1 = Success.

Python

Triangle group IDTrue = object is hidden to global illumination.

False = object is not hidden to global illumination.

Anchor

	settrianglegroupsethidetogisettrianglegroup
	sethidetogi

...

setHideToGI

Sets group that's the triangle belongs to"hide to global Illumination" status of the object.

Language	Syntax
C++	byte setTriangleGroup( dword iTriangle, dword idGroup setHideToGI( bool hide )
Python	int setTriangleGroup( int iTriangle, int idGroup setHideToGI( bool hide )

Return value

0 = Error setting the triangle group"hide to global illumination" state.

1 = Success.

Anchor

	gettriangleuvwisexcludedofcutplanesgettriangleuvw
	isexcludedofcutplanes

...

isExcludedOfCutPlanes

Gets triangle UVW coordinates"excluded of cut planes" status of the object.

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 isExcludedOfCutPlanes( bool& excluded )
Python	dict getTriangleUVW( int iTriangle, int iChannelID bool isExcludedOfCutPlanes()

Return value

C++

0 = Error getting the triangle UVW coordinates"excluded of cut planes" status.

1 = Success.

Python

Dictionary containing the triangle UVW coordinates ('u1','v1,'w1,'u2','v2','w2','u2','v2','w3')True = object is excluded to cut planes.

False = object is not excluded of cut planes.

Anchor

	settriangleuvwexcludeofcutplanessettriangleuvw
	excludeofcutplanes

...

excludeOfCutPlanes

Sets triangle UVW coordinantes"excluded of cut planes" status of the object.

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 excludeOfCutPlanes( bool exclude )
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 excludeOfCutPlanes( bool exclude )

Return value

0 = Error setting the triangle UVW coordinates"excluded of cut planes" state.

1 = Success.

Gets triangle material

Anchor
gettrianglematerial	gettrianglematerial

getTriangleMaterial

	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.

Language	Syntax
C++	byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material float* getReferenceDisplayPoints( const dword& percent, const dword& maxPoints, dword& nPoints )
Python	CmaxwellMaterial getTriangleMaterialarray getReferenceDisplayPoints( int iTriangle )

Return value

C++

0 = Error getting triangle material.

1 = Success.

Python

Triangle material.

...

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.

...

getGroupMaterial

...

percent, int maxPoints )

Parameters

Type	Name	In/Out	Description
const dword&	percent	in	Percent of points of the mesh that will be returned.
const dword&	maxPoints	in	Maximum number of points that will be in the returned array (-1 means there is not a maximum fixed)
dword&	nPoints	out	Number of points returned.

Return value

C++

Array of nPoints * 3 containing the proxy points requested.

Python

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

Anchor

	setcolorid
	setcolorid

setColorID

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

Language	Syntax
C++	byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material setColorID( const Crgb& color )
Python	CmaxwellMaterial getGroupMaterial( int iGroup int setColorID( Crgb color )

Return value

C++

...

0 = Error

...

setting color ID.

1 = Success

...

Python

...

.

Anchor

	setgroupmaterialgetcoloridsetgroupmaterial
	getcolorid

setGroupMaterial

...

getColorID

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

Language	Syntax
C++	byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material getColorID( Crgb & color )
Python	int setGroupMaterial( int iGroup, CmaxwellMaterial material Crgb getColorID()

Return value

C++

0 = Error

...

getting the color ID.

1 = Success.

Python

Crgb containing the color ID.

Anchor

	setbaseandpivotsetsubdivisionlevelsetbaseandpivot
	setsubdivisionlevel

...

setSubdivisionLevel

Sets base and pivot axes the subdivision level of the objectmesh.

setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0

Language	Syntax
C++	byte
setSubdivisionLevel( const dword& level )
Python	int
setSubdivisionLevel( int level )

Return value

0 = Error setting object base and pivot.

1 = Success.

Anchor

	getbaseandpivotgetsubdivisionlevelgetbaseandpivot
	getsubdivisionlevel

...

getSubdivisionLevel

Gets base and pivot axes the subdivision level of the objectmesh.

tuple getBaseAndPivot( float substepTime = 0.0

Language	Syntax
C++	byte getBaseAndPivotgetSubdivisionLevel( Cbase& base, Cbase& pivot, const real substepTime = 0.0 )	Python	dword& level )
Python	(int level, int success) getSubdivisionLevel()

Return value

C++

0 = Error getting object base and pivot.

1 = Success.

Python

Object base and pivot axesTuple containing the subdivision level of the mesh and the success value of the method.

Anchor

	getworldtransformsetgeometrydirtygetworldtransform
	setgeometrydirty

getWorldTransform

...

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.

Language	Syntax
C++	byte getWorldTransformsetGeometryDirty( Cbase& base )
Python	Cbase getWorldTransformint setGeometryDirty()

Return value

C++

...

0 = Error

...

setting geometry dirty.

1 = Success

...

Python

...

.

Anchor

	gettransformsubstepscountinitializemeshgettransformsubstepscount
	initializemesh

...

initializeMesh

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

Language	Syntax
C++	dword getTransformSubstepsCount()
Python	int getTransformSubstepsCount()

...

getTransformStepInfoByIndex

Return transform information( base, pivot and time) for the given indexClean the mesh and allocates memory for vertexes, normals, triangles and motion blur.

Language	Syntax
C++	byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index initializeMesh( dword nVertex, dword nNormals, dword nFaces, dword positionsPerVertex )
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').

...

isPosRotScaleInitialized

...

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.

Language	Syntax
C++	byte isPosRotScaleInitialized( bool& init resizeMesh( dword newNVertex, dword newNNormals, dword newNFaces, dword newNpositionsPerVertex )
Python	bool isPosRotScaleInitialized(int resizeMesh( int newNVertex, int newNNormals, int newNFaces, int newNpositionsPerVertex )

Return value

...

C++

0 = Error
...
1 = Success.

Python

...

resizing mesh.

1 = Success.

Anchor

	cleangeometrygeneratecustomuvwcleangeometry
	generatecustomuvw

cleanGeometry

...

generateCustomUVW

--TODO--.

Language	Syntax
C++	byte cleanGeometrygenerateCustomUVW( dword iChannel, dword iGeneratorType )
Python	int cleanGeometrygenerateCustomUVW( int iChannel, int iGeneratorType )

Return value

0 = Error cleaning geometrygenerating custom UVW coordinates.

1 = Success.

Gets "hide" status of the object

Anchor

	gethidegetuvwchannelproperties	gethide

getHide

getuvwchannelproperties

getUVWChannelProperties

--TODO--.

bool getHide(

Language	Syntax
C++	byte getHide( bool& hide )	Python	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 "hide" statusUVW channel properties.

1 = Success.

Python

True = object is hidden.

False = object is not hidden.

...

setHide

Sets "hide" status of the object.

Language	Syntax
C++	byte setHide( bool hide )
Python	int setHide( bool hide )

Return value

0 = Error setting "hide" state.

...

Tuple containing the UVW channel properties.

Anchor

	gethidetocameragetglobalxformgethidetocamera
	getglobalxform

getHideToCamera

...

getGlobalXform

--TODO--.

Language	Syntax
C++	byte getHideToCameragetGlobalXform( bool Cbase& hide xForm )
Python	bool getHideCbase getGlobalXform()

Return value

C++

0 = Error getting "hide to camera" status. --TODO--

1 = Success.

Python

True = object is hidden to camera.False = object is not hidden to camera.Cbase containing --TODO--

Anchor

	sethidetocameragetglobalnormalsxformsethidetocamera
	getglobalnormalsxform

setHideToCamera

...

getGlobalNormalsXform

--TODO--.

Language	Syntax
C++	byte setHideToCamera( bool hide getGlobalNormalsXform( Cbase& xForm )
Python	int setHideToCameraCbase getGlobalNormalsXform( bool hide )

Return value

C++

0 = Error

...

getting --TODO--

1 = Success.

Python

Cbase containing --TODO--

Anchor

	gethidetoreflectionsrefractionsgetinverseglobalxformgethidetoreflectionsrefractions
	getinverseglobalxform

getHideToReflectionsRefractions

...

getInverseGlobalXform

--TODO--.

Language	Syntax
C++	byte getHideToReflectionsRefractionsgetInverseGlobalXform( bool Cbase& hide ixForm )
Python	bool getHideToReflectionsRefractionsCbase getInverseGlobalXform()

Return value

C++

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

1 = Success.

Python

True = object is hidden to reflections and refractions.False = object is not hidden to reflections and refractions.Cbase containing --TODO--

Anchor

	sethidetoreflectionsrefractionsgetinverseglobalnormalxformsethidetoreflectionsrefractions
	getinverseglobalnormalxform

setHideToReflectionsRefractions

...

getInverseGlobalNormalXform

--TODO--.

Language	Syntax
C++	byte setHideToReflectionsRefractions( bool hide getInverseGlobalNormalXform( Cbase& ixForm )
Python	int setHideToReflectionsRefractionsCbase getInverseGlobalNormalXform( bool hide )

Return value

C++

0 = Error

...

getting --TODO--

1 = Success.

Python

Cbase containing --TODO--

Anchor

	gethidetogiisgeometryloadergethidetogi
	isgeometryloader

getHideToReflectionsRefractions

...

isGeometryLoader

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

Language	Syntax
C++	byte getHideToGIisGeometryLoader( bool& hide isGeomExtension )
Python	bool getHideToGI isGeometryLoader()

Return value

C++

0 = Error getting "hide to global illumination" statuschecking object was created from a geometry loader extension.

1 = Success.

Python

True = object is hidden to global illumination.False = object is not hidden to global illuminationthe object was created by a geometry loader extension.

Anchor

	sethidetogiisgeometryproceduralsethidetogi
	isgeometryprocedural

setHideToGI

...

isGeometryProcedural

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

Language	Syntax
C++	byte setHideToGIisGeometryProcedural( bool hide & isGeomProceduralExtension )
Python	int setHideToGIbool isGeometryProcedural( bool hide )

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

	isexcludedofcutplaneshasgeometrymodifiersisexcludedofcutplanes
	hasgeometrymodifiers

isExcludedOfCutPlanes

...

hasGeometryModifiers

Checks if the object has geometry modifiers (extensions).

Language	Syntax
C++	byte isExcludedOfCutPlaneshasGeometryModifiers( bool& excluded isGeomModifiersExtension )
Python	bool isExcludedOfCutPlaneshasGeometryModifiers()

Return value

C++

0 = Error getting "excluded of cut planes" statuschecking object have geometry modifiers (extensions).

1 = Success.

Python

True = object is excluded to cut planes.False = object is not excluded of cut planes= the object have geometry modifiers (extensions).

Anchor

	cleanallgeometrymodifierextensions
	cleanallgeometrymodifierextensions

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

	excludeofcutplanesgetgeometrymodifierextensionsnumberexcludeofcutplanes
	getgeometrymodifierextensionsnumber

excludeOfCutPlanes

...

getGeometryModifierExtensionsNumber

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

Language	Syntax
C++	byte excludeOfCutPlanes( bool exclude getGeometryModifierExtensionsNumber( dword& numModifierExtensions )
Python	int excludeOfCutPlanesgetGeometryModifierExtensionsNumber( bool exclude )

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.

Page Comparison

Versions Compared

Old Version 13

New Version Current

Key

Inherited methods

free

Return value

Return value

mergeMeshes

getReferencedOverrideFlags

Return value

C++

Examples

getParent

Python

setReferencedOverrideFlags

Return value

mergeMeshes

Return value

Examples

getParent

Return value

C++

Python

setParent

Return value

getUuid

setUuid

Return value

getMaterial

Return value

C++

Python

setMaterial

Return value

setProperties

Return value

getDependencies

Parameters

Return value

C++

Python

getNumVertexes

Return value

C++

Python

getNumTriangles

Return value

C++

Python

getNumNormals

Return value

C++

Python

getNumPositionsPerVertex

Return value

C++

Python

getNumChannelsUVW

Return value

C++

Python

addChannelUVW

Return value

C++

Python

generateSphericalUVW

Return value

generateCylindricalUVW

Return value

generateCubicUVW

Return value

generatePlanarUVW

Return value

getVertex

Return value

C++

Python

setVertex

0 = Error
...
setting triangle group material.
1 = Success.
...

0 = Error
...
setting object base and pivot.
1 = Success
...