The Cmaxwell class describes the whole Maxwell Render scene.
...
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. |
| 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 | 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 | --TODO-- |
| computeAbbeGraph | --TODO-- |
| 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 | --TODO-- |
| createGeometryProceduralObject | --TODO-- |
| applySkyExtension | --TODO-- |
| applySceneModifierExtension | --TODO-- |
...
| 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.
...
| 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.
...
| 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.
...
| 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 getSunProperties( byte& enabled, real& sunTemperature, real& sunPowerScaleFactor ) |
| Python | {'(int enabled', 'float sunTemperature', 'float sunPowerScaleFactor'} ) getSunProperties() |
Parameters
...
0 = Error getting sun properties.
1 = Success.
Python
Dictionary Tuple containing the sun properties.
...
| 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() |
...
0 = Error getting atmosphere parameters.
1 = Success.
Python
Dictionary Tuple containing all atmosphere parameters.
...
| Language | Syntax |
|---|---|
| C++ | byte getSkyColor( Crgb& hdrRgb, Crgb8& ldrRgb, const Cvector& dir ) |
| Python | dict getSkyColor(Crgb hdr, Crgb8 ldr) getSkyColor( Cvector dir ) |
Return value
...
0 = Error getting sky color.
1 = Success.
Python
Dictionary Tuple containing 'hdr' and 'ldr' colors.
...
| 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 ) |
...
0 = Error getting environment layer values.
1 = Success.
Python
Dictionary Tuple containing all environment layer values.
...
| Language | Syntax |
|---|---|
| C++ | byte getToneMapping( real& monitorGamma, real& burn ) |
| Python | dict (float monitorGamma, float burn) getToneMapping() |
Return value
...
0 = Error getting tonemapping value.
1 = Success.
Python
Dictionary Tuple containing 'monitorGamma' and 'burn' values.
...
| 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
...
0 = Error getting diffraction parameters.
1 = Success.
Python
Dictionary Tuple containing all diffraction parameters.
...
| Language | Syntax |
|---|---|
| C++ | byte getSceneInfo( CsceneInfo& info ) |
| Python | dict CsceneInfo getSceneInfo() |
Return value
...
0 = Error getting scene info.
1 = Success.
Python
Dictionary Structure containing the scene info.
...
| Language | Syntax |
|---|---|
| C++ | byte getSolidLobeIES( const char* fileName, unsigned int& numPoints, unsigned int& numTriangles, unsigned int*& faces, float*& points, const char* pAxisSystem = NULL ) |
| Python | dict (int numPoints, list points, int numTriangles, list faces) getSolidLobeIES( str filename, str pAxisSystem = "" ) |
Parameters
| Type | Name | In/Out | Description |
|---|---|---|---|
| const char* | fileName | in | IES/EULUM file name. |
| unsigned int& | numPoints | out | Number of points returned. |
| unsigned int& | numTriangles | out | 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. |
...
0 = Error getting IES/EULUM 3D emission pattern.
1 = Success.
Python
Dictionary Tuple containing 'numPoints', 'points', 'numTriangles' and 'faces'.
...
| 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 |
...