Cobject

Describes a scene object.

Inherits from

Cpointer.

Sub-classes

Citerator

Methods

Inherited methods

isNull.

free

Destroys the object.

Return value

0 = Error destroying object.

1 = Success.

getName

Gets the name of the object.

Return value

C++

0 = Error getting name.

1 = Success.

Python

Object name.

setName

Sets the name of the object.

Return value

0 = Error setting name.

1 = Success.

isMesh

Checks whether the object is a mesh.

Return value

C++

0 = Error getting isMesh value.

1 = Success.

Python

0 = The object is not a mesh.

1 = The object is a mesh.

"" = Error.

isInstance

Checks whether the object is an instance.

Return value

C++

0 = Error getting isInstance value.

1 = Success.

Python

0 = The object is not an instance.

1 = The object is an instance.

"" = Error.

getInstanced

If this Cobject is an instance this method returns its parent object.

Return value

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

isRFRK

Checks whether the object is a RealFlow RenderKit object.

Return value

C++

0 = Error getting isRfrk value.

1 = Success.

Python

0 = Object is not a RFRK object.

1 = Object is a RFRK object.

"" = Error.

getRFRKParameters

Gets RealFlow parameters of the object if it is a RFRK object.

Parameters

Return value

C++

0 = Error getting RFRK parameters.

1 = Success.

Python

Dictionary containing all RFRK parameters.

"" = Error.

setRFRKParameters

Gets RealFlow parameters of the object if it is a RFRK object.

Parameters

Return value

0 = Error setting RFRK parameters.

1 = Success.

getReferencedScenePath

Gets the scene file referenced by this object.

setReferencedScenePach

Sets the scene file referenced by this object.

Return value

0 = Error setting reference scene file.

1 = Success.

getReferencedSceneMaterial

Gets the material of an specific object inside the referenced scene.

setReferencedSceneMaterial

Sets the material of an specific object inside the referenced scene.

Return value

0 = Error setting reference scene file.

1 = Success.

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.

Return value

0 = Error setting reference scene file.

1 = Success.

Examples

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.

Return value

C++

0 = Error getting parent object.

1 = Success.

Python

Parent object.

setParent

Sets the parent object in the hierarchy.

Return value

0 = Error setting parent object.

1 = Success.

getUuid

Unique user ID that can be used for custom purposes.

setUuid

Sets the unique user ID.

Return value

0 = Error setting unique user ID.

1 = Success.

getMaterial

Gets the material applied.

Return value

C++

0 = Error getting object material.

1 = Success.

Python

Object material.

setMaterial

Sets the object material.

Return value

0 = Error setting object material.

1 = Success.

setProperties

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

Return value

0 = Error setting object material.

1 = Success.

getDependencies

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

Parameters

Return value

C++

0 = Error getting dependency paths.

1 = Success.

Python

List of str containing the dependency paths.

getNumVertexes

Gets number of vertexes of the object.

Return value

C++

0 = Error getting number of vertexes.

1 = Success.

Python

Number of vertexes.

getNumTriangles

Gets number of triangles of the object.

Return value

C++

0 = Error getting number of triangles.

1 = Success.

Python

Number of triangles.

getNumNormals

Gets number of normals of the object.

Return value

C++

0 = Error getting number of normals.

1 = Success.

Python

Number of normals.

getNumPositionsPerVertex

Gets number of positions per vertex of the object.

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.

Return value

C++

0 = Error getting number UVW channels.

1 = Success.

Python

Number of UVW channels.

addChannelUVW

Adds an UVW channel to the object.

Return value

C++

0 = Error adding UVW channel.

1 = Success.

Python

Index of the new channel.

generateSphericalUVW

Generates spherical UVW coordinates.

Return value

0 = Error generating spherical UVW coordinaltes.

1 = Success.

generateCylindricalUVW

Generates cylindrical UVW coordinates.

Return value

0 = Error generating cylindrical UVW coordinaltes.

1 = Success.

generateCubicUVW

Generates cubic UVW coordinates.

Return value

0 = Error generating cubic UVW coordinaltes.

1 = Success.

generatePlanarUVW

Generates planar UVW coordinates.

Return value

0 = Error generating planar UVW coordinaltes.

1 = Success.

getVertex

Gets vertex by index.

Return value

C++

0 = Error getting the vertex.

1 = Success.

Python

Cvector containing the vertex requested.

setVertex

Sets vertex by index.

Return value

0 = Error setting the vertex.

1 = Success.

getNormal

Gets normal by index.

Return value

C++

0 = Error getting the normal.

1 = Success.

Python

Cvector containing the normal requested.

setNormal

Sets normal by index.

Return value

0 = Error setting the normal.

1 = Success.

getTriangle

Gets triangle (vertexes and normals) by index.

Return value

C++

0 = Error getting the triangle.

1 = Success.

Python

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

setTriangle

Sets triangle (vertexes and normals) by index.

Return value

0 = Error setting the triangle.

1 = Success.

getTriangleGroup

Gets triangle group by index.

Return value

C++

0 = Error getting the triangle group.

1 = Success.

Python

Triangle group ID.

setTriangleGroup

Sets group that's the triangle belongs to.

Return value

0 = Error setting the triangle group.

1 = Success.

getTriangleUVW

Gets triangle UVW coordinates.

Return value

C++

0 = Error getting the triangle UVW coordinates.

1 = Success.

Python

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

setTriangleUVW

Sets triangle UVW coordinantes.

Return value

0 = Error setting the triangle UVW coordinates.

1 = Success.

getTriangleMaterial

Gets triangle material.

Return value

C++

0 = Error getting triangle material.

1 = Success.

Python

Triangle material.

setTriangleMaterial

Sets the triangle material.

Return value

0 = Error setting triangle material.

1 = Success.

getGroupMaterial

Gets material of a group of triangles.

Return value

C++

0 = Error getting triangle group material.

1 = Success.

Python

Triangle group material.

setGroupMaterial

Sets material of a group of triangles.

Return value

0 = Error setting triangle group material.

1 = Success.

setBaseAndPivot

Sets base and pivot axes of the object.

Return value

0 = Error setting object base and pivot.

1 = Success.

getBaseAndPivot

Gets base and pivot axes of the object.

Return value

C++

0 = Error getting object base and pivot.

1 = Success.

Python

Object base and pivot axes.

getWorldTransform

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

Return value

C++

0 = Error getting world transform of the object.

1 = Success.

Python

Object world transform.

getTransfromSubstepsCount

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

getTransformStepInfoByIndex

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

Return value

C++

0 = Error getting transform information of the object.

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.

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.

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.

Return value

0 = Error cleaning geometry.

1 = Success.

getHide

Gets "hide" status of the object.

Return value

C++

0 = Error getting "hide" status.

1 = Success.

Python

True = object is hidden.

False = object is not hidden.

setHide

Sets "hide" status of the object.

Return value

0 = Error setting "hide" state.

1 = Success.

getHideToCamera

Gets "hide to camera" status of the object.

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.

setHideToCamera

Sets "hide to camera" status of the object.

Return value

0 = Error setting "hide to camera" state.

1 = Success.

getHideToReflectionsRefractions

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

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

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

Return value

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

1 = Success.

getHideToGI

Gets "hide to global illumination" status of the object.

Return value

C++

0 = Error getting "hide to global illumination" status.

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.

Return value

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

1 = Success.

isExcludedOfCutPlanes

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

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.

excludeOfCutPlanes

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

Return value

0 = Error setting "excluded of cut planes" state.

1 = Success.

getProxyDisplayPoints

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.

Parameters

Return value

C++

Array of nPoints * 3 containing the proxy points requested.

Python

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

setColorID

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

Return value

0 = Error setting color ID.

1 = Success.

getColorID

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

Return value

C++

0 = Error getting the color ID.

1 = Success.

Python

Crgb containing the color ID.

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.

Return value

0 = Error setting geometry dirty.

1 = Success.

initializeMesh

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

Return value

0 = Error initializing mesh.

1 = Success.

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.

Return value

0 = Error resizing mesh.

1 = Success.

generateCustomUVW

--TODO--.

Return value

0 = Error generating custom UVW coordinates.

1 = Success.

getUVWChannelProperties

--TODO--.

Return value

C++

0 = Error getting UVW channel properties.

1 = Success.

Python

Dictionary containing the UVW channel properties ('startLatitude', 'endLatutide', 'startLongitude', 'endLongitude', 'startAngle', 'endAngle', 'mirrorBackFaces')

getGlobalXform

--TODO--.

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

getGlobalNormalsXform

--TODO--.

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

getInverseGlobalXform

--TODO--.

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

getInverseGlobalNormalXform

--TODO--.

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

isGeometryLoader

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

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.

isGeometryProcedural

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

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.

hasGeometryModifiers

Checks if the object has geometry modifiers (extensions).

Return value

C++

0 = Error checking object have geometry modifiers (extensions).

1 = Success.

Python

True = the object have geometry modifiers (extensions).

cleanAllGeometryModifierExtensions

Clean all geometry modifier extensions applyed to the object.

Return value

0 = Error cleaning geometry modifier extensions.

1 = Success.

getGeometryModifierExtensionsNumber

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

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.