omni.usd Functions

Functions Summary:

attr_has_timesample_on_key	Internal. If attribute has authored value to the specific time code.
can_be_copied	Internal. If the prim can be copied. A prim can be copied means the prim is authored to the local layer stack directly.
can_prim_have_children	Internal. If a prim can have children authored.
check_ancestral	Check if prim is brought into composition by its ancestor.
clear_attr_val_at_time	Clears attribute at specified timecode.
copy_timesamples_from_weaker_layer	Internal. Copy timesamples of the attribute from weak layer to the current edit target.
correct_filename_case	Internal.
create_material_input	Creates a material input.
duplicate_prim	Duplicate prim.
find_path_in_nodes	Internal. Finds specific spec recursively from node’s layer stack.
find_spec_on_session_or_its_sublayers	Finds spec in the session layer or its sublayers.
gather_default_attributes	Internal. Gets default attributes for specific prim type.
get_all_sublayers	Gets all sublayers from local layer stack of the stage ranking from strongest to weakest.
get_attribute_effective_defaultvalue_layer_info	Internal. Gets the strength type and layer for the default value of the attribute.
get_attribute_effective_timesample_layer_info	Internal. Gets the strength type and layer for the timesamples of the attribute.
get_attribute_effective_value_layer_info	Internal. Gets the strength type and layer for the default value or timesamples of the attribute.
get_audio_prim_list	Gets pre-defined audio types.
get_authored_prim	Internal.
get_composed_payloads_from_prim	Gets composed payload list from prim.
get_composed_references_from_prim	Gets composed reference list from prim.
get_context_from_stage	Gets corresponding UsdContext of the stage if it’s found.
get_dirty_layers	Gets all dirty layers that have unsaved changes.
get_edit_target_identifier	Gets the layer identifier of current edit target.
get_frame_time	Internal. Utility to convert time code into frame time.
get_frame_time_code	Internal. Utility to convert fps into time code.
get_geometry_standard_prim_list	Gets a list of pre-defined geometry types.
get_introducing_layer	Gets the introducing layer.
get_light_prim_list	Gets a list of pre-defined light types.
get_local_transform_SRT	Internal. Return a tuple of [scale, rotation, rotation_order, translate] for given prim.
get_local_transform_matrix	Gets local transform matrix of specific time code from prim.
get_prim_at_path	Internal. Gets prim at specific path.
get_prim_descendents	Internal. Returns all descendants for a given prim.
get_prop_at_path	Internal. Gets property at specific path.
get_prop_auto_target_session_layer	Get property auto retarget layer.
get_sdf_layer	Internal. Gets the introducing layer of the prim.
get_shader_from_material
get_stage_next_free_path	Gets a new prim path that doesn’t exist in the stage given a base path.
get_subidentifier_from_material	Deprecated. Use {py:func}`omni.kit.material.library.get_subidentifier_from_material` instead.
get_subidentifier_from_mdl	Deprecated. Use {py:func}`omni.kit.material.library.get_subidentifier_from_mdl` instead.
get_timesamples_count_in_authoring_layer	Internal. Gets the count of timesamples of the attribute in the current edit target.
get_url_from_prim	Returns url of Prim when authored reference or None.
get_world_transform_matrix	Gets work transform matrix of specific time code from prim.
handle_exception	Decorator to print exception in async functions.
is_ancestor_prim_type	Internal. If any parent prims of the prim are specific type.
is_child_type	Internal. If prim has specific type of children.
is_hidden_type	Internal. If prim or its parent has metadata “hide_in_stage_window” authored.
is_layer_locked	Checkes if layer is locked or not in this usd context.
is_layer_writable	Checks if layer is writable on file system.
is_path_valid	Internal. If the path points to a valid USD object in the default UsdContext.
is_prim_material_supported	Internal. If material can be bound to the prim.
is_usd_readable_filetype	Whether the given file path is a supported readable USD file or not.
is_usd_writable_filetype	Whether the given file path is a supported writable USD file or not.
make_path_relative_to_current_edit_target	Make path relative to the current edit target of the stage.
on_layers_saved_result	Internal callback.
on_stage_result	Internal callback.
readable_usd_dotted_file_exts	Gets a list of file extensions about readable USD formats.
readable_usd_file_exts	Gets a list of file extensions (without dots) about readable USD formats.
readable_usd_file_exts_str	Gets a string that includes all readable USD file formats supported by Kit.
readable_usd_files_desc	Gets a description of all readable USD file formats.
readable_usd_re	Gets the regex that matches readable USD files.
remove_property	Removes specified property from the prim.
set_attr_val	Deprecated. See :func:`.set_prop_val` instead.
set_edit_target_by_identifier	Sets the edit target of stage by layer identifier.
set_prop_val	Sets the value of property.
stitch_prim_specs	Sitches prim specs specified by path scattered in all sublayers and all its children to target layer.
writable_usd_dotted_file_exts	Gets a list of file extensions about writable USD formats.
writable_usd_file_exts	Gets a list of file extensions (without dots) about writable USD formats.
writable_usd_file_exts_str	Gets a string that includes all writable USD file formats supported by Kit.
writable_usd_files_desc	Gets a description of all writable USD file formats.
writable_usd_re	Gets the regex that matches writable USD files.
add_hydra_engine	add_hydra_engine(name: str, context: omni.usd._usd.UsdContext) -> None
attach_all_hydra_engines	attach_all_hydra_engines(context: omni.usd._usd.UsdContext) -> None
create_context	create_context(name: str = ‘’) -> omni.usd._usd.UsdContext
destroy_context	destroy_context(name: str = ‘’) -> bool
get_context	get_context(name: str = ‘’) -> omni.usd._usd.UsdContext
get_context_from_stage_id	get_context_from_stage_id(stage_id: int) -> omni.usd._usd.UsdContext
merge_layers	merge_layers(dst_layer_identifier: str, src_layer_identifier: str, dst_is_stronger_than_src: bool = True, src_layer_offset: float = 0.0, src_layer_scale: float = 1.0) -> bool
merge_prim_spec	merge_prim_spec(dst_layer_identifier: str, src_layer_identifier: str, prim_spec_path: str, dst_is_stronger_than_src: bool = True, target_prim_path: str = ‘’) -> None
release_all_hydra_engines	release_all_hydra_engines(context: omni.usd._usd.UsdContext = None) -> None
resolve_paths	resolve_paths(src_layer_identifier: str, dst_layer_identifier: str, store_relative_path: bool = True, relative_to_src_layer: bool = False, copy_sublayer_offsets: bool = False) -> None
resolve_prim_path_references	resolve_prim_path_references(layer: str, old_prim_path: str, new_prim_path: str) -> None
resolve_prim_paths_references	resolve_prim_paths_references(layer: str, old_prim_paths: List[str], new_prim_paths: List[str]) -> None
shutdown_usd	shutdown_usd() -> None