Clarisse 5.0 SP9 SDK  5.0.5.9.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Functions | Variables
Resource Variation API

Classes

class  ModuleObject::ResourceVariation
 Wrapper allowing to configure a resource variation. More...
 

Functions

bool ModuleObject::add_variation (unsigned int variation_key, ResourceUser *user)
 Add a new resource variation for the module. This method returns true if a new variation was created, false if it already existed. When the method returns true, you need to get the variation (get_variation), and configure it, otherwise you have nothing to do (the variation is already created and configured)
 
ResourceVariation ModuleObject::get_variation (unsigned int variation_key)
 Get a wrapper of the resource variation given its key.
 
void ModuleObject::remove_variation (unsigned int variation_key, ResourceUser *user)
 Remove the variation given its key.
 
void ModuleObject::clear_resource (unsigned int variation_key, ResourceID resource_id)
 If this resource ID exists in the given variation clear it, otherwise does nothing.
 
unsigned int ModuleObject::create_resource_hash (ResourceID resource_id) const
 Return a hash key of the current resource data for this module which can be used as a fingerprint.
 
unsigned int ModuleObject::create_resource_hash (unsigned int variation_key, ResourceID resource_id) const
 Return a hash key of the current resource data for this module which can be used as a fingerprint.
 
bool ModuleObject::is_resource_connection_for_id (ResourceID resource_id, const ResourceConnection &connection) const
 Return true if the given resource connection corresponds to the resource connection for this resource ID.
 
bool ModuleObject::is_resource_connection_for_id (unsigned int variation_key, ResourceID resource_id, const ResourceConnection &connection) const
 Return true if the given resource connection corresponds to the resource connection for this resource ID for this variation.
 

Variables

static constexpr unsigned int ModuleObject::null_variation = 0
 Key of the null resource variation.
 

Detailed Description

The class and methods below are a temporary API, it is going to change in the next major release, and it is not intended to be used

Function Documentation

bool ModuleObject::add_variation ( unsigned int  variation_key,
ResourceUser user 
)

Add a new resource variation for the module. This method returns true if a new variation was created, false if it already existed. When the method returns true, you need to get the variation (get_variation), and configure it, otherwise you have nothing to do (the variation is already created and configured)

Parameters
variation_keyThe key of the variation
unsigned int ModuleObject::create_resource_hash ( ResourceID  resource_id) const

Return a hash key of the current resource data for this module which can be used as a fingerprint.

Parameters
resource_idThe ID of the resource
unsigned int ModuleObject::create_resource_hash ( unsigned int  variation_key,
ResourceID  resource_id 
) const

Return a hash key of the current resource data for this module which can be used as a fingerprint.

Parameters
variation_keyThe variation in which to consider the resource for the hash key creation
resource_idThe ID of the resource