class ART::IAssetManager

Resource management interface. More...

#include <ARTIAssetManager.h>

Inherits: IREDObject.

Public functions:

virtual RED_RCBuildGeometryREDGraph ( RED::Object *& oRoot, RED::Map< RED::ShapePath, RED::Object * > & oMeshes, RED::Vector< RED::Object * > & oLights, RED::Map< int, RED::Object * > & oMaterials, RED::Object * iGeometry ) const = 0
virtual RED_RCClearGeometryGICache ( RED::Vector< RED::Vector< RED::Object * > > & iGiCaches, RED::Vector< RED::Vector< RED::Object * > > & iGiCachesBakedLights, RED::Vector< RED::Object * > & iAoCaches ) const = 0
virtual RED_RCClearGeometrySourceFile ( RED::Object * iRoot, const RED::Vector< unsigned int > & iContext ) const = 0
virtual RED_RCClearGeometrySourceFileImages ( const RED::Vector< unsigned int > & iContext ) const = 0
virtual RED_RCClearGeometrySourceFileMaterials ( const RED::Vector< unsigned int > & iContext ) const = 0
virtual RED_RCComputeShapePaths ( RED::Vector< RED::ShapePath > & oShapePaths, RED::Object * iSceneRoot, RED::Object * iShape, bool iUpward = true, bool iDownward = true, bool iIncludeShape = true ) const = 0
virtual RED_RCConvertGeometrySourceAxis ( RED::Object *& oRootZUp, RED::Object * iRoot, const RED::Matrix & iConvert ) const = 0
virtual RED_RCCreateAtlas ( RED::Object *& oAtlas, const RED::Color & iColor ) = 0
virtual RED_RCCreateGeometry ( RED::Object *& oGeometry, RED::Object * iSceneRoot, const RED::LayerSet & iMaterialLayerSet, const RED::Vector< RED::String > & iExcludedNames, RED::Map< unsigned int, RED::String > & ioIDToNames, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) = 0
virtual RED_RCCreateGeometryInstance ( RED::Object *& oInstance, RED::Object * iGeometry ) const = 0
virtual RED_RCDeleteAtlas ( RED::Object * iAtlas ) = 0
virtual RED_RCDeleteAtlas ( unsigned int iContext ) = 0
virtual RED_RCDeleteGeometry ( RED::Object * iGeometry ) = 0
virtual RED_RCDeleteLightStaticShadowMaps ( const RED::Vector< RED::Object * > & iShadowMaps ) const = 0
virtual RED_RCDeleteLightStaticShadowMaps ( unsigned int iDataContext ) const = 0
virtual RED_RCDeleteReflectionProbesMaps ( RED::Object * iEnvironmentMapAtlas, RED::Object * iEnvironmentMapAtlasIndex ) const = 0
virtual RED_RCDeleteReflectionProbesMaps ( unsigned int iDataContext ) const = 0
virtual RED_RCGenerateGeometryGICache ( RED::Vector< RED::Vector< RED::Object * > > & oGiCaches, RED::Vector< RED::Vector< RED::Object * > > & oGiCachesBakedLights, RED::Vector< RED::Object * > & oAoCaches, RED::Vector< unsigned char > & oGroundAO, double oGroundBC[3], RED::Object * iRoot, const RED::LayerSet & iMaterialLayerSet, const RED::Vector< RED::Vector3 > & iFilterPosIndoor, const RED::Vector< RED::Vector3 > & iFilterPosOutdoor, const RED::Vector< RED::Object * > & iSkyPortals, const RED::Vector< RED::Object * > & iGISplitters, const RED::Vector< unsigned int > & iBakedLightsFull, const RED::Vector< unsigned int > & iBakedLightsIndirect, const RED::Vector< unsigned int > & iBakedLightsShared, bool iHasGround, const RED::Color & iGroundColor, double iGroundAltitude, int iGICacheSamplesCount, int iLightsSamplingRate, int iGICacheHemiSamplingRate, int iGICacheInterpSamplesCount, int iGIEstimatorSamplingRate, int iGIEstimatorInterpSamplesCount, double iGICacheMergeBorderShrink, bool iDynamicSun, const RED::Vector3 & iSunDirection, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCGenerateGeometryGroundFields ( RED::Vector< float > & oElevation, RED::Vector< float > & oElevationWeight, RED::Vector< float > oDensity[4], double & oElevationMin, double & oElevationMax, double oElevationBC[3], RED::Object * iRoot, double iElevationFadeSize, double iDensityFadeSize[4], int iResolution, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCGenerateGeometryVertexAO ( RED::Vector< float > & oVertexAO, const RED::Object * iGeometry, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCGenerateGIFilteringPositions ( RED::Vector< RED::Vector3 > & ioFilterPos, const RED::Vector3 & iReference, bool iIndoor, const RED::Object * iSceneRoot, double iSpacing, double iGroundAltitude, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) = 0
virtual RED_RCGenerateLightStaticShadowMaps ( RED::Vector< RED::Object * > & oShadowMaps, RED::Object * iLight, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCGenerateReflectionProbeMaps ( RED::Object *& oEnvironmentMapAtlas, RED::Object *& oEnvironmentMapAtlasIndex, const RED::Object * iReflectionProbe, int iCubeSize, bool iDynamicSun, const RED::Vector3 & iSunDirection, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCGetMaterialLayerSets ( RED::Vector< RED::LayerSet > & oLayerSets, const RED::Vector< unsigned int > & iContext ) const = 0
virtual RED_RCLoadAtlas ( RED::Object *& oAtlas, RED::Vector< RED::Object * > & oCameras, unsigned int & oContext, const RED::String & iName, ART::ProgressCallback iProgress = NULL, void * iParam = NULL ) = 0
virtual RED_RCLoadEnvironment ( RED::Object *& oEnvironment, RED::Matrix & oPosition, RED::Matrix & oPlanetAxisSystemForSun, const RED::String & iName ) = 0
virtual RED_RCLoadGeometry ( RED::Object *& oGeometry, const RED::String & iPath, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) = 0
virtual RED_RCLoadGeometryGICache ( RED::Vector< RED::Vector< RED::Object * > > & oGiCaches, RED::Vector< RED::Vector< RED::Object * > > & oGiCachesBakedLights, RED::Vector< RED::Object * > & oAoCaches, RED::Vector< unsigned char > & oGroundAO, double oGroundBC[3], RED::Vector3 & oSunDirection, const RED::String & iPath, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCLoadGeometryGroundFields ( RED::Vector< float > & oElevation, RED::Vector< float > & oElevationWeight, RED::Vector< float > oDensity[4], int & oResolution, double oElevationBC[3], const RED::String & iPath ) const = 0
virtual RED_RCLoadGeometrySourceFile ( RED::Object *& oRoot, RED::Vector< unsigned int > & oContext, RED::Map< unsigned int, RED::String > & oId2Names, const RED::String & iFilePath, const RED::Matrix & iConvert, const RED::LayerSet & iMaterialLayerSet, bool iLoadTextures = true, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCLoadGeometrySourceFile ( RED::Object *& oRoot, RED::Vector< unsigned int > & oContext, RED::Map< unsigned int, RED::String > & oId2Names, RED::IStream & iStream, const RED::Matrix & iConvert, const RED::LayerSet & iMaterialLayerSet, ART::ProgressCallback iProgress = NULL, void * iUserData = NULL ) const = 0
virtual RED_RCLoadIESFile ( RED::Vector< double > & oAttributes, const RED::String & iFile ) const = 0
virtual RED_RCLoadLightStaticShadowMaps ( RED::Vector< RED::Object * > & oShadowMaps, RED::Vector< int > & oLightIds, RED::Vector< int > & oInstances, unsigned int & oDataContext, const RED::String & iPath ) const = 0
virtual RED_RCLoadReflectionProbesMaps ( RED::Vector< RED::Object * > & oEnvironmentMapAtlas, RED::Vector< RED::Object * > & oEnvironmentMapAtlasIndex, unsigned int & oDataContext, const RED::String & iPath ) const = 0
virtual RED_RCSaveGeometry ( const RED::Object * iGeometry, const RED::String & iPath ) = 0
virtual RED_RCSaveGeometryGICache ( const RED::Vector< RED::Vector< RED::Object * > > & iGiCaches, const RED::Vector< RED::Vector< RED::Object * > > & iGiCachesBakedLights, const RED::Vector< RED::Object * > & iAoCaches, const RED::Vector< unsigned char > & iGroundAO, double iGroundBC[3], const RED::Vector3 & iSunDirection, const RED::String & iPath ) const = 0
virtual RED_RCSaveGeometryGroundFields ( const RED::Vector< float > & iElevation, const RED::Vector< float > & iElevationWeight, const RED::Vector< float > iDensity[4], int iResolution, double iElevationBC[3], const RED::String & iPath ) const = 0
virtual RED_RCSaveLightStaticShadowMaps ( const RED::Vector< RED::Object * > iShadowMaps, const RED::Vector< int > & iLightIds, const RED::Vector< int > & iInstances, const RED::String & iPath ) const = 0
virtual RED_RCSaveReflectionProbesMaps ( const RED::Vector< RED::Object * > & iEnvironmentMapAtlas, const RED::Vector< RED::Object * > & iEnvironmentMapAtlasIndex, const RED::String & iPath ) const = 0
virtual RED_RCSetGeometryPartVisible ( RED::Object * ioGeometry, RED::Object * iSceneRoot, RED::Object * iUpdatedShape, bool iVisible, bool iShadowVisible ) const = 0
virtual RED_RCStopGenerateGeometryGICache ( ) const = 0
virtual RED_RCStopGenerateGeometryVertexAO ( ) const = 0
virtual RED_RCUpdateGeometryPartTransform ( RED::Object * ioGeometry, RED::Object * iSceneRoot, RED::Object * iUpdatedShape ) const = 0

Public static functions:

static RED::CIDGetClassID ( )

Detailed description:

Resource management interface.

One asset manager instance must be created from the ART::Factory using the CID_ARTAssetManager identifier. The asset manager is a singleton. The asset manager handles all resources needed by the world to run the simulation.

Functions documentation

public virtual RED_RC ART::IAssetManager::BuildGeometryREDGraph(RED::Object *&oRoot,
RED::Map< RED::ShapePath, RED::Object * > &oMeshes,
RED::Vector< RED::Object * > &oLights,
RED::Map< int, RED::Object * > &oMaterials,
RED::Object *iGeometry
)const = 0

Creates a native RED graph from a geometry.

The returned graph contains RED meshes (RED::IMeshShape) and lights (RED::ILightShape) created from the geometry and new REDsdk realistic materials corresponding to iGeometry materials.

oMeshes maps the geometry parts (accessed via the initial shape path) to the associated new meshes.
oLights maps the geometry lights (given by their index) to the associated new lights.
oMaterials returns the list of materials (in values of the map) that were created for oRoot.

Parameters:

oRoot:returned root of the graph implementing the RED::ITransformShape interface.
oMeshes:returned list of meshes in the graph (RED::IMeshShape).
oLights:returned list of lights in the graph (RED::ILightShape).
oMaterials:returned list of materials in the graph (RED::IMaterial).
iGeometry:The geometry to create the graph from.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::ClearGeometryGICache(RED::Vector< RED::Vector< RED::Object * > > &iGiCaches,
RED::Vector< RED::Vector< RED::Object * > > &iGiCachesBakedLights,
RED::Vector< RED::Object * > &iAoCaches
)const = 0

Clears loaded geometry GI caches.

This method can be used as an helper to release all GI caches retrieved using RED::IAssetManager::LoadGeometryGICache. RED::Vector objects get cleared by the method too.

Parameters:

iGiCaches:List of GI cache objects for the sun illumination directions.
iGiCachesBakedLights:List of GI cache objects for the baked lights.
iAoCaches:List of GI cache objects containing AO data.

Returns:

RED_OK if the operation has succeeded,
Other RED_RCs from the REDsdk API can be returned.
public virtual RED_RC ART::IAssetManager::ClearGeometrySourceFile(RED::Object *iRoot,
const RED::Vector< unsigned int > &iContext
)const = 0

Clears the original source data previously loaded.

Clears all data loaded using RED::IAssetManager::LoadGeometrySourceFile.

Parameters:

iRoot:Root shape to be released by the call.
iContext:List of loaded data contexts in REDsdk, that are released by the call.

Returns:

RED_OK if the method has succeeded,
Other RED_RCs from the REDdsk API.
public virtual RED_RC ART::IAssetManager::ClearGeometrySourceFileImages(const RED::Vector< unsigned int > &iContext) const = 0

Clears all images loaded from an original source data previously loaded.

These images loaded may not be needed after the creation of a geometry and can be released using this method.

Parameters:

iContext:List of loaded data contexts in REDsdk. All images linked to these contexts are destroyed.

Returns:

RED_OK if the method has succeeded,
Other RED_RCs from the REDdsk API.
public virtual RED_RC ART::IAssetManager::ClearGeometrySourceFileMaterials(const RED::Vector< unsigned int > &iContext) const = 0

Clears all materials loaded from an original source data previously loaded.

These materials loaded may not be needed after the creation of a geometry and can be released using this method.

Parameters:

iContext:List of loaded data contexts in REDsdk. All materials linked to these contexts are destroyed.

Returns:

RED_OK if the method has succeeded,
Other RED_RCs from the REDdsk API.
public virtual RED_RC ART::IAssetManager::ComputeShapePaths(RED::Vector< RED::ShapePath > &oShapePaths,
RED::Object *iSceneRoot,
RED::Object *iShape,
booliUpward = true,
booliDownward = true,
booliIncludeShape = true
)const = 0

Computes all the shape paths containing the shape in a scene graph.

Parameters:

oShapePaths:returned list of shape paths.
iSceneRoot:source root of the scene containing the shape.
iShape:RED::ITransformShape whose matrix has been updated.
iUpward:true include all the parent shapes of iShape in the paths list.
iDownward:true to include all the children shapes of iShape in the paths list.
iIncludeShape:true to include iShape in the paths list.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::ConvertGeometrySourceAxis(RED::Object *&oRootZUp,
RED::Object *iRoot,
const RED::Matrix &iConvert
)const = 0

Converts an existing source graph to set its axis system for a correct geometry setup.

Geometries in ART must use a right handed axis system and have a vertical direction set to +Z. This method just adds a transform shape set with the iConvert matrix on top of iRoot. The new root iRootZUp is returned instead and can be used for all geometry API methods.

Parameters:

oRootZUp:Top node created by the method that has iRoot as child and iConvert as transform.
iRoot:Source root to modify.
iConvert:The transformation matrix to set.

Returns:

RED_OK if the method has succeeded,
RED_BAD_PARAM if iRoot is invalid,
Other RED_RCs from the REDsdk API.
public virtual RED_RC ART::IAssetManager::CreateAtlas(RED::Object *&oAtlas,
const RED::Color &iColor
) = 0

Creates an empty flat atlas.

This helper method builds an Earth flat atlas with the specified soil color in iColor. All internal atlas parameters are those of the Earth. The created atlas must be then set as a planetary atlas using ART::IPlanet::SetAtlas. It must be released using ART::IAssetManager::DeleteAtlas.

Parameters:

oAtlas:The created atlas object.
iColor:The atlas creation color.

Returns:

RED_OK if the method has succeeded,
RED_ALLOC_FAILURE if a memory allocation error has occurred,
RED_FAIL otherwise.
public virtual RED_RC ART::IAssetManager::CreateGeometry(RED::Object *&oGeometry,
RED::Object *iSceneRoot,
const RED::LayerSet &iMaterialLayerSet,
const RED::Vector< RED::String > &iExcludedNames,
RED::Map< unsigned int, RED::String > &ioIDToNames,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
) = 0

Creates a geometry from a RED::ITransformShape root.

The loaded geometry is the property of the caller and must be deleted using ART::AssetManager::DeleteGeometry. The loaded geometry does not contain any shape whose name is in iExcludedNames. Names of the objects must be provided in the ioIDToNames map.

All the material images from the scene must have their properties set accordingly to the local pixel storage. If the local pixels are not null (RED::IImage2D::GetLocalPixels), then the local properties must be set (RED::IImage::SetLocalWrapModes for instance).

See Building a geometry - part 1 - Loading a source scene.

Parameters:

oGeometry:returned object implementing the ART::IGeometry interface.
iSceneRoot:root of the input graph as RED::ITransformShape.
iMaterialLayerSet:material layerset to get material parameters from.
iExcludedNames:Remove all objects whose names match any entry in iExcludedNames from the result.
ioIDToNames:Caller supplied map returned filled with objects ID associated to names.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::CreateGeometryInstance(RED::Object *&oInstance,
RED::Object *iGeometry
)const = 0

Creates an instance of the provided geometry.

Both the provided iGeometry and the returned oInstance geometry copy will share the same data.

Parameters:

oInstance:returned ART::IGeometry instance.
iGeometry:geometry to duplicate.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,

Deletes an atlas created with ART::IAssetManager::CreateAtlas.

Parameters:

iAtlas:The atlas address destroyed by the method.

Returns:

RED_OK if the method has succeeded,
RED_ALLOC_FAILURE if a memory error has occurred.
public virtual RED_RC ART::IAssetManager::DeleteAtlas(unsigned intiContext) = 0

Deletes an atlas loaded with ART::IAssetManager::LoadAtlas.

Parameters:

iContext:Data context provided at the loading time.

Returns:

RED_OK if the method has succeeded,
RED_FAIL if the .red file is not a valid atlas file,
Other file access, read RED_RC error codes from the REDsdk API.

Deletes a geometry.

If the geometry belongs to a planet, this method removes it from the planet before the deletion. In this case, the geometry is not destroyed immediately but during the next call to ART::World::Update.

Parameters:

iGeometry:geometry to destroy.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::DeleteLightStaticShadowMaps(const RED::Vector< RED::Object * > &iShadowMaps) const = 0

Deletes one or more light static shadow maps from the resource manager.

This method must be called to delete the static shadow maps created using the resource manager. Using ART::AssetManager::GenerateLightStaticShadowMaps for instance. Images loaded with the data manager must be deleted through the data manager context.

Parameters:

iShadowMaps:list of shadow maps as RED::IImage2D.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::DeleteLightStaticShadowMaps(unsigned intiDataContext) const = 0

Deletes one or more light static shadow maps from the data manager.

This method must be called to delete the static shadow maps created using the data manager. Using ART::AssetManager::LoadLightStaticShadowMaps for instance.

Parameters:

iDataContext:data context containing the shadow maps to delete.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::DeleteReflectionProbesMaps(RED::Object *iEnvironmentMapAtlas,
RED::Object *iEnvironmentMapAtlasIndex
)const = 0

Deletes a reflection probe environment map atlas and its index from the resource manager.

This method must be called to delete the environment maps created using the resource manager. Using ART::AssetManager::GenerateReflectionProbeMaps for instance. Images loaded with the data manager must be deleted through the data manager context.

Parameters:

iEnvironmentMapAtlas:environment map atlas to delete.
iEnvironmentMapAtlasIndex:environment map atlas index to delete.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::DeleteReflectionProbesMaps(unsigned intiDataContext) const = 0

Deletes a reflection probe environment map atlas and its index from the data manager.

This method must be called to delete the environment maps created using the data manager. Using ART::AssetManager::LoadReflectionProbesMaps for instance.

Parameters:

iDataContext:data context containing the reflection probes to delete.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GenerateGeometryGICache(RED::Vector< RED::Vector< RED::Object * > > &oGiCaches,
RED::Vector< RED::Vector< RED::Object * > > &oGiCachesBakedLights,
RED::Vector< RED::Object * > &oAoCaches,
RED::Vector< unsigned char > &oGroundAO,
doubleoGroundBC[3],
RED::Object *iRoot,
const RED::LayerSet &iMaterialLayerSet,
const RED::Vector< RED::Vector3 > &iFilterPosIndoor,
const RED::Vector< RED::Vector3 > &iFilterPosOutdoor,
const RED::Vector< RED::Object * > &iSkyPortals,
const RED::Vector< RED::Object * > &iGISplitters,
const RED::Vector< unsigned int > &iBakedLightsFull,
const RED::Vector< unsigned int > &iBakedLightsIndirect,
const RED::Vector< unsigned int > &iBakedLightsShared,
booliHasGround,
const RED::Color &iGroundColor,
doubleiGroundAltitude,
intiGICacheSamplesCount,
intiLightsSamplingRate,
intiGICacheHemiSamplingRate,
intiGICacheInterpSamplesCount,
intiGIEstimatorSamplingRate,
intiGIEstimatorInterpSamplesCount,
doubleiGICacheMergeBorderShrink,
booliDynamicSun,
const RED::Vector3 &iSunDirection,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Generates GI and AO data for a geometry.

The generated data can be set to the geometry with ART::IGeometry::SetGICache and ART::IGeometry::SetGroundAOCache or can be saved with ART::IAssetManager::SaveGeometryGICache.

Images used by materials in the source scene graph are expected to have their contents properly filled on the CPU and/or GPU (e.g. RED::IImage2D::SetPixels has been called).

See Building a geometry - part 2 - Setting up a GI cache.

Please make sure that the world does not get updated while running this method.

Parameters:

oGiCaches:Returned list of GI cache objects for the sun illumination directions.
oGiCachesBakedLights:Returned list of GI cache objects for the baked lights.
oAoCaches:Returned list of GI cache objects containing AO data.
oGroundAO:returned AO data for the ground under the geometry.
oGroundBC:returned bounding circle data for the ground AO [center.x, center.y, radius].
iRoot:Root shape of the geometry source. May be temporarily modified by the call. Note that this shape can't be the root shape of a RED::IViewpoint, otherwise the method will return RED_WORKFLOW_ERROR.
iMaterialLayerSet:The layerset to apply to scene materials to properly read the scene.
iFilterPosIndoor:List of indoor filtering positions.
iFilterPosOutdoor:List of outdoor filtering positions.
iSkyPortals:List of sky portals shapes to consider. All shapes in this list must be valid shapes.
iGISplitters:List of scene objects that can be used to block GI samples from viewing some filtering positions. For instance, the glass shape of a window can be declared as a GI splitter to prevent outdoor filtering positions to reach samples that are indoor and vice-versa. All shapes in this list must be valid shapes.
iBakedLightsFull:List of the light names that are fully baked.
iBakedLightsIndirect:List of the light names that are baked on indirect lighting.
iBakedLightsShared:List of the light names that - if baked - will store their baking in the shared light GI cache.
iHasGround:When true, add a ground when generating the indirect lighting on the geometry.
iGroundColor:ground color used when generating the indirect lighting on the geometry.
iGroundAltitude:altitude of the ground used when generating indirect lighting on the geometry in meters. Vertical is +Z.
iGICacheSamplesCount:see RED::OPTIONS_RAY_WORLD_CACHE_SAMPLES_COUNT.
iLightsSamplingRate:see RED::OPTIONS_RAY_LIGHTS_SAMPLING_RATE.
iGICacheHemiSamplingRate:see RED::OPTIONS_RAY_GI_CACHE_HEMI_SAMPLING_RATE.
iGICacheInterpSamplesCount:see RED::OPTIONS_RAY_GI_CACHE_INTERP_SAMPLES_COUNT.
iGIEstimatorSamplingRate:see RED::OPTIONS_RAY_GI_ESTIMATOR_SAMPLING_RATE.
iGIEstimatorInterpSamplesCount:see RED::OPTIONS_RAY_GI_ESTIMATOR_INTERP_SAMPLES_COUNT.
iGICacheMergeBorderShrink:border shrink used when merging indoor and outdoor GI caches. In [ 0.0, 1.0 ]. Samples closer to walls and to occluding objects have their size shrinked using this value.
iDynamicSun:true to generate GI caches for multiple sun positions. False for a single sun position.
iSunDirection:direction of the sun if iDynamicSun is false.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
RED_WORKFLOW_ERROR if 'iRoot' is a viewpoint's root shape,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GenerateGeometryGroundFields(RED::Vector< float > &oElevation,
RED::Vector< float > &oElevationWeight,
RED::Vector< float >oDensity[4],
double &oElevationMin,
double &oElevationMax,
doubleoElevationBC[3],
RED::Object *iRoot,
doubleiElevationFadeSize,
doubleiDensityFadeSize[4],
intiResolution,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Generates elevation and density fields for a geometry.

The generated data can be set to the geometry with ART::IGeometry::SetGroundFields or saved with ART::IAssetManager::SaveGeometryGroundFields.

See Building a geometry - part 5 - Defining ground elevation.

Please make sure that the world does not get updated while running this method.

Parameters:

oElevation:returned map of iResolution x iResolution containing the elevation.
oElevationWeight:returned map of iResolution x iResolution containing the elevation weights [0;1].
oDensity:returned map of iResolution x iResolution containing the densities [0;1] for each prism type.
oElevationMin:returned minimum elevation value.
oElevationMax:returned maximum elevation value.
oElevationBC:returned bounding circle of the elevation maps [center.x, center.y, radius].
iRoot:Root of the scene graph of the geometry source.
iElevationFadeSize:fade size for the elevation weights (source units).
iDensityFadeSize:fade sizes for the four densities (source units).
iResolution:size of the maps to generate.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GenerateGeometryVertexAO(RED::Vector< float > &oVertexAO,
const RED::Object *iGeometry,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Generates vertex ambient occlusion for a geometry.

oVertexAO size = geometry opaque vertex count + geometry transparent vertex count.

The generated data can be set to the geometry with ART::IGeometry::SetVertexAO.

Please make sure that the world does not get updated while running this method.

Parameters:

oVertexAO:returned list of ambient occlusion values for each vertex of the geometry.
iGeometry:geometry to build the AO for.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GenerateGIFilteringPositions(RED::Vector< RED::Vector3 > &ioFilterPos,
const RED::Vector3 &iReference,
booliIndoor,
const RED::Object *iSceneRoot,
doubleiSpacing,
doubleiGroundAltitude,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
) = 0

Generates GI filtering positions for the specified source scene.

This method generates a list of filtering positions that can be used afterwards for the generation of a GI cache. These filtering positions are either computed for indoor rendering or for outdoor rendering.

The method will start from the specified iReference position and explore the iSceneRoot to generate relevant positions that can be viewed and reached out from iReference. For instance, if iReference is inside a closed box, all filtering positions will be generated inside that box, since it won't be possible to reach any point outside of this box starting from iReference. Transparent surfaces can be crossed.

All calculations are performed in the coordinate system of geometries contained by iSceneRoot.

A model whose space is not properly split in indoor and outdoor regions should only generate one set of indoor filtering positions for the entire model. The partition between indoor and outdoor areas of the model can be achieved using any geometry, including portals, window glasses or any other element. Its important that these geometries do split the model in two parts, otherwise filtering positions can leak in another area and the resulting GI caches of these areas will incorrectly overlap when merged.

Filtering positions can be preserved and don't need to be recalculated unless the model geometry has changed.

Filtering positions are spread evenly on a grid using the iSpacing distance between them. The number of filtering positions that can be spread out is limited internally to avoid overflowing the GI cache generation afterwards.

Please make sure that the world does not get updated while running this method.

Parameters:

ioFilterPos:The generated list of filtering positions which is appened at the end of ioFilterPos.
iReference:The reference position that must be in the considered domain.
iIndoor:If true, we compute indoor positions, if false, we compute outdoor positions.
iSceneRoot:The root of the scene to process.
iSpacing:Spacing between filtering positions in scene units.
iGroundAltitude:Altitude of the ground surrounding the geometry in meters. No filtering positions will be generated below the ground. Vertical axis is +Z.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the method has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk API are possible.
public virtual RED_RC ART::IAssetManager::GenerateLightStaticShadowMaps(RED::Vector< RED::Object * > &oShadowMaps,
RED::Object *iLight,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Generates light shadow maps for a static use.

The generated data can be set to a light with ART::ILight::SetStaticShadowMap or saved with ART::IAssetManager::SaveLightStaticShadowMaps.

Please make sure that the world does not get updated while running this method.

Parameters:

oShadowMaps:returned list of shadow maps for each of the light instance.
iLight:light for which the maps are generated.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GenerateReflectionProbeMaps(RED::Object *&oEnvironmentMapAtlas,
RED::Object *&oEnvironmentMapAtlasIndex,
const RED::Object *iReflectionProbe,
intiCubeSize,
booliDynamicSun,
const RED::Vector3 &iSunDirection,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Generates reflection probe environment maps from a probe parameters.

The generated data can be set to a reflection probe with ART::IReflectionProbe::SetEnvironmentMap or saved with ART::IAssetManager::SaveReflectionProbesMaps.

See Building a geometry - part 4 - Adding reflection probes.

Please make sure that the world does not get updated while running this method.

Parameters:

oEnvironmentMapAtlas:returned environment map atlas for multiple sun directions as RED::IImage2D.
oEnvironmentMapAtlasIndex:returned RED::IImage2D containing index data for the atlas.
iReflectionProbe:reflection for which the maps are generated.
iCubeSize:size of the cube map in pixels.
iDynamicSun:true to generate environment maps for multiple sun positions. False for a single sun position.
iSunDirection:direction of the sun if iDynamicSun is false.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::GetMaterialLayerSets(RED::Vector< RED::LayerSet > &oLayerSets,
const RED::Vector< unsigned int > &iContext
)const = 0

Gets all the RED::LayerSet used by the materials in the RED::IDataManager context iContext.

Parameters:

oLayerSets:returned list of material RED::LayerSet.
iContext:Data manager context where to search the layer sets.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::LoadAtlas(RED::Object *&oAtlas,
RED::Vector< RED::Object * > &oCameras,
unsigned int &oContext,
const RED::String &iName,
ART::ProgressCallbackiProgress = NULL,
void *iParam = NULL
) = 0

Loads an atlas.

This method loads the specified atlas file identified by 'iName'. The loaded atlas must then be set as a planetary atlas using ART::IPlanet::SetAtlas. The atlas is managed by the ART::IAssetManager.

Parameters:

oAtlas:The loaded atlas object. NULL if nothing was loaded.
oCameras:List of cameras associated to the atlas. These implement the ART::ICamera interface.
oContext:Data context of the loaded atlas. Needed for releasing the data.
iName:Atlas complete filename. Must be a .red file exported by the REDart editor.
iProgresspointer to an optional progress callback.
iParamoptional parameter to the progress callback.

Returns:

RED_OK if the method has succeeded,
RED_FAIL if the .red file is not a valid atlas file,
Other file access, read RED_RC error codes from the REDsdk API.
public virtual RED_RC ART::IAssetManager::LoadEnvironment(RED::Object *&oEnvironment,
RED::Matrix &oPosition,
RED::Matrix &oPlanetAxisSystemForSun,
const RED::String &iName
) = 0

Loads an environment.

This method loads an environment map that can be used instead of an atlas. The loaded environment is a classic latitude longitude HDR map image. The method also returns the axis system on the planet that was used to create the map (so in Planet Coordinate System - PCS) as well as the planetary axis system (in World Coordinate System - WCS) that was used to create the map, so that the sun can be properly repositioned using ART::IPlanet::OverrideAxisSystem.

The loaded environment map is managed by the ART::IAssetManager.

Parameters:

oEnvironment:The loaded environment map. NULL if nothing was loaded.
oPosition:Environment axis system used for the generation of the environment in PCS.
oPlanetAxisSystemForSun:The planetary axis system used for the sun position at the generation of the environment in WCS.
iName:Environment complete filename. Must be a .red file exported by the asset editor.

Returns:

RED_OK if the method has succeeded,
Other RED_RC file reading related error codes,
RED_FAIL if the provided iName is not an editor generated environment map file.
public virtual RED_RC ART::IAssetManager::LoadGeometry(RED::Object *&oGeometry,
const RED::String &iPath,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
) = 0

Loads a .red file containing a ready-to-use geometry.

This method must be called from the main thread or from the REDsdk rendering thread. The loaded geometry is the property of the caller and must be deleted. The loaded geometry may contain all the features contained by a geometry: meshes, reflection probes, GI caches, lights,...

See Importing geometries.

Parameters:

oGeometry:The created and returned object implementing the ART::IGeometry interface.
iPath:The full path to the .red file.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
RED_WORKFLOW_ERROR if the file was not created using ART::IAssetManager::SaveGeometry,
RED_FAIL if the loaded .red file does not have the correct author or does not contain the correct geometry object,
Other RED_RC error codes from the REDsdk file management API.
public virtual RED_RC ART::IAssetManager::LoadGeometryGICache(RED::Vector< RED::Vector< RED::Object * > > &oGiCaches,
RED::Vector< RED::Vector< RED::Object * > > &oGiCachesBakedLights,
RED::Vector< RED::Object * > &oAoCaches,
RED::Vector< unsigned char > &oGroundAO,
doubleoGroundBC[3],
RED::Vector3 &oSunDirection,
const RED::String &iPath,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Loads a .red file containing global illumination and ambient occlusion data of a geometry.

The loaded data can be set to the geometry with ART::IGeometry::SetGICache and ART::IGeometry::SetGroundAOCache.

See Building a geometry - part 2 - Setting up a GI cache.

Please make sure that the world does not get updated while running this method.

Parameters:

oGiCaches:Returned list of GI cache objects for the sun illumination directions.
oGiCachesBakedLights:Returned list of GI cache objects for the baked lights.
oAoCaches:Returned list of GI cache objects containing AO data.
oGroundAO:returned ground ambient occlusion. Copy of the loaded array, must be released by the caller.
oGroundBC:returned bounding circle used to calibrate the ground ambient occlusion.
oSunDirection:returned sun direction used in the case of a static cache.
iPath:full path to the .red file.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
public virtual RED_RC ART::IAssetManager::LoadGeometryGroundFields(RED::Vector< float > &oElevation,
RED::Vector< float > &oElevationWeight,
RED::Vector< float >oDensity[4],
int &oResolution,
doubleoElevationBC[3],
const RED::String &iPath
)const = 0

Loads the binary file containing the elevation and density fields of a geometry.

The loaded data can be set to the geometry with ART::IGeometry::SetGroundFields.

See Building a geometry - part 5 - Defining ground elevation.

Parameters:

oElevation:returned map of iResolution x iResolution containing the elevation.
oElevationWeight:returned map of iResolution x iResolution containing the elevation weights [0;1].
oDensity:returned map of iResolution x iResolution containing the densities [0;1] for each prism type.
oResolution:returned size of the maps.
oElevationBC:returned bounding circle of the elevation maps [center.x, center.y, radius].
iPath:path to the binary file to load.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::LoadGeometrySourceFile(RED::Object *&oRoot,
RED::Vector< unsigned int > &oContext,
RED::Map< unsigned int, RED::String > &oId2Names,
const RED::String &iFilePath,
const RED::Matrix &iConvert,
const RED::LayerSet &iMaterialLayerSet,
booliLoadTextures = true,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Load the original source data of a geometry from a .red file.

Use ART::IAssetManager::ClearGeometrySourceFile to discard all data created by this method.

The loaded scene is attached to a transform shape that holds the iConvert transformation matrix. The iConvert matrix ensures that the returned scene graph is using a right handed axis system and has a vertical direction set to +Z.

All images that are loaded by the call store their data into their local pixel storage. They're not uploaded on the GPU after the method.

Parameters:

oRoot:Root shape of the loaded source data. Must be released after use.
oContext:List of data manager contexts storing the loaded data. Must be released after use.
oId2Names:List of ID to names conversions extracted from the loaded .red file.
iFilePath:Complete filepath to load.
iConvert:Axis system and scaling conversion matrix to be applied to the geometry.
iMaterialLayerSet:The layerset to use for the loading of the file and access to materials.
iLoadTextures:Set this flag to false to skip the loading of images contained by the source file. This flag is ignored for .RED files loading and applies only to .FBX files.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the method has succeeded,
Any RED_RC from the file management API in case of an inacessible, unreadable file,
Other RED_RCs from the underlying REDsdk API.
public virtual RED_RC ART::IAssetManager::LoadGeometrySourceFile(RED::Object *&oRoot,
RED::Vector< unsigned int > &oContext,
RED::Map< unsigned int, RED::String > &oId2Names,
RED::IStream &iStream,
const RED::Matrix &iConvert,
const RED::LayerSet &iMaterialLayerSet,
ART::ProgressCallbackiProgress = NULL,
void *iUserData = NULL
)const = 0

Load the original source data of a geometry from a memory stream.

Use ART::IAssetManager::ClearGeometryOriginalFile to discard all data created by this method.

The loaded scene is attached to a transform shape that holds the iConvert transformation matrix. The iConvert matrix ensures that the returned scene graph is using a right handed axis system and has a vertical direction set to +Z.

All images that are loaded by the call store their data into their local pixel storage. They're not uploaded on the GPU after the method.

Parameters:

oRoot:Root shape of the loaded source data. Must be released after use.
oContext:List of data manager contexts storing the loaded data. Must be released after use.
oId2Names:List of ID to names conversions extracted from the loaded .red file.
iStream:Memory stream to load.
iConvert:Axis system and scaling conversion matrix to be applied to the geometry.
iMaterialLayerSet:The layerset to use for the loading of the file and access to materials.
iProgress:progress callback.
iUserData:progress callback user data.

Returns:

RED_OK if the method has succeeded,
Any RED_RC from the file management API in case of an inacessible, unreadable file,
Other RED_RCs from the underlying REDsdk API.
public virtual RED_RC ART::IAssetManager::LoadIESFile(RED::Vector< double > &oAttributes,
const RED::String &iFile
)const = 0

Loads the IES file and gets its attributes.

Parameters:

oAttributes:returned index of the first direction.
iFile:file path of the file to load.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::LoadLightStaticShadowMaps(RED::Vector< RED::Object * > &oShadowMaps,
RED::Vector< int > &oLightIds,
RED::Vector< int > &oInstances,
unsigned int &oDataContext,
const RED::String &iPath
)const = 0

Loads a .red file containing multiple light static shadow maps.

The loaded data can be set to a light with ART::ILight::SetStaticShadowMap.

Parameters:

oShadowMaps:returned list of shadow maps as RED::IImage2D.
oLightIds:returned list of light IDs.
oInstances:returned list of light instance number.
oDataContext:returned data context id.
iPath:path of the .red file to load.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::LoadReflectionProbesMaps(RED::Vector< RED::Object * > &oEnvironmentMapAtlas,
RED::Vector< RED::Object * > &oEnvironmentMapAtlasIndex,
unsigned int &oDataContext,
const RED::String &iPath
)const = 0

Loads a .red file containing multiple reflection probe environment maps.

The loaded data can be set to a reflection probe with ART::IReflectionProbe::SetEnvironmentMap.

It is the user responsability to release the data context with RED::IDataManager::ReleaseContext once the environment maps are not used anymore.

See Building a geometry - part 4 - Adding reflection probes.

Parameters:

oEnvironmentMapAtlas:returned list of environment map atlases for multiple sun directions as RED::IImage2D.
oEnvironmentMapAtlasIndex:returned list of RED::IImage2D containing index data for the atlases.
oDataContext:returned data context id.
iPath:path of the .red file to load.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::SaveGeometry(const RED::Object *iGeometry,
const RED::String &iPath
) = 0

Saves a .red file containing a ready-to-use geometry.

This method must be called from the main thread or from the REDsdk rendering thread. The saved geometry contains all the features contained by a geometry: meshes, reflection probes, GI caches, lights,...

See Importing geometries.

Parameters:

iGeometry:The saved geometry implementing the ART::IGeometry interface.
iPath:The full path to the .red file.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC error codes from the REDsdk file management API.
public virtual RED_RC ART::IAssetManager::SaveGeometryGICache(const RED::Vector< RED::Vector< RED::Object * > > &iGiCaches,
const RED::Vector< RED::Vector< RED::Object * > > &iGiCachesBakedLights,
const RED::Vector< RED::Object * > &iAoCaches,
const RED::Vector< unsigned char > &iGroundAO,
doubleiGroundBC[3],
const RED::Vector3 &iSunDirection,
const RED::String &iPath
)const = 0

Saves the .red file containing global illumination and ambient occlusion data of a geometry.

See Building a geometry - part 2 - Setting up a GI cache.

Parameters:

iGiCaches:List of GI cache objects for the sun illumination directions.
iGiCachesBakedLights:List of GI cache objects for the baked lights.
iAoCaches:List of GI cache objects containing the AO data.
iGroundAO:AO data of the ground under the geometry.
iGroundBC:Bounding circle data of the ground AO [center.x, center.y, radius].
iSunDirection:Sun direction in the case of a static GI cache.
iPath:Path where the .red file is saved.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::SaveGeometryGroundFields(const RED::Vector< float > &iElevation,
const RED::Vector< float > &iElevationWeight,
const RED::Vector< float >iDensity[4],
intiResolution,
doubleiElevationBC[3],
const RED::String &iPath
)const = 0

Saves a binary file containing the elevation and density fields of a geometry.

See Building a geometry - part 5 - Defining ground elevation.

Parameters:

iElevation:map of iResolution x iResolution containing the elevation.
iElevationWeight:map of iResolution x iResolution containing the elevation weights [0;1].
iDensity:map of iResolution x iResolution containing the densities [0;1] for each prism type.
iResolution:size of the maps.
iElevationBC:bounding circle of the elevation maps [center.x, center.y, radius].
iPath:path of the binary file to create.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::SaveLightStaticShadowMaps(const RED::Vector< RED::Object * >iShadowMaps,
const RED::Vector< int > &iLightIds,
const RED::Vector< int > &iInstances,
const RED::String &iPath
)const = 0

Saves a .red file containing multiple light static shadow maps.

Parameters:

iShadowMaps:list of light static shadow map to save as RED::IImage2D.
iLightIds:list of light IDs.
iInstances:list of light instance number.
iPath:path of the .red file to create.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::SaveReflectionProbesMaps(const RED::Vector< RED::Object * > &iEnvironmentMapAtlas,
const RED::Vector< RED::Object * > &iEnvironmentMapAtlasIndex,
const RED::String &iPath
)const = 0

Saves a .red file containing multiple reflection probe environment maps.

See Building a geometry - part 4 - Adding reflection probes.

Parameters:

iEnvironmentMapAtlas:list of environment map atlases to save as RED::IImage2D.
iEnvironmentMapAtlasIndex:list of atlas index map to save as RED::IImage2D.
iPath:path of the .red file to create.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::SetGeometryPartVisible(RED::Object *ioGeometry,
RED::Object *iSceneRoot,
RED::Object *iUpdatedShape,
booliVisible,
booliShadowVisible
)const = 0

Sets a geometry part visible or not.

Every shape in the graph under the updated node will be affected by the visibility set.

Parameters:

ioGeometry:ART::IGeometry to update.
iSceneRoot:source root of the scene containing the shape to update.
iUpdatedShape:RED::ITransformShape whose matrix has been updated.
iVisible:true to set the geometry part visible, false otherwise.
iShadowVisible:true to set the geometry part shadow visible, false otherwise.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.

Stops the generation of the GI and AO data for a geometry.

The ART::IAssetManager::GenerateGeometryGICache method may take time. It can be stopped from another thread by calling ART::StopGenerateGeometryGICache().

Calling this method immediately stops the GI cache calculation. ART::IAssetManager::GenerateGeometryGICache returns RED_INTERRUPT.

Returns:

RED_OK if the operation has succeeded,
Other RED_RC values from the REDsdk material setup API.

Stops the generation of the vertex AO data for a geometry.

The ART::IAssetManager::GenerateGeometryVertexAO method may take time. It can be stopped from another thread by calling ART::StopGenerateGeometryVertexAO().

Calling this method immediately stops the vertex AO calculation. ART::IAssetManager::GenerateGeometryVertexAO returns RED_INTERRUPT.

Returns:

RED_OK if the operation has succeeded,
Other RED_RC values from the REDsdk material setup API.
public virtual RED_RC ART::IAssetManager::UpdateGeometryPartTransform(RED::Object *ioGeometry,
RED::Object *iSceneRoot,
RED::Object *iUpdatedShape
)const = 0

Updates a geometry part transform.

Modifies the ART::IGeometry to take into account a transform update in the source scene graph.

Parameters:

ioGeometry:ART::IGeometry to update.
iSceneRoot:source root of the scene containing the shape to update.
iUpdatedShape:RED::ITransformShape whose matrix has been updated.

Returns:

RED_OK if the operation has succeeded,
RED_BAD_PARAM if the method has received an invalid parameter,
RED_ALLOC_FAILURE if a memory allocation has failed,
Other RED_RC values from the REDsdk material setup API.