Page Comparison

The Cmaxwell class describes the whole Maxwell Render scene.

...

Methods

Name	Description
Cmaxwell	Class constructor.
~Cmaxwell	Class destructor.
getMxsVersion	Gets MXS file version.
getMostRecentVersionMXS	Gets most recent MXS version supported.
getPluginID	Gets the plug-in identifier from which the MXS was created.
setPluginID	Gets the plug-in identifier from which the MXS was created.
isProtectionEnabled	Gets scene protection state in Maxwell Studio (ability to export to other formats).
enableProtection	Sets scene protection state in Maxwell Studio (ability to export to other formats).
Scene methods
freeGeometry	Deletes all geometry of the scene.
freeScene	Resets the scene. Cleans all objects, geometry, materials, etc.
getScenePreview	Preview image of the scene stored in the file (useful for thumbnals).
setScenePreview	Sets preview image.
readPreview	Read scene Sets sene preview image from pathanother MXS --TODO--.
setInputDataType	Set the axis orientation of the scene.
setSinglePrecisionOfGeometry	Uses floats instead of doubles for geometry.
setSceneUserData	Internal use.
addCluster	Adds a triangle cluster to the scene.	freeCluster	--TODO-- not implemented
Object methods
getObject	Gets a object reference from the scene.
createMesh	Creates a mesh with the given parameters and adds it to the scene.
createInstancement	Creates an instancement.
createProxy	Creates a proxy object from a MXS.
createRFRK	Creates a RealFlow RenderKit object.
addObject	Adds an existent object to the scene.
mergeMeshes	Merges meshes into a new one.
Camera methods
addCamera	Adds a new camera to the scene with the given parameters.
getCamera	Gets a camera requested by name.
getActiveCamera	Gets the active camera of the scene.
Paths methods
setPath	Sets the path and depth for the given channel.
getPath	Gets the path and depth for the given channel.
addSearchingPath	Adds a path to look for missing textures, ior and ies files.
getSearchingPaths	Gets all searching paths of the scene.
Sky methods
getSunPositionType	Sets sun position type.
setSunPositionType	Gets sun position type.
getSkyConstant	Gets the parameters of the constant sky.
setSkyConstant	Sets the parameters of the constant sky.
getSunLongitudeAndLatitude	Gets sun longitude and latitude data.
setSunLongitudeAndLatitude	Sets sun longitude and latitude data.
getSunAngles	Gets sun position angles.
setSunAngles	Sets sun position angles.
getSunDirection	Gets sun direction vector.
setSunDirection	Sets sun direction vector.
getSunRotation	Gets sun rotation angles.
setSunRotation	Sets sun rotation angles.
getSunProperties	Gets sun properties
setSunProperties	Sets sun properties.
getPhysicalSkyAtmosphere	Gets physical atmosphere parameters.
setPhysicalSkyAtmosphere	Sets physical atmosphere parameters.
getActiveSky	Gets active sky name.
setActiveSky	Sets active sky name.
Additional sky methods
getSunDirectionUsedForRendering	Returns the sun direction.
saveSkyToHDR	Saves current sky to an HDR file.
saveSkyToPreset	Saves current physical sky values to a file.
loadSkyFromPreset	Loads a preset file replacing current physical sky values.
getSkyColor	Returns sky RGB color of the current sky values in the given direction.
getSkyColorNoTonemapped	Returns sky RGB color (without tonemapping nor exposure) of the current sky values in the given direction.
Environment methods
isEnvironmentEnabled	Gets IBL (Image Based Lighting) state.
enableEnvironment	Sets the IBL (Image Based Lighting) on/off.
getEnvironmentWeight	Gets the value for the global multiplier of all the environment layers.
setEnvironmentWeight	Sets the value for the global multiplier of all the environment layers.
getEnvironmentLayer	Gets the parameters of each environment layer.
setEnvironmentLayer	Sets the parameters of each environment layer.
Material methods
readMaterial	Reads a material from file (MXM).
createMaterial	Creates a new material.
getMaterial	Gets a material by name.
addMaterial	Adds a material to the scene.
eraseUnusedMaterials	Remove unused materials from the scene.
setOverrideMaterial	Sets the path and state (enabled/disabled) of the material that overrides all materials of the scene (except emitter materials).
getOverrideMaterial	gets the path and state (enabled/disabled) of the material that overrides all materials of the scene (except emitter materials).
setDefaultMaterial	Sets the path and state (enabled/disabled) of the material that will be used for all the objects/triangles without material.
getDefaultMaterial	Gets the path and state (enabled/disabled) of the material that will be used for all the objects/triangles without material.
Render methods
setRenderParameter	Sets render parameter.
getRenderParameter	Gets render parameter.
Tonemapping methods
getToneMapping	Gets tonemapping values.
setToneMapping	Sets tonemapping values.
getActiveToneMapping	Deprecated.
setAdvancedToneMapping	Deprecated.
getAdvancedToneMapping	Deprecated.
Read/write scene methods
readMXS	Reads scene from disk.
writeMXS	Writes scene to disk.
Glare methods
setDiffraction	Sets diffraction parameters.
getDiffraction	Gets diffraction parameters.
enableDiffraction	Enables diffraction.
disableDiffraction	Disables diffraction.
setColorSpace	Sets the output color space used by the render engine.
getColorSpace	Gets the output color space used by the render engine.
getColorSpaceGamma	Returns the gamma used by the active color space.
Miscellaneous methods
getLastError	Returns the latest error occurred.
getLastErrorString	Returns an human readable string containing the latest error occurred.
getDependencies	Returns all the extern dependencies of the scene (textures, ior files, hdr files, etc).
getObjectsCount	Returns the number of objects in the scene.
getMaterialsCount	Returns the number of materials in the scene.
getCamerasCount	Returns the number of cameras in the scene.
getTriangleGroupsCount	Returns the number of triangle groups in the scene.
getSceneInfo	Returns by reference a Cmaxwell::CsceneInfo structure with information about the scene.
computeFresnelGraph
computeAbbeGraph
getCorrelatedColorTemperature
generateUuid	Generates an unique ID.
searchFileInCommonPaths	Looks for the given file in all of the searching paths of the scene.
createGeometryLoaderObject
createGeometryProceduralObject
applySkyExtension
applySceneModifierExtension

...

Language	Syntax
C++	void enableProtection( bool enable )
Python	void enableProtection( bool enable )

Anchor

	setinputdatatypefreegeometrysetinputdatatype
	freegeometry

setInputDataType

...

freeGeometry

Deletes all geometry of the scene.

Language	Syntax
C++	byte setInputDataType( const char* pInput void freeGeometry()
Python	int setInputDataTypevoid freeGeometry( str pInput )

...

Anchor

	freescene

...

	freescene

...

Must be one of the following: "YXZ", "ZXY" or "YZX".

The following equivalences are accepted as well:

"YXZ" = "LIGHTWAVE" or "CINEMA".

"ZXY" = "FORMZ" or "3DSMAX"

...

freeScene

Resets the scene. Cleans all objects, geometry, materials, etc.

Language	Syntax
C++	void freeScene()
Python	void freeScene()

Anchor

	getscenepreview
	getscenepreview

getScenePreview

Preview image of the scene stored in the file (useful for thumbnals).

Language	Syntax
C++	Crgb8* getScenePreview( dword& xRes, dword& yRes )
Python	array getScenePreview()

Parameters

Type	Name	In/Out	Description
dword	xRes	out	Preview image width.
dword	yRes	out	Preview image height.

Return value

C++

Crgb8 pointer to the preview image. The memory pointed belongs to the scene, so the programmer must not free it.

Python

NumPy array containing the RGB image. Array dimensions: (height, width, 3).

Anchor

	setscenepreview
	setscenepreview

setScenePreview

Sets the scene preview image.

Language	Syntax
C++	byte setScenePreview( dword xRes, dword yRes, Crgb8* pRGB )
Python	bool setScenePreview( array image )

Parameters

Type	Name	In/Out	Description
dword	xRes	in	(C++) Image width.
dword	yRes	in	(C++) Image height.
Crgb8*	pRGB	in	(C++) Image buffer.
image	array	in	(Python) NumPy ubyte array. Shape is (width,height,3).

Return value

0 = Error setting scene preview image.

1 = Success.

Anchor

	readpreview
	readpreview

readPreview

Sets the scene preview from another MXS.

Language	Syntax
C++	Crgb8* readPreview( const char* pPath, dword& xResPreview, dword& yResPreview )
Python	array readPreview( str filename )

Parameters

Type	Name	In/Out	Description
const char*	pPath	in	MXS file name.
dword&	xResPreview	out	(C++) Preview width.
dword&	yResPreview	out	(C++) Preview height.

Return value

C++

Crgb8 pointer to the preview image. The memory pointed belongs to the scene, so the programmer must not free it.

Python

NumPy array containing the RGB image. Array dimensions: (height, width, 3).

Anchor

	setinputdatatype
	setinputdatatype

setInputDataType

Sets the axis orientation of the scene.

Language	Syntax
C++	byte setInputDataType( const char* pInput )
Python	int setInputDataType( str pInput )

Parameters

Type

Name

In/Out

Description

const char*

pInput

in

Must be one of the following: "YXZ", "ZXY" or "YZX".

The following equivalences are accepted as well:

"YXZ" = "LIGHTWAVE" or "CINEMA".

"ZXY" = "FORMZ" or "3DSMAX"

"YZX" = "MAXWELL", "MAYA", "XSI", "HOUDINI", "RHINO" or "SOLIDWORKS"

Anchor

	setsingleprecisionofgeometry
	setsingleprecisionofgeometry

setSinglePrecisionOfGeometry

Uses floats instead of doubles for geometry.

Language	Syntax
C++	void setSinglePrecisionOfGeometry()
Python	void setSinglePrecisionOfGeometry()

Anchor

	cmaxwell_addcluster
	cmaxwell_addcluster

addCluster

Creates a triangle cluster in the scene.

Language	Syntax
C++	Cmaxwell::Ccluster addCluster( const char* pName )
Python	Ccluster addCluster( pName)

Parameters

Type	Name	In/out	Description
const char*	pName	in	Cluster name

Return value

Returns a Cmaxwell::Ccluster object, that is a reference to the cluster added to the scene.

Examples

Code Block

language	cpp
title	Python

Cmaxwell::Ccluster cluster = scene->addCluster( "cluster1" );

Code Block

title	Python

cluster = scene.addCluster( "cluster1" );

Anchor

	createmesh
	createmesh

...

Type	Name	In/Out	Description
const char*	pName	in	Object name.
dword	nVertexes	in	Number of vertexes to create.
dword	nNormals	in	Number of normals to create.
dword	nTriangles	in	Number of triangles to create.
dword	nPositionsPerVertex	in	Sets the number of deformation motion blur substeps (1 or 2, 1 means no deformation blur).

Return value

Cmaxwell::Cobject reference to the new mesh object created in the scene. Null object if it was not created (Cmaxwell::Cobject::isNull() = true).

...

Language	Syntax
C++	Cmaxwell::Cobject createInstancement( const char* pName, Cmaxwell::Cobject& object )
Python	CmaxwellObject createInstancement( str pName, CmaxwellObject object )

Parameters

Type	Name	In/Out	Description
const char*	pName	in	Instancement name. If exists, an unique name will be assigned, but it is more efficient the user gives an unique name at first.
Cmaxwell::Cobject&	object	in	Cmaxwell::Cobject to be instanced.

...

Language	Syntax
C++	Cmaxwell::Cobject addObject( Cmaxwell::Cobject& object )
Python	CmaxwellObject addObject( CmaxwellObject object )

Return value

Cmaxwell::Cobject reference to the object added in the scene. Null object if it was not created (Cmaxwell::Cobject::isNull() = true).

...

Language	Syntax
C++	Cmaxwell::Cobject mergeMeshes( const char* pName, const Cmaxwell::Cobject* pMeshes, dword nMeshes )
Python	CmaxwellObject mergeMeshes( str pName, CmaxwellObject[] pMeshes )

Return value

Cmaxwell::Cobject reference to the new merged object created in the scene. Null object if it was not created (Cmaxwell::Cobject::isNull() = true).

Examples

Code Block

title	Python

list = []
list.append(scene.getObject('sphere'));
list.append(scene.getObject('cube'));
newobject = scene.mergeMeshes('merged',list);

...

Language	Syntax
C++	Cmaxwell::Ccamera addCamera( const char pName, dword nSteps, real shutter, real filmWidth, real filmHeight, real iso, const char pDiaphragmType, real angle, word nBlades, dword fps, word xRes, dword yRes, real pixelAspect, byte projectionType = 0 );
Python	CmaxwellCamera addCamera( name, nSteps, shutter, filmWidth, filmHeight, iso, diaphragmType, angle, nBlades, fps, xRes, yRes, pixelAspect, proyectionType = 0 )

Parameters

Type	Name	In/Out	Description
const char*	pName	in	Camera name.
dword	nSteps	in	Number of steps.
real	shutter	in	Camera shutter.
real	filmWidth	in	Camera film width.
real	filmHeitgt	in	Camera film height.
real	iso	in	Camera ISO.
const char*	pDiaphragmType	in	Camera diaphragm type. Must be "CIRCULAR" or "POLYGONAL".
real	angle	in	Camera diaphragm angle.
dword	nBlades	in	Camera diaphragm blades number.
dword	fps	in	Frames per second.
dword	xRes	in	Camera width resolution.
dword	yRes	in	Camera height resolution.
real	pixelAspect	in	Pixel aspect.
byte	projectionType	in	Camera projection type. Must be 0 (perspective, default), 1 (front), 2 (top), 3 (left), 4 (back), 5 (bottom), or 6 (right).

Return value

Returns a Cmaxwell::Ccamera object, that is a reference to the camera added to the scene. Null if it was not created (Cmaxwell::Ccamera::isNull() = true).

Examples

Code Block

language	cpp
title	C++

Cmaxwell* scene = new Cmaxwell(mwcallback);
Cmaxwell::Ccamera camera = scene->addCamera( "Camera1", 1, 0.1, 0.1, 0.1, 500, "CIRCULAR", 90.0, 0, 25, 800, 600, 1, 0 );

...

Language	Syntax
C++	byte setPath( const char* pType, const char* pPath, byte& outputBitDepthMode )
Python	int setPath( str pType, str pPath, int outputBitDepthMode )

Parameters

Type

Name

In/Out

Description

const char*

pType

in

Path type: "RENDER", "ALPHA", "SHADOW", "OBJECT", "MATERIAL", "MOTION", "Z". ("BITMAPS" is deprecated, use Cmaxwell::addSearchingPath() instead)

const char*

pPath

in

Output path of the channel.

byte

outputBitDepthMode

in

Bits depth per pixel (8/16/32). If the depth is not correct for the given format, the engine tries to change this parameter.

i.e. setPath( "image.jpg", 32 ) is not correct because jpg does not support 32 bits so the engine will change it to 8. Get more info about supported image formats.

...

Language	Syntax
C++	const char* getPath( const char* pType, byte& outputBitDepthMode )
Python	(path,outputBitDepthMode) getPath( str pType )

Parameters

Type	Name	In/Out	Description
const char*	pType	in	Path type: "RENDER", "ALPHA", "SHADOW", "OBJECT", "MATERIAL", "MOTION", "Z". ("BITMAPS" is deprecated, use Cmaxwell::addSearchingPath() instead)
byte	outputBitDepthMode	out	Bits depth per pixel (8/16/32).

Return value

C++

Output path of the channel.

Python

(path,outputBitDepthMode) = Tuple containing the output path of the channel and its bit depth.

...

Language	Syntax
C++	byte addSearchingPath( const char* pPath )
Python	int addSearchingPath( str pPath )

Return value

0 = Error adding searching path.

...

Language	Syntax
C++	byte getSearchingPaths( dword& numPaths, char**& paths )
Python	str[] getSearchingPaths()

Parameters

Type	Name	In/Out	Description
dword	numPaths	out	Number of paths returned.
char**	paths	out	List of paths.

Return value

C++

0 = Error getting searching paths.

1 = Success

Python

List of paths

...

addCluster

Creates a triangle cluster in the scene.

Language	Syntax
C++	Cmaxwell::Ccluster addCluster( const char* pName )
Python	Ccluster addCluster( pName)

Parameters

Type	Name	In/out	Description
const char*	pName	in	Cluster name

Return value

Returns a Cmaxwell::Ccluster object, that is a reference to the cluster added to the scene.

Examples

Code Block

language	cpp
title	Python

Cmaxwell::Ccluster cluster = scene->addCluster( "cluster1" );

...

title	Python

...

	numPaths	out	Number of paths returned.
char**	paths	out	List of paths.

Return value

C++

0 = Error getting searching paths.

1 = Success

Python

List of paths

Anchor

	getsunpositiontype
	getsunpositiontype

...

Language	Syntax
C++	byte getSunPositionType( byte& positionType )
Python	int getSunPositionType()

Parameters

Type	Name	In/Out	Description
byte	positionType	out	Position type: 0 (Latitude/Longitude), 1 (Zenith/azimuth angles) or 2 (Direction vector)

Return value

C++

0 = Error getting sun position type.

1 = Success.

Python

Sun position type.

Anchor

	setsunpositiontype
	setsunpositiontype

...

Language	Syntax
C++	byte setSunPositionType( byte& positionType )
Python	int setSunPositionType( int positionType )

Parameters

Type	Name	In/Out	Description
byte	positionType	in	Position type: 0 (Latitude/Longitude), 1 (Zenith/azimuth angles) or 2 (Direction vector)

Return value

0 = Error setting sun position type.

...

Language	Syntax
C++	byte getSkyConstant( real& luminance, Crgb& color0, Crgb& color90, real& controlPoint )
Python	{ float 'luminance', Crgb 'color0', Crgb 'color90', 'controlPoint' } getSkyConstant()

Parameters

Type	Name	In/Out	Description
real	luminance	out	Sky luminance. Must be a positive number.
Crgb	color0	out	Color at the horizont.
Crgb	color90	out	Color at the zenith.
real	controlPoint	out	Sets the angle where the two colors are 50/50 mixed. i.e controlPoint = 45.0 means that the color at 45º angle is 50% color0 and 50% color90.

Return value

C++

0 = Error getting constant sky parameters.

1 = Success.

Python

Dictionary containing all constant sky parameters.

...

Language	Syntax
C++	byte getSkyConstant( real luminance, const Crgb& color0, const Crgb& color90, real controlPoint )
Python	int getSkyConstant( float luminance, Crgb color0, Crgb color90, float controlPoint )

Parameters

Type	Name	In/Out	Description
real	luminance	out	Sky luminance. Must be a positive number.
Crgb	color0	out	Color at the horizont.
Crgb	color90	out	Color at the zenith.
real	controlPoint	out	Sets the angle where the two colors are 50/50 mixed. i.e controlPoint = 45.0 means that the color at 45º angle is 50% color0 and 50% color90.

Return value

0 = Error setting constant sky parameters.

...

Language	Syntax
C++	byte getSunLongitudeAndLatitude( real& longitude, real& latitude, int& sm, dword& dayOfYear, real&timeOfDay )
Python	{ float 'longitude', float 'latitude', int 'sm', int 'dayOfYear', int 'timeOfDay'} getSunLongitudeAndLatitude()

Parameters

Type	Name	In/Out	Description
real	longitude	out	Longitude in degrees (from -180.0 to 180.0).
real	latitude	out	Latitude in degrees (from -90.0 to 90.0).
int	sm	out	GMT.
int	dayOfYear	out	Day of the year (from 1 to 365, default = 100).
real	timeOfDay	out	Hour (from 0.0 to 24.0, default = 17.0 ).

Return value

C++

0 = Error getting sun longitude and latitude.

1 = Success.

Python

Dictionary contaning all sun longitude and latittude values.

...

Language	Syntax
C++	byte setSunLongitudeAndLatitude( real longitude, real latitude, int sm, dword dayOfYear, real timeOfDay )
Python	int setSunLongitudeAndLatitude( float longitude, float latitude, int sm, int dayOfYear, float timeOfDay )

Parameters

Type	Name	In/Out	Description
real	longitude	out	Longitude in degrees (from -180.0 to 180.0).
real	latitude	out	Latitude in degrees (from -90.0 to 90.0).
int	sm	out	GMT.
int	dayOfYear	out	Day of the year (from 1 to 365, default = 100).
real	timeOfDay	out	Hour (from 0.0 to 24.0, default = 17.0 ).

...

Language	Syntax
C++	byte getSunAngles( real& zenith, real& azimuth )
Python	(zenith,azimuth) getSunAngles()

Parameters

Type	Name	In/out	Description
real	zenith	out	Zenith angle (from 0.0 to PI/2 radians).
real	azimuth	out	Azimuth angle (from 0.0 to 2PI in radians).

Return values

C++

0 = Error getting sun angles.

1 = Success

Python

(zenith,azimuth) = Tuple containing zenith and azimuth angles.

...

Language	Syntax
C++	byte setSunAngles( real zenith, real azimith )
Python	int setSunAngles( float zenith, float azimuth )

Parameters

Type	Name	In/out	Description
real	zenith	out	Zenith angle (from 0.0 to PI/2 radians).
real	azimuth	out	Azimuth angle (from 0.0 to 2PI in radians).

...

Language	Syntax
C++	byte getSunDirection( Cvector3DT& dir )
Python	Cvector3DT getSunDirection()

Return value

C++

0 = Error getting sun direction.

1 = Success.

Python

Sun direction vector

Anchor

	setsundirection
	setsundirection

...

Language	Syntax
C++	byte setSunDirection( Cvector3DT dir )
Python	int setSunDirection( Cvector3DT dir )

Return value

0 = Error setting sun direction.

...

Type	Name	In/Out	Description
real	rotation	out	Ground rotation of the sky hemisphere (from 0 to 2PI radians).

Return value

C++

0 = Error getting sun rotation.

1 = Success.

Python

Ground rotation.

Anchor

	setsunrotation
	setsunrotation

...

Type	Name	In/Out	Description
real	rotation	in	Ground rotation of the sky hemisphere (from 0 to 2PI radians).

Return value

0 = Error setting sun rotation.

...

Language	Syntax
C++	byte getSunProperties( byte& enabled, real& sunTemperature, real& sunPowerScaleFactor )
Python	{'enabled','sunTemperature','sunPowerScaleFactor'} getSunProperties()

Parameters

Type	Name	In/Out	Description
byte	enabled	out	Sun enabled (1) or disabled (0).
real	sunTemperature	out	Temperature in kelvins.
real	sunPowerScaleFactor	out	Total power refered to the Earth's sun. For example a value of 0.8 would mean a sun emitting 0.8 times less energy than ours. Default: 1.0. Range: is allowed any value greater than 0.

Return values

C++

0 = Error getting sun properties.

1 = Success.

Python

Dictionary containing the sun properties.

...

Language	Syntax
C++	byte setSunProperties( byte enabled, real sunTemperature, real sunPowerScaleFactor )
Python	int setSunProperties( int enabled, float sunTemperature, float sunPowerScaleFactor )

Parameters

Type	Name	In/Out	Description
byte	enabled	in	Sun enabled (1) or disabled (0).
real	sunTemperature	in	Temperature in kelvins.
real	sunPowerScaleFactor	in	Total power refered to the Earth's sun. For example a value of 0.8 would mean a sun emitting 0.8 times less energy than ours. Default: 1.0. Range: is allowed any value greater than 0.

...

Language	Syntax
C++	byte getPhysicalSkyAtmosphere( real& intensity, real& ozone, real& water, real& angstromTurbidity, real& wavelengthTurbidity, real& aerosolAlbedo, real& asimmetryFactor, real& planetReflectance )
Python	{ float 'intensity, float 'ozone', float 'water', float 'angstromTurbidity', float 'wavelengthTurbidity', float 'aerosolAlbedo', float 'asimmetryFactor', float 'planetReflectance' } getPhysicalSkyAtmosphere()

Parameters

Type	Name	In/Out	Description
real	intensity	out	Intensity weight. Default: 1.0. Range: Any value greater than 0.
real	ozone	out	(cms) Default: 0.4. Range: Any value greater than 0 (usually between 0 and 1).
real	water	out	Water vapor (cms). Default: 2.0. Range: Any value greater than 0.
real	angstromTurbidity	out	Angstrom turbidity coefficient. Default: 0.04. Range: Any value greater than 0.
real	wavelengthTurbidity	out	Wavelength turbidity exponent. Default 1.2. Range: Any value greater than 0.
real	aerosolAlbedo	out	Aerosol albedo. Default 0.8. Range: (0-1).
real	asimmetryFactor	out	"Anisotropy" of aerosol. Default: 0.7. Range (-0.99999, 0.99999).
real	planetReflectance	out	Planet reflectance. From 0 to 1.

Return values

C++

0 = Error getting atmosphere parameters.

1 = Success.

Python

Dictionary containing all atmosphere parameters.

...

Language	Syntax
C++	byte setPhysicalSkyAtmosphere( real intensity, real ozone, real water, real angstromTurbidity, real wavelengthTurbidity, real aerosolAlbedo, real asimmetryFactor, real planetReflectance )
Python	byte setPhysicalSkyAtmosphere( float intensity, float ozone, float water, float angstromTurbidity, float wavelengthTurbidity, float aerosolAlbedo, float asimmetryFactor, float planetReflectance )

Parameters

Type	Name	In/Out	Description
real	intensity	in	Intensity weight. Default: 1.0. Range: Any value greater than 0.
real	ozone	in	(cms) Default: 0.4. Range: Any value greater than 0 (usually between 0 and 1).
real	water	in	Water vapor (cms). Default: 2.0. Range: Any value greater than 0.
real	angstromTurbidity	in	Angstrom turbidity coefficient. Default: 0.04. Range: Any value greater than 0.
real	wavelengthTurbidity	in	Wavelength turbidity exponent. Default 1.2. Range: Any value greater than 0.
real	aerosolAlbedo	in	Aerosol albedo. Default 0.8. Range: (0-1).
real	asimmetryFactor	in	"Anisotropy" of aerosol. Default: 0.7. Range (-0.99999, 0.99999).
real	planetReflectance	in	Planet reflectance. From 0 to 1.

...

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

Return value

Active sky name. "constant " = constant sky, "physical" = physical sky, NULL = no sky.

...

Language	Syntax
C++	byte setActiveSky( const char* pActiveSky )
Python	int setActiveSky( str pActiveSky )

Parameters

Type	Name	In/Out	Description
const char*	pActiveSky	in	Active sky name. "constant " = constant sky, "physical" = physical sky, NULL = no sky.

...

Language	Syntax
C++	byte getSunDirectionUsedForRendering( Cvector3DT& dir )
Python	Cvector3DT getSunDirectionUsedForRendering()

Return value

C++

0 = Error getting sun direction.

1 = Success

Python

Sun direction vector.

Anchor

	getenvironmentlayer
	getenvironmentlayer

...

Language	Syntax
C++	byte getEnvironmentLayer( const char* pLayerName, const char*& pBitmapFileName, byte& state, bool& sphericalMapping, bool& interpolate, real& intensity, real& uTile, real& vTile, real& uTileOffset, real& vTileOffset )
Python	{ str 'bitmapFileName', int 'state', bool 'sphericalMapping', bool 'interpolate', float 'intensity', float 'uTile', float 'vTile', float 'uTileOffset', float 'TileOffset'} getEnvironmentLayer( str pLayerName )

Parameters

Type	Name	In/Out	Description
const char*	pLayerName	in	Sets the layer type. Must be "background", "reflection", "refraction" or "illumination".
const char*	pBitmapFileName	out	Path of the texture file.
byte	state	out	Channel state: 0 = Disabled; 1 = Enabled; 2 = Use active sky instead. Default: Enabled.
bool	sphericalMapping	out	Spherical mapping enabled. When pLayerName = "background" must be false.
bool	interpolate	out	If true, pixel values are interpolated.
real	intensity	out	Intensity range: From 0.0001 to 1000.0 (Default: 1.0).
real	uTile	out	Tile range: From 0.0001 to 1000.0 (default 1.0).
real	vTile	out	Tile range: From 0.0001 to 1000.0 (default 1.0).
real	uTileOffset	out	Offset range: From 0.0 to 360.0 (default 0.0).
real	vTileOffset	out	Offset range: From 0.0 to 360.0 (default 0.0).

Return value

C++

0 = Error getting environment layer values.

1 = Success.

Python

Dictionary containing all environment layer values.

...

Language	Syntax
C++	byte setEnvironmentLayer( const char* pLayerName, const char* pBitmapFileName, byte state, bool sphericalMapping, bool interpolate, real intensity, real uTile, real vTile, real uTileOffset, real vTileOffset )
Python	int setEnvironmentLayer( str pLayerName, str pBitmapFilename, int state, bool sphericalMapping, bool interpolate, float intensity, float uTile, float vTile, float uTileOffset, float vTileOffset )

Parameters

Type	Name	In/Out	Description
const char*	pLayerName	in	Sets the layer type. Must be "background", "reflection", "refraction" or "illumination".
const char*	pBitmapFileName	in	Path of the texture file.
byte	state	in	Channel state: 0 = Disabled; 1 = Enabled; 2 = Use active sky instead. Default: Enabled.
bool	sphericalMapping	in	Spherical mapping enabled. When pLayerName = "background" must be false.
bool	interpolate	in	If true, pixel values are interpolated.
real	intensity	in	Intensity range: From 0.0001 to 1000.0 (Default: 1.0).
real	uTile	in	Tile range: From 0.0001 to 1000.0 (default 1.0).
real	vTile	in	Tile range: From 0.0001 to 1000.0 (default 1.0).
real	uTileOffset	in	Offset range: From 0.0 to 360.0 (default 0.0).
real	vTileOffset	in	Offset range: From 0.0 to 360.0 (default 0.0).

Return value

0 = Error setting environment layer values.

...

Language	Syntax
C++	Cmaxwell::Cmaterial readMaterial( const char* pFileName )
Python	CmaxwellMaterial readMaterial( str pFilename )

Return value

Returns a Cmaxwell::Cmaterial object. Null if it was not created (Cmaxwell::Cmaterial::isNull() = true).

...

Language	Syntax
C++	Cmaxwell::Cmaterial createMaterial( const char* pMaterialName, bool addToScene = true )
Python	CmaxwellMaterial createMaterial( str pMaterialName, bool addToScene = True )

Return value

Returns a Cmaxwell::Cmaterial object. Null if it was not created (Cmaxwell::Cmaterial::isNull() = true).

...

Language	Syntax
C++	Cmaxwell::Cmaterial getMaterial( const char* pMaterialName )
Python	CmaxwellMaterial getMaterial( str pMaterialName )

Return value

Returns a Cmaxwell::Cmaterial object. Null if it was not created (Cmaxwell::Cmaterial::isNull() = true).

...

Language	Syntax
C++	Cmaxwell::Cmaterial addMaterial( Cmaxwell::Cmaterial& material )
Python	CmaxwellMaterial addMaterial( CmaxwellMaterial material )

Return value

Returns a Cmaxwell::Cmaterial object. Null if it was not created (Cmaxwell::Cmaterial::isNull() = true).

...

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

Return value

0 = Error erasing unused materials.

...

Language	Syntax
C++	void setOverrideMaterial( const char* pPathMaterial )
	void setOverrideMaterial( bool enabled )
Python	void setOverrideMaterial( str pPathMaterial )
	void setOverrideMaterial( bool enabled )

Parameters

Type	Name	In/Out	Description
const char*	pPathMaterial	in	MXM file name of the override material.
bool	enabled	in	Sets override material state (enabled/disabled).

...

Language	Syntax
C++	const char* getOverrideMaterial()
	void getOverrideMaterial( bool& enabled )
Python	str getOverrideMaterial()
	bool getOverrideMaterialEnabled()

Return value

Requesting override material: File name of the MXM.

...

Language	Syntax
C++	void setDefaultMaterial( const char* pPathMaterial )
	void setDefaultMaterial( bool enabled )
Python	void setDefaultMaterial( str pPathMaterial )
	void setDefaultMaterial( bool enabled )

Parameters

Type	Name	In/Out	Description
const char*	pPathMaterial	in	MXM file name of the default material.
bool	enabled	in	Sets default material state (enabled/disabled).

...

Language	Syntax
C++	const char* getDefaultMaterial()
	void getDefaultMaterial( bool& enabled )
Python	str getDefaultMaterial()
	bool getDefaultMaterialEnabled()

Return value

Requesting default material: File name of the MXM.

...

Language	Syntax
C++	byte setRenderParameter( const char* pParameterName, dword size, const void* pParameterValue )
	byte getRenderParameter( const char* pParameterName, dword size, void* pParameterValue )
Python	int setRenderParameter( str pParameterName, value )
	value getRenderParameter( str pParameterName )

Parameters

Type

Name

In/Out

Description

const char*

pParameterName

in

Parameter name (see pParameterValue for parameter name list).

dcord

size

in

Size of the parameter in bytes (see pParameterValue to view sizes by parameter).

Note: parameter size is not needed in Python.

void*

pParameterValue

in/out

Parameter value, according to the following correspondences:

Parameter name	Size	Value
"ENGINE"	sizeof( char ) * 3	Selects render engine. "RS0" or "RS1".
"NUM THREADS"	sizeof( dword )	Number of threads. 0 = automatic.
"STOP TIME"	sizeof( dword )	Render time in seconds.
"SAMPLING LEVEL"	sizeof( float )	Target sampling level.
"USE MULTILIGHT"	sizeof( byte )	0 = No multilight; 1 = Intensity multilight; 2 = Intensity + Color multilight.
"SAVE LIGHTS IN SEPARATE FILES"	sizeof( byte )	0 = no, 1 = yes.
"MXI FULLNAME"	0	const char* that specifies the MXI path.
"DO NOT SAVE MXI FILE"	sizeof( byte )	0 = no, 1 = yes.
"DO NOT SAVE IMAGE FILE"	sizeof( byte )	0 = no, 1 = yes.
"RENAME AFTER SAVING"	sizeof( byte )	0 = no, 1 = yes.
"COPY MXI AFTER RENDER"	0	const char* that specifies the MXI path where output will be copied.
"COPY IMAGE AFTER RENDER"	0	const char* that specifies the image path where output will be copied.
"REMOVE FILES AFTER COPY"	sizeof( byte )	0 = no, 1 = yes.
"DO MOTION BLUR"	sizeof( byte )	0 = no, 1 = yes.
"DO DISPLACEMENT"	sizeof( byte )	0 = no, 1 = yes.
"DO DISPERSION"	sizeof( byte )	0 = no, 1 = yes.
"DO DIRECT LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO INDIRECT LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO DIRECT REFLECTION CAUSTIC LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO INDIRECT REFLECTION CAUSTIC LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO DIRECT REFRACTION CAUSTIC LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO INDIRECT REFRACTION CAUSTIC LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO RENDER CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO ALPHA CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"OPAQUE ALPHA"	sizeof( byte )	0 = no, 1 = yes.
"EMBED CHANNELS"	sizeof( byte )	0 = no, 1 = yes.
"DO IDOBJECT CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO IDMATERIAL CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO SHADOW PASS CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO MOTION CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO ROUGHNESS CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO FRESNEL CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO NORMALS CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"NORMALS CHANNEL SPACE"	sizeof( byte )	0 = world space (default ); 1 = camera space.
"POSITION CHANNEL SPACE"	sizeof( byte )	0 = world space (default ); 1 = camera space.
"MOTION CHANNEL TYPE"	sizeof( byte )	0 = RealSmart
"DO POSITION CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"DO ZBUFFER CHANNEL"	sizeof( byte )	0 = no, 1 = yes.
"ZBUFFER RANGE"	2 * sizeof( real )	Two values: z-near and z-far.
"DO DEVIGNETTING"	sizeof( byte )	0 = no, 1 = yes.
"DEVIGNETTING"	sizeof( byte )	Devignetting value. Range: 0-100.
"DO SCATTERING_LENS"	sizeof( real )	Range: 0-1
"DO SHARPNESS"	sizeof( byte )	0 = no, 1 = yes.
"SHARPNESS"	sizeof( byte )	Sharpness value. Range: 0-100.

Return value

C++

0 = Error getting/setting render parameter.

1 = Success.

Python

Setting parameter:

0 = Error setting render parameter.

...

Language	Syntax
C++	byte readMXS( const char* pPath, const Cmaxwell::CoptionsReadMXS& mxsOptions = CoptionsReadMXS() )
Python	int readMXS( str pPath, CoptionsReadMXS mxsOptions = CoptionsReadMXS() )

Parameters

Type	Name	In/Out	Description
const char*	pPath	in	MXS file name.
Cmaxwell::CoptionsReadMXS	mxsOptions	in	Read options. Useful to skip, in example, meshes in huge scenes.

...

Language	Syntax
C++	byte setDiffraction( real intensity, real frequency, const char* pApperture, const char* pObstacle = NULL )
Python	int setDiffraction( float intensity, float frequency, str pAperture, str pObstacle = 0 )

Parameters

Type	Name	In/Out	Description
real	intensity	in	Diffraction intensity.
real	frequency	in	Diffraction frequency.
const char*	pApperture	in	Diffraction apperture map path.
const char*	pObstacle	in	Diffraction obstacle map path.

Return value

0 = Error setting diffraction parameters.

...

Language	Syntax
C++	byte getDiffraction( bool& isEnabled, real& intensity, real& frequency, const char pApperture, const char pObstacle )
Python	{ bool 'isEnabled', float 'intensity', float 'frequence', str 'aperture', str 'obstacle' } getDiffraction()

Parameters

Type	Name	In/Out	Description
bool	isEnabled	out	Diffraction state (enabled/disabled).
real	intensity	out	Diffraction intensity.
real	frequency	out	Diffraction frequency.
const char*	pApperture	out	Diffraction apperture map path.
const char*	pObstacle	out	Diffraction obstacle map path.

Return value

C++

0 = Error getting diffraction parameters.

1 = Success.

Python

Dictionary containing all diffraction parameters.

...

Language	Syntax
C++	byte getDependencies( dword& numDependencies, char**& paths )
Python	str[] getDependencies()

Parameters

Type	Name	In/Out	Description
dword	numDependencies	out	Number of dependencies.
char**	paths	out	Dependencies' file names.

Return value

C++

0 = Error getting dependencies.

1 = Success

Python

String list containing all the dependencies.

...

Language	Syntax
C++	byte generateUuid( char** uuid )
Python	str generateUuid()

Return value

C++

0 = Error generating unique ID.

1 = Success.

Python

String containing the unique ID.

...

Language	Syntax
C++	byte searchFileInCommonPaths( const char* fileToSearch, char*& newFoundFile )
Python	str searchFileInCommonPaths( str fileToSearch )

Parameters

Type	Name	In/Out	Description
const char*	fileToSearch	in	File to search.
char*	newFoundFile	out	File name of the found file.

Return value

C++

0 = File not found.

1 = File founded and returned in newFoundFile.

Python

0 = File not found.

String containing found file name.

...

Value	C++	Python
0	Cmaxwell::ALL_CLEAN	Cmaxwell.ALL_CLEAN
1	Cmaxwell::CAMERA_DIRTY	Cmaxwell.CAMERA_DIRTY
2	Cmaxwell::MATERIALS_ASSIGNMENTS_DIRTY	Cmaxwel.MATERIALS_ASSIGNMENTS_DIRTY
8	Cmaxwell::GEOMETRY_DIRTY	Cmaxwell.GEOMETRY_DIRTY
16	Cmaxwell::VOXELIZATION_DIRTY	Cmaxwell.VOXELIZATION_DIRTY
32	Cmaxwell::SKY_OR_HDR_DIRTY	Cmaxwell.SKY_OR_HDR_DIRTY
64	Cmaxwell::DEFAULT_OR_OVERRIDE_MATERIAL_DIRTY	Cmaxwell.DEFAULT_OR_OVERRIDE_MATERIAL_DIRTY
0x3F	Cmaxwell::ALL_DIRTY	Cmaxwell.ALL_DIRTY

...

Page Comparison

Versions Compared

Old Version 87

New Version 88

Key

setInputDataType

freeGeometry

freeScene

getScenePreview

Parameters

Return value

C++

Python

setScenePreview

Parameters

Return value

readPreview

Parameters

Return value

C++

Python

setInputDataType

Parameters

setSinglePrecisionOfGeometry

addCluster

Parameters

Examples

Return value

Parameters

Return value

Return value

Examples

Parameters

Return value

Examples

Parameters

Parameters

Return value

C++

Python

Return value

Parameters

Return value

C++

Python

addCluster

Parameters

Examples

Return value

C++

Python

Parameters

Return value

C++

Python

Parameters

Return value

Parameters

Return value

C++

Python

Parameters

Return value

Parameters

Return value

C++

Python

Parameters

Parameters

Return values

C++

Python

Parameters

Return value

C++

Python

Return value

Return value

C++

Python