Clarisse 4.0 SP9 SDK  4.0.0.0.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
AppBuiltinCommands Class Reference
Inheritance diagram for AppBuiltinCommands:
CoreBaseObject CoreBaseType

Public Types

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_shading_layer_commands ()
 
void declare_isolate_commands ()
 
void declare_flag_commands (AppObject &app)
 
void declare_move_copy_commands ()
 
void declare_particle_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)
 
OfObjectcreate_object (const CoreString &object_name, const CoreString &class_name, const CoreString &selection_slot=GLOBAL_SLOT, const CoreString &context_path="", void *requester=0)
 
OfObjectcreate_reference (const CoreBasicArray< CoreString > &attributes, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectcreate_reference (const CoreString &attribute, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectcreate_texture (const CoreBasicArray< CoreString > &attributes, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectcreate_texture (const CoreString &attribute, const CoreString &class_name, const CoreString &context_name="", void *requester=0)
 
OfObjectcreate_group (const CoreBasicArray< CoreString > &attributes, const CoreBasicArray< CoreString > &elements, const CoreString &group_name, const CoreString &context_name="", void *requester=0)
 
OfObjectcreate_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)
 
CoreArray< OfItem * > instantiate (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)
 
void set_value (const CoreString &attr_path, const CoreBasicArray< CoreString > &values, void *requester=0)
 
void set_value (const CoreBasicArray< CoreString > &attr_paths, const CoreString &value, void *requester=0)
 
void set_value (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< CoreString > &values, void *requester=0)
 
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 OfAttr &destination_attr, void *requester)
 
void add_value (const CoreBasicArray< CoreString > &attr_paths, const CoreBasicArray< CoreString > &values, void *requester=0)
 
void add_value (const CoreBasicArray< CoreString > &attr_paths, const CoreString &value, void *requester=0)
 
void add_value (const CoreString &attr_path, const CoreBasicArray< CoreString > &values, void *requester=0)
 
void add_value (const CoreString &attr_path, const CoreString &value, void *requester=0)
 
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)
 
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 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, 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)
 
void remove_value (const CoreBasicArray< CoreString > &attr_paths, const CoreArray< CoreArray< unsigned int > > &indices, void *requester=0)
 
void remove_value (const CoreBasicArray< CoreString > &attr_paths, const CoreArray< unsigned int > &indices, void *requester=0)
 
void remove_all_values (const CoreString &attr_path, void *requester=0)
 
void remove_all_values (const CoreVector< CoreString > &attr_path, void *requester=0)
 
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)
 
void set_texture (const CoreArray< CoreString > &attr_paths, const CoreString &texture, void *requester=0)
 
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)
 
void set_binding (const CoreArray< CoreString > &attr_paths, const CoreString &plug_output, void *requester=0)
 
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 set_keys_property_values (const CoreVector< CoreString > &attr_path, const CoreVector< unsigned int > &indexes, const CoreString &property_name, const CoreVector< CoreString > &property_values)
 
void set_keys_property_values (const CoreVector< CoreString > &attr_path, const CoreVector< unsigned int > &indexes, const CoreString &property_name, const CoreVector< CoreString > &property_values, const CoreVector< CoreString > &property_undo_values, 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 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 (OfItem &item, void *requester=0)
 
void rename_item (OfItem &item, const CoreString &name, void *requester=0)
 
void rename_item (const CoreString &item_name, const CoreString &new_name, void *requester=0)
 
OfObjectgroup_items (const CoreVector< CoreString > &items_names, const CoreString &target_path, void *requester=0)
 
OfObjectcombine_items (const CoreVector< CoreString > &items, const CoreString &target_path, void *requester=0)
 
OfObjectcreate_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, 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 (const OfItem &item, OfItem &target, void *requester=0)
 
void copy_item_to (const OfItem &item, OfItem &target, void *requester=0)
 
void create_instance_to (const OfItem &item, OfItem &target, void *requester=0)
 
void move_items_to (const CoreVector< OfItem * > items, OfItem &target, void *requester=0)
 
void copy_items_to (const CoreVector< OfItem * > items, OfItem &target, void *requester=0)
 
void create_instances_to (const CoreVector< OfItem * > items, OfItem &target, void *requester=0)
 
void paint_instance (const ModuleSceneItem &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, const ModuleSceneItem &source, const OfContext &ctx, void *requester=0)
 
void paint_copy (const ModuleSceneItem &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, const ModuleSceneItem &source, const OfContext &ctx, void *requester=0)
 
void set_items_positions (const CoreBasicArray< OfItem * > &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< OfItem * > &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 localize_attrs_in (const CoreString &object, const CoreArray< CoreString > &attrs, CoreArray< CoreString > &path, 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 (const OfItem &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_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)
 
- 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
 
CoreString get_class_interface () const
 
const unsigned long & get_class_info_id () const
 
bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
bool operator== (const CoreBaseObject &obj) 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
 
bool operator== (const CoreBaseType &obj) 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 (const OfItem &item, const OfContext *destination_ctx)
 
static bool is_item_copy_to_allowed (const OfItem &item, const OfContext &destination_ctx, const bool allow_in_parent_context=true)
 
static bool is_item_instantiate_allowed (const OfItem &item, const OfContext &destination_ctx)
 
- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
static bool ___class_destructor__ (void *instance, const bool &is_array)
 
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 bool ___class_destructor__ (void *instance, const bool &is_array)
 
static const CoreClassInfoclass_info ()
 

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::declare_expression_commands ( void  )

Register expression related commands

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??