Page Comparison

Cmaxwell class describes the whole Maxwell Render scene.

...

CoptionsReadMXS, CsceneInfo, CmultiValue, Cmaterial, CmaterialLayer, CmaterialEmitter, Creflectance, Ccoating, Cbsdf, Ccamera and Cobject.

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	Internal use.
enableProtection	Internal use.
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 preview image from path.
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
a ddCamera	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
setToneMapping
getActiveToneMapping
setAdvancedToneMapping
getAdvancedToneMapping
Read/write scene methods
readMXS	Reads scene from disk.
writeMXS	Writes scene to disk.
Glare methods
setDiffraction
getDiffraction
enableDiffraction
disableDiffraction
setColorSpace
getColorSpace
getColorSpaceGamma
Miscellaneous methods
getLastError
getLastErrorString
getDependencies
getObjectsCount
getMaterialsCount
getCamerasCount
getTriangleGroupsCount
getSceneInfo
computeFresnelGraph
computeAbbeGraph
getCorrelatedColorTemperature
generateUuid
searchFileInCommonPaths
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.

...

Anchor

	getsetrenderparameter
	getsetrenderparameter

getRenderParameter, setRenderParameter

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

Language	SyntexSyntax
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	ValuesValue
"ENGINE"	sizeof( char ) * 3	Selects render engine. "RS0" or "RS1".
"NUM THREADS"	sizeof( dword )	Number of threads. 0 = automatic.
"STOP TIME"	sizeof( dword )	SecondsRender 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 )

// "SAVE LIGHTS IN SEPARATE FILES",

0 = no, 1 = yes.
"MXI FULLNAME"	0	const char* that specifies the MXI path.
"DO NOT SAVE MXI FILE"	sizeof( byte )

// "MXI FULLNAME", 0, const char* that specifies the MXI path
//

0 = no, 1 = yes.

"DO NOT SAVE

MXI

IMAGE FILE"

,

sizeof( byte )

// "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 )

// "DO INDIRECT

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 )
// "DO DEVIGNETTING", sizeof( byte )
// "DEVIGNETTING", sizeof( real )
// "DO SCATTERING_LENS", sizeof( byte )
// "SCATTERING_LENS", sizeof( real ) [Range 0-1]
// "DO SHARPNESS", sizeof( byte )
// "SHARPNESS", sizeof( real )

...

	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

	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

	cmaxwell_typecallback
	cmaxwell_typecallback

...

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

...

Versions Compared

Old Version 69

New Version 70

Key

getRenderParameter, setRenderParameter

Parameters

Return value

C++

Python

readMXS

Parameters

Return values