Page Comparison

The Cmaxwell class describes the whole Maxwell Render scene.

...

Type	Name	Description
unsigned char	_interactiveFlags	Internal use.

Enumerations

typeCallback and InteractiveFlags.

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	Sets sene preview image from another 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.
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.
getActiveToneMappingDeprecated	Gets the active tonemapping used ("BASIC" or "ADVANCED" ).
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. Deprecated.
getSceneInfo	Returns by reference a Cmaxwell::CsceneInfo structure with information about the scene.
computeFresnelGraph	Computes the reflectance as a function of the angle of incidence.
computeAbbeGraph	Computes the reflectance as a function of the spectral input.
getCorrelatedColorTemperature	Gets the correlated RGB values given the temperature color.
generateUuid	Generates an unique ID.
searchFileInCommonPaths	Looks for the given file in all of the searching paths of the scene.
createGeometryLoaderObject
createGeometryProceduralObject
applySkyExtension
applySceneModifierExtension

Static Methods

Name	Description
getEngineVersion	Returns the current engine version.
getSdkVersion	Returns the current SDK version.
isDepthSupportedForThisFormat	Returns true if for the given extension the depth is valid.
getHighestDepthSupportedForThisFormat	Returns the highest bits per plane supported for the given format.
isEmbeddingAlphaSupportedForThisFormat
isEmbeddingAllChannelsSupportedForThisFormat
isTextureExtensionSupported
Returns true if for the given format it is possible embedding the alpha channel.
isEmbeddingAllChannelsSupportedForThisFormat	Returns true if for the given format it is possible embedding all channels in a multilayer file.
isTextureExtensionSupported	Returns true if the extension of the given texture path is supported by the render engine.
getSquareSwatchIES	Used to get the IES/EULUM emission pattern plotted into a square rgb buffer of size "resolution". The caller is responsible of freeing the buffer "buf" after using it.
getSolidLobeIES	Used to get the IES/EULUM emission pattern plotted as a 3d object. The caller is responsible of freeing the buffers "faces, points" after using them.

Virtual Methods

Name	Description
printMessage	Prints a message in the render console or in the message handler installed.

Anchor

	cmaxwellctor
	cmaxwellctor

...

Type

Name

In/Out

Description

const char*

pInput

in

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

The following equivalences are accepted Typedefs with plugin names can be used as well:

"YXZYZXRH" = "LIGHTWAVE"MAXWELL", "MAYA", "XSI", "HOUDINI", "RHINO" or "CINEMASOLIDWORKS".

"ZXYZXYLH" = "FORMZ" or "3DSMAX".

"YZXYXZLH" = "MAXWELLCINEMA", .

"MAYAYZXLH" , = "XSI", "HOUDINI", "RHINO" or "SOLIDWORKS"

...

LIGHTWAVE".

Anchor

	setsingleprecisionofgeometry
	setsingleprecisionofgeometry

...

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.

...

Returns the Cobject with the given name or a null object if there is not an object with that name ( Cmaxwell::Cobject::isNull() == true ).

Anchor

	createmesh
	createmesh

...

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

Anchor

	createinstancement
	createinstancement

...

So it's highly reccommended to assign unique names in each instancement creation when we create a lot of them. A good example of creating instancements is provided here.

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

...

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

Anchor

	createproxy
	createproxy

...

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

Anchor

	createrfrk
	createrfrk

...

Method used to create RealFlow objects. Returns a null object that can be filled with Cmaxwell::Cobject::setRfrkParameters().

Language	Syntax
C++	Cmaxwell::Cobject createRFRK( const char* objName )
Python	CmaxwellObject createRFRK( str objName )

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

Anchor

	addobject
	addobject

...

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

Anchor

	mergemeshes
	mergemeshes

...

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

...

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.

...

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

...

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

Parameters

...

0 = Error getting constant sky parameters.

1 = Success.

Python

Dictionary Tuple containing all constant sky parameters.

...

Gets the location of the sun when Cmaxwell::getSunPositionType() = 0.

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

...

0 = Error getting sun longitude and latitude.

1 = Success.

Python

Dictionary Tuple contaning all sun longitude and latittude values.

...

Sets the location of the sun when Cmaxwell::getSunPositionType() = 0.

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 )

...

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

Parameters

...

0 = Error getting sun angles.

1 = Success

Python

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

...

Language	Syntax
C++	byte getSunRotation( real& rotation )
Python	float getSunRotation()

Parameters

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

...

Language	Syntax
C++	byte getSunProperties( byte& enabled, real& sunTemperature, real& sunPowerScaleFactor )
Python	{'(int enabled', 'float sunTemperature', 'float 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.

...

0 = Error getting sun properties.

1 = Success.

Python

Dictionary Tuple 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.

...

0 = Error getting atmosphere parameters.

1 = Success.

Python

Dictionary Tuple 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++	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.

...

Sun direction vector.

Anchor

	getenvironmentlayersaveskytohdrgetenvironmentlayer
	saveskytohdr

getEnvironmentLayer

...

saveSkyToHDR

Saves current sky to an HDR file in the given path with the given resolution.

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

Language	Syntax
C++	byte
saveSkyToHDR(
char*
path, const
dword&
xRes,
const dword& yRes )
Python
int saveSkyToHDR( str path, int

Parameters

Offset range: From 0.0 to 360.0 (default 0.0).

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
xRes, int yRes )

Return value

0 = Error saving HDR.

1 = Success.

Anchor

	saveskytopreset
	saveskytopreset

saveSkyToPreset

Saves current physical sky values to a sky preset file.

Language	Syntax
C++	byte saveSkyToPreset( const char* path )
Python	int saveSkyToPreset( str path )

Return value

0 = Error saving sky.

1 = Success.

Anchor

	loadskyfrompreset
	loadskyfrompreset

loadSkyFromPreset

Loads a preset file into the scene replacing current physical sky values.

Language	Syntax
C++	byte saveSkyToPreset( const char* path )
Python	int saveSkyToPreset( str path )

Return value

0 = Error loading sky.

1 = Success.

Anchor

	getskycolor
	getskycolor

getSkyColor

Returns sky RGB color (already tonemapped and after exposure is applied) of the current sky values in the given direction.

Language	Syntax
C++	byte getSkyColor( Crgb& hdrRgb, Crgb8& ldrRgb, const Cvector& dir )
Python	(Crgb hdr, Crgb8 ldr) getSkyColor( Cvector dir )

Return value

C++

0 = Error getting environment layer valuessky color.

1 = Success.

Python

Dictionary containing all environment layer valuesTuple containing 'hdr' and 'ldr' colors.

Anchor

	setenvironmentlayergetskycolornotonemappedsetenvironmentlayer
	getskycolornotonemapped

setEnvironmentLayer

...

getSkyColorNoTonemapped

Returns sky RGB color (without tonemapping nor exposure) of the current sky values in the given direction.

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 getSkyColorNoTonemapped( Crgb& hdrRgb, const Cvector& dir )
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).dict getSkyColorNoTonemapped( Cvector dir )

Return value

C++

0 = Error getting sky color.

1 = Success.

Python

Cvector containing the HDR color.

Anchor

	isenvironmentenabled
	isenvironmentenabled

isEnvironmentEnabled

Gets IBL (Image Based Lighting) state.

Language	Syntax
C++	byte isEnvironmentEnabled( bool& enabled )
Python	bool isEnvironmentEnabled()

Return value

C++

0 = Error getting IBL state.

1 = Success.

Python

IBL state.

Anchor

	enableenvironment
	enableenvironment

enableEnvironment

Sets the IBL (Image Based Lighting) on/off.

Language	Syntax
C++	byte enableEnvironment( bool enabled )
Python	int enableEnvironment( bool enabled )

Return value

0 = Error getting IBL state.

1 = Success.

Anchor

	setenvironmentweight
	setenvironmentweight

setEnvironmentWeight

Sets the value for the global multiplier of all the environment layers.

Language	Syntax
C++	byte setEnvironmentWeight( real weight )
Python	int setEnvironmentWeight( float weight )

Return value

0 = Error setting environment layer valuesweight.

1 = Success.

Anchor

	readmaterialgetenvironmentweightreadmaterial
	getenvironmentweight

readMaterial

...

getEnvironmentWeight

Sets the value for the global multiplier of all the environment layers.

Cmaxwell::Cmaterial readMaterial( const char* pFileName CmaxwellMaterial readMaterial str pFilename

Language	Syntax
C++
byte getEnvironmentWeight( real& weight )
Python
float getEnvironmentWeight(
)

Return value

...

C++

0 = Error getting IBL state.

1 = Success.

Python

Environment weight.

Anchor

	creatematerialgetenvironmentlayercreatematerial
	getenvironmentlayer

createMaterial

...

getEnvironmentLayer

Gets the parameters of each environment layer.

Language	Syntax
C++	Cmaxwell::Cmaterial createMaterialbyte getEnvironmentLayer( 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).

...

getMaterial

Given the name of a material, returns its Cmaxwell::Cmaterial reference.

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

...

addMaterial

Adds a material to the scene and returns a reference to the added material.

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

...

eraseUnusedMaterials

Removes unused materials from the scene.

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

Return value

0 = Error erasing unused materials.

1 = Success.

...

setOverrideMaterial

Sets the path and state (enabled/disabled) the material that overrides all the materials of the scene (except emitter materials).

void setOverrideMaterial( bool enabled

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

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

Tuple containing all environment layer values.

Anchor

	setenvironmentlayer
	setenvironmentlayer

setEnvironmentLayer

Sets the parameters of each environment layer.

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

pPathMaterial

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

...

getOverrideMaterial

Gets the path and state (enabled/disabled) of the material that overrides all the materials of the scene (except emitter materials).

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.

Requesting override material state: true if override material is enabled, false if not.

...

setDefaultMaterial

Sets the path and state (enabled/disabled) the material that will be used for all the objects/triangles without material.

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

...

getDefaultMaterial

...

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.

1 = Success.

Anchor

	readmaterial
	readmaterial

readMaterial

Reads a material from disk.

getDefaultMaterial( bool getDefaultMaterialEnabled(

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

Python
void getDefaultMaterial( bool& enabled )
CmaxwellMaterial readMaterial( str pFilename )

Return value

Requesting default material: File name of the MXM.

Requesting default material state: true if default material is enabled, false if not.

...

getRenderParameter, setRenderParameter

Gets/sets the value of the render parameter given by nameReturns a Cmaxwell::Cmaterial object. Null if it was not created (Cmaxwell::Cmaterial::isNull() = true).

Anchor

	creatematerial
	creatematerial

createMaterial

Creates a material with the given name and adds it to the scene if the parameter addToScene is true (default).

byte setRenderParameter pParameterName, dword size, const void* pParameterValue )byte getRenderParameter( const char* pParameterName, dword size, void* pParameterValue int setRenderParameter pParameterName, value

Language	Syntax
C++
Cmaxwell::Cmaterial createMaterial( const char*

pMaterialName, bool addToScene = true )
Python
CmaxwellMaterial createMaterial( str
pMaterialName, bool addToScene = True )
	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.

1 = Success.

Getting parameter:

Parameter value.

...

readMXS

Read scene from disk.

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.

Return values

0 = Error reading scene.

1 = Success.

...

writeMXS

Write the scene to disk.

Language	Syntax
C++	byte writeMXS( const char* pPath = NULL )
Python	int writeMXS( str pPath )

Return value

0 = Error writing scene to disk.

1 = Success.

...

setDiffraction

...

Return value

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

Anchor

	getmaterial
	getmaterial

getMaterial

Given the name of a material, returns its Cmaxwell::Cmaterial reference.

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

Anchor

	addmaterial
	addmaterial

addMaterial

Adds a material to the scene and returns a reference to the added material.

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

Anchor

	eraseunusedmaterials
	eraseunusedmaterials

eraseUnusedMaterials

Removes unused materials from the scene.

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

Return value

0 = Error erasing unused materials.

1 = Success.

Anchor

	setoverridematerial
	setoverridematerial

setOverrideMaterial

Sets the path and state (enabled/disabled) the material that overrides all the materials of the scene (except emitter 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).

Anchor

	getoverridematerial
	getoverridematerial

getOverrideMaterial

Gets the path and state (enabled/disabled) of the material that overrides all the materials of the scene (except emitter materials).

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.

Requesting override material state: true if override material is enabled, false if not.

Anchor

	setdefaultmaterial
	setdefaultmaterial

setDefaultMaterial

Sets the path and state (enabled/disabled) the material that will be used for all the objects/triangles without material.

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

Anchor

	getdefaultmaterial
	getdefaultmaterial

getDefaultMaterial

Gets the path and state (enabled/disabled) of the material that will be used for all the objects/triangles without material.

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.

Requesting default material state: true if default material is enabled, false if not.

Anchor

	getsetrenderparameter
	getsetrenderparameter

getRenderParameter, setRenderParameter

Gets/sets the value of the render parameter given by name.

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

dword

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 DIFFUSE LAYER"	sizeof( byte )	0 = no, 1 = yes.
"DO REFLECTION LAYER"	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.

1 = Success.

Getting parameter:

Parameter value.

Anchor

	gettonemapping
	gettonemapping

getToneMapping

Gets the tonemapping values.

Language	Syntax
C++	byte getToneMapping( real& monitorGamma, real& burn )
Python	(float monitorGamma, float burn) getToneMapping()

Return value

C++

0 = Error getting tonemapping value.

1 = Success.

Python

Tuple containing 'monitorGamma' and 'burn' values.

Anchor

	settonemapping
	settonemapping

setToneMapping

Sets the tonemapping values.

Language	Syntax
C++	byte setToneMapping( real monitorGamma, real burn )
Python	int setToneMapping( float monitorGamma, float burn )

Return value

0 = Error setting tonemapping value.

1 = Success.

Anchor

	getactivetonemapping
	getactivetonemapping

getActiveToneMapping

Gets the active tonemapping used: "BASIC" or "ADVANCED", default "BASIC" (Extensions only use "BASIC").

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

Anchor

	readmxs
	readmxs

readMXS

Read scene from disk.

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.

Return values

0 = Error reading scene.

1 = Success.

Anchor

	writemxs
	writemxs

writeMXS

Write the scene to disk.

Language	Syntax
C++	byte writeMXS( const char* pPath = NULL )
Python	int writeMXS( str pPath )

Return value

0 = Error writing scene to disk.

1 = Success.

Anchor

	setdiffraction
	setdiffraction

setDiffraction

Sets diffraction parameters.

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.

1 = Success.

Anchor

	getdiffraction
	getdiffraction

getDiffraction

Gets 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

Tuple containing all diffraction parameters.

Anchor

	enablediffraction
	enablediffraction

enableDiffraction

Enables diffraction.

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

Return value

0 = Error enabling diffraction.

1 = Success.

Anchor

	disablediffraction
	disablediffraction

disableDiffraction

Disables diffraction.

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

Return value

0 = Error disabling diffraction.

1 = Success.

Anchor

	setcolorspace
	setcolorspace

setColorSpace

Sets the output color space used by the render engine.

Language	Syntax
C++	byte setColorSpace( dword type )
Python	int setColorSpace( int type )

Parameters

Type	Name	In/Out	Description
dword	type	in	Color space selected. See COLOR_SPACES enum.

Return value

0 = Error setting color space.

1 = Success.

Anchor

	getcolorspace
	getcolorspace

getColorSpace

Gets the output color space used by the render engine.

Language	Syntax
C++	void getColorSpace( dword& type )
Python	int getColorSpace()

Parameters

Type	Name	In/Out	Description
dword	type	out	(C++) Color space used. See COLOR_SPACES enum.

Return value

Python

Color space used. See COLOR_SPACES enum.

Anchor

	getcolorspacegamma
	getcolorspacegamma

getColorSpaceGamma

Returns the gamma used by the active color space.

Language	Syntax
C++	real getColorSpaceGamma()
Python	float getColorSpaceGamma()

Anchor

	getlasterror
	getlasterror

getLastError

Returns the latest error occurred, Cerror is defined in error.h. Useful for finding out i/o problems when reading/writing MXS/MXI files.

Language	Syntax
C++	Cerror::error getLastError()
Python	int getLastError()

Anchor

	getlasterrorstring
	getlasterrorstring

getLastErrorString

Returns an human readable string containing the latest error occurred.

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

Anchor

	getdependencies
	getdependencies

getDependencies

Returns an array of strings (length and content) with all the extern dependencies of the scene (textures, ior files, hdr files, etc).

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.

Anchor

	getobjectscount
	getobjectscount

getObjectsCount

Returns the number of objects in the scene.

Language	Syntax
C++	byte getObjectsCount( dword& nObjects )
Python	int getObjectsCount()

Return value

C++

0 = Error getting objects count.

1 = Success.

Python

Number of objects.

Anchor

	getmaterialscount
	getmaterialscount

getMaterialsCount

Returns the number of materials in the scene.

Language	Syntax
C++	byte getMaterialsCount( dword& nMaterials )
Python	int getMaterialsCount()

Return value

C++

0 = Error getting materials count.

1 = Success.

Python

Number of materials.

Anchor

	getcamerascount
	getcamerascount

getCamerasCount

Returns the number of cameras in the scene.

Language	Syntax
C++	byte getCamerasCount( dword& nCameras )
Python	int getCamerasCount()

Return value

C++

0 = Error getting cameras count.

1 = Success.

Python

Number of cameras.

Anchor

	getsceneinfo
	getsceneinfo

getSceneInfo

Returns by reference a CsceneInfo structure with information about the scene.

Language	Syntax
C++	byte getSceneInfo( CsceneInfo& info )
Python	CsceneInfo getSceneInfo()

Return value

C++

0 = Error getting scene info.

1 = Success.

Python

Structure containing the scene info.

Anchor

	computefresnelgraph
	computefresnelgraph

computeFresnelGraph

Computes the reflectance as a function of the angle of incidence.

Language	Syntax
C++	void computeFresnelGraph( float* pX, float* pY, dword n, real iorOutgoing )
Python	array list[2] computeFresnelGraph( int n, float ioirOutgoing )

Parameters

Type	Name	In/Out	Description
float*	pX	out	Float array of size 'n' containing the angle of incidence (from 0 to Pi/2). It must be allocated before call computeFresnelGraph.
float*	pY	out	Float array of size 'n' containing the reflectance graph (from 0 to 1). It must be allocated before call computeFresnelGraph.
dword	n	in	Size of pX and pY float vectors.
real	iorOutgoing	in	Refraction index of the material.

Return value

Python

List containing both (pX and pY) vectors as NumPy arrays.

Anchor

	computeabbegraph
	computeabbegraph

computeAbbeGraph

Computes the reflectance as a function of the spectral input.

Language	Syntax
C++	void computeAbbeGraph( float* pX, float* pY, dword n, real nd, real abbe )
Python	array list[2] computeAbbeGraph( int n, float nd, float abbe )

Parameters

Type	Name	In/Out	Description
float*	pX	out	Float array of size 'n' containing the spectral range (in nm). It must be allocated before call computeAbbeGraph (C++).
float*	pY	out	Float array of size 'n' containing the spectral IOR. It must be allocated before call computeAbbeGraph (C++).
dword	n	in	Size of pX and pY float vectors.
real	nd	in	Refraction index.
real	abbe	in	Abbe number of the material.

Return value

Python

List containing both (pX and pY) vectors as NumPy arrays.

Anchor

	getcorrelatedcolortemperature
	getcorrelatedcolortemperature

getCorrelatedColorTemperature

Gets the correlated RGB values given the temperature color.

Language	Syntax
C++	byte getCorrelatedColorTemperature( Crgb& rgb, real temperature )
Python	Crgb getCorrelatedColorTemperature( float temperature )

Return value

C++

0 = Error getting correlated Crgb. i.e. a negative temperature passed as input.

1 = Success.

Python

Crgb color correlated to the temperature color passed as input.

Anchor

	generateuuid
	generateuuid

generateUuid

Generates a free uuid useful for storing unique identifiers in scene entities using setUuid() method. The caller owns the pointer passed as argument. It is responsability of the caller to allocate and destroy the passed pointer.

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.

Anchor

	searchfileincommonpaths
	searchfileincommonpaths

searchFileInCommonPaths

Looks for the given file in all of the searching paths of the scene.

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.

Anchor

	getengineversion
	getengineversion

getEngineVersion

Returns the current version of Maxwell.

Language	Syntax
C++	void getEngineVersion( char pVersion[64] )
Python	str getEngineVersion()

Anchor

	getsdkversion
	getsdkversion

getSdkVersion

Returns the current version of the Maxwell SDK.

Language	Syntax
C++	void getSdkVersion( char pVersion[64] )
	int getSdkVersion()
Python	str getSdkVersionString()
	int getSdkVersion()

Anchor

	isdepthsupportedforthisformat
	isdepthsupportedforthisformat

isDepthSupportedForThisFormat

Returns true if for the given extension the depth is valid. In example:

isDepthSupportedForThisFormat( "exr", 32 ) returns true.
isDepthSupportedForThisFormat( "jpg", 16 ) returns false.

Language	Syntax
C++	bool isDepthSupportedForThisFormat( const char* extension, byte bitDepth )
Python	bool isDepthSupportedForThisFormat( str extension, int bitDepth )

Anchor

	gethighestdepthsupportedforthisformat
	gethighestdepthsupportedforthisformat

getHighestDepthSupportedForThisFormat

Returns the highest bits per plane supported for the given format. In example:

getHighestDepthSupportedForThisFormat( "exr" ) returns 32.
getHighestDepthSupportedForThisFormat( "jpg" ) returns 8.

Language	Syntax
C++	byte setDiffraction( real intensity, real frequency, isDepthSupportedForThisFormat( const char* pApperture, const char* pObstacle = NULL extension )
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.

1 = Success.

...

getDiffraction

...

isDepthSupportedForThisFormat( str extension )

Anchor

	isembeddingalphasupportedforthisformat
	isembeddingalphasupportedforthisformat

isEmbeddingAlphaSupportedForThisFormat

Returns true if for the given format it is possible embedding the alpha channel.

isEmbeddingAlphaSupportedForThisFormat( "tga" ) returns true.
isEmbeddingAlphaSupportedForThisFormat( "jpg" ) returns false.

Language	Syntax
C++	byte isEmbeddingAlphaSupportedForThisFormat( const char* extension )
Python	int isEmbeddingAlphaSupportedForThisFormat( str extension )

Anchor

	isembeddingallchannelssupportedforthisformat
	isembeddingallchannelssupportedforthisformat

isEmbeddingAllChannelsSupportedForThisFormat

Returns true if for the given format it is possible embedding all channels in a multilayer file.

isEmbeddingAllChannelsSupportedForThisFormat( "tif" ) returns true.
isEmbeddingAllChannelsSupportedForThisFormat( "exr" ) returns true.
rest of formats : returns false.

getDiffraction( bool& isEnabled, real& intensity, real& frequency, * pApperture, const char** pObstacle

Language	Syntax
C++	byte
isEmbeddingAllChannelsSupportedForThisFormat( const char*
extension )
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.

...

getLastError

Returns the latest error occurred, Cerror is defined in error.h. Useful for finding out i/o problems when reading/writing MXS/MXI files.

Language	Syntax
C++	Cerror::error getLastError()
Python	int getLastError()

...

getLastErrorString

Returns an human readable string containing the latest error occurred.

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

...

getDependencies

...

int isEmbeddingAllChannelsSupportedForThisFormat( str extension )

Anchor

	istextureextensionsupported
	istextureextensionsupported

isTextureExtensionSupported

Returns true if the extension of the given texture path is supported by the render engine.

Language	Syntax
C++	byte isTextureExtensionSupported( const char* extension )
Python	int isTextureExtensionSupported( str extension )

Anchor

	getsquareswatchies
	getsquareswatchies

getSquareSwatchIES

Used to get the IES/EULUM emission pattern plotted into a square rgb buffer of size "resolution". The caller is responsible of freeing the buffer "buf" after using it.

Language	Syntax
C++	byte getSquareSwatchIES( const char* file, int resolution, unsigned char*& buf )
Python	list getSquareSwatchIES( str file, int resolution )

Parameters

Type	Name	In/Out	Description
const char*	file	in	IES/EULUM file name.
int	resolution	in	Resolution requested. Output buffer will have resolution * resolution * 3 values.
unsigned char*&	buf	out	Output buffer containing the emission patter.

Return value

C++

0 = Error getting IES/EULUM emission pattern.

1 = Success.

Python

List of size = resolution * resolution * 3, containing the RGB emission pattern.

Anchor

	getsolidlobeies
	getsolidlobeies

getSolidLobeIES

Used to get the IES/EULUM emission pattern plotted as a 3d object. The caller is responsible of freeing the buffers "faces, points" after using them.

getDependencies( dword& numDependencies, char**& paths )str[] getDependencies(

Language	Syntax
C++	byte
Python
getSolidLobeIES( const char* fileName, unsigned int& numPoints, unsigned int& numTriangles, unsigned int& faces, float& points, const char* pAxisSystem = NULL )
Python	(int numPoints, list points, int numTriangles, list faces) getSolidLobeIES( str filename, str pAxisSystem = "" )

Parameters

numDependencies dependenciespaths

Type
Name	In/Out	Description	dword
	Name	In/Out	Description
const char*	fileName	in	IES/EULUM file name.
unsigned int&	numPoints	out	Number of
points returned.
char**
unsigned int&	numTriangles	out
Dependencies' file names.

Return value

C++

0 = Error getting dependencies.

1 = Success

Python

String list containing all the dependencies.

...

generateUuid

Generates a free uuid useful for storing unique identifiers in scene entities using setUuid() method. The caller owns the pointer passed as argument. It is responsability of the caller to allocate and destroy the passed pointer.

str generateUuid()

Language	Syntax
C++	byte generateUuid( char** uuid )
Python
Number of triangles returned.
unsigned int*&	faces	out	0-based indices into points array : v00, v01, v02, v10, v11, v12, .....
float*&	points	out	Array of vertices, x0, y0, z0, x1, y1, z1, .....
const char*	pAxisSystem	in	Same as setInputDataType.

Return value

C++

0 = Error generating unique IDgetting IES/EULUM 3D emission pattern.

1 = Success.

Python

String containing the unique IDTuple containing 'numPoints', 'points', 'numTriangles' and 'faces'.

Anchor

	searchfileincommonpathsprintmessagesearchfileincommonpaths
	printmessage

searchFileInCommonPaths

...

printMessage

Prints a message in the render console or in the message handler installed. Can be reimplemented in subclasses to install handlers.

byte searchFileInCommonPaths fileToSearch, char*& newFoundFile )

Language	Syntax
C++
virtual void printMessage( const char*
Python	str searchFileInCommonPaths( str fileToSearch )
text, const int code )

Parameters

fileToSearchFile to searchchar*

Type	Name	In/Out
const char*
text	in
Message.
const int
newFoundFile	out	File name of the found file.

Return value

C++

code

in

0 =

...

Info.

1 =

...

Error.

Python

0 = File not found.

String containing found file name.

2 = Warning.

Anchor

	cmaxwell_typecallback
	cmaxwell_typecallback

...

InteractiveFlags

Values of the _interactiveFlags property.

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 89

New Version Current

Key

Enumerations

Static Methods

Virtual Methods

Examples

Parameters

Python

Python

Parameters

Python

Parameters

Parameters

Python

Parameters

Parameters

Python

Parameters

Parameters

getEnvironmentLayer

saveSkyToHDR

Parameters

Return value

saveSkyToPreset

Return value

loadSkyFromPreset

Return value

getSkyColor

Return value

C++

Python

setEnvironmentLayer

getSkyColorNoTonemapped

Parameters

Return value

C++

Python

isEnvironmentEnabled

Return value

C++

Python

enableEnvironment

Return value

setEnvironmentWeight

Return value

readMaterial

getEnvironmentWeight

Return value

C++

Python

createMaterial

getEnvironmentLayer

Return value

getMaterial

Return value

addMaterial

Return value

eraseUnusedMaterials

Return value

setOverrideMaterial

Parameters

Return value

C++

Python

setEnvironmentLayer

Parameters

getOverrideMaterial

Return value

setDefaultMaterial

Parameters

getDefaultMaterial

Return value

readMaterial

Return value

getRenderParameter, setRenderParameter

createMaterial

Parameters