Hi,
I have noticed that many functions just do not have documentation available online and I am wondering if omniverse is free or do I need to get enterprise version to get access to documentation?
For example, if you were to look at the methods that some function has lets say the viewport.
vp_window_active = get_active_viewport_window()
viewport_api = vp_window_active.viewport_api
print(f"Attributes and methods of viewport_api: {dir(viewport_api)}")
This is what the output will be:
[py stdout]: Attributes and methods of viewport_api: ['_ViewportAPI__ViewportSubscription',
'_ViewportAPI__accelerate_rtx_changed', '_ViewportAPI__accelerate_rtx_picking',
'_ViewportAPI__accelerate_rtx_picking_sub', '_ViewportAPI__aspect_ratios', '_ViewportAPI__callback_args',
'_ViewportAPI__clean_weak_views', '_ViewportAPI__create_scene_camera_model', '_ViewportAPI__fill_frame',
'_ViewportAPI__first_synch', '_ViewportAPI__flat_rendered_projection', '_ViewportAPI__flatten_matrix',
'_ViewportAPI__frame_changed', '_ViewportAPI__freeze_frame', '_ViewportAPI__get_conform_policy',
'_ViewportAPI__hydra_texture', '_ViewportAPI__is_requires_scene_camera_model',
'_ViewportAPI__lock_to_render_result', '_ViewportAPI__ndc_to_world', '_ViewportAPI__notify_objects',
'_ViewportAPI__notify_scene_views', '_ViewportAPI__projection', '_ViewportAPI__render_settings_changed',
'_ViewportAPI__requires_scene_camera_model', '_ViewportAPI__scene_camera_model',
'_ViewportAPI__scene_camera_model_import_failed', '_ViewportAPI__scene_views',
'_ViewportAPI__set_hydra_texture', '_ViewportAPI__subscribe_to_change', '_ViewportAPI__time',
'_ViewportAPI__transform', '_ViewportAPI__updates_enabled', '_ViewportAPI__usd_context_name',
'_ViewportAPI__view', '_ViewportAPI__view_changed', '_ViewportAPI__viewport_changed',
'_ViewportAPI__viewport_id', '_ViewportAPI__viewport_texture', '_ViewportAPI__world_to_ndc', '__class__',
'__del__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__',
'__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__',
'__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__',
'_conform_projection', '_hydra_texture', '_notify_frame_change', '_notify_render_settings_change',
'_scene_camera_model', '_settings_path', '_sync_viewport_api', '_viewport_texture', 'add_scene_view',
'camera_path', 'display_render_var', 'fill_frame', 'fps', 'frame_info', 'freeze_frame', 'full_resolution',
'get_active_camera', 'get_full_texture_resolution', 'get_render_product_path', 'get_texture_resolution',
'get_texture_resolution_scale', 'hydra_engine', 'id', 'lock_to_render_result', 'map_ndc_to_texture',
'map_ndc_to_texture_pixel', 'ndc_to_world', 'pick', 'projection', 'query', 'remove_scene_view', 'render_mode',
'render_product_path', 'request_pick', 'request_query', 'resolution', 'resolution_scale', 'schedule_capture',
'set_active_camera', 'set_hd_engine', 'set_render_product_path', 'set_texture_resolution',
'set_texture_resolution_scale', 'set_updates_enabled', 'stage', 'subscribe_to_frame_change',
'subscribe_to_render_settings_change', 'subscribe_to_view_change', 'time', 'transform', 'updates_enabled',
'usd_context', 'usd_context_name', 'view', 'viewport_changed', 'wait_for_render_settings_change',
'wait_for_rendered_frames', 'world_to_ndc']
Now I want to get documenation about:
viewport_api.pick()
viewport_api.request_pick()
They are present in the list of methods above but I cannot find them online. Is this documentation missing, or is it not available to public or something on those lines? I have noticed this with a few other scenarios as well hence the question.
I know its a weird question but would love to know whats happening.
Thanks a lot,
Siddharth