Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
ModuleRenderScene Class Reference
Inheritance diagram for ModuleRenderScene:
ModuleProjectItem ModuleObject OfModule ResourceUser EventObject CoreCustomData CoreBaseObject CoreBaseType

Public Types

enum  ObjectType {
  OBJECT_TYPE_VISIBILITY = 0,
  OBJECT_TYPE_SHADOWS,
  OBJECT_TYPE_RAYTRACING,
  OBJECT_TYPE_GI,
  OBJECT_TYPE_MATTE,
  OBJECT_TYPE_COUNT
}
 

Public Member Functions

virtual size_t get_memory_size () const override
 
ModuleGroupget_objects_group (const ObjectType &type) const
 
ModuleGroupget_visibility_objects_group () const
 
ModuleGroupget_shadow_objects_group () const
 
ModuleGroupget_raytracing_objects_group () const
 
ModuleGroupget_global_illumination_objects_group () const
 
ModuleGroupget_matte_objects_group () const
 
ModuleGroupget_lights_group () const
 
const CoreArray
< ModuleSceneObject * > & 
get_objects (const ObjectType &type) const
 Return the list of objects in a group.
 
void get_objects (CoreArray< OfObjectHandle > &objects, const ObjectType &type, const OfContext *working_context=0) const
 Return the list of object handles in a group.
 
const CoreArray
< ModuleSceneObject * > & 
get_visibility_objects () const
 Return the list of visible objects.
 
const CoreArray
< ModuleSceneObject * > & 
get_shadow_objects () const
 Return the list of occluder objects for shadows.
 
const CoreArray
< ModuleSceneObject * > & 
get_raytracing_objects () const
 Return the list of objects that are visible in relfections and refractions.
 
const CoreArray
< ModuleSceneObject * > & 
get_global_illumination_objects () const
 Return the list of objects that are visible by global illumination.
 
const CoreSet
< ModuleSceneObject * > & 
get_matte_objects () const
 Return the list of matte objects.
 
MatteOverrideget_matte_override () const
 Return the matte override.
 
const CoreArray< ModuleLight * > & get_lights () const
 Return the list of lights.
 
void get_lights (CoreArray< OfObjectHandle > &lights, const OfContext *working_context=0) const
 Return the list of object handles in the light group.
 
ModuleLightingLayer * get_lighting_layer () const
 Return the lighting layer. May be null.
 
ModuleMaterialget_override_material () const
 Return the override material. May be null if none is set.
 
ModuleShadingLayerget_shading_layer () const
 Return the shading layer. May be null.
 
const CoreBasicArray
< ModuleLpe * > & 
get_lpes () const
 Return the list of LPEs that are computed.
 
const CoreBasicArray< LpeDesc > & get_lpe_descs () const
 
const CoreBasicArray< short > & get_available_aovs () const
 
const CoreBasicArray< short > & get_selected_aovs () const
 Returns the list of AOV groups that have been enabled in the render scene.
 
const CoreBasicArray< short > & get_computed_aovs () const
 Returns the list of AOV groups that will be computed.
 
const CoreBasicArray
< OfChannelManager::Channel > & 
get_selected_aovs_channels () const
 Returns the list of aovs channels that will be written to the image node.
 
const CoreBasicArray
< OfChannelManager::Channel > & 
get_computed_aovs_channels () const
 Returns the list of aovs channels that will be computed.
 
unsigned int get_width () const
 
unsigned int get_height () const
 
const float & get_display_aspect_ratio () const
 
const float & get_pixel_aspect_ratio () const
 
const float & get_sampling_quality () const
 
const double & get_near_clip () const
 
const double & get_far_clip () const
 
const bool & has_limited_region () const
 
GMathVec4f get_limited_region () const
 
GMathVec4i get_overscan () const
 
const CoreBasicArray
< ModuleSubPixelFilter * > & 
get_sub_pixel_filters () const
 
OfObjectHandle get_camera () const
 
OfObjectHandle get_renderer () const
 
CoreArray< ModuleAovStore * > & get_global_aov_store () const
 
const CoreBasicArray
< AovVarianceChannel > & 
get_aovs_variance_channels () const
 

Protected Member Functions

virtual void module_constructor (OfObject &object) override
 
virtual void on_attribute_change (const OfAttr &attr, int &dirtiness, const int &dirtiness_flags) override
 
void register_component_implementation ()
 

Additional Inherited Members

- Static Public Member Functions inherited from ModuleObject
static ResourceID declare_resource (const char *tag)
 
static ResourceID declare_resource (const CoreString &tag)
 
static bool declare_resource (ResourceID id, const char *tag)
 
static bool declare_resource (ResourceID id, const CoreString &tag)
 
static ResourceID get_resource_id (const char *tag)
 
static ResourceID get_resource_id (const CoreString &tag)
 
static const char * get_resource_tag (ResourceID id)
 
static void clear_unused_resources (SysThreadManager &thread_manager, const CoreBasicArray< OfObject * > &objects)
 
- Static Public Attributes inherited from ModuleObject
static constexpr unsigned int null_variation = 0
 Key of the null resource variation.
 

Member Function Documentation

void ModuleRenderScene::get_lights ( CoreArray< OfObjectHandle > &  lights,
const OfContext working_context = 0 
) const

Return the list of object handles in the light group.

Parameters
[in]working_contextContext in which we want to consider the light objects
void ModuleRenderScene::get_objects ( CoreArray< OfObjectHandle > &  objects,
const ObjectType &  type,
const OfContext working_context = 0 
) const

Return the list of object handles in a group.

Parameters
[in]working_contextContext in which we want to consider the objects