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 | Static Public Member Functions | Public Attributes | Friends | List of all members
OfAttrEvent Class Reference

Defines OfAttr related events. More...

Public Types

enum  Type {
  TYPE_SET_VALUE = 0,
  TYPE_ADD_VALUE,
  TYPE_REMOVE_VALUE,
  TYPE_MOVE_VALUE,
  TYPE_PERMUTE_VALUE,
  TYPE_REMOVE_ALL,
  TYPE_SET_COUNT,
  TYPE_TEXTURE,
  TYPE_OUTPUT,
  TYPE_ANIMATE,
  TYPE_LOCALIZE,
  TYPE_LOCKED,
  TYPE_SETTINGS,
  TYPE_OVERRIDEN,
  TYPE_READ_ONLY,
  TYPE_PRESET,
  TYPE_HIDDEN,
  TYPE_PROMOTE_ATTRIBUTE,
  TYPE_PROPAGATE,
  TYPE_UNKNOWN,
  TYPE_COUNT
}
 Specifies the type of event. More...
 
enum  Flag {
  FLAG_NONE = 0,
  FLAG_CHANGING = 1 << 0,
  FLAG_DRIVEN = 1 << 1,
  FLAG_DISABLED = 1 << 2,
  FLAG_OVERRIDEN = 1 << 3,
  FLAG_INSTANCE = 1 << 4,
  FLAG_VALUE_ONLY = 1 << 5,
  FLAG_REVERT = 1 << 6,
  FLAG_COUNT = 7
}
 

Public Member Functions

CoreString get_type_name () const
 
void add_dg_info (OfDirtinessEventInfo *info) const
 
CoreVector
< OfDirtinessEventInfo * > & 
get_dg_info (const CoreClassInfo &class_info) const
 
 OfAttrEvent (const OfAttrEvent &event)
 
 OfAttrEvent (const Type &type)
 
 OfAttrEvent (Type type_, const CoreBasicArray< unsigned int > &indices_, char flags_, void *requester_=nullptr)
 Helper constructor.
 
OfAttrEventoperator= (const OfAttrEvent &event)
 

Static Public Member Functions

static void * driven_requester ()
 
static CoreString get_type_name (const Type &type)
 

Public Attributes

Type type
 
CoreArray< unsigned int > indices
 
CoreArray< FCurveKeyIdkeys
 
unsigned int count
 
void * requester
 
char flags
 

Friends

class OfAttr
 

Detailed Description

Defines OfAttr related events.

Member Enumeration Documentation

Enumerator:
FLAG_NONE 

No info to complement the event's type.

FLAG_CHANGING 

The event is describing a change (on the current value page is modified).

FLAG_DRIVEN 

The attribute change is driven by a f-curve for example.

FLAG_DISABLED 

The attribute notifies usage of disabled items or itself disabled.

FLAG_OVERRIDEN 

The attribute notifies usage of override.

FLAG_INSTANCE 

The attribute is not local and the change is due to the source attribute changing.

FLAG_VALUE_ONLY 

On a TYPE_SET_VALUE, in addition with FLAG_DISABLED, it differenciates between attribute disabled and attribute value disabled. On a TYPE_LOCKED, differenciates between attribute locked and attribute value locked.

FLAG_REVERT 

On a TYPE_SET_VALUE, it will inform about restoring attribute process.

Specifies the type of event.

Enumerator:
TYPE_SET_VALUE 

An attribute value has been set.

TYPE_ADD_VALUE 

An attribute value has been added to the array of attribute values.

TYPE_REMOVE_VALUE 

An attribute value has been removed from the array of attribute values.

TYPE_MOVE_VALUE 

An attribute value has been moved (its index changed) within array of attribute values.

TYPE_PERMUTE_VALUE 

All attribute values has been moved due to a permutation of their respective index in the attribute value array.

TYPE_REMOVE_ALL 

All attribute values has been removed from the attribute value array setting the attribute value count to 0.

TYPE_SET_COUNT 

The number of attribute values has changed.

TYPE_TEXTURE 

A texture has been bound or unbound.

TYPE_OUTPUT 

An object output has been bound or unbound.

TYPE_ANIMATE 

An animation f-curve has been bound or unbound.

TYPE_LOCALIZE 

The attribute has been localized or unlocalized.

TYPE_LOCKED 

The locked flag has changed.

TYPE_SETTINGS 

A settings has dynamically changed (added/removed)

TYPE_OVERRIDEN 

The overriden flag has changed.

TYPE_READ_ONLY 

The read-only flag has changed.

TYPE_PRESET 

A preset was dynamically changed.

TYPE_HIDDEN 

The hidden flag has changed.

TYPE_PROMOTE_ATTRIBUTE 

The promote attribute flag has changed.

TYPE_PROPAGATE 

An attribute change is propagated through the scene dependency graph but this attribute is not the source of the change.

TYPE_UNKNOWN 

A change occurred but no information about is given.