Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Static Public Member Functions | List of all members
SdkHelpers Class Reference

This static class defines SDK/Script Items function helpers. More...

Inheritance diagram for SdkHelpers:
CoreBaseType

Static Public Member Functions

static OfObjectgroup_items_selected (AppObject &app)
 
static OfObjectcombine_items_selected (AppObject &app, const unsigned int &mode=0)
 
static OfObjectcreate_shading_layer_for_items_selected (AppObject &app, int creation_mode)
 
static void delete_items_selected (AppObject &app)
 
static void trash_items_selected (AppObject &app)
 
static CoreArray< OfItemHandleinstantiate_items_selected (AppObject &app)
 
static void copy_items_selected (AppObject &app)
 
static void paste (AppObject &app)
 
static void cut_items_selected (AppObject &app)
 
static void make_local_items_selected (AppObject &app)
 
static void make_instance_items_selected (AppObject &app, OfItemHandle source)
 
static void toggle_items_selected_display (AppObject &app, const bool &display)
 
static void enable_disable_items_selected (AppObject &app, const bool &disable)
 
static void isolate_items_selected (AppObject &app)
 
static void isolate_more_items_selected (AppObject &app)
 
static void isolate_less_items_selected (AppObject &app)
 
static void isolate_swap_items_selected (AppObject &app)
 
static void colortag_items_selected (AppObject &app, const CoreString &tag)
 
static void center_objects_pivots_items_selected (AppObject &app, bool rest_on_ground)
 
static void reset_pivots_items_selected (AppObject &app, bool use_translate_offset)
 
static void remove_offsets_items_selected (AppObject &app)
 
static void record_offsets_items_selected (AppObject &app)
 
static void reset_transforms_items_selected (AppObject &app)
 
static void contextualize_items (AppObject &app)
 
static void revert_items_overrides (AppObject &app)
 
static void revert_sub_items_overrides (AppObject &app)
 
static bool export_nodes_as_build_package (AppObject &app, int mode=2, const CoreString &path=CoreString::get_null_string())
 
static CoreArray< OfItemHandleset_vizroot_from_selection (AppObject &app, bool select_origin_item)
 Set the application Vizroot from the current selection.
 
static OfObjectHandle group_items (AppObject &app, const OfContext &working_context, const CoreVector< OfItemHandle > &selection)
 
static OfObjectHandle combine_items (AppObject &app, const OfContext &working_context, const CoreVector< OfItemHandle > &selection, const unsigned int &mode=0)
 
static OfObjectHandle create_shading_layer_for_items (AppObject &app, const OfContext &working_context, const CoreVector< OfItemHandle > &selection, int creation_mode)
 
static void delete_items (AppObject &app, CoreVector< OfItemHandle > &selection)
 
static void trash_items (AppObject &app, CoreVector< OfItemHandle > &selection)
 
static CoreArray< OfItemHandleinstantiate_items (AppObject &app, CoreVector< OfItemHandle > &selection, const CoreString &selection_slot)
 
static void copy_items (AppObject &app, const CoreVector< OfItemHandle > &selection, bool include_dependencies=false)
 
static void cut_items (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void make_local_items (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void make_instance_items (AppObject &app, const CoreVector< OfItemHandle > &selection, OfItemHandle source)
 
static void toggle_items_display (AppObject &app, const CoreVector< OfItemHandle > &selection, const bool &display)
 
static void enable_disable_items (AppObject &app, const CoreVector< OfItemHandle > &selection, const bool &disable)
 
static void colortag_items (AppObject &app, const CoreVector< OfItemHandle > &selection, const CoreString &tag)
 
static void isolate_items (AppObject &app, const CoreVector< OfItemHandle > &selection, int mode)
 
static void center_objects_pivots (AppObject &app, const CoreVector< OfItemHandle > &selection, bool rest_on_ground)
 
static void reset_pivots (AppObject &app, const CoreVector< OfItemHandle > &selection, bool use_translate_offset)
 
static void remove_offsets (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void record_offsets (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void reset_transforms (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void contextualize_items (AppObject &app, const OfContext &working_context, const CoreVector< OfItemHandle > &selection)
 
static OfContextcreate_context (AppObject &app, const OfContext &working_context)
 
static bool export_context_as_reference (AppObject &app, OfContext &context, const CoreString &path)
 
static bool import_nodes_from_build_package (AppObject &app, OfContext &context)
 
static bool export_nodes_as_build_package (AppObject &app, const CoreVector< OfItemHandle > &selection, int mode=2, const CoreString &path=CoreString::get_null_string())
 
static void revert_items_overrides (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static void revert_sub_items_overrides (AppObject &app, const CoreVector< OfItemHandle > &selection)
 
static CoreArray< OfItemHandleset_vizroot_from_selection (AppObject &app, const CoreVector< OfItemHandle > &selection, bool select_origin_item)
 Set the application Vizroot from a given selection.
 
static void log_item_usage (const CoreHashTable< OfItem *, CoreSet< OfItem * > > &items, CoreString &log_msg)
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Additional Inherited Members

- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Detailed Description

This static class defines SDK/Script Items function helpers.

Member Function Documentation

CoreArray< OfItemHandle > SdkHelpers::set_vizroot_from_selection ( AppObject app,
bool  select_origin_item 
)
static

Set the application Vizroot from the current selection.

Parameters
appcurrent application
select_origin_itemif true, it selects the origin of the selected item in the scene assembly, and then set the vizroot from on its root context. Otherwise, it just set the vizroot from the root context of the selected item
Returns
the new selection in the new vizroot
CoreArray< OfItemHandle > SdkHelpers::set_vizroot_from_selection ( AppObject app,
const CoreVector< OfItemHandle > &  selection,
bool  select_origin_item 
)
static

Set the application Vizroot from a given selection.

Parameters
appcurrent application
selectioncurrent selection
select_origin_itemif true, it selects the origin of the selected item in the scene assembly, and then set the vizroot from on its root context. Otherwise, it just set the vizroot from the root context of the selected item
Returns
the new selection in the new vizroot