Clarisse 5.0 SP10 SDK 5.0.5.10.0
Loading...
Searching...
No Matches
OfModule Class Referenceabstract

Inherits ResourceUser.

Inherited by ModuleObject, and OfEmptyModule.

Public Member Functions

OfObjectget_object () const
 
void set_object (OfObject &object)
 
virtual bool is_protected () const override
 
CoreString get_object_name () const
 
virtual size_t get_memory_size () const override
 
OfItemHandle get_traversal_item () const
 Get the "replacement" item of the current module object. Returns get_object() if no replacement item exists.
 
bool is_traversal () const
 
void set_shading_layer_values (const CoreBasicArray< OfObject * > &new_materials, const CoreBasicArray< OfObject * > &new_clip_maps, const CoreBasicArray< OfObject * > &new_displacements) const
 
OfAppget_application () const
 
virtual CoreBasicArray< OfObject * > get_inputs () const
 
bool is_kindof (const OfClass &object) const =delete
 
bool is_kindof (const CoreBaseObject &object) const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
- Public Member Functions inherited from ResourceUser
virtual void refresh ()
 
virtual void on_resource_update (const ResourceConnection &connection, ResourceData *data)
 
virtual bool is_protected () const =0
 
- Public Member Functions inherited from EventObject
 EventObject ()
 Constructor.
 
 EventObject (const EventObject &src)
 Copy Constructor.
 
virtual ~EventObject () override
 Destructor.
 
void connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event. More...
 
void connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events. More...
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 
bool disconnect_all (EventObject &sender)
 Disconnects from all objects sender was listening on. More...
 
void disconnect_all ()
 Disconnects from all objects we were listening on.
 
void remove_all_connection ()
 Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.
 
void raise_event (const CoreString &event_id) const
 sends an event More...
 
void raise_event (const EventInfo &event_info) const
 sends an event More...
 
bool is_connected (EventObject &sender, const CoreString &event_id, void *data)
 
void set_mute (const bool &mute)
 Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.
 
bool is_mute () const
 Returns if object is muted.
 
CoreArray< EventObject * > get_senders () const
 
unsigned int get_sender_count () const
 
unsigned int get_receiver_count () const
 
virtual size_t get_memory_size () const override
 
void connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event. More...
 
void connect (EventObject &sender, EventMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events. More...
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Disconnects this from an object for a specific event. More...
 
- Public Member Functions inherited from CoreCustomData
 CoreCustomData (const CoreCustomData &src)
 
void add_custom_data (void *key, const bool &data)
 
void add_custom_data (void *key, const int &data)
 
void add_custom_data (void *key, const unsigned int &data)
 
void add_custom_data (void *key, const char *data)
 
void add_custom_data (void *key, const CoreString &data)
 
void add_custom_data (void *key, const double &data)
 
void add_custom_data (void *key, void *data)
 
void remove_custom_data (void *key)
 
void remove_all_custom_data ()
 
void set_custom_data (void *key, const bool &data)
 
void set_custom_data (void *key, const int &data)
 
void set_custom_data (void *key, const unsigned int &data)
 
void set_custom_data (void *key, const double &data)
 
void set_custom_data (void *key, const char *data)
 
void set_custom_data (void *key, const CoreString &data)
 
void set_custom_data (void *key, void *data)
 
void get_custom_data (void *key, bool &data) const
 
void get_custom_data (void *key, int &data) const
 
void get_custom_data (void *key, unsigned int &data) const
 
void get_custom_data (void *key, double &data) const
 
void get_custom_data (void *key, CoreString &data) const
 
void get_custom_data (void *key, void *&data) const
 
virtual size_t get_memory_size () const override
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
virtual size_t get_memory_size () const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Protected Member Functions

virtual bool on_new_time (const double &new_time)=0
 
virtual void on_attribute_change (const OfAttr &attr, int &dirtiness, const int &dirtiness_flags)=0
 
virtual void on_send_event (const CoreString &event)=0
 
virtual void module_constructor (OfObject &object)=0
 
virtual void module_destructor ()=0
 
virtual void update_resource_keys ()=0
 
void protect_object (const bool &enable) const
 
virtual ResourceDataset_resource_data (const int &resource_id, ResourceData *data, const CoreString &key)=0
 
virtual ResourceDataset_resource_data (const int &resource_id, void *data_serial, const size_t &data_serial_size, const CoreString &key)
 
virtual unsigned int get_project_resource_count () const
 
virtual int get_project_resource_id (const unsigned int &index) const
 
virtual ResourceObject * get_project_resource (const unsigned int &index) const
 
virtual void get_attr_preset_hints (CoreArray< bool > &hints, const OfAttr &attr)=0
 
virtual void on_deserialize (const CoreVersion &serial_version, const ParserGroup &parser_group, const OfSerialOptions &serial_options)
 
virtual void register_variable (CoreBasicArray< OfObjectVariableValue * > &variables, CoreVector< unsigned int > &unknown_variable_indices)=0
 
virtual void unregister_variable (CoreBasicArray< OfObjectVariableValue * > &variables)=0
 
template<class T_Callbacks >
T_Callbacks * get_callbacks () const
 
void set_callbacks (OfClassCallbacks *clbk)
 

Friends

class OfObject
 
class OfContext
 
class OfTime
 
class OfContextEngine
 
class OfSceneAssemblyContextEngine
 

Additional Inherited Members

- Public Types inherited from EventObject
typedef void(* EventInfoFunction) (EventObject &, const EventInfo &, void *)
 event callback signature for free functions / static methods.
 
typedef void(EventObject::* EventInfoMethod) (EventObject &, const EventInfo &, void *)
 event callback signature for methods.
 
typedef void(* EventFunction) (EventObject &, const CoreString &, void *)
 
typedef void(EventObject::* EventMethod) (EventObject &, const CoreString &, void *)
 
- Static Public Member Functions inherited from EventObject
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event. More...
 
static void connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen any of its events. More...
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 
static void raise_event (EventObject &sender, const CoreString &event_id)
 Sends an event. More...
 
static void raise_event (EventObject &sender, const EventInfo &event_info)
 Sends an event. More...
 
static void connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event. More...
 
static void connect (EventObject &sender, EventFunction event_cb, void *data=0)
 Connects to an object to listen any of its events. More...
 
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Disconnects this from an object for a specific event. More...
 
- Static Public Member Functions inherited from CoreCustomData
static void * get_custom_data_key (const CoreString &key)
 
- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Member Function Documentation

◆ get_inputs()

CoreBasicArray< OfObject * > OfModule::get_inputs ( ) const
virtual

Returns the active input references The method can be overridden for every module defining a notion of active inputs. An active input is an input reference on which the module and all its ouputs depend of

◆ get_memory_size()

size_t OfModule::get_memory_size ( ) const
overridevirtual

Reimplemented from EventObject.

Reimplemented in ModuleImage, and ModuleLayer.

◆ is_kindof()

bool CoreBaseObject::is_kindof ( const CoreClassInfo cinfo) const
virtual

Reimplemented from CoreBaseObject.

◆ is_protected()

virtual bool OfModule::is_protected ( ) const
inlineoverridevirtual

Implements ResourceUser.

◆ module_constructor()

virtual void OfModule::module_constructor ( OfObject object)
protectedpure virtual

Implemented in ModuleImage.

◆ on_attribute_change()

virtual void OfModule::on_attribute_change ( const OfAttr attr,
int &  dirtiness,
const int &  dirtiness_flags 
)
protectedpure virtual

Implemented in ModuleImage.

◆ register_variable()

virtual void OfModule::register_variable ( CoreBasicArray< OfObjectVariableValue * > &  variables,
CoreVector< unsigned int > &  unknown_variable_indices 
)
protectedpure virtual

Implemented in ModuleObject.

◆ unregister_variable()

virtual void OfModule::unregister_variable ( CoreBasicArray< OfObjectVariableValue * > &  variables)
protectedpure virtual

Implemented in ModuleObject.

◆ update_resource_keys()

virtual void OfModule::update_resource_keys ( )
protectedpure virtual

Implemented in ModuleObject.