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

...

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.

...

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

Language	Syntax
C++	byte
saveSkyToHDR(
char*
path, const
dword&
xRes,
const dword& yRes )
Python
int saveSkyToHDR( str path, int
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	dict getSkyColor( Cvector dir )

Return value

C++

0 = Error getting sky color.

1 = Success.

Python

Dictionary containing 'hdr' and 'ldr' colors.

Anchor

	getskycolor
	getskycolor

getSkyColorNoTonemapped

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

Language	Syntax
C++	byte getSkyColorNoTonemapped( Crgb& hdrRgb, const Cvector& dir )
Python	dict getSkyColorNoTonemapped( Cvector dir )

Return value

C++

0 = Error getting sky color.

1 = Success.

Python

Cvector containing the HDR color.

Anchor

	getenvironmentlayer
	getenvironmentlayer

getEnvironmentLayer

Gets the parameters of each environment layer.

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 )

...

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.

...

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++	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++	const char* getDefaultMaterial()
	void getDefaultMaterial( bool& enabled )
Python	str getDefaultMaterial()
	bool getDefaultMaterialEnabled()

Return value

Requesting default material: File name of the MXM.

...

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

...

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.

...

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.

...

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.

...

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 91

New Version 92

Key

getEnvironmentLayer

saveSkyToHDR

Return value

saveSkyToPreset

Return value

loadSkyFromPreset

Return value

getSkyColor

Return value

C++

Python

getSkyColorNoTonemapped

Return value

C++

Python

getEnvironmentLayer

Return value

C++

Python

Return value

Return value

Return value

Return value

Return value

Return value

Return value

Return value

Return value

C++

Python

Return value

Return value

C++

Python

Return value

C++

Python

Return value

C++

Python

Return value

C++

Python