Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
OfBaseAttrHandle< T > Class Template Reference
Inheritance diagram for OfBaseAttrHandle< T >:
OfBasePlugHandle< T > CoreBaseObject CoreBaseType

Public Types

typedef core_conditional< T,
const OfAttr, OfAttr >::type 
AttrType
 
typedef core_conditional< T,
const OfContext, OfContext >
::type 
ContextType
 
- Public Types inherited from OfBasePlugHandle< T >
typedef core_conditional< T,
const OfObject, OfObject >
::type 
ObjectType
 
typedef core_conditional< T,
const OfPlugType, OfPlugType >
::type 
PlugType
 
typedef core_conditional< T,
const OfContext, OfContext >
::type 
ContextType
 

Public Member Functions

CoreString get_flags_names () const
 
bool is_custom () const
 
bool is_custom_root () const
 
bool is_custom_instance () const
 
int get_flags () const
 
const CoreStringget_group_name () const
 
const unsigned int & get_dependency_count () const
 
OfAttrget_dependency (const unsigned int &index) const
 
OfObjectget_top_object () const
 
OfAttrget_proto_ptr () const
 
bool is_single () const
 
bool is_array () const
 
bool is_list () const
 
bool is_numeric_type () const
 
const CoreStringget_doc () const
 
bool has_preset () const
 
const unsigned int & get_preset_count () const
 
CoreString get_preset_label (const unsigned int &preset_index) const
 
CoreString get_preset_value (const unsigned int &preset_index) const
 
const GuiIconget_preset_icon (const unsigned int &preset_index) const
 
CoreString get_preset_value (const CoreString &preset_label) const
 
int get_preset_index (const CoreString &preset_label) const
 
unsigned int get_applied_preset_index () const
 
CoreString get_applied_preset_label () const
 
CoreString serialize_presets () const
 
void get_preset_hints (CoreArray< bool > &hints) const
 
const CoreStringget_null_label () const
 
const CoreStringget_null_value () const
 
bool has_actions () const
 
const CoreVector< OfAction * > & get_actions () const
 
AttrTypeget_source_ptr () const
 
const OfAttrget_serialized_source () const
 
const unsigned int get_serialized_value_count () const
 
const unsigned int get_value_count (const bool &consider_disabled=true) const
 
bool is_vec3d () const
 
bool is_vec4d () const
 
bool get_bool (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreArray< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreVector< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
bool get_raw_bool (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreArray< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreVector< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
bool get_serialized_bool (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreArray< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< bool > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
long get_long (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreArray< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreVector< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
long get_raw_long (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreArray< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreVector< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
long get_serialized_long (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreArray< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< long > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_double (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreArray< double > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_values (CoreVector< double > &values, const OfAttr::ValuePage &pages=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_vec2d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_vec3d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_vec4d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_raw_double (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreArray< double > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_raw_values (CoreVector< double > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_raw_vec2d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_raw_vec3d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_raw_vec4d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_serialized_double (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreArray< double > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< double > &value, const OfAttr::ValuePage &pages=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_serialized_vec2d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_serialized_vec3d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_serialized_vec4d (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
CoreString get_serialized_string (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreArray< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
OfContextget_referenced_context (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfContextget_serialized_referenced_context (const unsigned int &index, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfObjectget_group (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_serialized_values (CoreArray< OfObject * > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< OfObject * > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreArray< OfItem * > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_values (CoreVector< OfItem * > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
OfObjectget_serialized_group (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
const FCurveget_curve (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_curve_double (const double &parameter, const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_double_at (const double &time, const unsigned int &index=0) const
 
void get_curve_values (CoreArray< double > &values, const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_curve_values (CoreVector< double > &values, const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_curve_values (CoreArray< double > &values, const CoreBasicArray< double > &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_curve_vec2d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_curve_vec2d (const GMathVec2d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_curve_vec3d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_vec3d_at (const double &time) const
 
GMathVec3d get_curve_vec3d (const GMathVec3d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_curve_vec4d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_vec4d_at (const double &time) const
 
GMathVec4d get_curve_vec4d (const GMathVec4d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
const FCurveget_serialized_curve (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_serialized_curve_double (const double &parameter, const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
double get_serialized_double_at (const double &time, const unsigned int &index=0) const
 
void get_serialized_curve_values (CoreArray< double > &values, const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_curve_values (CoreVector< double > &values, const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
void get_serialized_curve_values (CoreArray< double > &values, const CoreBasicArray< double > &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_serialized_curve_vec2d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec2d get_serialized_curve_vec2d (const GMathVec2d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_serialized_curve_vec3d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec3d get_serialized_vec3d_at (const double &time) const
 
GMathVec3d get_serialized_curve_vec3d (const GMathVec3d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_serialized_curve_vec4d (const double &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
GMathVec4d get_serialized_vec4d_at (const double &time) const
 
GMathVec4d get_serialized_curve_vec4d (const GMathVec4d &parameter, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
bool is_animatable () const
 
bool is_animated (const unsigned int &index=-1) const
 
bool is_driver_anim_fcurve (const unsigned int &index) const
 
bool is_serialized_driver_anim_fcurve (const unsigned int &index) const
 
bool has_fcurve (const unsigned int &index=-1) const
 
AnimFCurveget_fcurve (const unsigned int &index) const
 
bool is_serialized_animated (const unsigned int &index=-1) const
 
bool has_serialized_fcurve (const unsigned int &index=-1) const
 
AnimFCurveget_serialized_fcurve (const unsigned int &index) const
 
bool is_texturable () const
 
const OfAttr::TextureModeget_texture_mode () const
 
bool is_textured (const bool &consider_disabled=true) const
 
const short & get_texture_channel_group () const
 
bool is_serialized_textured () const
 
const short & get_serialized_texture_channel_group () const
 
OfObjectget_serialized_texture () const
 
bool is_shading_variable_enabled () const
 
bool is_shading_variable_activated () const
 
bool is_bound_to_shading_variable () const
 
const CoreStringget_bound_shading_variable () const
 
bool is_serialized_shading_variable_activated () const
 
bool is_serialized_bound_to_shading_variable () const
 
const CoreStringget_serialized_bound_shading_variable () const
 
bool is_expression_enabled () const
 
bool can_manage_expression () const
 
bool is_expression_bound (const unsigned int &value_index=0) const
 
bool is_serialized_expression_bound (const unsigned int &value_index=0) const
 
bool is_any_expression_bound () const
 
bool is_any_serialized_expression_bound () const
 
bool is_expression_activated (const unsigned int &value_index=0) const
 
bool is_expression_legacy (const unsigned int &value_index=0) const
 
bool is_serialized_expression_activated (const unsigned int &value_index=0) const
 
const CoreStringget_expression (const unsigned int &value_index=0) const
 
const CoreStringget_serialized_expression (const unsigned int &value_index=0) const
 
bool is_slider () const
 
bool is_range_enabled () const
 
void get_numeric_range (double &min, double &max) const
 
const double & get_numeric_range_min () const
 
const double & get_numeric_range_max () const
 
bool is_ui_range_enabled () const
 
void get_numeric_ui_range (double &min, double &max) const
 
const double & get_ui_range_min () const
 
const double & get_ui_range_max () const
 
const CoreStringget_object_filter () const
 
const CoreBasicArray
< CoreString > & 
get_item_filters () const
 
const CoreStringget_item_filter () const
 
const CoreStringget_context_filter () const
 
const CoreStringget_group_filter () const
 
const CoreBasicArray
< CoreString > & 
get_texture_filters () const
 
const CoreStringget_enum_type () const
 
OfEnumget_enum () const
 
const CoreStringget_scripting_filter () const
 
const CoreBasicArray
< CoreString > & 
get_filename_extensions () const
 
OfAttr::TagCandidateCallback get_tag_candidate_callback () const
 
void get_tag_candidates (CoreVector< CoreString > &candidates, CoreArray< bool > &preset_hints) const
 
bool is_depending_on_variable (const CoreString &variable_name) const
 
unsigned int get_settings_count () const
 
ParserEntrysettings_exists (const CoreString &settings_key) const
 
ParserEntryget_settings (const CoreString &settings_key) const
 
void get_settings_keys (CoreVector< CoreString > &keys) const
 
unsigned int get_serialized_settings_count () const
 
ParserEntryserialized_settings_exists (const CoreString &settings_key) const
 
ParserEntryget_serialized_settings (const CoreString &settings_key) const
 
void get_serialized_settings_keys (CoreVector< CoreString > &keys) const
 
bool is_asleep () const
 
bool is_awake () const
 
bool is_dg_active () const
 
bool is_dg_cyclic () const
 
const int get_output_dirtiness () const
 
const int get_input_dirtiness () const
 
const OfAttrEventget_event_info () const
 
const CoreBasicArray
< OfAttrEvent > & 
get_event_infos () const
 
bool is_local () const
 
bool is_instance () const
 
bool is_proto () const
 
bool is_synchronized () const
 
bool is_value_proto () const
 
bool is_default_value () const
 
bool is_private () const
 
bool is_hidden () const
 
bool is_read_only () const
 
bool is_saveable () const
 
bool is_experimental () const
 
bool is_advanced () const
 
bool is_overriden () const
 
bool is_promoted () const
 
bool is_weak_referencing () const
 
bool is_locked () const
 
bool is_value_locked (const unsigned int &value_index) const
 
bool is_serialized_value_locked (const unsigned int &value_index) const
 
bool is_any_serialized_value_locked () const
 
bool can_mute_local_value () const
 
bool is_local_muted () const
 
bool can_disable () const
 
bool is_disabled () const
 
bool is_value_disabled (const unsigned int &value_index) const
 
bool is_any_value_disabled () const
 
bool is_serialized_value_disabled (const unsigned int &value_index) const
 
bool is_any_serialized_value_disabled () const
 
bool is_value_equal_to (const OfAttr &attr, const bool &consider_disabled=true) const
 
bool is_serialized_value_equal_to (const OfAttr &attr) const
 
void add_to_path_attrs () const
 
void remove_from_path_attrs () const
 
void get_statistics (SysStatistic &stats) const
 
bool can_revert () const
 
const OfAttrState * get_revert () const
 
bool is_revert_dirty () const
 
OfAttrState * save_state (const OfAttr::ValuePage &page) const
 
ParserEntryserialize (const OfSerialOptions &options=OfSerialOptions::get_default()) const
 
bool has_ui_data () const
 
bool can_use_override () const
 
bool can_use_override (const OfAttr *overrider) const
 
OfAttrget_override () const
 
bool is_using_override () const
 
bool is_override () const
 
void get_override_users (CoreVector< OfAttr * > &users) const
 
bool is_override_user_protected () const
 
bool is_column (void) const
 
OfAttrTable get_table (unsigned int row_index=0) const
 
unsigned int get_table_column_index (void) const
 
OfContextget_root_context () const
 
bool has_output_binding (bool consider_disabled=true) const
 
bool has_serialized_output_binding () const
 
bool set_flags (const int &flags)
 
bool add_dependency (const CoreString attr_name)
 
bool remove_dependency (const CoreString attr_name)
 
bool add_preset (const CoreString &preset_label, const CoreString &preset_value, const GuiIcon *icon=0)
 
bool remove_preset (const CoreString &label)
 
bool remove_preset (const unsigned int &index)
 
bool remove_all_presets ()
 
bool set_preset_label (const unsigned int &preset_index, const CoreString &preset_label)
 
bool set_preset_value (const unsigned int &preset_index, const CoreString &preset_value)
 
bool set_preset_value (const CoreString &preset_label, const CoreString &preset_value)
 
bool apply_preset (const CoreString &preset_label)
 
bool apply_preset (const unsigned int &preset_index)
 
void deserialize_presets (const CoreString &line)
 
OfActionadd_action (const CoreString &name)
 
bool set_null_label (const CoreString &label)
 
bool set_null_value (const CoreString &value)
 
bool localize (const bool &flag, void *requester=0)
 
bool reset ()
 
OfAttrget_serialized_source ()
 
bool set_value_count (const unsigned int &count, void *requester=0)
 
bool remove_item (const unsigned int &index, void *requester=0)
 
bool remove_item (const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool remove_item (const CoreList< unsigned int > &indices, void *requester=0)
 
bool remove_all (void *requester=0)
 
bool move_item (const unsigned int &from, const unsigned int &to, void *requester=0)
 
bool permute (const CoreBasicArray< unsigned int > &permutation, const bool &check_permutation=true, void *requester=0)
 
bool permute (const CoreList< unsigned int > &permutation, const bool &check_permutation=true, void *requester=0)
 
bool set_bool (const bool &value, const unsigned int &index=0, void *requester=0)
 
bool drive_bool (const bool &value, const unsigned int &index=0, void *requester=0)
 
bool change_bool (const bool &value, const unsigned int &index=0, void *requester=0)
 
bool set_bool (const CoreBasicArray< bool > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool change_bool (const CoreBasicArray< bool > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool set_bool (const CoreBasicArray< bool > &values, void *requester=0)
 
bool change_bool (const CoreBasicArray< bool > &values, void *requester=0)
 
bool set_bool (const CoreList< bool > &values, void *requester=0)
 
bool change_bool (const CoreList< bool > &values, void *requester=0)
 
bool add_bool (const bool &value, void *requester=0)
 
bool toggle_bool (const unsigned int &index=0, void *requester=0)
 
bool set_long (const long &value, const unsigned int &index=0, void *requester=0)
 
bool change_long (const long &value, const unsigned int &index=0, void *requester=0)
 
bool set_long (const CoreBasicArray< long > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool change_long (const CoreBasicArray< long > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool set_long (const CoreBasicArray< long > &values, void *requester=0)
 
bool change_long (const CoreBasicArray< long > &values, void *requester=0)
 
bool set_long (const CoreList< long > &values, void *requester=0)
 
bool change_long (const CoreList< long > &values, void *requester=0)
 
bool add_long (const long &value, void *requester=0)
 
bool inc_long (const long &value, const unsigned int &index=0, void *requester=0)
 
bool set_double (const double &value, const unsigned int &index=0, void *requester=0)
 
bool change_double (const double &value, const unsigned int &index=0, void *requester=0)
 
bool set_double (const CoreBasicArray< double > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool change_double (const CoreBasicArray< double > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool set_double (const CoreBasicArray< double > &values, void *requester=0)
 
bool change_double (const CoreBasicArray< double > &values, void *requester=0)
 
bool set_double (const CoreList< double > &values, void *requester=0)
 
bool change_double (const CoreList< double > &values, void *requester=0)
 
bool set_vec3d (const GMathVec3d &vec, void *requester=0)
 
bool change_vec3d (const GMathVec3d &vec, void *requester=0)
 
bool set_vec4d (const GMathVec4d &vec, void *requester=0)
 
bool change_vec4d (const GMathVec4d &vec, void *requester=0)
 
bool add_double (const double &value, void *requester=0)
 
bool inc_double (const double &value, const unsigned int &index=0, void *requester=0)
 
bool set_string (const CoreString &value, const unsigned int &index=0, void *requester=0)
 
bool change_string (const CoreString &value, const unsigned int &index=0, void *requester=0)
 
bool set_string (const CoreBasicArray< CoreString > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool change_string (const CoreBasicArray< CoreString > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0)
 
bool set_string (const CoreBasicArray< CoreString > &values, void *requester=0)
 
bool change_string (const CoreBasicArray< CoreString > &values, void *requester=0)
 
bool set_string (const CoreList< CoreString > &values, void *requester=0)
 
bool change_string (const CoreList< CoreString > &values, void *requester=0)
 
bool add_string (const CoreString &value, void *requester=0)
 
bool add_string (const CoreBasicArray< CoreString > &values, void *requester=0)
 
bool add_embedded_object (const CoreString &class_name, const CoreString &object_name, const CoreString &source_path, void *requester)
 
bool set_object (OfObject *value, const unsigned int &index=0, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_item (OfItem *value, const unsigned int &index=0, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_item (const CoreBasicArray< OfItem * > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_object (const CoreBasicArray< OfObject * > &values, const CoreBasicArray< unsigned int > &indices, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_item (const CoreBasicArray< OfItem * > &values, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_object (const CoreBasicArray< OfObject * > &values, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_object (const CoreList< OfObject * > &values, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool set_item (const CoreList< OfItem * > &values, void *requester=0, const OfAttr::CyclicCheckInfo &cyclic_check=OfAttr::CYCLIC_CHECK_AND_WARN)
 
bool add_object (OfObject *value, void *requester=0)
 
bool add_item (OfItem *value, void *requester=0)
 
bool add_object (const CoreBasicArray< OfObject * > &values, void *requester)
 
bool add_item (const CoreBasicArray< OfItem * > &values, void *requester)
 
bool add_string (const CoreString &class_name, const CoreString &object_name, void *requester=0)
 
bool add_string (const CoreBasicArray< CoreString > &class_name, const CoreBasicArray< CoreString > &object_name, void *requester=0)
 
bool add_string (const CoreString &class_name, const CoreString &object_name, const CoreString &source_name, void *requester)
 
bool add_string (const CoreBasicArray< CoreString > &values, const CoreBasicArray< CoreString > &object_names, const CoreBasicArray< CoreString > &source_names, void *requester)
 
bool remove_object (const OfObject &object, void *requester=0)
 
bool set_curve (const FCurve &curve, const unsigned int &index, void *requester=0)
 
bool add_curve_key (const int &key_type, const double &x, const double &y, const unsigned int &index, void *requester=0)
 
bool add_curve_key (const int &key_type, const double &x, const CoreBasicArray< double > &y, void *requester=0)
 
bool remove_curve_key (const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool remove_curve_key (const FCurveKeyId &key_id, void *requester=0)
 
bool remove_curve_key (const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool remove_curve_key (const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool set_curve_extrapolation (const int &behavior, const short &pre_or_post, const unsigned int &index, void *requester=0)
 
bool set_curve_extrapolation (const int &behavior, const short &pre_or_post, void *requester=0)
 
bool set_curve_key_type (const int &key_type, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_type (const int &key_type, const FCurveKeyId &key_id, void *requester=0)
 
bool set_curve_key_type (const int &key_type, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_type (const int &key_type, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool set_curve_key_property (const CoreString &property_name, const CoreString &property_value, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_property (const CoreString &property_name, const CoreString &property_value, const FCurveKeyId &key_id, void *requester=0)
 
bool set_curve_key_property (const CoreString &property_name, const CoreString &property_value, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_property (const CoreString &property_name, const CoreString &property_value, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool set_curve_key_tangent_left (const GMathVec2d &left, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_tangent_right (const GMathVec2d &right, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_tangents (const GMathVec2d &left, const GMathVec2d &right, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool change_curve_key_tangent_left (const GMathVec2d &left, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool change_curve_key_tangent_right (const GMathVec2d &right, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool change_curve_key_tangents (const GMathVec2d &left, const GMathVec2d &right, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_tcb (const GMathVec3d &tcb, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool change_curve_key_tcb (const GMathVec3d &tcb, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_x (const double &x, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_x (const CoreBasicArray< double > &x, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_x (const double &x, const FCurveKeyId &key_id, void *requester=0)
 
bool set_curve_key_x (const CoreBasicArray< double > &x, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool change_curve (const FCurve &curve, const unsigned int &index, void *requester=0) const
 
bool change_curve_key_x (const double &x, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool change_curve_key_x (const CoreBasicArray< double > &x, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool change_curve_key_x (const double &x, const FCurveKeyId &key_id, void *requester=0)
 
bool change_curve_key_x (const CoreBasicArray< double > &x, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool set_curve_key_y (const double &y, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool set_curve_key_y (const CoreBasicArray< double > &y, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_y (const CoreBasicArray< double > &y, const FCurveKeyId &key_id, void *requester=0)
 
bool set_curve_key_y (const double &y, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool set_curve_key_y (const CoreBasicArray< double > &y, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool change_curve_key_y (const double &y, const FCurveKeyId &key_id, const unsigned int &index, void *requester=0)
 
bool change_curve_key_y (const CoreBasicArray< double > &y, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool change_curve_key_y (const CoreBasicArray< double > &y, const FCurveKeyId &key_id, void *requester=0)
 
bool change_curve_key_y (const double &y, const CoreBasicArray< FCurveKeyId > &key_ids, const unsigned int &index, void *requester=0)
 
bool change_curve_key_y (const CoreBasicArray< double > &y, const CoreBasicArray< FCurveKeyId > &key_ids, void *requester=0)
 
bool set_animatable (const bool &flag)
 
bool set_time (const double &time)
 
AnimFCurveadd_fcurve (const unsigned int &index, void *requester=0)
 
AnimFCurveadd_fcurve_with_key (const unsigned int &index, void *requester=0)
 
AnimFCurveadd_fcurve (const ParserEntry &entry, const unsigned int &index, void *requester=0)
 
bool set_key (const double &time, const unsigned int &index=-1, void *requester=0)
 
bool remove_anim (const unsigned int &index=-1, void *requester=0)
 
bool remove_fcurve (const unsigned int &index=-1, void *requester=0)
 
bool set_texturable (const bool &flag)
 
bool set_texture_mode (const OfAttr::TextureMode &mode)
 
bool set_texture (OfObject *texture, void *requester=0)
 
bool set_texture_channel_group (const short &channel_group_index, void *requester=0)
 
bool enable_shading_variable (const bool &enable)
 
bool activate_shading_variable (const bool &flag, void *requester=0)
 
bool bind_shading_variable (const CoreString &variable, void *requester=0)
 
bool unbind_shading_variable (void *requester=0)
 
bool enable_expression (const bool &capable)
 
bool activate_expression (const bool &enable, const unsigned int &value_index=0, void *requester=0)
 
bool activate_expression (const CoreBasicArray< bool > &enable, const CoreBasicArray< unsigned int > &value_indices, void *requester=0)
 
bool set_expression (const CoreString &expression, unsigned int index=0, bool activated=true, void *requester=nullptr)
 
bool set_expression (const CoreBasicArray< CoreString > &expressions, const CoreBasicArray< unsigned int > &indices, const CoreBasicArray< bool > &activated, void *requester=nullptr)
 
bool set_slider (const bool &flag)
 
bool enable_range (const bool &flag)
 
bool set_numeric_range (const double &min, const double &max)
 
bool set_numeric_range_min (const double &min, const bool &auto_set_max=false)
 
bool set_numeric_range_max (const double &max, const bool &auto_set_min=false)
 
bool enable_ui_range (const bool &flag)
 
bool set_numeric_ui_range (const double &min, const double &max)
 
bool set_ui_range_min (const double &min, const bool &auto_set_max=false)
 
bool set_ui_range_max (const double &max, const bool &auto_set_min=false)
 
bool add_validator (OfAttr::ValidatorBool validator, void *data=0)
 
bool add_validator (OfAttr::ValidatorLong validator, void *data=0)
 
bool add_validator (OfAttr::ValidatorDouble validator, void *data=0)
 
bool add_validator (OfAttr::ValidatorString validator, void *data=0)
 
bool add_validator (OfAttr::ValidatorItem validator, void *data=0)
 
bool remove_all_validators ()
 
bool remove_validator (OfAttr::ValidatorBool validator, void *data=0)
 
bool remove_validator (OfAttr::ValidatorLong validator, void *data=0)
 
bool remove_validator (OfAttr::ValidatorDouble validator, void *data=0)
 
bool remove_validator (OfAttr::ValidatorString validator, void *data=0)
 
bool remove_validator (OfAttr::ValidatorItem validator, void *data=0)
 
bool enable_all_validators ()
 
bool enable_validator (OfAttr::ValidatorBool validator, void *data=0)
 
bool enable_validator (OfAttr::ValidatorLong validator, void *data=0)
 
bool enable_validator (OfAttr::ValidatorDouble validator, void *data=0)
 
bool enable_validator (OfAttr::ValidatorString validator, void *data=0)
 
bool enable_validator (OfAttr::ValidatorItem validator, void *data=0)
 
bool disable_all_validators ()
 
bool disable_validator (OfAttr::ValidatorBool validator, void *data=0)
 
bool disable_validator (OfAttr::ValidatorLong validator, void *data=0)
 
bool disable_validator (OfAttr::ValidatorDouble validator, void *data=0)
 
bool disable_validator (OfAttr::ValidatorString validator, void *data=0)
 
bool disable_validator (OfAttr::ValidatorItem validator, void *data=0)
 
bool set_object_filters (const CoreBasicArray< CoreString > &filters, void *requester=0)
 
bool set_item_filters (const CoreBasicArray< CoreString > &filters, void *requester=0)
 
bool set_context_filter (const CoreString &filter)
 
bool set_texture_filters (const CoreBasicArray< CoreString > &filters, void *requester=0)
 
bool set_group_filter (const CoreString &filter)
 
bool set_enum_type (const CoreString &type)
 
bool set_scripting_filter (const CoreString &filter)
 
bool set_filename_extensions (const CoreVector< CoreString > &extensions)
 
bool set_tag_candidate_callback (OfAttr::TagCandidateCallback callback)
 
bool add_settings (const CoreString &settings_key, const ParserEntry &settings, void *requester=0)
 
bool remove_settings (const CoreString &settings_key, void *requester=0)
 
bool remove_all_settings (void *requester=0)
 
bool notify_object_disabled (const int &dependency_type, void *requester=0)
 
bool asleep (bool silent=false)
 
bool awake (const bool &silent=false)
 
bool set_dg_active (const bool &flag)
 
bool set_dg_cyclic (const bool &flag)
 
bool set_output_dirtiness (const int &dirtiness)
 
bool set_input_dirtiness (const int &dirtiness)
 
bool set_hidden (const bool &flag)
 
bool set_read_only (const bool &flag)
 
bool set_saveable (const bool &flag)
 
bool set_overriden (const bool &flag)
 
bool set_private (const bool &flag)
 
bool set_promoted (const bool &flag)
 
bool set_preserve_on_undo (const bool &flag)
 
bool set_weak_referencing (const bool &weak, void *requester=0)
 
bool set_locked (const bool &locked, void *requester=0)
 
bool set_value_locked (const CoreBasicArray< unsigned int > &value_indices, const bool &locked, void *requester=0)
 
bool set_value_locked (const unsigned int &value_index, const bool &locked, void *requester=0)
 
bool set_can_mute_local_value (const bool enable)
 
bool mute_local_value (const bool &flag)
 
bool set_can_disable (const bool enable)
 
bool set_disabled (const bool &disable)
 
bool set_value_disabled (const unsigned int &value_index, const bool &disable, void *requester=0)
 
bool set_value_disabled (const CoreBasicArray< unsigned int > &value_indices, const bool &disable, void *requester=0)
 
bool set_disabled_values (const CoreBasicArray< unsigned int > &value_indices, void *requester=0)
 
bool raise_object_attr_changed ()
 
bool release_revert ()
 
bool dirty_revert (const bool &dirty=true)
 
bool update_revert (const bool &force=false, OfAttrState *state=0)
 
bool revert (OfAttrState *state=0, const bool &auto_delete_state=true)
 
void print_revert_state ()
 
bool restore_state (OfAttrState *state, const bool &auto_delete_state=false)
 
bool deserialize (const ParserEntry &entry, const OfSerialOptions &options=OfSerialOptions::get_default())
 
bool set_ui_data (const CoreString &key, const CoreString &value)
 
CoreStringget_ui_data (const CoreString &key)
 
bool clear_ui_data (const CoreString &key)
 
bool clear_ui_data ()
 
bool set_overridable (const bool &enable)
 
bool override (OfAttr &overrider, void *requester=0)
 
bool remove_override (void *requester=0)
 
bool set_root_context (OfContext *context)
 
bool set_output_binding (OfObject *object, unsigned int id, void *requester=0)
 
 OfBaseAttrHandle (ContextType &context, AttrType *attr)
 
template<bool U>
 OfBaseAttrHandle (const OfBasePlugHandle< U > &other)
 
 OfBaseAttrHandle (const OfHandle &handle)
 
 OfBaseAttrHandle (AttrType *attr)
 
template<bool U>
bool operator== (const OfBasePlugHandle< U > &other) const
 
template<bool U>
bool operator!= (const OfBasePlugHandle< U > &other) const
 
template<bool U>
OfBaseAttrHandle< T > & operator= (const OfBasePlugHandle< U > &other)
 
 operator const OfAttr * () const
 
 OF_WRITE_ONLY (T) operator OfAttr *() const
 
AttrTypeget_ptr () const
 
OfBaseAttrHandle< T > get_proto () const
 
bool is_editable (const int &read_only_mask=RO_ALL_MASK) const
 
OfObjectHandle get_object (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfObjectHandle get_raw_object (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfItemHandle get_item (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfItemHandle get_raw_item (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfObjectHandle get_texture (const bool &consider_disabled=true) const
 
OfObjectHandle get_raw_texture (const bool &consider_disabled=true) const
 
CoreString get_string (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
CoreString get_raw_string (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreArray< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreVector< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreArray< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreVector< CoreString > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreArray< OfObjectHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreVector< OfObjectHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreArray< OfItemHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_values (CoreVector< OfItemHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreArray< OfObjectHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreVector< OfObjectHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreArray< OfItemHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
void get_raw_values (CoreVector< OfItemHandle > &values, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT, const bool &consider_disabled=true) const
 
OfObjectHandle get_serialized_object (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
OfItemHandle get_serialized_item (const unsigned int &index=0, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
 
OfObjectHandle get_output_binding (unsigned int &id, bool consider_disabled=true) const
 
OfObjectHandle get_serialized_output_binding (unsigned int &id) const
 
OfBaseAttrHandle< T > get_parent_attribute () const
 
OfBaseAttrHandle< T > get_source () const
 
- Public Member Functions inherited from OfBasePlugHandle< T >
const CoreStringget_name () const
 
const OfPlugType::Typeget_type () const
 
const OfPlugType::VisualHintget_visual_hint () const
 
const OfPlugType::Containerget_container () const
 
OfAppget_application () const
 
OfObjectFactoryget_factory () const
 
PlugTypeget_ptr () const
 
OfBaseContextHandle< T > get_parent_context () const
 
ContextTypeget_parent_context_ptr () const
 
OfBaseObjectHandle< T > get_parent_object () const
 
CoreString get_full_name () const
 
CoreString get_project_full_name () const
 
bool is_valid () const
 
bool is_parent_object_real () const
 
bool is_parent_object_virtual () const
 
bool operator== (const OfPlugType *plug) const
 
bool operator== (const OfPlugType &plug) const
 
bool operator!= (const OfPlugType *plug) const
 
bool operator!= (const OfPlugType &plug) const
 
template<bool U>
bool operator== (const OfBasePlugHandle< U > &other) const
 
template<bool U>
bool operator!= (const OfBasePlugHandle< U > &other) const
 
template<bool U>
OfBasePlugHandle< T > & operator= (const OfBasePlugHandle< U > &other)
 
OfBasePlugHandleoperator= (const OfHandle &handle)
 
 operator const OfPlugType * () const
 
 OF_WRITE_ONLY (T) operator OfPlugType *() const
 
 OfBasePlugHandle (ContextType &context, PlugType *plug)
 
template<bool U>
 OfBasePlugHandle (const OfBasePlugHandle< U > &plug_handle)
 
 OfBasePlugHandle (PlugType *plug)
 
 OfBasePlugHandle (const OfHandle &handle)
 
- 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
 

Static Public Member Functions

static CoreString get_type_name (const OfAttr::Type &type)
 Returns the stringified name of the specified attribute type enum value.
 
static CoreString get_type_serial_name (const OfAttr::Type &type)
 Returns the stringified name of the specified attribute type enum value (without TYPE_).
 
static void get_type_min (const OfAttr::Type &type, double &min)
 Returns the minimum value according to specified type.
 
static void get_type_max (const OfAttr::Type &type, double &max)
 Returns the maximum value according to specified type.
 
static const CoreStringget_container_name (const OfAttr::Container &type)
 Returns the stringified name of the specified attribute container enum value.
 
static OfAttr::Container get_container_from_name (const CoreString &container)
 
 
static const CoreStringget_visual_hint_name (const OfAttr::VisualHint &visual_hint)
 Returns the stringified name of the specified attribute visual hint enum value.
 
static CoreString get_visual_hint_serial_name (const OfAttr::VisualHint &visual_hint)
 Returns the stringified name of the specified attribute visual hint enum value (without VISUAL_HINT_).
 
static OfAttr::VisualHint get_visual_hint_from_name (const CoreString &visual_hint)
 
 
static CoreString get_texture_mode_name (const OfAttr::TextureMode &mode)
 Returns the stringified name of the specified texture mode enum value.
 
static const OfAttr::Dirtinessget_dirtiness (const unsigned int &index)
 Returns the dirtiness enum value from the specified index. Helper method used to iterate over the attribute dirtiness values.
 
static CoreString get_dirtiness_name (const OfAttr::Dirtiness &dirtiness)
 Returns the stringified name of the specified attribute dirtiness binary mask.
 
static bool get_info_from_visual_hint (const OfAttr::VisualHint &visual_hint, OfAttr::Type &type, OfAttr::Container &container, bool &fixed_value_count, unsigned int &value_count)
 Gets the associated type, preferential container and value count from the specified visual hint, returns true if managed, false otherwise.
 
static void get_dirtinesses (CoreVector< OfAttr::Dirtiness > &dirtinesses, const int &dirtiness)
 Break down the specified dirtiness into actomic binary masks composing it.
 
static void get_dirtiness_names (CoreVector< CoreString > &names, const int &dirtiness)
 Breaks down the specified dirtiness into stringified names of the actomic binary masks composing it.
 
static CoreString get_unit_from_visual_hint (const OfAttr::VisualHint &of_attr_visual_hint)
 Returns the unit corresponding to the specified visual hint.
 
static OfAttr::VisualHint get_visual_hint_from_unit (const CoreString &of_attr_unit)
 Returns the visual hint corresponding to the specified unit.
 
static OfAttr::Flag get_flag (unsigned int index)
 Returns the attribute flag from the specified index. Helper method used to iterate over the attribute flags.
 
static CoreString get_flag_name (OfAttr::Flag flag)
 Returns the stringified name of the specified attribute flag binary mask.
 
static bool get_flag_default_value (OfAttr::Flag flag)
 Returns the default value for the specified attribute flag.
 
static const CoreSet< OfAttr * > & get_path_attrs ()
 
 
static bool is_revert_event_info (const OfAttrEvent &event)
 
 
static bool is_override_flag_change_event (const OfAttrEvent &event)
 
 
static void delete_state (OfAttrState *state)
 Deletes the state data that was created using save_state().
 

Static Public Attributes

static OfBaseAttrHandle< T > s_empty_handle = OfBaseAttrHandle<T>()
 
- Static Public Attributes inherited from OfBasePlugHandle< T >
static OfBasePlugHandle< T > s_empty_handle = OfBasePlugHandle<T>()
 

Additional Inherited Members

- Protected Attributes inherited from OfBasePlugHandle< T >
ContextTypem_context
 context in which to consider the plug
 
PlugTypem_data
 the original plug
 

Detailed Description

template<bool T>
class OfBaseAttrHandle< T >

Base class for const and non-const attribute handles. Attribute handles allow to manipulate attributes of objects into a specific context. It is mainly use to resolve references of the attribute contextually.

Member Function Documentation

template<bool T>
static void OfBaseAttrHandle< T >::delete_state ( OfAttrState *  state)
inlinestatic

Deletes the state data that was created using save_state().

template<bool T>
static OfAttr::Container OfBaseAttrHandle< T >::get_container_from_name ( const CoreString container)
inlinestatic

template<bool T>
static const CoreString& OfBaseAttrHandle< T >::get_container_name ( const OfAttr::Container type)
inlinestatic

Returns the stringified name of the specified attribute container enum value.

template<bool T>
static const OfAttr::Dirtiness& OfBaseAttrHandle< T >::get_dirtiness ( const unsigned int &  index)
inlinestatic

Returns the dirtiness enum value from the specified index. Helper method used to iterate over the attribute dirtiness values.

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_dirtiness_name ( const OfAttr::Dirtiness dirtiness)
inlinestatic

Returns the stringified name of the specified attribute dirtiness binary mask.

template<bool T>
static void OfBaseAttrHandle< T >::get_dirtiness_names ( CoreVector< CoreString > &  names,
const int &  dirtiness 
)
inlinestatic

Breaks down the specified dirtiness into stringified names of the actomic binary masks composing it.

Parameters
[out]dirtinessesVector of stringified names of the atomic dirtiness binary masks.
[in]dirtinessThe Dirtiness to get broken down.

template<bool T>
static void OfBaseAttrHandle< T >::get_dirtinesses ( CoreVector< OfAttr::Dirtiness > &  dirtinesses,
const int &  dirtiness 
)
inlinestatic

Break down the specified dirtiness into actomic binary masks composing it.

Parameters
[out]dirtinessesVector of atomic dirtiness binary masks.
[in]dirtinessThe Dirtiness to get broken down.

template<bool T>
static OfAttr::Flag OfBaseAttrHandle< T >::get_flag ( unsigned int  index)
inlinestatic

Returns the attribute flag from the specified index. Helper method used to iterate over the attribute flags.

template<bool T>
static bool OfBaseAttrHandle< T >::get_flag_default_value ( OfAttr::Flag  flag)
inlinestatic

Returns the default value for the specified attribute flag.

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_flag_name ( OfAttr::Flag  flag)
inlinestatic

Returns the stringified name of the specified attribute flag binary mask.

template<bool T>
static bool OfBaseAttrHandle< T >::get_info_from_visual_hint ( const OfAttr::VisualHint visual_hint,
OfAttr::Type type,
OfAttr::Container container,
bool &  fixed_value_count,
unsigned int &  value_count 
)
inlinestatic

Gets the associated type, preferential container and value count from the specified visual hint, returns true if managed, false otherwise.

template<bool T>
static const CoreSet<OfAttr *>& OfBaseAttrHandle< T >::get_path_attrs ( )
inlinestatic

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_texture_mode_name ( const OfAttr::TextureMode mode)
inlinestatic

Returns the stringified name of the specified texture mode enum value.

template<bool T>
static void OfBaseAttrHandle< T >::get_type_max ( const OfAttr::Type type,
double &  max 
)
inlinestatic

Returns the maximum value according to specified type.

template<bool T>
static void OfBaseAttrHandle< T >::get_type_min ( const OfAttr::Type type,
double &  min 
)
inlinestatic

Returns the minimum value according to specified type.

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_type_name ( const OfAttr::Type type)
inlinestatic

Returns the stringified name of the specified attribute type enum value.

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_type_serial_name ( const OfAttr::Type type)
inlinestatic

Returns the stringified name of the specified attribute type enum value (without TYPE_).

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_unit_from_visual_hint ( const OfAttr::VisualHint of_attr_visual_hint)
inlinestatic

Returns the unit corresponding to the specified visual hint.

template<bool T>
static OfAttr::VisualHint OfBaseAttrHandle< T >::get_visual_hint_from_name ( const CoreString visual_hint)
inlinestatic

template<bool T>
static OfAttr::VisualHint OfBaseAttrHandle< T >::get_visual_hint_from_unit ( const CoreString of_attr_unit)
inlinestatic

Returns the visual hint corresponding to the specified unit.

template<bool T>
static const CoreString& OfBaseAttrHandle< T >::get_visual_hint_name ( const OfAttr::VisualHint visual_hint)
inlinestatic

Returns the stringified name of the specified attribute visual hint enum value.

template<bool T>
static CoreString OfBaseAttrHandle< T >::get_visual_hint_serial_name ( const OfAttr::VisualHint visual_hint)
inlinestatic

Returns the stringified name of the specified attribute visual hint enum value (without VISUAL_HINT_).

template<bool T>
static bool OfBaseAttrHandle< T >::is_override_flag_change_event ( const OfAttrEvent event)
inlinestatic

template<bool T>
static bool OfBaseAttrHandle< T >::is_revert_event_info ( const OfAttrEvent event)
inlinestatic