Cobject

C++	Python
Cmaxwell::Cobject	CmaxwellObject

Describes a scene object.

Inherits from

Cpointer.

Sub-classes

Citerator

Methods

Name	Description
setPointer	Internal use.
Cobject#free	Destroys the object.
getName	Gets object name.
setName	Sets object name.
isMesh	Checks whether the object is a mesh.
isInstance	Checks whether the object is an instance.
getInstanced	Gets instance's parent.
isRFRK	Checks whether the object is a RFRK object.
getRFRKParameters	Gets ReaFlow RenderKit parameters.
setRFRKParameters	Sets RealFlow RenderKit parameters.
getReferencedScenePath	Gets the scene file referenced by this object.
setReferencedScenePath	Sets the scene file referenced by this object.
getReferencedSceneMaterial	Gets the material of an specific object inside the referenced scene.
setReferencedSceneMaterial	Sets the material of an specific object inside the referenced scene.
mergeMeshes	Merges an array of meshes into a single mesh. Target object must not be included.
getParent	Gets the parent object in the hierarchy.
setParent	Sets the parent object in the hierarchy.
getUuid	Unique user ID that can be used for custom purposes.
setUuid	Sets the unique user ID.
getMaterial	Gets the material applied.
setMaterial	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
getNumTriangles
getNumNormals
getNumPositionsPerVertex
getNumChannelsUVW
addChannelUVW
generateSphericalUVW
generateCylindricalUVW
generateCubicUVW
generatePlanarUVW
getVertex
setVertex
getNormal
setNormal
getTriangle
setTriangle
getTriangleGroup
setTriangleGroup
getTriangleUVW
setTriangleUVW
getTriangleMaterial
setTriangleMaterial
getGroupMaterial
setGroupMaterial
getBaseAndPivot
setBaseAndPivot
getWorldTransform
getTransformSubstepsCount
getTransfrormStepInfoByIndex
getPosition
setPosition
getRotation
setRotation
getScale
setScale
getShear
setShear
getPivotPosition
setPivotPosition
getPivotRotation
setPivotRotation
isPosRotScaleInitialized
cleanGeometry
Display
getHide
setHide
getHideToCamera
setHideToCamera
getHideToReflectionsRefractions
setHideToReflectionsRefractions
getHideToGI
setHideToGI
isExcludedOfCutPlanes
excludeOfCutPlanes
getProxyDisplayPoints
setColorID
getColorID
setGeometryDirty
getUserData
setUserData
getVertexesBuffer
getNormalsBuffer
getTrianglesBuffer
initializeMesh
resizeMesh
generateCustomUVW
getUVWChannelProperties
getGlobalXform
getGlobalNormalsXform
getInverseGlobalXform
getInverseGlobalNormalsXform
isGeometryLoader
isGeometryProcedural
hasGeometryModifiers
applyGeometryModifierExtension
cleanAllGeometryModifierExtensions
getGeometryLoaderExtensionParams
getGeometryProceturalExtensionParams
getGeometryModifierExtensionNumber
getGeometryModifierExtensionParamsAtIndex

free

Destroys the object.

Language	Syntax
C++	byte free()
Python	int free()

Return value

0 = Error destroying object.

1 = Success.

getName

Gets the name of the object.

Language	Syntax
C++	byte getName( char** pName)
Python	str getName()

Return value

C++

0 = Error getting name.

1 = Success.

Python

Object name.

setName

Sets the name of the object.

Language	Syntax
C++	byte setName( const char* pName )
Python	int setName( str pName )

Return value

0 = Error setting name.

1 = Success.

isMesh

Checks whether the object is a mesh.

Language	Syntax
C++	byte isMesh( byte& isMesh )
Python	int isMesh()

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.

Language	Syntax
C++	byte isInstance( byte& isInstance )
Python	int isInstance()

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.

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

isRFRK

Checks whether the object is a RealFlow RenderKit object.

Language	Syntax
C++	byte isRFRK( byte& isRfrk )
Python	int isRFRK()

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.

Language	Syntax
C++	byte getRFRKParameters( char& binSeqNames, char& rwName, char*& substractiveField, real& scale, real& resolution, real& polySize, real& radius, real& smooth, real& core, real& splash, real& maxVelocity, int& axis, real& fps, int& frame, int& offset, bool& flipNormals, int& rwTesselation, bool& mb, real& mbCoef )
Python	{ str 'binSeqNames', str 'rwName', str 'substractiveField', float 'scale', float 'resolution', float 'polySize', float 'radius', float 'smooth', float 'core', float 'splash', float 'maxVelocity', int 'axis', float 'fps', int 'frame', int 'offset', bool 'flipNormals', int 'rwTesselation', bool 'mb', float 'mbCoef' } getRFRKParameters()

Parameters

Type	Name	In/Out	Description
char*	binSeqNames	out	Comma separated list of full paths to .bin or .pd files.
char*	rwName	out	Full path to a realwave .sd file.
char*	substractiveField	out	'' or Null -> all particle fields are positive. i.e: substractiveField = '011010' -> six particle files, first, third and sixth are negative, and second, third and fifth are positive.
real	scale	out	Default value = 1.0.
real	resolution	out	Default value = 1.0.
real	polySize	out	Default value = 0.0.
real	radius	out	Default value = 0.33.
real	smooth	out	Default value = 0.3.
real	core	out	Default value = 0.0.
real	splash	out	Default value = 0.0.
real	maxVelocity	out	Default value = 1000.0.
int	axis	out	0 = YXZ, 1 = ZXY, 2 = YZX.
real	fps	out	Default value = 25.0.
int	frame	out
int	offset	out	Default value = 0.
bool	flipNormals	out	Default value = false.
int	rwTesselation	out	Default value = 3.
bool	mb	out	Motion blur (true) or not (false).
real	mbCoef	out	0.0 to 1.0. Motion blur duration in % of shutter angle.

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.

Language	Syntax
C++	byte setRFRKParameters( const char* binSeqNames, const char* rwName, char* substractiveField, real scale, real resolution, real polySize, real radius, real smooth, real core, real splash, real maxVelocity, int axis, real fps, int frame, int offset, bool flipNormals, int rwTesselation, bool mb, real mbCoef )
Python	int setRFRKParameters( str binSeqNames, str rwName, str substractiveField, float scale, float resolution, float polySize, float radius, float smooth, float core, float splash, float maxVelocity, int axis, float fps, int frame, int offset, bool flipNormals, int rwTesselation, bool mb, float mbCoef )

Parameters

Type	Name	In/Out	Description
char*	binSeqNames	in	Comma separated list of full paths to .bin or .pd files.
char*	rwName	in	Full path to a realwave .sd file.
char*	substractiveField	in	'' or Null -> all particle fields are positive. i.e: substractiveField = '011010' -> six particle files, first, third and sixth are negative, and second, third and fifth are positive.
real	scale	in	Default value = 1.0.
real	resolution	in	Default value = 1.0.
real	polySize	in	Default value = 0.0.
real	radius	in	Default value = 0.33.
real	smooth	in	Default value = 0.3.
real	core	in	Default value = 0.0.
real	splash	in	Default value = 0.0.
real	maxVelocity	in	Default value = 1000.0.
int	axis	in	0 = YXZ, 1 = ZXY, 2 = YZX.
real	fps	in	Default value = 25.0.
int	frame	in
int	offset	in	Default value = 0.
bool	flipNormals	in	Default value = false.
int	rwTesselation	in	Default value = 3.
bool	mb	in	Motion blur (true) or not (false).
real	mbCoef	in	0.0 to 1.0. Motion blur duration in % of shutter angle.

Return value

0 = Error setting RFRK parameters.

1 = Success.

getReferencedScenePath

Gets the scene file referenced by this object.

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

setReferencedScenePach

Sets the scene file referenced by this object.

Language	Syntax
C++	byte setReferencedScenePath( const char* proxyPath )
Python	int setReferencedScenePath( const char* proxyPath )

Return value

0 = Error setting reference scene file.

1 = Success.

getReferencedSceneMaterial

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

Language	Syntax
C++	byte getReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial& material )
Python	CmaxwellMaterial getReferencedSceneMaterial( str objectName )

setReferencedSceneMaterial

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

Language	Syntax
C++	byte setReferencedSceneMaterial( const char* objectName, Cmaxwell::Cmaterial material )
Python	int setReferencedSceneMaterial( str objectName, Cmaterial material )

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.

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

Return value

0 = Error setting reference scene file.

1 = Success.

Examples

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

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.

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.

getUuid

Unique user ID that can be used for custom purposes.

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

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.

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.

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

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.

getDependencies

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

Language	Syntax
C++	byte getDependencies( dword& numDependencies, char** & paths, const bool& searchInsideProxy = true )
Python	str[] getDependencies( bool searchInsideProxy = true )

Parameters

Type	Name	In/Out	Description
dword&	numDependencies	out	(C++ only) Number of dependencies returned.
char**&	paths	out	(C++ onlu) String array (size = numDependencies) containing all the dependencies requested.
const bool&	searchIndideProxy	in	If true, the function search for dependencies also in the referenced proxy object if exists. searchInsideProxy is true by default.

Return value

C++

0 = Error getting dependency paths.

1 = Success.

Python

List of str containing the dependency paths.