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 | Friends | List of all members
AppBuiltinCommands Class Reference
Inheritance diagram for AppBuiltinCommands:
CoreBaseObject CoreBaseType

Classes

class  ContextEngineBackUpData
 

Public Types

enum  AutoLocalizeMode {
  AUTOLOCALIZE_PREF,
  AUTOLOCALIZE_ON,
  AUTOLOCALIZE_OFF
}
 
enum  CombineItemsPivot {
  COMBINE_ITEMS_PIVOT_BBOX =0,
  COMBINE_ITEMS_PIVOT_GROUND,
  COMBINE_ITEMS_PIVOT_ORIGIN,
  COMBINE_ITEMS_PIVOT_CENTER,
  COMBINE_ITEMS_PIVOT_MASTER,
  COMBINE_ITEMS_PIVOT_COUNT
}
 

Public Member Functions

 AppBuiltinCommands (AppObject &application, OfCommandManager &cmd_manager)
 
void declare_curve_commands ()
 
void declare_expression_commands ()
 
void declare_table_commands ()
 
void declare_shading_layer_commands ()
 
void declare_isolate_commands ()
 
void declare_flag_commands (AppObject &app)
 
void declare_move_copy_commands ()
 
void declare_particle_commands ()
 
void declare_edit_layer_commands ()
 
void set_current_time (const double &time, const double &old_time, void *requester=0)
 
void set_current_frame (const double &frame, const double &old_frame, void *requester=0)
 
void set_fps (const double &value, void *requester=0)
 
void set_current_frame_range (const double &min, const double &max, void *requester=0)
 
void set_current_frame_range_min (const double &min, void *requester=0)
 
void set_current_frame_range_max (const double &max, void *requester=0)
 
void goto_next_keyframe (void *requester=0)
 
void goto_previous_keyframe (void *requester=0)
 
void set_parent_in_place (const bool &value, void *requester=0)
 
OfObjectHandle create_object (const CoreString &object_name, const CoreString &class_name, const CoreString &selection_slot=GLOBAL_SLOT, const CoreString &context_path="", void *requester=0)
 
OfObjectHandle create_reference (const CoreBasicArray< CoreString > &attributes, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectHandle create_reference (const CoreString &attribute, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectHandle create_texture (const CoreBasicArray< CoreString > &attributes, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectHandle create_texture (const CoreString &attribute, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectHandle create_group (const CoreBasicArray< CoreString > &attributes, const CoreBasicArray< CoreString > &elements, const CoreString &group_name, const CoreString &context_name="", void *requester=0)
 
OfObjectHandle create_group (const CoreString &attribute, const CoreArray< CoreString > &elements, const CoreString &group_name, const CoreString &context_name="", void *requester=0)
 
OfContextcreate_context (const CoreString &context_name, const CoreString &selection_slot="", const CoreString &context_path="", void *requester=0)
 
OfContextcreate_custom_context (const CoreString &context_name, const CoreString &context_engine, const CoreString &selection_slot="", const CoreString &context_path="", void *requester=0)
 
CoreArray< OfItemHandleinstantiate (const CoreVector< CoreString > &items, const CoreString &select_slot="", void *requester=0)
 
void delete_selection (void *requester=0)
 
void reset_attributes (const CoreBasicArray< CoreString > &attributes, void *requester=0)
 
void revert_attributes (const CoreBasicArray< CoreString > &attributes, void *requester=0)
 
void revert_items_overrides (const CoreBasicArray< CoreString > &items, void *requester=0)
 
void revert_sub_items_overrides (const CoreBasicArray< CoreString > &items, void *requester=0)
 
void activate_shading_variable (const CoreBasicArray< CoreString > &attributes, const CoreBasicArray< bool > &values, void *requester=0)
 
void bind_to_shading_variable (const CoreBasicArray< CoreString > &attributes, const CoreBasicArray< CoreString > &values, void *requester=0)
 
void unbind_shading_variable (const CoreBasicArray< CoreString > &attributes, void *requester=0)
 
void set_value (const CoreString &attr_path, const CoreString &value, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_value (const CoreString &attr_path, const CoreBasicArray< CoreString > &values, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_value (const CoreBasicArray< CoreString > &attr_paths, const CoreString &value, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_value (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< CoreString > &values, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_value_disabled (const CoreString &attr_full_name, const unsigned int &value_index, const bool &disable, void *requester=0)
 
void set_value_disabled (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< unsigned int > &value_indices, const bool &disable, void *requester=0)
 
void paste_attr_value (const CoreString &serialized_attr, const OfSerialOptions::ModePasteAdvanced &paste_mode, const CoreBasicArray< OfAttr * > &destination_attrs, void *requester)
 
void paste_attr_value (const CoreString &serialized_attr, const OfSerialOptions::ModePasteAdvanced &paste_mode, const CoreBasicArray< OfAttrHandle > &destination_attrs, void *requester)
 
void paste_attr_value (const CoreString &serialized_attr, const OfSerialOptions::ModePasteAdvanced &paste_mode, const OfAttr &destination_attr, void *requester)
 
void add_value (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< CoreString > &values, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void add_value (const CoreBasicArray< CoreString > &attr_paths, const CoreString &value, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void add_value (const CoreString &attr_path, const CoreBasicArray< CoreString > &values, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void add_value (const CoreString &attr_path, const CoreString &value, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_curve (const CoreArray< CoreString > &attr_paths, const CoreArray< CoreArray< int > > &types, const CoreArray< CoreArray< double > > &positions, const CoreArray< CoreArray< double > > &values, void *requester=0)
 deprecated
 
void set_curve (const CoreArray< CoreString > &attr_paths, const CoreArray< int > &key_type, const CoreArray< double > &key_x, const CoreArray< double > &key_y, const GMathVec2ui &behaviors, void *requester=0)
 deprecated
 
void set_curve (const CoreVector< CoreString > &attr_paths, const CoreString &serialized_fcurve, void *requester=0)
 
void add_curve_value (const CoreArray< CoreString > &attr_paths, const CoreArray< CoreArray< int > > &types, const CoreArray< CoreArray< double > > &positions, const CoreArray< CoreArray< double > > &values, void *requester=0)
 
void add_curve_value (const CoreArray< CoreString > &attr_paths, const CoreArray< double > &serial, void *requester=0)
 
void remove_curve_value (const CoreArray< CoreString > &attr_paths, const CoreArray< CoreArray< unsigned int > > &key_ids, void *requester=0)
 
void set_curve_key_type (const CoreArray< CoreString > &attr_paths, const CoreArray< unsigned int > &serial, void *requester=0)
 
void set_curve_key_value (const CoreArray< CoreString > &attr_paths, const CoreArray< double > &values, const CoreArray< unsigned int > &key_ids, void *requester=0)
 
void set_curve_key_position (const CoreArray< CoreString > &attr_paths, const CoreArray< double > &positions, const CoreArray< unsigned int > &key_ids, void *requester=0)
 
void move_curve_value (const CoreArray< CoreString > &attr_paths, unsigned short what, const CoreArray< double > &serial, void *requester=0)
 
void add_to_group (const CoreArray< CoreString > &groups, const CoreArray< CoreString > &elements, void *requester=0)
 
void add_to_group (const CoreArray< CoreString > &groups, const CoreString &element, void *requester=0)
 
void add_to_group (const CoreString &group, const CoreArray< CoreString > &elements, void *requester=0)
 
void add_to_group (const CoreString &group, const CoreString &element, void *requester=0)
 
void move_value (const CoreString &attr_path, const unsigned int &from, const unsigned int &to, void *requester=0)
 
void permute_values (const CoreArray< CoreString > &attr_paths, const CoreArray< CoreArray< unsigned int > > &permutations, void *requester=0)
 
void remove_value (const CoreString &attr_path, const CoreArray< unsigned int > &indices, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void remove_value (const CoreBasicArray< CoreString > &attr_paths, const CoreArray< CoreArray< unsigned int > > &indices, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void remove_value (const CoreBasicArray< CoreString > &attr_paths, const CoreArray< unsigned int > &indices, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void remove_all_values (const CoreString &attr_path, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void remove_all_values (const CoreVector< CoreString > &attr_path, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_value_count (const CoreString &attr_path, const unsigned int &count, void *requester=0)
 
void set_value_count (const CoreBasicArray< CoreString > &attr_path, const CoreBasicArray< unsigned int > &count, void *requester=0)
 
void set_texture (const CoreString &attr_path, const CoreString &texture, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_texture (const CoreArray< CoreString > &attr_paths, const CoreString &texture, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_channel (const CoreString &attr_path, const CoreString &channel, void *requester=0)
 
void set_channel (const CoreArray< CoreString > &attr_paths, const CoreString &channel, void *requester=0)
 
void set_binding (const CoreString &attr_path, const CoreString &plug_output, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_binding (const CoreArray< CoreString > &attr_paths, const CoreString &plug_output, void *requester=0, AutoLocalizeMode loc=AUTOLOCALIZE_PREF)
 
void set_key (const CoreString &attr_path, void *requester=0)
 
void set_key (const CoreString &attr_path, const double &time, const double &value, const int &key_type, void *requester=0)
 
void set_key (const CoreVector< CoreString > &attr_paths, const double &times, const CoreVector< double > &values, const int &key_type, void *requester=0)
 
void move_keys (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &indexes, const CoreVector< double > &times, const CoreVector< double > &values, const CoreVector< double > &undo_times, const CoreVector< double > &undo_values, void *requester)
 
void set_keys_values (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &indexes, const CoreVector< double > &values, const CoreVector< double > &undo_values, void *requester)
 
void set_keys_type (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &indexes, const int &type, void *requester)
 
void set_keys_times (const CoreVector< CoreString > &attr_path, const CoreVector< unsigned int > &indexes, const CoreVector< double > &times, const CoreVector< double > &undo_times, void *requester)
 
void set_keys_tcb (const CoreVector< CoreString > &attr_path, const CoreVector< unsigned int > &indexes, const CoreVector< double > &tcb_values, const CoreVector< double > &undo_tcb_values, void *requester)
 
void set_key_tangents (const CoreString &attr_path, const unsigned int &index, const CoreVector< double > &tangents_values, const CoreVector< double > &undo_tangents_values, void *requester)
 
void remove_key (const CoreString &attr_path, const unsigned int &index, void *requester=0)
 
void remove_key (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &ids, void *requester=0)
 
void remove_keys_at (const CoreVector< CoreString > &attr_paths, const double &time, void *requester=0)
 
void insert_keys_at (const CoreVector< CoreString > &attr_paths, const double &time, void *requester=0)
 
void set_keys_property_values (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &indexes, const CoreString &property_name, const CoreVector< CoreString > &property_values, void *requester=0)
 
void set_keys_property_values (const CoreVector< CoreString > &attr_paths, const CoreVector< unsigned int > &indexes, const CoreString &property_name, const CoreString &property_value, void *requester=0)
 
void set_curve_extrapolation_mode (const CoreVector< CoreString > &attr_paths, unsigned int mode, unsigned short where=3, void *requester=0)
 
void remove_fcurve (const CoreString &attr_path, void *requester=0)
 
void remove_fcurve (const CoreVector< CoreString > &attr_paths, void *requester=0)
 
void bake_fcurve (const CoreVector< CoreString > &attr_paths, double frame_step=1.0, void *requester=0)
 
void set_fcurve (const CoreVector< CoreString > &attr_paths, const CoreString &serialized_fcurve, void *requester=0)
 
void set_item_view_point (const CoreString &item, const GMathVec3d &pos, const GMathVec3d &rot, const double &aim_distance, void *requester=0)
 
void add_shading_layer_rule (const CoreString &shading_layer, const unsigned int &index, const CoreVector< CoreString > &sl_params, void *requester=0)
 
void remove_shading_layer_rules (const CoreString &shading_layer, const CoreVector< unsigned int > &sl_rule_indexes, void *requester=0)
 
void set_shading_layer_rules_property (const CoreString &shading_layer, const CoreVector< unsigned int > &rule_indexes, const CoreString &property_name, const CoreVector< CoreString > &property_values, void *requester=0)
 
void move_shading_layer_rules (const CoreString &shading_layer, const CoreVector< unsigned int > &indexes, const int &move_delta, bool is_relative=true, void *requester=0)
 
void trash_items (const CoreVector< CoreString > &items_names, void *requester=0)
 
void delete_items (const CoreVector< CoreString > &items, void *requester=0)
 
void delete_item (OfItemHandle item, void *requester=0)
 
void rename_item (OfItemHandle item, const CoreString &name, void *requester=0)
 
void rename_item (const CoreString &item_name, const CoreString &new_name, void *requester=0)
 
OfObjectHandle group_items (const CoreVector< CoreString > &items_names, const CoreString &target_path, void *requester=0)
 
OfObjectHandle combine_items (const CoreVector< CoreString > &items, const CoreString &target_path, void *requester=0)
 
OfObjectHandle create_shading_layer_for_items (const CoreVector< CoreString > &items, const int &creation_node, const CoreString &target_path, void *requester=0)
 
void make_local (const CoreVector< CoreString > &item_names, bool keep_values=true, void *requester=0)
 
void make_instance (const CoreVector< CoreString > &item_names, const CoreString &source_name, void *requester=0)
 
void paste_items (const CoreString &copy_buffer, const bool &select, const CoreString &context_path, const CoreString &selection_slot, void *requester=0)
 
void move_item_to (OfConstItemHandle item, OfItemHandle target, void *requester=0)
 
void copy_item_to (OfConstItemHandle item, OfItemHandle target, void *requester=0)
 
void create_instance_to (OfConstItemHandle item, OfItemHandle target, void *requester=0)
 
void move_items_to (const CoreVector< OfItemHandle > items, OfItemHandle target, void *requester=0)
 
void copy_items_to (const CoreVector< OfItemHandle > items, OfItemHandle target, void *requester=0)
 
void create_instances_to (const CoreVector< OfItemHandle > items, OfItemHandle target, void *requester=0)
 
void paint_instance (OfConstObjectHandle source, const OfContext &ctx, const GMathVec3d &pos, const GMathVec3d &rot, const GMathVec3d &scl, void *requester=0)
 
void drag_paint_instance (const CoreString &instance_name, const CoreArray< CoreString > &previous_selection, OfConstObjectHandle source, const OfContext &ctx, void *requester=0)
 
void paint_copy (OfConstObjectHandle source, const OfContext &ctx, const GMathVec3d &pos, const GMathVec3d &rot, const GMathVec3d &scl, void *requester=0)
 
void drag_paint_copy (const CoreString &copy_name, const CoreArray< CoreString > &previous_selection, OfConstObjectHandle source, const OfContext &ctx, void *requester=0)
 
void set_items_positions (const CoreBasicArray< OfItemHandle > &items, const CoreBasicArray< GMathVec2i > &positions, const CoreString &position_slot, void *requester=0)
 
void set_item_position (OfItem *item, const GMathVec2i &position, const CoreString &position_slot, void *requester=0)
 
void set_items_nodal_properties (const CoreBasicArray< OfItemHandle > &objects, const CoreBasicArray< unsigned int > &properties, const CoreString &slot, void *requester=0)
 
void localize_attrs (const CoreVector< CoreString > &attr_paths, const bool &flag, void *requester=0)
 
void mute_local_value_attrs (const CoreVector< CoreString > &attr_paths, const bool &flag, void *requester=0)
 
void disable_attrs (const CoreVector< CoreString > &attr_paths, const bool &disable, void *requester=0)
 
void lock_attrs (const CoreBasicArray< CoreString > &attr_paths, const bool &locked, void *requester=0)
 
void lock_attr_values (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< unsigned int > &value_indices, const bool &locked, void *requester=0)
 
void center_objects_pivots (const CoreVector< CoreString > &objects, void *requester=0)
 
void center_objects_pivots (const CoreVector< CoreString > &objects, bool rest_on_ground, void *requester=0)
 
void reset_objects_pivots (const CoreVector< CoreString > &objects, void *requester=0)
 
void reset_objects_pivots (const CoreVector< CoreString > &objects, bool use_translate_offset, void *requester=0)
 
void remove_objects_offsets (const CoreVector< CoreString > &objects, void *requester=0)
 
void record_objects_offsets (const CoreVector< CoreString > &objects, void *requester=0)
 
void inplace_set_objects_translation (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, void *requester=0)
 
void inplace_set_objects_rotation (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, void *requester=0)
 
void inplace_set_objects_scaling (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, void *requester=0)
 
void set_objects_local_transform (const CoreBasicArray< CoreString > &objects, const CoreBasicArray< GMathMatrix4x4d > &values, void *requester=0)
 
void set_objects_global_transform (const CoreBasicArray< CoreString > &objects, const CoreBasicArray< GMathMatrix4x4d > &values, void *requester=0)
 
void reset_objects_transforms (const CoreBasicArray< CoreString > &objects, void *requester=0)
 
void set_objects_translation (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, const CoreString &axis, void *requester=0)
 
void set_objects_scaling (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, const CoreString &axis, void *requester=0)
 
void set_objects_rotation (const CoreVector< CoreString > &objects, const CoreVector< GMathVec3d > &values, const CoreString &axis, void *requester=0)
 
void set_reference_filename (const CoreBasicArray< OfContext * > &contexts, const CoreString &filename, void *requester=0)
 
void set_reference_filename (const CoreBasicArray< OfContext * > &contexts, const CoreArray< CoreArray< unsigned int > > &indices, const CoreBasicArray< CoreString > &filename, void *requester=0)
 
void remove_reference_filename (const CoreBasicArray< OfContext * > &contexts, const CoreArray< CoreArray< unsigned int > > &indices, void *requester=0)
 
void add_reference_filename (const CoreBasicArray< OfContext * > &contexts, const CoreBasicArray< CoreString > &filenames, void *requester=0)
 
void permute_reference_filename (const CoreBasicArray< OfContext * > &contexts, const CoreArray< CoreArray< unsigned int > > &permutations, void *requester=0)
 
void clear_context_overrides (OfContext &context, void *requester=0)
 
void cleanup_context_overrides (OfContext &context, void *requester=0)
 
void create_override_set (OfContext &context, void *requester=0)
 
void make_local_context (OfContext &context, void *requester=0)
 
void make_local_context (const CoreBasicArray< CoreString > &context_paths, void *requester=0)
 
void isolate (const CoreVector< CoreString > &items_names, void *requester=0)
 
void isolate_more (const CoreVector< CoreString > &items_names, void *requester=0)
 
void isolate_less (const CoreVector< CoreString > &items_names, void *requester=0)
 
void isolate_swap (void *requester=0)
 
void disable_item (const CoreString &item_full_name, void *requester=0)
 
void disable_items (const CoreVector< CoreString > &item_full_names, void *requester=0)
 
void enable_item (const CoreString &item_full_name, void *requester=0)
 
void enable_items (const CoreVector< CoreString > &item_full_names, void *requester=0)
 
void colortag_items (const CoreVector< CoreString > &items_names, const CoreString &tag, void *requester=0)
 
void comment_item (OfConstItemHandle item, const CoreString &comment, void *requester=0)
 
void override_attrs (const CoreVector< CoreString > &attr_paths, const CoreString &override_attr_path, void *requester=0)
 
void clear_override_attrs (const CoreVector< CoreString > &attr_paths, void *requester=0)
 
AppObjectget_application () const
 
OfCommandManagerget_command_manager () const
 
void add_custom_attribute (const CoreVector< CoreString > &items_paths, const OfItem::AttrCreationParams &creation_params, void *requester=0)
 
void add_custom_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &items_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_vh, const CoreString &group_name, void *requester=0)
 
void edit_custom_attribute (const CoreVector< CoreString > &attr_paths, const OfItem::AttrCreationParams &creation_params, void *requester=0)
 
void edit_custom_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &attr_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_vh, const CoreString &group_name, void *requester=0)
 
void remove_custom_attribute (const CoreVector< CoreString > &attr_paths, void *requester=0)
 
void set_expression (const CoreBasicArray< CoreString > &attr_names, const CoreBasicArray< CoreString > &expressions, void *requester=nullptr)
 
void activate_expression (const CoreBasicArray< CoreString > &attr_names, const CoreBasicArray< bool > &enables, void *requester=nullptr)
 
void clear_table (const CoreString &table_path)
 
void localize_table (const CoreString &table_path, bool localized)
 
void lock_table (const CoreString &table_path, bool locked)
 
void hide_table (const CoreString &table_path, bool hidden)
 
void revert_table (const CoreString &table_path)
 
void reset_table (const CoreString &table_path)
 
void add_table_row (const CoreString &table_path, unsigned int index=CORE_INVALID_INDEX)
 
void remove_table_row (const CoreString &table_path, unsigned int index=CORE_INVALID_INDEX)
 
void remove_table_rows (const CoreString &table_path, const CoreBasicArray< unsigned int > &indices)
 
void swap_table_rows (const CoreString &table_path, unsigned int first_index, unsigned int second_index)
 
void move_table_row (const CoreString &table_path, unsigned int from_index, unsigned int to_index)
 
void set_table_row (const CoreString &table_path, unsigned int index, const CoreBasicArray< CoreVariant > &values)
 
void set_table_cell (const CoreString &table_path, unsigned int row_index, unsigned int column_index, const CoreBasicArray< CoreVariant > &values)
 
void set_table_cell (const CoreString &table_path, unsigned int row_index, unsigned int column_index, const CoreVariant &value, unsigned int value_index=0u)
 
void enable_table_row (const CoreString &table_path, unsigned int index, bool enabled)
 
void enable_table_rows (const CoreString &table_path, const CoreBasicArray< unsigned int > &indices, const CoreBasicArray< bool > &enabled)
 
void clear_particles (const CoreVector< CoreString > &items_names, void *requester=0)
 
void clear_particle (const CoreString &item_name, void *requester=0)
 
void bake_particles (const CoreVector< CoreString > &items_names, const CoreString &target_path, void *requester=0)
 
void jitter_particles (const CoreVector< CoreString > &items_names, const GMathVec3d &variance, unsigned short space, bool keep_sign, void *requester=0)
 
void jitter_particle (const CoreString &item_name, const GMathVec3d &variance, unsigned short space, bool keep_sign, void *requester=0)
 
void activate_package_edit_layer (const CoreString &build_package_path, int layer_index)
 
void add_package_edit_layer (const CoreString &build_package_path, const CoreString &layer_name="", int layer_index=-1, int parent_group_index=-1)
 
void remove_package_edit_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices)
 
void clear_package_edit_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices)
 
void merge_package_edit_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices, bool discard_disabled, bool preserve_locked=true)
 
void duplicate_package_edit_layer (const CoreString &build_package_path, unsigned int layer_index, unsigned int new_layer_index)
 
void disable_package_layer (const CoreString &build_package_path, unsigned int layer_index, bool value)
 
void disable_package_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices, bool value)
 
void rename_package_layer (const CoreString &build_package_path, unsigned int layer_index, const CoreString &name)
 
void comment_package_layer (const CoreString &build_package_path, unsigned int layer_index, const CoreString &comment)
 
void comment_package_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices, const CoreString &comment)
 
void lock_package_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &layer_indices, bool lock)
 
void move_package_layer (const CoreString &build_package_path, unsigned int layer_index, unsigned int new_layer_index)
 
void permute_package_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &new_layer_indices, const CoreBasicArray< unsigned int > &layers_to_reparent, int new_parent=-1)
 
void add_package_preset (const CoreString &build_package_path, const CoreString &name, bool is_published, const CoreString &description)
 
void remove_package_preset (const CoreString &build_package_path, const CoreString &name)
 
void remove_all_package_presets (const CoreString &build_package_path)
 
void duplicate_package_preset (const CoreString &build_package_path, const CoreString &name)
 
void rename_package_preset (const CoreString &build_package_path, const CoreString &name, const CoreString &new_name)
 
void publish_package_preset (const CoreString &build_package_path, const CoreString &name, bool is_published)
 
void comment_package_preset (const CoreString &build_package_path, const CoreString &name, const CoreString &description)
 
void group_package_layers (const CoreString &build_package_path, const CoreString &group_name="", int layer_index=-1, int count=0, int parent_group_index=-1)
 
void ungroup_package_layers (const CoreString &build_package_path, const CoreBasicArray< unsigned int > &group_indices, bool preserve_locked=true)
 
- 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_combine_items_pivot_name (const CombineItemsPivot &value)
 
static bool is_context_writable (const OfContext &context)
 
static bool is_item_move_allowed (OfConstItemHandle item, const OfContext *destination_ctx, bool ignore_item_move_cap=false)
 
static bool is_item_copy_to_allowed (OfConstItemHandle item, const OfContext &destination_ctx, const bool allow_in_parent_context=true)
 
static bool is_item_instantiate_allowed (OfConstItemHandle item, const OfContext &destination_ctx)
 
- 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.
 

Friends

class CmdDuplicatePackageEditLayer
 

Member Function Documentation

void AppBuiltinCommands::activate_expression ( const CoreBasicArray< CoreString > &  names,
const CoreBasicArray< bool > &  enables,
void *  requester = nullptr 
)

Activate/Deactivate expressions on a list of attributes.

Parameters
attr_namesThe list of attributes' paths
enableIf true, will activate the expression, otherwise will deactivate it.
requester??
void AppBuiltinCommands::activate_package_edit_layer ( const CoreString build_package_path,
int  layer_index 
)

Set the active edit layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex to make active (-1 to reset)
void AppBuiltinCommands::add_package_edit_layer ( const CoreString build_package_path,
const CoreString layer_name = "",
int  layer_index = -1,
int  parent_group_index = -1 
)

Add a new empty edit layer in a build package

Parameters
build_package_pathfull path of the build package
layer_nameRequested name for new layer
layer_indexIndex to insert at (-1 to add on top of stack).
parent_group_indexIndex of group to parent to (-1 to set no parent).
void AppBuiltinCommands::add_package_preset ( const CoreString build_package_path,
const CoreString name,
bool  is_published,
const CoreString description 
)

Add a new preset corresponding to the current edits layers visibilities

Parameters
build_package_pathfull path of the build package
namename of the preset
is_publisheddoes this preset must be displayed in the build package preset attribute?
descriptiondescription of this preset
void AppBuiltinCommands::add_table_row ( const CoreString table_path,
unsigned int  index = CORE_INVALID_INDEX 
)

Add a new row at the given index

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indexOptional index where to add the row. By default, the row is added at the end of the table.
void AppBuiltinCommands::clear_package_edit_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices 
)

Clear all edits of the given edit layers in a build package

Parameters
build_package_pathfull path of the build package
layer_indiceslist of indices of edit layers in the build package to clear
void AppBuiltinCommands::clear_table ( const CoreString table_path)

Clear the whole table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
void AppBuiltinCommands::comment_package_layer ( const CoreString build_package_path,
unsigned int  layer_index,
const CoreString comment 
)

Comment the given layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex of the layer in the build package to comment
commentnew comment of the layer
void AppBuiltinCommands::comment_package_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices,
const CoreString comment 
)

Comment the given layers in a build package

Parameters
build_package_pathfull path of the build package
layer_indicesindices of the layers in the build package to comment
commentnew comment of the layers
void AppBuiltinCommands::comment_package_preset ( const CoreString build_package_path,
const CoreString name,
const CoreString description 
)

Change the description of a preset in a build package

Parameters
build_package_pathfull path of the build package
namename of the preset
descriptionthe description to set to the preset
void AppBuiltinCommands::declare_edit_layer_commands ( void  )

Register layer related commands.

Note
Calling register_command with the same command name will return the same command caller instance, and will just add new signatures
void AppBuiltinCommands::declare_expression_commands ( void  )

Register expression related commands

void AppBuiltinCommands::declare_table_commands ( void  )

Register expression related commands.

Note
Calling register_command with the same command name will return the same command caller instance, and will just add new signatures
void AppBuiltinCommands::disable_package_layer ( const CoreString build_package_path,
unsigned int  layer_index,
bool  value 
)

Disable/Enable the given layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex of the layer in the build package to disable/enable
valueif true, the layer is disabled, otherwise it is enabled
void AppBuiltinCommands::disable_package_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices,
bool  value 
)

Disable/Enable the given layers in a build package

Parameters
build_package_pathfull path of the build package
layer_indicesindices of the layers in the build package to disable/enable
valueif true, the layers are disabled, otherwise they are enabled
void AppBuiltinCommands::duplicate_package_edit_layer ( const CoreString build_package_path,
unsigned int  layer_index,
unsigned int  new_layer_index 
)

Duplicate an edit layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex of the layer to duplicate
new_layer_indexindex of the created layer
void AppBuiltinCommands::duplicate_package_preset ( const CoreString build_package_path,
const CoreString name 
)

Duplicate a preset in a build package

Parameters
build_package_pathfull path of the build package
namename of the preset
void AppBuiltinCommands::enable_table_row ( const CoreString table_path,
unsigned int  index,
bool  enabled 
)

Enable or disable a single row of a table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indexIndex of the row.
enabledEnabled state of the row.
void AppBuiltinCommands::enable_table_rows ( const CoreString table_path,
const CoreBasicArray< unsigned int > &  indices,
const CoreBasicArray< bool > &  enabled 
)

Enable or disable multiple rows.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indicesIndices of the rows.
enabledEnabled states of the rows. Their number must match the number of indices.
void AppBuiltinCommands::group_package_layers ( const CoreString build_package_path,
const CoreString group_name = "",
int  layer_index = -1,
int  count = 0,
int  parent_group_index = -1 
)

Create a layer group in a build package

Parameters
build_package_pathfull path of the build package
group_nameRequested name for the new group
layer_indexIndex where to start the group (first layer in group). If count is null, layer_index is just used to specify the location of the new group in hierarchy.
countnumber of consecutive layers moved into the group
parent_group_indexUsed only if count is null, to specify the location of the new group in hierarchy. (If count is not null, the new group will be child of the former parent of first grouped layer)
void AppBuiltinCommands::hide_table ( const CoreString table_path,
bool  hidden 
)

Hide or show the whole table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
hiddenHidden state of the table: if true the whole table is hidden, otherwise it's shown.
void AppBuiltinCommands::localize_table ( const CoreString table_path,
bool  localized 
)

Set the localized state of the whole table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
localizedThe localized state of the table.
void AppBuiltinCommands::lock_package_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices,
bool  lock 
)

Lock/unlock the given layers in a build package

Parameters
build_package_pathfull path of the build package
layer_indicesindices of the layers in the build package to lock/unlock
lockif true, the layers are locked, otherwise they are unlocked
void AppBuiltinCommands::lock_table ( const CoreString table_path,
bool  locked 
)

Lock or unlock the whole table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
lockedLocked state of the table: if true the whole table is locked, otherwise it's unlocked.
void AppBuiltinCommands::merge_package_edit_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices,
bool  discard_disabled,
bool  preserve_locked = true 
)

Merge the given edit layers into the first one

Parameters
build_package_pathfull path of the build package
layer_indiceslist of indices of edit layers in the build package to merge. If empty, all layers are merged and disabled layers are discarded.
discard_disabledif true, the disabled layers in the given list are discarded, otherwise, there are kept
preserve_lockedif true, the locked layers in the given list are kept, otherwise there are merged
void AppBuiltinCommands::move_package_layer ( const CoreString build_package_path,
unsigned int  layer_index,
unsigned int  new_layer_index 
)

Move a layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex of the layer to move
new_layer_indexnew index of the layer
void AppBuiltinCommands::move_table_row ( const CoreString table_path,
unsigned int  from_index,
unsigned int  to_index 
)

Move a row to another index without changing the relative order of the other rows.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
from_indexIndex of the row to move
to_indexThe index the row will have after the operation
void AppBuiltinCommands::permute_package_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  new_layer_indices,
const CoreBasicArray< unsigned int > &  layers_to_reparent,
int  new_parent = -1 
)

Reorder the layers of a build package Each layer must have a new index specification, no unicity or range check done. No unicity or range check done about hierarchy either.

Parameters
build_package_pathfull path of the build package
new_layer_indicesrequested indices of layers in the build package to reorder.
layers_to_reparentindices of layers that need reparenting
new_parentindex of group to reparent to
void AppBuiltinCommands::publish_package_preset ( const CoreString build_package_path,
const CoreString name,
bool  is_published 
)

Specify if a preset must be exposed in the attribute editor of a build package

Parameters
build_package_pathfull path of the build package
namename of the preset
is_publishedthe value
void AppBuiltinCommands::remove_all_package_presets ( const CoreString build_package_path)

Remove all presets from a build package

Parameters
build_package_pathfull path of the build package
void AppBuiltinCommands::remove_package_edit_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  layer_indices 
)

Remove the given edit layers from a build package

Parameters
build_package_pathfull path of the build package
layer_indiceslist of indices of edit layers in the build package to remove
void AppBuiltinCommands::remove_package_preset ( const CoreString build_package_path,
const CoreString name 
)

Remove a preset from a build package

Parameters
build_package_pathfull path of the build package
namename of the preset
void AppBuiltinCommands::remove_table_row ( const CoreString table_path,
unsigned int  index = CORE_INVALID_INDEX 
)

Remove an existing row at the given index

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indexOptional index of the row to remove. By default, removes the last row.
void AppBuiltinCommands::remove_table_rows ( const CoreString table_path,
const CoreBasicArray< unsigned int > &  indices 
)

Remove multiple rows in 1 command.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indicesRow indices to remove.
void AppBuiltinCommands::rename_package_layer ( const CoreString build_package_path,
unsigned int  layer_index,
const CoreString name 
)

Rename the given layer in a build package

Parameters
build_package_pathfull path of the build package
layer_indexindex of the layer in the build package to rename
namenew name of the layer
void AppBuiltinCommands::rename_package_preset ( const CoreString build_package_path,
const CoreString name,
const CoreString new_name 
)

Rename a preset in a build package

Parameters
build_package_pathfull path of the build package
namename of the preset
new_namenew name to give to the preset
void AppBuiltinCommands::reset_table ( const CoreString table_path)

Reset all columns of a table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
void AppBuiltinCommands::revert_table ( const CoreString table_path)

Revert all columns of a table.

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
void AppBuiltinCommands::set_expression ( const CoreBasicArray< CoreString > &  attr_names,
const CoreBasicArray< CoreString > &  expressions,
void *  requester = nullptr 
)

Set an expression to a list of attributes. Expressions set will also be activated. If an expression is an empty string, it will unbind the expression (if any) from the corresponding attribute.

Parameters
attr_namesThe list of attributes' paths
expressionsThe list of expressions. Must have the same number of elements as attr_names.
requester??
void AppBuiltinCommands::set_table_cell ( const CoreString table_path,
unsigned int  row_index,
unsigned int  column_index,
const CoreBasicArray< CoreVariant > &  values 
)

Set a table cell values. The number of values must match the stride of the cell (e.g. if the column is of type 'double[3]', you need to provide 3 values)

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
row_indexIndex of the row.
column_indexIndex of the column.
valuesThe values of the cell.
void AppBuiltinCommands::set_table_cell ( const CoreString table_path,
unsigned int  row_index,
unsigned int  column_index,
const CoreVariant value,
unsigned int  value_index = 0u 
)

Set a table cell value. This allows to set the Nth value of a single cell (e.g. you want to set the 2d component if your cell has a type 'double[3]')

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
row_indexIndex of the row.
column_indexIndex of the column.
valueThe value.
value_indexThe index of the value in the cell. 0 by default.
void AppBuiltinCommands::set_table_row ( const CoreString table_path,
unsigned int  index,
const CoreBasicArray< CoreVariant > &  values 
)

Set a table row values. You must provide the exact number of values to fill the row (e.g. if you have a 'bool' and a 'double[3]' column, you need to provide 4 values)

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
indexIndex of the row to set.
valuesThe values for the rows.
void AppBuiltinCommands::swap_table_rows ( const CoreString table_path,
unsigned int  first_index,
unsigned int  second_index 
)

Swap 2 rows of a table

Parameters
table_pathPath of the table: it's the same syntax as an attribute path where the attr name is the table name.
first_indexIndex of the first row
second_indexIndex of the second row
void AppBuiltinCommands::ungroup_package_layers ( const CoreString build_package_path,
const CoreBasicArray< unsigned int > &  group_indices,
bool  preserve_locked = true 
)

Remove group layers from a build package

Parameters
build_package_pathfull path of the build package
group_indicesindex of the groups to remove. For each group, the child layers are reparented to upper group if any
preserve_lockedIf true, the locked groups in the given list are kept, otherwise, there are removed.