file_path
stringlengths 21
202
| content
stringlengths 19
1.02M
| size
int64 19
1.02M
| lang
stringclasses 8
values | avg_line_length
float64 5.88
100
| max_line_length
int64 12
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/include/omni/ui/bind/DocSimpleListModel.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_SimpleListModel \
"A very simple model that holds the the root model and the flat list of models.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_SimpleListModel_getItemChildren \
"Reimplemented. Returns the vector of items that are nested to the given parent item.\n"
#define OMNIUI_PYBIND_DOC_SimpleListModel_appendChildItem \
"Reimplemented. Creates a new item from the value model and appends it to the list of the children of the given item.\n"
#define OMNIUI_PYBIND_DOC_SimpleListModel_removeItem "Reimplemented. Removes the item from the model.\n"
#define OMNIUI_PYBIND_DOC_SimpleListModel_getItemValueModel \
"Reimplemented. Get the value model associated with this item.\n"
#define OMNIUI_PYBIND_DOC_SimpleListModel_SimpleListModel \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `rootModel :`\n" \
" The model that will be returned when querying the root item.\n" \
"\n" \
" `models :`\n" \
" The list of all the value submodels of this model.\n"
| 2,628 | C | 63.12195 | 124 | 0.414764 |
omniverse-code/kit/include/omni/ui/bind/DocIntField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_IntField \
"The IntField widget is a one-line text editor with a string model.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_IntField_IntField "Construct IntField.\n"
| 776 | C | 44.70588 | 120 | 0.643041 |
omniverse-code/kit/include/omni/ui/bind/Pybind.h | // Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#ifdef _MSC_VER
// WAR Pybind11 issue with VS2019+: https://github.com/pybind/pybind11/issues/3459
// Also: https://github.com/microsoft/onnxruntime/issues/9735
#include <corecrt.h>
#endif
#include <pybind11/functional.h>
#include <pybind11/pybind11.h>
| 702 | C | 35.999998 | 82 | 0.782051 |
omniverse-code/kit/include/omni/ui/bind/BindOffsetLine.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindFreeShape.h"
#include "BindUtils.h"
#include "DocOffsetLine.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_OffsetLine \
OMNIUI_PYBIND_INIT_FreeLine \
OMNIUI_PYBIND_INIT_CAST(offset, setOffset, float) \
OMNIUI_PYBIND_INIT_CAST(bound_offset, setBoundOffset, float)
#define OMNIUI_PYBIND_KWARGS_DOC_OffsetLine \
"\n `offset : `\n " \
OMNIUI_PYBIND_DOC_OffsetLine_offset \
"\n `bound_offset : `\n " \
OMNIUI_PYBIND_DOC_OffsetLine_boundOffset \
OMNIUI_PYBIND_KWARGS_DOC_FreeLine
// clang-format on
| 1,638 | C | 59.703701 | 120 | 0.455433 |
omniverse-code/kit/include/omni/ui/bind/BindIntSlider.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindAbstractSlider.h"
#include "BindUtils.h"
#include "DocCommonIntSlider.h"
#include "DocIntSlider.h"
#include "DocUIntSlider.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_IntSlider \
OMNIUI_PYBIND_INIT_AbstractSlider \
OMNIUI_PYBIND_INIT_CAST(min, setMin, int64_t) \
OMNIUI_PYBIND_INIT_CAST(max, setMax, int64_t)
#define OMNIUI_PYBIND_INIT_UIntSlider \
OMNIUI_PYBIND_INIT_AbstractSlider \
OMNIUI_PYBIND_INIT_CAST(min, setMin, uint64_t) \
OMNIUI_PYBIND_INIT_CAST(max, setMax, uint64_t)
#define OMNIUI_PYBIND_KWARGS_DOC_IntSlider \
"\n `min : `\n " \
OMNIUI_PYBIND_DOC_CommonIntSlider_min \
"\n `max : `\n " \
OMNIUI_PYBIND_DOC_CommonIntSlider_max \
OMNIUI_PYBIND_KWARGS_DOC_Widget
#define OMNIUI_PYBIND_KWARGS_DOC_UIntSlider \
OMNIUI_PYBIND_KWARGS_DOC_IntSlider
// clang-format on
| 2,264 | C | 58.605262 | 120 | 0.427562 |
omniverse-code/kit/include/omni/ui/bind/DocContainer.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Container \
"The container is an abstract widget that can hold one or several child widgets.\n" \
"The user is allowed to add or replace child widgets. If the widget has multiple children internally (like Button) and the user doesn't have access to them, it's not necessary to use this class.\n"
#define OMNIUI_PYBIND_DOC_Container_addChild \
"Adds widget to this container in a manner specific to the container. If it's allowed to have one sub-widget only, it will be overwriten.\n"
#define OMNIUI_PYBIND_DOC_Container_clear "Removes the container items from the container.\n"
| 1,263 | C | 59.190473 | 201 | 0.659541 |
omniverse-code/kit/include/omni/ui/bind/DocContainerScopeBase.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ContainerScopeBase \
"Puts the given container to the top of the stack when this object is constructed. And removes this container when it's destructed.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ContainerScopeBase_get "Returns the container it was created with.\n"
#define OMNIUI_PYBIND_DOC_ContainerScopeBase_isValid \
"Checks if this object is valid. It's always valid untill it's invalidated. Once it's invalidated, there is no way to make it valid again.\n"
#define OMNIUI_PYBIND_DOC_ContainerScopeBase_invalidate "Makes this object invalid.\n"
| 1,202 | C | 49.124998 | 145 | 0.674709 |
omniverse-code/kit/include/omni/ui/bind/DocRadioButton.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_RadioButton \
"RadioButton is the widget that allows the user to choose only one of a predefined set of mutually exclusive options.\n" \
"RadioButtons are arranged in collections of two or more with the class RadioCollection, which is the central component of the system and controls the behavior of all the RadioButtons in the collection.\n"
#define OMNIUI_PYBIND_DOC_RadioButton_radioCollection "This property holds the button's text.\n"
#define OMNIUI_PYBIND_DOC_RadioButton_RadioButton "Constructs RadioButton.\n"
| 1,098 | C | 53.949997 | 209 | 0.730419 |
omniverse-code/kit/include/omni/ui/bind/BindMenu.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindMenuHelper.h"
#include "BindStack.h"
#include "BindUtils.h"
#include "DocMenu.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Menu \
OMNIUI_PYBIND_INIT_CALLBACK(shown_changed_fn, setShownChangedFn, void(const bool&)) \
OMNIUI_PYBIND_INIT_CAST(tearable, setTearable, bool) \
OMNIUI_PYBIND_INIT_CALLBACK(teared_changed_fn, setTearedChangedFn, void(const bool&)) \
OMNIUI_PYBIND_INIT_CALLBACK(on_build_fn, setOnBuildFn, void()) \
OMNIUI_PYBIND_INIT_MenuHelper \
OMNIUI_PYBIND_INIT_Stack
#define OMNIUI_PYBIND_KWARGS_DOC_Menu \
"\n `tearable : bool`\n " \
OMNIUI_PYBIND_DOC_Menu_tearable \
"\n `shown_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Menu_shown \
"\n `teared_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Menu_teared \
"\n `on_build_fn : `\n " \
OMNIUI_PYBIND_DOC_Menu_OnBuild \
OMNIUI_PYBIND_KWARGS_DOC_MenuHelper \
OMNIUI_PYBIND_KWARGS_DOC_Stack
// clang-format off
| 2,592 | C | 65.487178 | 120 | 0.38966 |
omniverse-code/kit/include/omni/ui/bind/DocColorWidget.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ColorWidget \
"The ColorWidget widget is a button that displays the color from the item model and can open a picker window to change the color.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ColorWidget_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. Currently this widget can't be smaller than the size of the ColorWidget square.\n"
#define OMNIUI_PYBIND_DOC_ColorWidget_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than the size of the ColorWidget square.\n"
#define OMNIUI_PYBIND_DOC_ColorWidget_onModelUpdated \
"Reimplemented the method from ItemModelHelper that is called when the model is changed.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `item :`\n" \
" The item in the model that is changed. If it's NULL, the root is chaged.\n"
#define OMNIUI_PYBIND_DOC_ColorWidget_ColorWidget "Construct ColorWidget.\n"
| 2,386 | C | 67.199998 | 190 | 0.49036 |
omniverse-code/kit/include/omni/ui/bind/BindFrame.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindContainer.h"
#include "BindUtils.h"
#include "DocFrame.h"
#include "DocRasterHelper.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Frame \
OMNIUI_PYBIND_INIT_Container \
OMNIUI_PYBIND_INIT_CAST(horizontal_clipping, setHorizontalClipping, bool) \
OMNIUI_PYBIND_INIT_CAST(vertical_clipping, setVerticalClipping, bool) \
OMNIUI_PYBIND_INIT_CAST(separate_window, setSeparateWindow, bool) \
OMNIUI_PYBIND_INIT_CAST(raster_policy, setRasterPolicy, RasterPolicy) \
OMNIUI_PYBIND_INIT_CALLBACK(build_fn, setBuildFn, void())
#define OMNIUI_PYBIND_KWARGS_DOC_Frame \
"\n `horizontal_clipping : `\n " \
OMNIUI_PYBIND_DOC_Frame_horizontalClipping \
"\n `vertical_clipping : `\n " \
OMNIUI_PYBIND_DOC_Frame_verticalClipping \
"\n `separate_window : `\n " \
OMNIUI_PYBIND_DOC_Frame_separateWindow \
"\n `raster_policy : `\n " \
OMNIUI_PYBIND_DOC_RasterHelper_rasterPolicy \
"\n `build_fn : `\n " \
OMNIUI_PYBIND_DOC_Frame_Build \
OMNIUI_PYBIND_KWARGS_DOC_Container
// clang-format on
| 2,753 | C | 71.473682 | 120 | 0.40247 |
omniverse-code/kit/include/omni/ui/bind/DocSeparator.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Separator \
"The Separator class provides blank space.\n" \
"Normally, it's used to create separator line in the UI elements\n"
#define OMNIUI_PYBIND_DOC_Separator_cascadeStyle \
"It's called when the style is changed. It should be propagated to children to make the style cached and available to children.\n"
#define OMNIUI_PYBIND_DOC_Separator_Separator "Construct Separator.\n"
| 1,100 | C | 51.428569 | 134 | 0.619091 |
omniverse-code/kit/include/omni/ui/bind/BindComboBox.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocComboBox.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_ComboBox \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(arrow_only, setArrowOnly, bool)
#define OMNIUI_PYBIND_KWARGS_DOC_ComboBox \
"\n `arrow_only : bool`\n " \
OMNIUI_PYBIND_DOC_ComboBox_arrowOnly \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 1,266 | C | 51.791665 | 120 | 0.511058 |
omniverse-code/kit/include/omni/ui/bind/BindArrowHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindShape.h"
#include "BindUtils.h"
#include "DocArrowHelper.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_ArrowHelper \
OMNIUI_PYBIND_INIT_CAST(begin_arrow_width, setBeginArrowWidth, float) \
OMNIUI_PYBIND_INIT_CAST(begin_arrow_height, setBeginArrowHeight, float) \
OMNIUI_PYBIND_INIT_CAST(begin_arrow_type, setBeginArrowType, ArrowHelper::ArrowType) \
OMNIUI_PYBIND_INIT_CAST(end_arrow_width, setEndArrowWidth, float) \
OMNIUI_PYBIND_INIT_CAST(end_arrow_height, setEndArrowHeight, float) \
OMNIUI_PYBIND_INIT_CAST(end_arrow_type, setEndArrowType, ArrowHelper::ArrowType)
#define OMNIUI_PYBIND_KWARGS_DOC_ArrowHelper \
"\n `arrow : `\n " \
OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowWidth \
OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowHeight \
OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowType \
OMNIUI_PYBIND_DOC_ArrowHelper_endArrowWidth \
OMNIUI_PYBIND_DOC_ArrowHelper_endArrowHeight \
OMNIUI_PYBIND_DOC_ArrowHelper_endArrowType
// clang-format on
| 2,361 | C | 70.575755 | 127 | 0.47734 |
omniverse-code/kit/include/omni/ui/bind/DocIntSlider.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_IntSlider \
"The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle's position into an integer value within the legal range.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_IntSlider_IntSlider \
"Constructs IntSlider.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The widget's model. If the model is not assigned, the default model is created.\n"
| 1,855 | C | 76.33333 | 222 | 0.381132 |
omniverse-code/kit/include/omni/ui/bind/BindInvisibleButton.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindWidget.h"
#include "DocInvisibleButton.h"
#define OMNIUI_PYBIND_INIT_InvisibleButton \
OMNIUI_PYBIND_INIT_Widget OMNIUI_PYBIND_INIT_CALLBACK(clicked_fn, setClickedFn, void())
// clang-format off
#define OMNIUI_PYBIND_KWARGS_DOC_InvisibleButton \
"\n `clicked_fn : Callable[[], None]`\n " \
OMNIUI_PYBIND_DOC_InvisibleButton_Clicked \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 1,161 | C | 51.818179 | 120 | 0.575366 |
omniverse-code/kit/include/omni/ui/bind/DocPlot.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Plot \
"The Plot widget provides a line/histogram to display.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Plot_Type "This type is used to determine the type of the image.\n"
#define OMNIUI_PYBIND_DOC_Plot_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than 1 pixel.\n"
#define OMNIUI_PYBIND_DOC_Plot_setDataProviderFn "Sets the function that will be called when when data required.\n"
#define OMNIUI_PYBIND_DOC_Plot_setData "Sets the image data value.\n"
#define OMNIUI_PYBIND_DOC_Plot_type \
"This property holds the type of the image, can only be line or histogram. By default, the type is line.\n"
#define OMNIUI_PYBIND_DOC_Plot_scaleMin "This property holds the min scale values. By default, the value is FLT_MAX.\n"
#define OMNIUI_PYBIND_DOC_Plot_scaleMax "This property holds the max scale values. By default, the value is FLT_MAX.\n"
#define OMNIUI_PYBIND_DOC_Plot_valueOffset "This property holds the value offset. By default, the value is 0.\n"
#define OMNIUI_PYBIND_DOC_Plot_valueStride \
"This property holds the stride to get value list. By default, the value is 1.\n"
#define OMNIUI_PYBIND_DOC_Plot_title "This property holds the title of the image.\n"
#define OMNIUI_PYBIND_DOC_Plot_Plot \
"Construct Plot.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `type :`\n" \
" The type of the image, can be line or histogram.\n" \
"\n" \
" `scaleMin :`\n" \
" The minimal scale value.\n" \
"\n" \
" `scaleMax :`\n" \
" The maximum scale value.\n" \
"\n" \
" `valueList :`\n" \
" The list of values to draw the image.\n"
| 4,161 | C | 62.060605 | 163 | 0.379236 |
omniverse-code/kit/include/omni/ui/bind/DocItemModelHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ItemModelHelper \
"The ItemModelHelper class provides the basic functionality for item widget classes.\n"
#define OMNIUI_PYBIND_DOC_ItemModelHelper_onModelUpdated \
"Called by the model when the model value is changed. The class should react to the changes.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `item :`\n" \
" The item in the model that is changed. If it's NULL, the root is chaged.\n"
#define OMNIUI_PYBIND_DOC_ItemModelHelper_setModel "Set the current model.\n"
#define OMNIUI_PYBIND_DOC_ItemModelHelper_getModel "Returns the current model.\n"
| 1,770 | C | 60.068963 | 120 | 0.449718 |
omniverse-code/kit/include/omni/ui/bind/BindLength.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "DocFraction.h"
#include "DocLength.h"
#include "DocPercent.h"
#include "DocPixel.h"
#define OMNIUI_PYBIND_INIT_Length
#define OMNIUI_PYBIND_KWARGS_DOC_Length
#define OMNIUI_PYBIND_INIT_Percent OMNIUI_PYBIND_INIT_Length
#define OMNIUI_PYBIND_KWARGS_DOC_Percent OMNIUI_PYBIND_KWARGS_DOC_Length
#define OMNIUI_PYBIND_INIT_Pixel OMNIUI_PYBIND_INIT_Length
#define OMNIUI_PYBIND_KWARGS_DOC_Pixel OMNIUI_PYBIND_KWARGS_DOC_Length
#define OMNIUI_PYBIND_INIT_Fraction OMNIUI_PYBIND_INIT_Length
#define OMNIUI_PYBIND_KWARGS_DOC_Fraction OMNIUI_PYBIND_KWARGS_DOC_Length
| 1,048 | C | 36.464284 | 77 | 0.803435 |
omniverse-code/kit/include/omni/ui/bind/DocStyleStore.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_StyleStore \
"A common template for indexing the style properties of the specific types.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_StyleStore_store "Save the color by name.\n"
#define OMNIUI_PYBIND_DOC_StyleStore_get "Return the color by index.\n"
#define OMNIUI_PYBIND_DOC_StyleStore_find "Return the index of the color with specific name.\n"
| 951 | C | 40.391303 | 120 | 0.675079 |
omniverse-code/kit/include/omni/ui/bind/DocRasterPolicy.h | // Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_RasterPolicy \
"Used to set the rasterization behaviour.\n"
#define OMNIUI_PYBIND_DOC_RasterPolicy_eNever \
"Do not rasterize the widget at any time.\n"
#define OMNIUI_PYBIND_DOC_RasterPolicy_eOnDemand \
"Rasterize the widget as soon as possible and always use the rasterized version. This means that the widget will only be updated when the user called invalidateRaster.\n"
#define OMNIUI_PYBIND_DOC_RasterPolicy_eAuto \
"Automatically determine whether to rasterize the widget based on performance considerations. If necessary, the widget will be rasterized and updated when its content changes.\n"
| 1,399 | C | 54.999998 | 182 | 0.620443 |
omniverse-code/kit/include/omni/ui/bind/DocCircle.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Circle \
"The Circle widget provides a colored circle to display.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Circle_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. when the circle is in fixed mode it can't be smaller than the radius.\n"
#define OMNIUI_PYBIND_DOC_Circle_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. when the circle is in fixed mode it can't be smaller than the radius.\n"
#define OMNIUI_PYBIND_DOC_Circle_radius \
"This property holds the radius of the circle when the fill policy is eFixed or eFixedCrop. By default, the circle radius is 0.\n"
#define OMNIUI_PYBIND_DOC_Circle_alignment \
"This property holds the alignment of the circle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the circle is centered.\n"
#define OMNIUI_PYBIND_DOC_Circle_arc \
"This property is the way to draw a half or a quarter of the circle. When it's eLeft, only left side of the circle is rendered. When it's eLeftTop, only left top quarter is rendered.\n"
#define OMNIUI_PYBIND_DOC_Circle_sizePolicy \
"Define what happens when the source image has a different size than the item.\n"
#define OMNIUI_PYBIND_DOC_Circle_Circle "Constructs Circle.\n"
| 2,437 | C | 58.463413 | 189 | 0.589659 |
omniverse-code/kit/include/omni/ui/bind/DocFrame.h | // Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Frame \
"The Frame is a widget that can hold one child widget.\n" \
"Frame is used to crop the contents of a child widget or to draw small widget in a big view. The child widget must be specified with addChild().\n"
#define OMNIUI_PYBIND_DOC_Frame_addChild \
"Reimplemented adding a widget to this Frame. The Frame class can not contain multiple widgets. The widget overrides.\n"
#define OMNIUI_PYBIND_DOC_Frame_clear "Reimplemented removing all the child widgets from this Stack.\n"
#define OMNIUI_PYBIND_DOC_Frame_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. Currently this widget can't be smaller than the minimal size of the child widgets.\n"
#define OMNIUI_PYBIND_DOC_Frame_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than the minimal size of the child widgets.\n"
#define OMNIUI_PYBIND_DOC_Frame_cascadeStyle \
"It's called when the style is changed. It should be propagated to children to make the style cached and available to children.\n"
#define OMNIUI_PYBIND_DOC_Frame_forceRasterDirty "Next frame the content will be forced to re-bake.\n"
#define OMNIUI_PYBIND_DOC_Frame_Build \
"Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It's useful for lazy load.\n"
#define OMNIUI_PYBIND_DOC_Frame_rebuild \
"After this method is called, the next drawing cycle build_fn will be called again to rebuild everything.\n"
#define OMNIUI_PYBIND_DOC_Frame_setVisiblePreviousFrame "Change dirty bits when the visibility is changed.\n"
#define OMNIUI_PYBIND_DOC_Frame_horizontalClipping \
"When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for horizontal direction.\n"
#define OMNIUI_PYBIND_DOC_Frame_verticalClipping \
"When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for vertial direction.\n"
#define OMNIUI_PYBIND_DOC_Frame_separateWindow \
"A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.\n"
#define OMNIUI_PYBIND_DOC_Frame_Frame "Constructs Frame.\n"
| 3,749 | C | 59.48387 | 193 | 0.612963 |
omniverse-code/kit/include/omni/ui/bind/DocCallback.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Callback \
"Callback containers that is used with OMNIUI_CALLBACK macro. It keeps only one function, but it's possible to set up another function called when the main one is replaced.\n" \
"\n"
| 828 | C | 58.214282 | 181 | 0.640097 |
omniverse-code/kit/include/omni/ui/bind/DocMenuDelegate.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MenuDelegate \
"MenuDelegate is used to generate widgets that represent the menu item.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_MenuDelegate "Constructor.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_buildItem "This method must be reimplemented to generate custom item.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_buildTitle "This method must be reimplemented to generate custom title.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_buildStatus \
"This method must be reimplemented to generate custom widgets on the bottom of the window.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildItem "Called to create a new item.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildTitle "Called to create a new title.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildStatus "Called to create a new widget on the bottom of the window.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_propagate \
"Determine if Menu children should use this delegate when they don't have the own one.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_getDefaultDelegate \
"Get the default delegate that is used when the menu doesn't have anything.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate_setDefaultDelegate \
"Set the default delegate to use it when the item doesn't have a delegate.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate__siblingsHaveHotkeyText \
"Return true if at least one of the siblings have the hotkey text.\n"
#define OMNIUI_PYBIND_DOC_MenuDelegate__siblingsHaveCheckable \
"Return true if at least one of the siblings is checkable.\n"
| 2,534 | C | 44.267856 | 120 | 0.626677 |
omniverse-code/kit/include/omni/ui/bind/DocTriangle.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Triangle \
"The Triangle widget provides a colored triangle to display.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Triangle_alignment \
"This property holds the alignment of the triangle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop.\
By default, the triangle is centered.\n"
#define OMNIUI_PYBIND_DOC_Triangle_Triangle "Constructs Triangle.\n"
| 1,068 | C | 47.590907 | 122 | 0.623596 |
omniverse-code/kit/include/omni/ui/bind/BindWindow.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "DocWindow.h"
#include <omni/ui/bind/Pybind.h>
#define OMNIUI_PYBIND_INIT_Window \
OMNIUI_PYBIND_INIT_CAST(flags, setFlags, Window::Flags) \
OMNIUI_PYBIND_INIT_CAST(visible, setVisible, bool) \
OMNIUI_PYBIND_INIT_CAST(title, setTitle, std::string) \
OMNIUI_PYBIND_INIT_CAST(padding_x, setPaddingX, float) \
OMNIUI_PYBIND_INIT_CAST(padding_y, setPaddingY, float) \
OMNIUI_PYBIND_INIT_CAST(width, setWidth, float) \
OMNIUI_PYBIND_INIT_CAST(height, setHeight, float) \
OMNIUI_PYBIND_INIT_CAST(position_x, setPositionX, float) \
OMNIUI_PYBIND_INIT_CAST(position_y, setPositionY, float) \
OMNIUI_PYBIND_INIT_CAST(auto_resize, setAutoResize, bool) \
OMNIUI_PYBIND_INIT_CAST(noTabBar, setNoTabBar, bool) \
OMNIUI_PYBIND_INIT_CAST(exclusive_keyboard, setExclusiveKeyboard, bool) \
OMNIUI_PYBIND_INIT_CAST(detachable, setDetachable, bool) \
OMNIUI_PYBIND_INIT_CAST(raster_policy, setRasterPolicy, RasterPolicy) \
OMNIUI_PYBIND_INIT_CALLBACK(width_changed_fn, setWidthChangedFn, void(const float&)) \
OMNIUI_PYBIND_INIT_CALLBACK(height_changed_fn, setHeightChangedFn, void(const float&)) \
OMNIUI_PYBIND_INIT_CALLBACK(visibility_changed_fn, setVisibilityChangedFn, void(bool))
// clang-format off
#define OMNIUI_PYBIND_KWARGS_DOC_Window \
"\n `flags : `\n " \
OMNIUI_PYBIND_DOC_Window_flags \
"\n `visible : `\n " \
OMNIUI_PYBIND_DOC_Window_visible \
"\n `title : `\n " \
OMNIUI_PYBIND_DOC_Window_title \
"\n `padding_x : `\n " \
OMNIUI_PYBIND_DOC_Window_paddingX \
"\n `padding_y : `\n " \
OMNIUI_PYBIND_DOC_Window_paddingY \
"\n `width : `\n " \
OMNIUI_PYBIND_DOC_Window_width \
"\n `height : `\n " \
OMNIUI_PYBIND_DOC_Window_heigh \
"\n `position_x : `\n " \
OMNIUI_PYBIND_DOC_Window_positionX \
"\n `position_y : `\n " \
OMNIUI_PYBIND_DOC_Window_positionY \
"\n `auto_resize : `\n " \
OMNIUI_PYBIND_DOC_Window_autoResize \
"\n `noTabBar : `\n " \
OMNIUI_PYBIND_DOC_Window_noTabBar \
"\n `raster_policy : `\n " \
OMNIUI_PYBIND_DOC_Window_getRasterPolicy \
"\n `width_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Window_width \
"\n `height_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Window_heigh \
"\n `visibility_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Window_visible
// clang-format on
| 6,389 | C | 92.970587 | 120 | 0.306308 |
omniverse-code/kit/include/omni/ui/bind/BindCanvasFrame.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindFrame.h"
#include "BindUtils.h"
#include "DocCanvasFrame.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_CanvasFrame \
OMNIUI_PYBIND_INIT_Frame \
OMNIUI_PYBIND_INIT_CAST(pan_x, setPanX, float) \
OMNIUI_PYBIND_INIT_CAST(pan_y, setPanY, float) \
OMNIUI_PYBIND_INIT_CAST(zoom, setZoom, float) \
OMNIUI_PYBIND_INIT_CAST(zoom_min, setZoomMin, float) \
OMNIUI_PYBIND_INIT_CAST(zoom_max, setZoomMax, float) \
OMNIUI_PYBIND_INIT_CAST(compatibility, setCompatibility, bool) \
OMNIUI_PYBIND_INIT_CALLBACK(pan_x_changed_fn, setPanXChangedFn, void(float)) \
OMNIUI_PYBIND_INIT_CALLBACK(pan_y_changed_fn, setPanYChangedFn, void(float)) \
OMNIUI_PYBIND_INIT_CALLBACK(zoom_changed_fn, setZoomChangedFn, void(float)) \
OMNIUI_PYBIND_INIT_CAST(smooth_zoom, setSmoothZoom, bool) \
OMNIUI_PYBIND_INIT_CAST(draggable, setDraggable, bool)
#define OMNIUI_PYBIND_KWARGS_DOC_CanvasFrame \
"\n `pan_x : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_panX \
"\n `pan_y : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_panY \
"\n `zoom : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_zoomMin \
"\n `zoom_min : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_zoomMax \
"\n `zoom_max : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_zoom \
"\n `compatibility : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_compatibility \
"\n `pan_x_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_panX \
"\n `pan_y_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_panY \
"\n `zoom_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_zoom \
"\n `draggable : `\n " \
OMNIUI_PYBIND_DOC_CanvasFrame_draggable \
OMNIUI_PYBIND_KWARGS_DOC_Frame
// clang-format on
| 4,655 | C | 86.849055 | 120 | 0.324597 |
omniverse-code/kit/include/omni/ui/bind/DocMenuBar.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MenuBar \
"The MenuBar class provides a MenuBar at the top of the Window, could also be the MainMenuBar of the MainWindow.\n" \
"it can only contain Menu, at the moment there is no way to remove item appart from clearing it all together\n"
#define OMNIUI_PYBIND_DOC_MenuBar_MenuBar "Construct MenuBar.\n"
| 882 | C | 50.941173 | 121 | 0.70068 |
omniverse-code/kit/include/omni/ui/bind/DocRadioCollection.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_RadioCollection \
"Radio Collection is a class that groups RadioButtons and coordinates their state.\n" \
"It makes sure that the choice is mutually exclusive, it means when the user selects a radio button, any previously selected radio button in the same collection becomes deselected.\n"
#define OMNIUI_PYBIND_DOC_RadioCollection_onModelUpdated \
"Called by the model when the model value is changed. The class should react to the changes.\n" \
"Reimplemented from ValueModelHelper\n"
#define OMNIUI_PYBIND_DOC_RadioCollection_RadioCollection "Constructs RadioCollection.\n"
| 1,265 | C | 56.545452 | 187 | 0.671937 |
omniverse-code/kit/include/omni/ui/bind/DocMenuHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MenuHelper \
"The helper class for the menu that draws the menu line.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_isInHorizontalLayout "Returns true if the item is in horizontal layout.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_Triggered \
"Sets the function that is called when an action is activated by the user; for example, when the user clicks a menu option, or presses an action's shortcut key combination.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_text "This property holds the menu's text.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_hotkeyText "This property holds the menu's hotkey text.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_checkable \
"This property holds whether this menu item is checkable. A checkable item is one which has an on/off state.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_delegate "The delegate that generates a widget per menu item.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_hideOnClick "Hide or keep the window when the user clicked this item.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper_MenuHelper "Constructor.\n"
#define OMNIUI_PYBIND_DOC_MenuHelper__getMenuHelper "Convert Widget to MenuHelper if possible.\n"
| 1,928 | C | 43.860464 | 179 | 0.663382 |
omniverse-code/kit/include/omni/ui/bind/DocCanvasFrame.h | // Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_CanvasFrame \
"CanvasFrame is the widget that allows the user to pan and zoom its children with a mouse. It has the layout that can be infinitely moved in any direction.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_screenToCanvasX "Transforms screen-space X to canvas-space X.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_screenToCanvasY "Transforms screen-space Y to canvas-space Y.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_setPanKeyShortcut "Specify the mouse button and key to pan the canvas.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_setZoomKeyShortcut "Specify the mouse button and key to zoom the canvas.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_panX "The horizontal offset of the child item.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_panY "The vertical offset of the child item.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_zoom "The zoom level of the child item.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_zoomMin "The zoom minimum of the child item.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_zoomMax "The zoom maximum of the child item.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_smoothZoom \
"When true, zoom is smooth like in Bifrost even if the user is using mouse wheen that doesn't provide smooth scrolling.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_draggable \
"Provides a convenient way to make the content draggable and zoomable.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_compatibility \
"This boolean property controls the behavior of CanvasFrame. When set to true, the widget will function in the old way. When set to false, the widget will use a newer and faster implementation. This variable is included as a transition period to ensure that the update does not break any existing functionality. Please be aware that the old behavior may be deprecated in the future, so it is recommended to set this variable to false once you have thoroughly tested the new implementation.\n"
#define OMNIUI_PYBIND_DOC_CanvasFrame_CanvasFrame "Constructs CanvasFrame.\n"
| 3,287 | C | 50.374999 | 496 | 0.680864 |
omniverse-code/kit/include/omni/ui/bind/DocToolButton.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ToolButton \
"ToolButton is functionally similar to Button, but provides a model that determines if the button is checked. This button toggles between checked (on) and unchecked (off) when the user clicks it.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ToolButton_onModelUpdated \
"Reimplemented from ValueModelHelper. It's called when the model is changed.\n"
#define OMNIUI_PYBIND_DOC_ToolButton_ToolButton \
"Construct a checkable button with the model. If the bodel is not provided, then the default model is created.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The model that determines if the button is checked.\n"
| 1,998 | C | 70.392855 | 204 | 0.425926 |
omniverse-code/kit/include/omni/ui/bind/DocFreeShape.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_FreeShape \
"The free widget is the widget that is independent of the layout. It means it is stuck to other widgets. When initializing, it's necessary to provide two widgets, and the shape is drawn from one widget position to the another.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_FreeShape_FreeShape \
"Initialize the the shape with bounds limited to the positions of the given widgets.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `start :`\n" \
" The bound corder is in the center of this given widget.\n" \
"\n" \
" `end :`\n" \
" The bound corder is in the center of this given widget.\n"
| 2,220 | C | 81.259256 | 235 | 0.358108 |
omniverse-code/kit/include/omni/ui/bind/BindAbstractMultiField.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocAbstractMultiField.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_AbstractMultiField \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(column_count, setColumnCount, uint8_t) \
OMNIUI_PYBIND_INIT_CAST(h_spacing, setHSpacing, float) \
OMNIUI_PYBIND_INIT_CAST(v_spacing, setVSpacing, float)
#define OMNIUI_PYBIND_KWARGS_DOC_AbstractMultiField \
"\n `column_count : `\n " \
OMNIUI_PYBIND_DOC_AbstractMultiField_columnCount \
"\n `h_spacing : `\n " \
OMNIUI_PYBIND_DOC_AbstractMultiField_hSpacing \
"\n `v_spacing : `\n " \
OMNIUI_PYBIND_DOC_AbstractMultiField_vSpacing \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 2,002 | C | 63.612901 | 120 | 0.441059 |
omniverse-code/kit/include/omni/ui/bind/BindStack.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindContainer.h"
#include "BindUtils.h"
#include "DocStack.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Stack \
OMNIUI_PYBIND_INIT_Container \
OMNIUI_PYBIND_INIT_CAST(direction, setDirection, Stack::Direction) \
OMNIUI_PYBIND_INIT_CAST(content_clipping, setContentClipping, bool) \
OMNIUI_PYBIND_INIT_CAST(spacing, setSpacing, float) \
OMNIUI_PYBIND_INIT_CAST(send_mouse_events_to_back, setSendMouseEventsToBack, bool)
#define OMNIUI_PYBIND_KWARGS_DOC_Stack \
"\n `direction : `\n " \
OMNIUI_PYBIND_DOC_Stack_Direction \
"\n `content_clipping : `\n " \
OMNIUI_PYBIND_DOC_Stack_contentClipping \
"\n `spacing : `\n " \
OMNIUI_PYBIND_DOC_Stack_spacing \
"\n `send_mouse_events_to_back : `\n " \
OMNIUI_PYBIND_DOC_Stack_sendMouseEventsToBack \
OMNIUI_PYBIND_KWARGS_DOC_Container
// clang-format on
| 2,386 | C | 69.20588 | 120 | 0.406538 |
omniverse-code/kit/include/omni/ui/bind/DocMultiFloatField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MultiFloatField \
"MultiFloatField is the widget that has a sub widget (FloatField) per model item.\n" \
"It's handy to use it for multi-component data, like for example, float3 or color.\n"
#define OMNIUI_PYBIND_DOC_MultiFloatField_MultiFloatField "Constructor.\n"
| 864 | C | 49.88235 | 120 | 0.681713 |
omniverse-code/kit/include/omni/ui/bind/DocAbstractField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_AbstractField \
"The abstract widget that is base for any field, which is a one-line text editor.\n" \
"A field allows the user to enter and edit a single line of plain text. It's implemented using the model-view pattern and uses AbstractValueModel as the central component of the system.\n"
#define OMNIUI_PYBIND_DOC_AbstractField_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_AbstractField_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_AbstractField_onStyleUpdated \
"Reimplemented. Something happened with the style or with the parent style. We need to gerenerate the cache.\n"
#define OMNIUI_PYBIND_DOC_AbstractField_onModelUpdated \
"Reimplemented the method from ValueModelHelper that is called when the model is changed.\n"
#define OMNIUI_PYBIND_DOC_AbstractField_focusKeyboard \
"Puts cursor to this field or removes focus if\n" \
"focus\n"
#define OMNIUI_PYBIND_DOC_AbstractField__onInputTextActive \
"Internal private callback. It's called when the internal text buffer needs to change the size.\n"
| 2,300 | C | 57.999999 | 192 | 0.59913 |
omniverse-code/kit/include/omni/ui/bind/BindScrollingFrame.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindFrame.h"
#include "BindUtils.h"
#include "DocScrollingFrame.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_ScrollingFrame \
OMNIUI_PYBIND_INIT_Frame \
OMNIUI_PYBIND_INIT_CAST(scroll_x, setScrollX, float) \
OMNIUI_PYBIND_INIT_CALLBACK(scroll_x_changed_fn, setScrollXChangedFn, void(float)) \
OMNIUI_PYBIND_INIT_CAST(scroll_y, setScrollY, float) \
OMNIUI_PYBIND_INIT_CALLBACK(scroll_y_changed_fn, setScrollYChangedFn, void(float)) \
OMNIUI_PYBIND_INIT_CAST(horizontal_scrollbar_policy, setHorizontalScrollBarPolicy, ScrollBarPolicy) \
OMNIUI_PYBIND_INIT_CAST(vertical_scrollbar_policy, setVerticalScrollBarPolicy, ScrollBarPolicy)
#define OMNIUI_PYBIND_KWARGS_DOC_ScrollingFrame \
"\n `scroll_x : float`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollX \
"\n `scroll_x_max : float`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollXMax \
"\n `scroll_x_changed_fn : Callable[[float], None]`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollX \
"\n `scroll_y : float`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollY \
"\n `scroll_y_max : float`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollYMax \
"\n `scroll_y_changed_fn : Callable[[float], None]`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_scrollY \
"\n `horizontal_scrollbar_policy : ui.ScrollBarPolicy`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_horizontalScrollBarPolicy \
"\n `vertical_scrollbar_policy : ui.ScrollBarPolicy`\n " \
OMNIUI_PYBIND_DOC_ScrollingFrame_verticalScrollBarPolicy \
OMNIUI_PYBIND_KWARGS_DOC_Frame
// clang-format on
| 3,609 | C | 82.953486 | 120 | 0.417844 |
omniverse-code/kit/include/omni/ui/bind/DocUIntDrag.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_UIntDrag \
"\n" \
"\n"
#define OMNIUI_PYBIND_DOC_UIntDrag_step \
"This property controls the steping speed on the drag, its float to enable slower speed, but of course the value on the Control are still integer.\n"
#define OMNIUI_PYBIND_DOC_UIntDrag_UIntDrag \
"Constructs UIntDrag.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The widget's model. If the model is not assigned, the default model is created.\n"
| 1,928 | C | 67.892855 | 153 | 0.352697 |
omniverse-code/kit/include/omni/ui/bind/BindMultiField.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindAbstractMultiField.h"
#include "DocMultiFloatField.h"
#include "DocMultiIntField.h"
#include "DocMultiStringField.h"
#define OMNIUI_PYBIND_INIT_MultiFloatField OMNIUI_PYBIND_INIT_AbstractMultiField
#define OMNIUI_PYBIND_INIT_MultiIntField OMNIUI_PYBIND_INIT_AbstractMultiField
#define OMNIUI_PYBIND_INIT_MultiStringField OMNIUI_PYBIND_INIT_AbstractMultiField
#define OMNIUI_PYBIND_KWARGS_DOC_MultiFloatField OMNIUI_PYBIND_KWARGS_DOC_AbstractMultiField
#define OMNIUI_PYBIND_KWARGS_DOC_MultiIntField OMNIUI_PYBIND_KWARGS_DOC_AbstractMultiField
#define OMNIUI_PYBIND_KWARGS_DOC_MultiStringField OMNIUI_PYBIND_KWARGS_DOC_AbstractMultiField
| 1,105 | C | 49.272725 | 93 | 0.833484 |
omniverse-code/kit/include/omni/ui/bind/BindTreeView.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocTreeView.h"
#include <omni/ui/AbstractItemDelegate.h>
// clang-format off
#define OMNIUI_PYBIND_INIT_TreeView \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(delegate, setDelegate, std::shared_ptr<AbstractItemDelegate>) \
OMNIUI_PYBIND_INIT_CAST(header_visible, setHeaderVisible, bool) \
OMNIUI_PYBIND_INIT_CAST(root_visible, setRootVisible, bool) \
OMNIUI_PYBIND_INIT_CAST(selection, setSelection, std::vector<std::shared_ptr<const AbstractItemModel::AbstractItem>>) \
OMNIUI_PYBIND_INIT_CAST(expand_on_branch_click, setExpandOnBranchClick, bool) \
OMNIUI_PYBIND_INIT_CAST(keep_alive, setKeepAlive, bool) \
OMNIUI_PYBIND_INIT_CAST(keep_expanded, setKeepExpanded, bool) \
OMNIUI_PYBIND_INIT_CAST(drop_between_items, setDropBetweenItems, bool) \
OMNIUI_PYBIND_INIT_CALL(column_widths, setColumnWidths, toLengths) \
OMNIUI_PYBIND_INIT_CALL(min_column_widths, setMinColumnWidths, toLengths) \
OMNIUI_PYBIND_INIT_CAST(columns_resizable, setColumnsResizable, bool) \
OMNIUI_PYBIND_INIT_CAST(root_expanded, setRootExpanded, bool) \
OMNIUI_PYBIND_INIT_CALLBACK( \
selection_changed_fn, setSelectionChangedFn, void(std::vector<std::shared_ptr<const AbstractItemModel::AbstractItem>>))
#define OMNIUI_PYBIND_KWARGS_DOC_TreeView \
"\n `delegate : `\n " \
OMNIUI_PYBIND_DOC_TreeView_delegate \
"\n `header_visible : `\n " \
OMNIUI_PYBIND_DOC_TreeView_headerVisible \
"\n `selection : `\n " \
OMNIUI_PYBIND_DOC_TreeView_setSelection \
"\n `expand_on_branch_click : `\n " \
OMNIUI_PYBIND_DOC_TreeView_expandOnBranchClick \
"\n `keep_alive : `\n " \
OMNIUI_PYBIND_DOC_TreeView_keepAlive \
"\n `keep_expanded : `\n " \
OMNIUI_PYBIND_DOC_TreeView_keepExpanded \
"\n `drop_between_items : `\n " \
OMNIUI_PYBIND_DOC_TreeView_dropBetweenItems \
"\n `column_widths : `\n " \
OMNIUI_PYBIND_DOC_TreeView_columnWidths \
"\n `min_column_widths : `\n " \
OMNIUI_PYBIND_DOC_TreeView_minColumnWidths \
"\n `columns_resizable : `\n " \
OMNIUI_PYBIND_DOC_TreeView_columnsResizable \
"\n `selection_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_TreeView_SelectionChanged \
"\n `root_expanded : `\n " \
OMNIUI_PYBIND_DOC_TreeView_rootExpanded \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
OMNIUI_NAMESPACE_OPEN_SCOPE
/**
* @brief Convert Python list to vector of lengths.
*/
inline std::vector<Length> toLengths(const pybind11::handle& obj)
{
using namespace pybind11;
if (!isinstance<list>(obj))
{
return {};
}
const auto& objList = obj.cast<list>();
std::vector<Length> result;
result.reserve(objList.size());
for (const auto& it : objList)
{
result.push_back(toLength(it));
}
return result;
}
OMNIUI_NAMESPACE_CLOSE_SCOPE
| 6,135 | C | 66.428571 | 136 | 0.385167 |
omniverse-code/kit/include/omni/ui/bind/BindButton.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindInvisibleButton.h"
#include "DocButton.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Button \
OMNIUI_PYBIND_INIT_InvisibleButton \
OMNIUI_PYBIND_INIT_CAST(text, setText, std::string) \
OMNIUI_PYBIND_INIT_CAST(image_url, setImageUrl, std::string) \
OMNIUI_PYBIND_INIT_CALL(image_width, setImageWidth, toLength) \
OMNIUI_PYBIND_INIT_CALL(image_height, setImageHeight, toLength) \
OMNIUI_PYBIND_INIT_CAST(spacing, setSpacing, float)
#define OMNIUI_PYBIND_KWARGS_DOC_Button \
"\n `text : str`\n " \
OMNIUI_PYBIND_DOC_Button_text \
"\n `image_url : str`\n " \
OMNIUI_PYBIND_DOC_Button_imageUrl \
"\n `image_width : float`\n " \
OMNIUI_PYBIND_DOC_Button_imageWidth \
"\n `image_height : float`\n " \
OMNIUI_PYBIND_DOC_Button_imageHeight \
"\n `spacing : float`\n " \
OMNIUI_PYBIND_DOC_Button_spacing \
OMNIUI_PYBIND_KWARGS_DOC_InvisibleButton
// clang-format on
| 2,708 | C | 74.249998 | 120 | 0.3726 |
omniverse-code/kit/include/omni/ui/bind/BindStringField.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindAbstractField.h"
#include "DocStringField.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_StringField \
OMNIUI_PYBIND_INIT_AbstractField \
OMNIUI_PYBIND_INIT_CAST(password_mode, setPasswordMode, bool) \
OMNIUI_PYBIND_INIT_CAST(read_only, setReadOnly, bool) \
OMNIUI_PYBIND_INIT_CAST(multiline, setMultiline, bool) \
OMNIUI_PYBIND_INIT_CAST(allow_tab_input, setTabInputAllowed, bool)
#define OMNIUI_PYBIND_KWARGS_DOC_StringField \
"\n `password_mode : `\n " \
OMNIUI_PYBIND_DOC_StringField_passwordMode \
"\n `read_only : `\n " \
OMNIUI_PYBIND_DOC_StringField_readOnly \
"\n `multiline : `\n " \
OMNIUI_PYBIND_DOC_StringField_multiline \
"\n `allow_tab_input : `\n " \
OMNIUI_PYBIND_DOC_StringField_allowTabInput \
OMNIUI_PYBIND_KWARGS_DOC_AbstractField
// clang-format on
| 2,361 | C | 70.575755 | 120 | 0.40576 |
omniverse-code/kit/include/omni/ui/bind/BindCircle.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindShape.h"
#include "BindUtils.h"
#include "DocCircle.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Circle \
OMNIUI_PYBIND_INIT_Shape \
OMNIUI_PYBIND_INIT_CAST(radius, setRadius, float) \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment) \
OMNIUI_PYBIND_INIT_CAST(arc, setArc, Alignment) \
OMNIUI_PYBIND_INIT_CAST(size_policy, setSizePolicy, Circle::SizePolicy)
#define OMNIUI_PYBIND_KWARGS_DOC_Circle \
"\n `alignment :`\n " \
OMNIUI_PYBIND_DOC_Circle_alignment \
"\n `radius :`\n " \
OMNIUI_PYBIND_DOC_Circle_radius \
"\n `arc :`\n " \
OMNIUI_PYBIND_DOC_Circle_arc \
"\n `size_policy :`\n " \
OMNIUI_PYBIND_DOC_Circle_sizePolicy \
OMNIUI_PYBIND_KWARGS_DOC_Shape
// clang-format on
| 2,364 | C | 68.558822 | 120 | 0.372673 |
omniverse-code/kit/include/omni/ui/bind/DocWindow.h | // Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Window \
"The Window class represents a window in the underlying windowing system.\n" \
"This window is a child window of main Kit window. And it can be docked.\n" \
"Rasterization\n" \
"omni.ui generates vertices every frame to render UI elements. One of the features of the framework is the ability to bake a DrawList per window and reuse it if the content has not changed, which can significantly improve performance. However, in some cases, such as the Viewport window and Console window, it may not be possible to detect whether the window content has changed, leading to a frozen window. To address this problem, you can control the rasterization behavior by adjusting RasterPolicy. The RasterPolicy is an enumeration class that defines the rasterization behavior of a window. It has three possible values:\n" \
"NEVER: Do not rasterize the widget at any time. ON_DEMAND: Rasterize the widget as soon as possible and always use the rasterized version. The widget will only be updated when the user calls invalidateRaster. AUTO: Automatically determine whether to rasterize the widget based on performance considerations. If necessary, the widget will be rasterized and updated when its content changes.\n" \
"To resolve the frozen window issue, you can manually set the RasterPolicy of the problematic window to Never. This will force the window to rasterize its content and use the rasterized version until the user explicitly calls invalidateRaster to request an update.\n" \
"window = ui.Window(\"Test window\", raster_policy=ui.RasterPolicy.NEVER)\n"
#define OMNIUI_PYBIND_DOC_Window_destroy "Removes all the callbacks and circular references.\n"
#define OMNIUI_PYBIND_DOC_Window_notifyAppWindowChange "Notifies the window that window set has changed.\n"
#define OMNIUI_PYBIND_DOC_Window_getWindowCallback "Returns window set draw callback pointer for the given UI window.\n"
#define OMNIUI_PYBIND_DOC_Window_moveToAppWindow "Moves the window to the specific OS window.\n"
#define OMNIUI_PYBIND_DOC_Window_getAppWindow "Current IAppWindow.\n"
#define OMNIUI_PYBIND_DOC_Window_setTopModal "Brings this window to the top level of modal windows.\n"
#define OMNIUI_PYBIND_DOC_Window_deferredDockIn \
"Deferred docking. We need it when we want to dock windows before they were actually created. It's helpful when extension initialization, before any window is created.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `targetWindowTitle :`\n" \
" Dock to window with this title when it appears.\n" \
"\n" \
" `activeWindow :`\n" \
" Make target or this window active when docked.\n"
#define OMNIUI_PYBIND_DOC_Window_isValid "Indicates if the window was already destroyed.\n"
#define OMNIUI_PYBIND_DOC_Window_getRasterPolicy "Determine how the content of the window should be rastered.\n"
#define OMNIUI_PYBIND_DOC_Window_setRasterPolicy "Determine how the content of the window should be rastered.\n"
#define OMNIUI_PYBIND_DOC_Window_KeyPressed \
"Sets the function that will be called when the user presses the keyboard key on the focused window.\n"
#define OMNIUI_PYBIND_DOC_Window_title "This property holds the window's title.\n"
#define OMNIUI_PYBIND_DOC_Window_visible "This property holds whether the window is visible.\n"
#define OMNIUI_PYBIND_DOC_Window_frame "The main layout of this window.\n"
#define OMNIUI_PYBIND_DOC_Window_menuBar \
"The MenuBar for this Window, it is always present but hidden when the MENUBAR Flag is missing you need to use kWindowFlagMenuBar to show it.\n"
#define OMNIUI_PYBIND_DOC_Window_width "This property holds the window Width.\n"
#define OMNIUI_PYBIND_DOC_Window_heigh "This property holds the window Height.\n"
#define OMNIUI_PYBIND_DOC_Window_paddingX "This property set the padding to the frame on the X axis.\n"
#define OMNIUI_PYBIND_DOC_Window_paddingY "This property set the padding to the frame on the Y axis.\n"
#define OMNIUI_PYBIND_DOC_Window_focused "Read only property that is true when the window is focused.\n"
#define OMNIUI_PYBIND_DOC_Window_positionX \
"This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.\n"
#define OMNIUI_PYBIND_DOC_Window_positionY \
"This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.\n"
#define OMNIUI_PYBIND_DOC_Window_setPosition \
"This property set/get the position of the window in both axis calling the property.\n"
#define OMNIUI_PYBIND_DOC_Window_flags "This property set the Flags for the Window.\n"
#define OMNIUI_PYBIND_DOC_Window_noTabBar \
"setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically\n"
#define OMNIUI_PYBIND_DOC_Window_autoResize "setup the window to resize automatically based on its content\n"
#define OMNIUI_PYBIND_DOC_Window_docked \
"Has true if this window is docked. False otherwise. It's a read-only property.\n"
#define OMNIUI_PYBIND_DOC_Window_selectedInDock \
"Has true if this window is currently selected in the dock. False otherwise. It's a read-only property.\n"
#define OMNIUI_PYBIND_DOC_Window_dockInWindow \
"place the window in a specific docking position based on a target window name. We will find the target window dock node and insert this window in it, either by spliting on ratio or on top if the window is not found false is return, otherwise true\n"
#define OMNIUI_PYBIND_DOC_Window_moveToNewOSWindow "Move the Window Callback to a new OS Window.\n"
#define OMNIUI_PYBIND_DOC_Window_moveToMainOSWindow \
"Bring back the Window callback to the Main Window and destroy the Current OS Window.\n"
#define OMNIUI_PYBIND_DOC_Window_exclusiveKeyboard \
"When true, only the current window will receive keyboard events when it's focused. It's useful to override the global key bindings.\n"
#define OMNIUI_PYBIND_DOC_Window_detachable "If the window is able to be separated from the main application window.\n"
#define OMNIUI_PYBIND_DOC_Window_virtual "Vitrual window is the window that is rendered to internal buffer.\n"
#define OMNIUI_PYBIND_DOC_Window_focusPolicy "How the Window gains focus.\n"
#define OMNIUI_PYBIND_DOC_Window_getDpiScale \
"Get DPI scale currently associated to the current window's viewport. It's static since currently we can only have one window.\n"
#define OMNIUI_PYBIND_DOC_Window_getMainWindowWidth "Get the width in points of the current main window.\n"
#define OMNIUI_PYBIND_DOC_Window_getMainWindowHeight "Get the height in points of the current main window.\n"
#define OMNIUI_PYBIND_DOC_Window_dockWindowInWindow \
"place a named window in a specific docking position based on a target window name. We will find the target window dock node and insert this named window in it, either by spliting on ratio or on top if the windows is not found false is return, otherwise true\n"
#define OMNIUI_PYBIND_DOC_Window_Window \
"Construct the window, add it to the underlying windowing system, and makes it appear.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `title :`\n" \
" The window title. It's also used as an internal window ID.\n" \
"\n" \
" `dockPrefence :`\n" \
" In the old Kit determines where the window should be docked. In Kit Next it's unused.\n"
#define OMNIUI_PYBIND_DOC_Window__drawWindow "Used as a callback of the underlying windowing system. Calls draw().\n"
| 14,569 | C | 82.257142 | 635 | 0.442858 |
omniverse-code/kit/include/omni/ui/bind/BindImage.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocImage.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Image \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment) \
OMNIUI_PYBIND_INIT_CAST(fill_policy, setFillPolicy, Image::FillPolicy) \
OMNIUI_PYBIND_INIT_CAST(pixel_aligned, setPixelAligned, bool) \
OMNIUI_PYBIND_INIT_CALLBACK(progress_changed_fn, setProgressChangedFn, void(const float&))
#define OMNIUI_PYBIND_KWARGS_DOC_Image \
"\n `alignment : `\n " \
OMNIUI_PYBIND_DOC_Image_alignment \
"\n `fill_policy : `\n " \
OMNIUI_PYBIND_DOC_Image_fillPolicy \
"\n `pixel_aligned : `\n " \
OMNIUI_PYBIND_DOC_Image_pixelAligned \
"\n `progress_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_Image_progress \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 2,388 | C | 69.264704 | 120 | 0.399916 |
omniverse-code/kit/include/omni/ui/bind/DocStringField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_StringField \
"The StringField widget is a one-line text editor with a string model.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_StringField_passwordMode \
"This property holds the password mode. If the field is in the password mode when the entered text is obscured.\n"
#define OMNIUI_PYBIND_DOC_StringField_readOnly "This property holds if the field is read-only.\n"
#define OMNIUI_PYBIND_DOC_StringField_multiline "Multiline allows to press enter and create a new line.\n"
#define OMNIUI_PYBIND_DOC_StringField_allowTabInput "This property holds if the field allows Tab input.\n"
#define OMNIUI_PYBIND_DOC_StringField_StringField \
"Constructs StringField.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The widget's model. If the model is not assigned, the default model is created.\n"
| 2,211 | C | 58.783782 | 120 | 0.444143 |
omniverse-code/kit/include/omni/ui/bind/BindCollapsableFrame.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindFrame.h"
#include "BindUtils.h"
#include "DocCollapsableFrame.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_CollapsableFrame \
OMNIUI_PYBIND_INIT_Frame \
OMNIUI_PYBIND_INIT_CAST(collapsed, setCollapsed, bool) \
OMNIUI_PYBIND_INIT_CAST(title, setTitle, std::string) \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment) \
OMNIUI_PYBIND_INIT_CALLBACK(build_header_fn, setBuildHeaderFn, void(bool, std::string)) \
OMNIUI_PYBIND_INIT_CALLBACK(collapsed_changed_fn, setCollapsedChangedFn, void(bool))
#define OMNIUI_PYBIND_KWARGS_DOC_CollapsableFrame \
"\n `collapsed : `\n " \
OMNIUI_PYBIND_DOC_CollapsableFrame_collapsed \
"\n `title : `\n " \
OMNIUI_PYBIND_DOC_CollapsableFrame_title \
"\n `alignment : `\n " \
OMNIUI_PYBIND_DOC_CollapsableFrame_alignment \
"\n `build_header_fn : `\n " \
OMNIUI_PYBIND_DOC_CollapsableFrame_BuildHeader \
"\n `collapsed_changed_fn : `\n " \
OMNIUI_PYBIND_DOC_CollapsableFrame_collapsed \
OMNIUI_PYBIND_KWARGS_DOC_Frame
// clang-format on
| 2,754 | C | 73.459457 | 120 | 0.405229 |
omniverse-code/kit/include/omni/ui/bind/DocAbstractValueModel.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_AbstractValueModel \
"\n" \
"\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_getValueAsBool "Return the bool representation of the value.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_getValueAsFloat "Return the float representation of the value.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_getValueAsInt "Return the int representation of the value.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_getValueAsString "Return the string representation of the value.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_getValue "A helper that calls the correct getValueXXX method.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_beginEdit \
"Called when the user starts the editing. If it's a field, this method is called when the user activates the field and places the cursor inside. This method should be reimplemented.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_endEdit \
"Called when the user finishes the editing. If it's a field, this method is called when the user presses Enter or selects another field for editing. It's useful for undo/redo. This method should be reimplemented.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_setValue "Set the value.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_subscribe \
"Subscribe the ValueModelHelper widget to the changes of the model.\n" \
"We need to use regular pointers because we subscribe in the constructor of the widget and unsubscribe in the destructor. In constructor smart pointers are not available. We also don't allow copy and move of the widget.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_unsubscribe \
"Unsubscribe the ValueModelHelper widget from the changes of the model.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_addValueChangedFn \
"Adds the function that will be called every time the value changes.\n" \
"The id of the callback that is used to remove the callback.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_removeValueChangedFn \
"Remove the callback by its id.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `id :`\n" \
" The id that addValueChangedFn returns.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_addBeginEditFn \
"Adds the function that will be called every time the user starts the editing.\n" \
"The id of the callback that is used to remove the callback.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_removeBeginEditFn \
"Remove the callback by its id.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `id :`\n" \
" The id that addBeginEditFn returns.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_addEndEditFn \
"Adds the function that will be called every time the user finishes the editing.\n" \
"The id of the callback that is used to remove the callback.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_removeEndEditFn \
"Remove the callback by its id.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `id :`\n" \
" The id that addEndEditFn returns.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_processBeginEditCallbacks \
"Called by the widget when the user starts editing. It calls beginEdit and the callbacks.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_processEndEditCallbacks \
"Called by the widget when the user finishes editing. It calls endEdit and the callbacks.\n"
#define OMNIUI_PYBIND_DOC_AbstractValueModel_AbstractValueModel "Constructs AbstractValueModel.\n"
| 6,850 | C | 64.247618 | 226 | 0.431825 |
omniverse-code/kit/include/omni/ui/bind/BindPlacer.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindContainer.h"
#include "BindUtils.h"
#include "DocPlacer.h"
#include "DocRasterHelper.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Placer \
OMNIUI_PYBIND_INIT_Container \
OMNIUI_PYBIND_INIT_CALL(offset_x, setOffsetX, toLength) \
OMNIUI_PYBIND_INIT_CALL(offset_y, setOffsetY, toLength) \
OMNIUI_PYBIND_INIT_CAST(draggable, setDraggable, bool) \
OMNIUI_PYBIND_INIT_CAST(drag_axis, setDragAxis, Axis) \
OMNIUI_PYBIND_INIT_CAST(stable_size, setStableSize, bool) \
OMNIUI_PYBIND_INIT_CAST(frames_to_start_drag, setFramesToStartDrag, int) \
OMNIUI_PYBIND_INIT_CAST(raster_policy, setRasterPolicy, RasterPolicy) \
OMNIUI_PYBIND_INIT_CALLBACK(offset_x_changed_fn, setOffsetXChangedFn, void(const Length &)) \
OMNIUI_PYBIND_INIT_CALLBACK(offset_y_changed_fn, setOffsetYChangedFn, void(const Length &))
#define OMNIUI_PYBIND_KWARGS_DOC_Placer \
"\n `offset_x : toLength`\n " \
OMNIUI_PYBIND_DOC_Placer_offsetX \
"\n `offset_y : toLength`\n " \
OMNIUI_PYBIND_DOC_Placer_offsetY \
"\n `draggable : bool`\n " \
OMNIUI_PYBIND_DOC_Placer_draggable \
"\n `drag_axis : Axis`\n " \
OMNIUI_PYBIND_DOC_Placer_dragAxis \
"\n `stable_size : bool`\n " \
OMNIUI_PYBIND_DOC_Placer_stableSize \
"\n `raster_policy : `\n " \
OMNIUI_PYBIND_DOC_RasterHelper_rasterPolicy \
"\n `offset_x_changed_fn : Callable[[ui.Length], None]`\n " \
OMNIUI_PYBIND_DOC_Placer_offsetX \
"\n `offset_y_changed_fn : Callable[[ui.Length], None]`\n " \
OMNIUI_PYBIND_DOC_Placer_offsetY \
OMNIUI_PYBIND_KWARGS_DOC_Container
// clang-format on
| 3,998 | C | 82.312498 | 120 | 0.370935 |
omniverse-code/kit/include/omni/ui/bind/DocHStack.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_HStack \
"Shortcut for Stack{eLeftToRight}. The widgets are placed in a row, with suitable sizes.\n"
#define OMNIUI_PYBIND_DOC_HStack_HStack "Construct a stack with the widgets placed in a row from left to right.\n"
| 789 | C | 48.374997 | 120 | 0.69455 |
omniverse-code/kit/include/omni/ui/bind/DocWidget.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Widget \
"The Widget class is the base class of all user interface objects.\n" \
"The widget is the atom of the user interface: it receives mouse, keyboard and other events, and paints a representation of itself on the screen. Every widget is rectangular. A widget is clipped by its parent and by the widgets in front of it.\n"
#define OMNIUI_PYBIND_DOC_Widget_kModifierFlagWantCaptureKeyboard \
"When WantCaptureKeyboard, omni.ui is using the keyboard input exclusively, e.g. InputText active, etc.\n"
#define OMNIUI_PYBIND_DOC_Widget_destroy "Removes all the callbacks and circular references.\n"
#define OMNIUI_PYBIND_DOC_Widget_draw \
"Execute the rendering code of the widget, that includes the work with inputs and run _drawContent() that can be implemented by derived clrasses.\n" \
"It's in the public section because it's not possible to put it to the protected section. If it's in the protected, then other widgets that have child widgets will not be able to call it.\n" \
"Example:\n" \
"class Widget { protected: virtual void draw() { } };\n" \
"class Frame : public Widget { protected: void draw() override { // error C2248: 'Widget::draw': cannot access protected member declared in class 'Widget' m_child.draw(); }\n" \
"private: Widget m_child; };\n" \
"Also, it's not possible to use friendship because friendship is neither inherited nor transitive. It means it's necessary to list all the classes that can use sub-objects explicitly. And in this way, custom extensions will not be able to use sub-objects.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `elapsedTime :`\n" \
" The time elapsed (in seconds)\n"
#define OMNIUI_PYBIND_DOC_Widget_getComputedWidth \
"Returns the final computed width of the widget. It includes margins.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_getComputedContentWidth \
"Returns the final computed width of the content of the widget.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_setComputedWidth \
"Sets the computed width. It subtract margins and calls setComputedContentWidth.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_setComputedContentWidth \
"The widget provides several functions that deal with a widget's geometry. Indicates the content width hint that represents the preferred size of the widget. The widget is free to readjust its geometry to fit the content when it's necessary.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_getComputedHeight \
"Returns the final computed height of the widget. It includes margins.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_getComputedContentHeight \
"Returns the final computed height of the content of the widget.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_setComputedHeight \
"Sets the computed height. It subtract margins and calls setComputedContentHeight.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_setComputedContentHeight \
"The widget provides several functions that deal with a widget's geometry. Indicates the content height hint that represents the preferred size of the widget. The widget is free to readjust its geometry to fit the content when it's necessary.\n" \
"It's in puplic section. For the explanation why please see the draw() method.\n"
#define OMNIUI_PYBIND_DOC_Widget_getScreenPositionX \
"Returns the X Screen coordinate the widget was last draw. This is in Screen Pixel size.\n" \
"It's a float because we need negative numbers and precise position considering DPI scale factor.\n"
#define OMNIUI_PYBIND_DOC_Widget_getScreenPositionY \
"Returns the Y Screen coordinate the widget was last draw. This is in Screen Pixel size.\n" \
"It's a float because we need negative numbers and precise position considering DPI scale factor.\n"
#define OMNIUI_PYBIND_DOC_Widget_MouseMoved \
"Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)\n"
#define OMNIUI_PYBIND_DOC_Widget_MousePressed \
"Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where 'button' is the number of the mouse button pressed. 'modifier' is the flag for the keyboard modifier key.\n"
#define OMNIUI_PYBIND_DOC_Widget_MouseReleased \
"Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_Widget_MouseDoubleClicked \
"Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_Widget_MouseWheel \
"Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_Widget_MouseHovered \
"Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)\n"
#define OMNIUI_PYBIND_DOC_Widget_KeyPressed \
"Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.\n"
#define OMNIUI_PYBIND_DOC_Widget_Drag \
"Specify that this Widget is draggable, and set the callback that is attached to the drag operation.\n"
#define OMNIUI_PYBIND_DOC_Widget_AcceptDrop \
"Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.\n"
#define OMNIUI_PYBIND_DOC_Widget_Drop \
"Specify that this Widget accepts drops and set the callback to the drop operation.\n"
#define OMNIUI_PYBIND_DOC_Widget_ComputedContentSizeChanged "Called when the size of the widget is changed.\n"
#define OMNIUI_PYBIND_DOC_Widget_opaqueForMouseEvents \
"If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don't get routed to the child widgets either\n"
#define OMNIUI_PYBIND_DOC_Widget_setStyle \
"Set the current style. The style contains a description of customizations to the widget's style.\n"
#define OMNIUI_PYBIND_DOC_Widget_updateStyle \
"Recompute internal cached data that is used for styling. Unlike cascadeStyle, updateStyle is called when the name or type of the widget is changed.\n"
#define OMNIUI_PYBIND_DOC_Widget_cascadeStyle \
"It's called when the style is changed. It should be propagated to children to make the style cached and available to children.\n"
#define OMNIUI_PYBIND_DOC_Widget_onStyleUpdated \
"Called when the style is changed. The child classes can use it to propagate the style to children.\n"
#define OMNIUI_PYBIND_DOC_Widget_useMarginFromStyle \
"The ability to skip margins. It's useful when the widget is a part of compound widget and should be of exactly provided size. Like Rectangle of the Button.\n"
#define OMNIUI_PYBIND_DOC_Widget_scrollHereX \
"Adjust scrolling amount to make current item visible.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `centerRatio :`\n" \
" 0.0: left, 0.5: center, 1.0: right\n"
#define OMNIUI_PYBIND_DOC_Widget_scrollHereY \
"Adjust scrolling amount to make current item visible.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `centerRatio :`\n" \
" 0.0: top, 0.5: center, 1.0: bottom\n"
#define OMNIUI_PYBIND_DOC_Widget_scrollHere \
"Adjust scrolling amount in two axes to make current item visible.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `centerRatioX :`\n" \
" 0.0: left, 0.5: center, 1.0: right\n" \
"\n" \
" `centerRatioY :`\n" \
" 0.0: top, 0.5: center, 1.0: bottom\n"
#define OMNIUI_PYBIND_DOC_Widget_getDpiScale "Return the application DPI factor multiplied by the widget scale.\n"
#define OMNIUI_PYBIND_DOC_Widget_forceWidthDirty "Next frame content width will be forced to recompute.\n"
#define OMNIUI_PYBIND_DOC_Widget_forceHeightDirty "Next frame content height will be forced to recompute.\n"
#define OMNIUI_PYBIND_DOC_Widget_setVisiblePreviousFrame \
"Change dirty bits when the visibility is changed. It's public because other widgets have to call it.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `visible :`\n" \
" True when the widget is colmpletley rendered. False when early exit.\n" \
"\n" \
" `dirtySize :`\n" \
" True to set the size diry bits.\n"
#define OMNIUI_PYBIND_DOC_Widget_visible "This property holds whether the widget is visible.\n"
#define OMNIUI_PYBIND_DOC_Widget_visibleMin \
"If the current zoom factor and DPI is less than this value, the widget is not visible.\n"
#define OMNIUI_PYBIND_DOC_Widget_visibleMax \
"If the current zoom factor and DPI is bigger than this value, the widget is not visible.\n"
#define OMNIUI_PYBIND_DOC_Widget_enabled \
"This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.\n"
#define OMNIUI_PYBIND_DOC_Widget_selected \
"This property holds a flag that specifies the widget has to use eSelected state of the style.\n"
#define OMNIUI_PYBIND_DOC_Widget_checked \
"This property holds a flag that specifies the widget has to use eChecked state of the style. It's on the Widget level because the button can have sub-widgets that are also should be checked.\n"
#define OMNIUI_PYBIND_DOC_Widget_width \
"This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.\n"
#define OMNIUI_PYBIND_DOC_Widget_height \
"This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.\n"
#define OMNIUI_PYBIND_DOC_Widget_dragging "This property holds if the widget is being dragged.\n"
#define OMNIUI_PYBIND_DOC_Widget_name "The name of the widget that user can set.\n"
#define OMNIUI_PYBIND_DOC_Widget_styleTypeNameOverride \
"By default, we use typeName to look up the style. But sometimes it's necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.\n"
#define OMNIUI_PYBIND_DOC_Widget_parent \
"Protected weak pointer to the parent object. We need it to query the parent style. Parent can be a Container or another widget if it holds sub-widgets.\n"
#define OMNIUI_PYBIND_DOC_Widget_style \
"The local style. When the user calls\n" \
"setStyle()\n"
#define OMNIUI_PYBIND_DOC_Widget_tooltip \
"Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style\n"
#define OMNIUI_PYBIND_DOC_Widget_Tooltip \
"Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.\n"
#define OMNIUI_PYBIND_DOC_Widget_tooltipOffsetX \
"Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.\n"
#define OMNIUI_PYBIND_DOC_Widget_tooltipOffsetY \
"Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.\n"
#define OMNIUI_PYBIND_DOC_Widget_skipDrawWhenClipped \
"The flag that specifies if it's necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It's needed to avoid the limitation of 65535 primitives in a single draw list.\n"
#define OMNIUI_PYBIND_DOC_Widget_scale \
"The scale factor of the widget.\n" \
"The purpose of this property is to cache the scale factor of the CanvasFarame that uniformly scales its children.\n"
#define OMNIUI_PYBIND_DOC_Widget_identifier \
"An optional identifier of the widget we can use to refer to it in queries.\n"
#define OMNIUI_PYBIND_DOC_Widget_getDragDropPayloadId "Get Payload Id for drag and drop.\n"
#define OMNIUI_PYBIND_DOC_Widget_scrollOnlyWindowHovered \
"When it's false, the scroll callback is called even if other window is hovered.\n"
| 23,896 | C | 80.006779 | 348 | 0.446602 |
omniverse-code/kit/include/omni/ui/bind/BindMenuHelper.h | // Copyright (c) 2020-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocMenuHelper.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_MenuHelper \
OMNIUI_PYBIND_INIT_CAST(text, setText, std::string) \
OMNIUI_PYBIND_INIT_CAST(hotkey_text, setHotkeyText, std::string) \
OMNIUI_PYBIND_INIT_CAST(checkable, setCheckable, bool) \
OMNIUI_PYBIND_INIT_CAST(hide_on_click, setHideOnClick, bool) \
OMNIUI_PYBIND_INIT_CAST(menu_compatibility, setMenuCompatibility, bool) \
OMNIUI_PYBIND_INIT_CAST(delegate, setDelegate, std::shared_ptr<MenuDelegate>) \
OMNIUI_PYBIND_INIT_CALLBACK(triggered_fn, setTriggeredFn, void())
#define OMNIUI_PYBIND_KWARGS_DOC_MenuHelper \
"\n `text : str`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_text \
"\n `hotkey_text : str`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_hotkeyText \
"\n `checkable : bool`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_checkable \
"\n `hide_on_click : bool`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_hideOnClick \
"\n `delegate : MenuDelegate`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_delegate \
"\n `triggered_fn : void`\n " \
OMNIUI_PYBIND_DOC_MenuHelper_Triggered
// clang-format on
| 2,982 | C | 71.756096 | 120 | 0.392689 |
omniverse-code/kit/include/omni/ui/bind/DocShape.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Shape \
"The Shape widget provides a base class for all the Shape Widget. Currently implemented are Rectangle, Circle, Triangle, Line, Ellipse and BezierCurve.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Shape_backgroundColorProperty \
"Determines which style entry the shape should use for the background. It's very useful when we need to use a custom color. For example, when we draw the triangle for a collapsable frame, we use \"color\" instead of \"background_color\".\n"
#define OMNIUI_PYBIND_DOC_Shape_borderColorProperty \
"Determines which style entry the shape should use for the border color.\n"
#define OMNIUI_PYBIND_DOC_Shape__intersects \
"Segment-circle intersection. Follows closely\n" \
"https://stackoverflow.com/questions/1073336/circle-line-segment-collision-detection-algorithm\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `p1 :`\n" \
" start of line\n" \
"\n" \
" `p2 :`\n" \
" end of line\n" \
"\n" \
" `center :`\n" \
" center of circle\n" \
"\n" \
" `r :`\n" \
" radius\n" \
"true intercects\n" \
"false doesn't intersect\n"
| 3,744 | C | 84.113634 | 244 | 0.298611 |
omniverse-code/kit/include/omni/ui/bind/DocLine.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Line \
"The Line widget provides a colored line to display.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Line_setMouseHoveredFn \
"Sets the function that will be called when the user use mouse enter/leave on the line. It's the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)\n"
#define OMNIUI_PYBIND_DOC_Line_setMousePressedFn \
"Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n" \
"It's the override to prevent the bounding box logic.\n"
#define OMNIUI_PYBIND_DOC_Line_setMouseReleasedFn \
"Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_Line_setMouseDoubleClickedFn \
"Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_Line_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. Currently this widget can't be smaller than 1 pixel.\n"
#define OMNIUI_PYBIND_DOC_Line_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than 1 pixel.\n"
#define OMNIUI_PYBIND_DOC_Line_alignment \
"This property holds the alignment of the Line can only LEFT, RIGHT, VCENTER, HCENTER , BOTTOM, TOP. By default, the Line is HCenter.\n"
#define OMNIUI_PYBIND_DOC_Line_Line "Constructs Line.\n"
| 3,243 | C | 69.521738 | 278 | 0.601912 |
omniverse-code/kit/include/omni/ui/bind/DocFraction.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Fraction \
"Fraction length is made to take the space of the parent widget, divides it up into a row of boxes, and makes each child widget fill one box.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Fraction_Fraction "Construct Fraction.\n"
#define OMNIUI_PYBIND_DOC_Fraction_resolve \
"Resolves the length value to a absolute value\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `relativeFactor :`\n" \
" the unit multiplier\n" \
"\n" \
" `totalFractions :`\n" \
" the number of total fractions of the parent value\n" \
"the computed absolute value\n"
| 2,205 | C | 70.161288 | 150 | 0.344671 |
omniverse-code/kit/include/omni/ui/bind/DocLength.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Length \
"OMNI.UI has several different units for expressing a length.\n" \
"Many widget properties take \"Length\" values, such as width, height, minWidth, minHeight, etc. Pixel is the absolute length unit. Percent and Fraction are relative length units, and they specify a length relative to the parent length. Relative length units are scaled with the parent.\n"
#define OMNIUI_PYBIND_DOC_Length_Length "Construct Length.\n"
#define OMNIUI_PYBIND_DOC_Length_resolve \
"Resolves the length value to a absolute value\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `absoluteFactor :`\n" \
" the unit multiplier if the value is Pixel\n" \
"\n" \
" `relativeFactor :`\n" \
" the unit multiplier if the value is Percent or Fraction\n" \
"\n" \
" `totalFractions :`\n" \
" the number of total fractions of the parent value if the value is Fraction.\n" \
"the computed absolute value\n"
| 2,787 | C | 80.999998 | 293 | 0.365267 |
omniverse-code/kit/include/omni/ui/bind/DocImageWithProvider.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ImageWithProvider \
"The Image widget displays an image.\n" \
"The source of the image is specified as a URL using the source property. By default, specifying the width and height of the item causes the image to be scaled to that size. This behavior can be changed by setting the fill_mode property, allowing the image to be stretched or scaled instead. The property alignment controls where to align the scaled image.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_onStyleUpdated \
"Reimplemented. Called when the style or the parent style is changed.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_prepareDraw \
"Force call `ImageProvider::prepareDraw` to ensure the next draw call the image is loaded. It can be used to load the image for a hidden widget or to set the rasterization resolution.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_alignment \
"This property holds the alignment of the image when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the image is centered.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_fillPolicy \
"Define what happens when the source image has a different size than the item.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_pixelAligned \
"Prevents image blurring when it's placed to fractional position (like x=0.5, y=0.5)\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_ImageWithProvider \
"Construct image with given ImageProvider. If the ImageProvider is nullptr, it gets the image URL from styling.\n"
#define OMNIUI_PYBIND_DOC_ImageWithProvider_ImageWithProvider01 \
"Construct image with given url. If the url is empty, it gets the image URL from styling.\n"
| 2,741 | C | 64.285713 | 363 | 0.618023 |
omniverse-code/kit/include/omni/ui/bind/BindPlot.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocPlot.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Plot \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(value_offset, setValueOffset, int) \
OMNIUI_PYBIND_INIT_CAST(value_stride, setValueStride, int) \
OMNIUI_PYBIND_INIT_CAST(title, setTitle, std::string)
#define OMNIUI_PYBIND_KWARGS_DOC_Plot \
"\n `value_offset : int`\n " \
OMNIUI_PYBIND_DOC_Plot_valueOffset \
"\n `value_stride : int`\n " \
OMNIUI_PYBIND_DOC_Plot_valueStride \
"\n `title : str`\n " \
OMNIUI_PYBIND_DOC_Plot_title \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 1,987 | C | 63.12903 | 120 | 0.40614 |
omniverse-code/kit/include/omni/ui/bind/DocTreeView.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_TreeView \
"TreeView is a widget that presents a hierarchical view of information. Each item can have a number of subitems. An indentation often visualizes this in a list. An item can be expanded to reveal subitems, if any exist, and collapsed to hide subitems.\n" \
"TreeView can be used in file manager applications, where it allows the user to navigate the file system directories. They are also used to present hierarchical data, such as the scene object hierarchy.\n" \
"TreeView uses a model/view pattern to manage the relationship between data and the way it is presented. The separation of functionality gives developers greater flexibility to customize the presentation of items and provides a standard interface to allow a wide range of data sources to be used with other widgets.\n" \
"TreeView is responsible for the presentation of model data to the user and processing user input. To allow some flexibility in the way the data is presented, the creation of the sub-widgets is performed by the delegate. It provides the ability to customize any sub-item of TreeView.\n"
#define OMNIUI_PYBIND_DOC_TreeView_DropLocation \
"The location of Drag and Drop.\n" \
"Specifies where exactly the user droped the item.\n"
#define OMNIUI_PYBIND_DOC_TreeView_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_TreeView_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_TreeView_onModelUpdated \
"Reimplemented the method from ItemModelHelper that is called when the model is changed.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `item :`\n" \
" The item in the model that is changed. If it's NULL, the root is chaged.\n"
#define OMNIUI_PYBIND_DOC_TreeView_clearSelection "Deselects all selected items.\n"
#define OMNIUI_PYBIND_DOC_TreeView_setSelection "Set current selection.\n"
#define OMNIUI_PYBIND_DOC_TreeView_toggleSelection "Switches the selection state of the given item.\n"
#define OMNIUI_PYBIND_DOC_TreeView_extendSelection \
"Extends the current selection selecting all the items between currently selected nodes and the given item. It's when user does shift+click.\n"
#define OMNIUI_PYBIND_DOC_TreeView_getSelection "Return the list of selected items.\n"
#define OMNIUI_PYBIND_DOC_TreeView_SelectionChanged "Set the callback that is called when the selection is changed.\n"
#define OMNIUI_PYBIND_DOC_TreeView_HoverChanged "Set the callback that is called when the item hover status is changed.\n"
#define OMNIUI_PYBIND_DOC_TreeView_isExpanded "Returns true if the given item is expanded.\n"
#define OMNIUI_PYBIND_DOC_TreeView_setExpanded \
"Sets the given item expanded or collapsed.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `item :`\n" \
" The item to expand or collapse.\n" \
"\n" \
" `expanded :`\n" \
" True if it's necessary to expand, false to collapse.\n" \
"\n" \
" `recursive :`\n" \
" True if it's necessary to expand children.\n"
#define OMNIUI_PYBIND_DOC_TreeView_dirtyWidgets \
"When called, it will make the delegate to regenerate all visible widgets the next frame.\n"
#define OMNIUI_PYBIND_DOC_TreeView_delegate "The Item delegate that generates a widget per item.\n"
#define OMNIUI_PYBIND_DOC_TreeView_columnWidths "Widths of the columns. If not set, the width is Fraction(1).\n"
#define OMNIUI_PYBIND_DOC_TreeView_minColumnWidths "Minimum widths of the columns. If not set, the width is Pixel(0).\n"
#define OMNIUI_PYBIND_DOC_TreeView_columnsResizable "When true, the columns can be resized with the mouse.\n"
#define OMNIUI_PYBIND_DOC_TreeView_headerVisible "This property holds if the header is shown or not.\n"
#define OMNIUI_PYBIND_DOC_TreeView_rootVisible \
"This property holds if the root is shown. It can be used to make a single level tree appear like a simple list.\n"
#define OMNIUI_PYBIND_DOC_TreeView_expandOnBranchClick \
"This flag allows to prevent expanding when the user clicks the plus icon. It's used in the case the user wants to control how the items expanded or collapsed.\n"
#define OMNIUI_PYBIND_DOC_TreeView_keepAlive \
"When true, the tree nodes are never destroyed even if they are disappeared from the model. It's useul for the temporary filtering if it's necessary to display thousands of nodes.\n"
#define OMNIUI_PYBIND_DOC_TreeView_keepExpanded "Expand all the nodes and keep them expanded regardless their state.\n"
#define OMNIUI_PYBIND_DOC_TreeView_dropBetweenItems "When true, the tree nodes can be dropped between items.\n"
#define OMNIUI_PYBIND_DOC_TreeView_rootExpanded \
"The expanded state of the root item. Changing this flag doesn't make the children repopulated.\n"
#define OMNIUI_PYBIND_DOC_TreeView_TreeView \
"Create TreeView with the given model.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The given model.\n"
#define OMNIUI_PYBIND_DOC_TreeView__clearNodeSelection "Deselects the given node and the children.\n"
#define OMNIUI_PYBIND_DOC_TreeView__getDropNode \
"This function converts the flat drop location (above-below-over) on the table to the tree's location.\n" \
"When the user drops an item, he drops it between rows. And we need to know the child index that corresponds to the parent into which the new rows are inserted.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `node :`\n" \
" The node the user droped something.\n" \
"\n" \
" `parent :`\n" \
" The parent of the node the user droped it.\n" \
"\n" \
" `dropLocation :`\n" \
" Above-below-over position in the table.\n" \
"\n" \
" `dropNode :`\n" \
" Output. The parent node into which the new item should be inserted.\n" \
"\n" \
" `dropId :`\n" \
" Output. The index of child the new item should be inserted. If -1, the new item should be inseted to the end.\n"
| 12,957 | C | 81.535031 | 327 | 0.372694 |
omniverse-code/kit/include/omni/ui/bind/DocInvisibleButton.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_InvisibleButton \
"The InvisibleButton widget provides a transparent command button.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_InvisibleButton_Clicked \
"Sets the function that will be called when when the button is activated (i.e., pressed down then released while the mouse cursor is inside the button).\n"
#define OMNIUI_PYBIND_DOC_InvisibleButton_InvisibleButton "Constructor.\n"
| 1,066 | C | 49.809521 | 159 | 0.639775 |
omniverse-code/kit/include/omni/ui/bind/BindLine.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindArrowHelper.h"
#include "BindShape.h"
#include "BindUtils.h"
#include "DocLine.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Line \
OMNIUI_PYBIND_INIT_Shape \
OMNIUI_PYBIND_INIT_ArrowHelper \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment)
#define OMNIUI_PYBIND_KWARGS_DOC_Line \
"\n `alignment : `\n " \
OMNIUI_PYBIND_DOC_Line_alignment \
OMNIUI_PYBIND_KWARGS_DOC_Shape
// clang-format on
| 1,471 | C | 53.518517 | 120 | 0.461591 |
omniverse-code/kit/include/omni/ui/bind/DocToolBar.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ToolBar \
"The ToolBar class represents a window in the underlying windowing system that as some fixed size property.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ToolBar_axis "@breif axis for the toolbar\n"
#define OMNIUI_PYBIND_DOC_ToolBar_ToolBar "Construct ToolBar.\n"
| 846 | C | 41.349998 | 120 | 0.692671 |
omniverse-code/kit/include/omni/ui/bind/DocValueModelHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ValueModelHelper \
"The ValueModelHelper class provides the basic functionality for value widget classes.\n" \
"ValueModelHelper class is the base class for every standard widget that uses a AbstractValueModel. ValueModelHelper is an abstract class and itself cannot be instantiated. It provides a standard interface for interoperating with models.\n"
#define OMNIUI_PYBIND_DOC_ValueModelHelper_onModelUpdated \
"Called by the model when the model value is changed. The class should react to the changes.\n"
#define OMNIUI_PYBIND_DOC_ValueModelHelper_setModel "Set the current model.\n"
#define OMNIUI_PYBIND_DOC_ValueModelHelper_getModel "Returns the current model.\n"
| 1,331 | C | 54.499998 | 244 | 0.699474 |
omniverse-code/kit/include/omni/ui/bind/BindBezierCurve.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindArrowHelper.h"
#include "BindShape.h"
#include "BindUtils.h"
#include "DocBezierCurve.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_BezierCurve \
OMNIUI_PYBIND_INIT_CALL(start_tangent_width, setStartTangentWidth, toLength) \
OMNIUI_PYBIND_INIT_CALL(start_tangent_height, setStartTangentHeight, toLength) \
OMNIUI_PYBIND_INIT_CALL(end_tangent_width, setEndTangentWidth, toLength) \
OMNIUI_PYBIND_INIT_CALL(end_tangent_height, setEndTangentHeight, toLength) \
OMNIUI_PYBIND_INIT_CALLBACK(mouse_hovered_fn, setMouseHoveredFn, void(bool)) \
OMNIUI_PYBIND_INIT_Shape \
OMNIUI_PYBIND_INIT_ArrowHelper
#define OMNIUI_PYBIND_KWARGS_DOC_BezierCurve \
"\nstart_tangent_width: " \
OMNIUI_PYBIND_DOC_BezierCurve_startTangentWidth \
"\nstart_tangent_height: " \
OMNIUI_PYBIND_DOC_BezierCurve_startTangentHeight \
"\nend_tangent_width: " \
OMNIUI_PYBIND_DOC_BezierCurve_endTangentWidth \
"\nend_tangent_height: " \
OMNIUI_PYBIND_DOC_BezierCurve_endTangentHeight \
"\nset_mouse_hovered_fn: " \
OMNIUI_PYBIND_DOC_BezierCurve_setMouseHoveredFn \
OMNIUI_PYBIND_KWARGS_DOC_Shape
// clang-format on
#define OMNIUI_PYBIND_DOC_BezierCurve_MouseHovered OMNIUI_PYBIND_DOC_BezierCurve_setMouseHoveredFn
| 2,945 | C | 70.853657 | 120 | 0.447538 |
omniverse-code/kit/include/omni/ui/bind/BindRadioButton.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindToolButton.h"
#include "BindUtils.h"
#include <omni/ui/RadioCollection.h>
// clang-format off
#define OMNIUI_PYBIND_INIT_RadioButton \
OMNIUI_PYBIND_INIT_ToolButton \
OMNIUI_PYBIND_INIT_CAST(radio_collection, setRadioCollection, std::shared_ptr<RadioCollection>)
#define OMNIUI_PYBIND_KWARGS_DOC_RadioButton \
"\n `radio_collection : `\n " \
OMNIUI_PYBIND_DOC_RadioButton_radioCollection \
OMNIUI_PYBIND_KWARGS_DOC_Button
// clang-format on
| 1,324 | C | 49.961537 | 120 | 0.541541 |
omniverse-code/kit/include/omni/ui/bind/BindMenuDelegate.h | // Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "DocMenuDelegate.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_PyMenuDelegate \
OMNIUI_PYBIND_INIT_CAST(propagate, setPropagate, bool) \
OMNIUI_PYBIND_INIT_CALLBACK(on_build_item, setOnBuildItemFn, void(MenuHelper const*)) \
OMNIUI_PYBIND_INIT_CALLBACK(on_build_title, setOnBuildTitleFn, void(MenuHelper const*)) \
OMNIUI_PYBIND_INIT_CALLBACK(on_build_status, setOnBuildStatusFn, void(MenuHelper const*))
#define OMNIUI_PYBIND_KWARGS_DOC_MenuDelegate \
"\n `on_build_item : `\n " \
OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildItem \
"\n `on_build_title : `\n " \
OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildTitle \
"\n `on_build_status : `\n " \
OMNIUI_PYBIND_DOC_MenuDelegate_OnBuildStatus \
"\n `propagate : `\n " \
OMNIUI_PYBIND_DOC_MenuDelegate_propagate
// clang-format on
OMNIUI_PROTECT_PYBIND11_OBJECT(OMNIUI_NS::MenuDelegate, MenuDelegate);
| 2,211 | C | 62.199998 | 120 | 0.464948 |
omniverse-code/kit/include/omni/ui/bind/DocMultiFloatDragField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MultiFloatDragField \
"MultiFloatDragField is the widget that has a sub widget (FloatDrag) per model item.\n" \
"It's handy to use it for multi-component data, like for example, float3 or color.\n"
#define OMNIUI_PYBIND_DOC_MultiFloatDragField_MultiFloatDragField \
"Constructs MultiFloatDragField.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The widget's model. If the model is not assigned, the default model is created.\n"
| 1,732 | C | 71.20833 | 120 | 0.406467 |
omniverse-code/kit/include/omni/ui/bind/BindTriangle.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindShape.h"
#include "BindUtils.h"
#include "DocTriangle.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_Triangle \
OMNIUI_PYBIND_INIT_Shape \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment) \
#define OMNIUI_PYBIND_KWARGS_DOC_Triangle \
"\n `alignment : `\n " \
OMNIUI_PYBIND_DOC_Triangle_alignment \
OMNIUI_PYBIND_KWARGS_DOC_Shape
// clang-format on
| 1,326 | C | 52.079998 | 120 | 0.486425 |
omniverse-code/kit/include/omni/ui/bind/DocMenu.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Menu \
"The Menu class provides a menu widget for use in menu bars, context menus, and other popup menus.\n" \
"It can be either a pull-down menu in a menu bar or a standalone context menu. Pull-down menus are shown by the menu bar when the user clicks on the respective item. Context menus are usually invoked by some special keyboard key or by right-clicking.\n"
#define OMNIUI_PYBIND_DOC_Menu_addChild "Reimplemented adding a widget to this Menu.\n"
#define OMNIUI_PYBIND_DOC_Menu_clear "Reimplemented removing all the child widgets from this Menu.\n"
#define OMNIUI_PYBIND_DOC_Menu_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Menu_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Menu_cascadeStyle \
"It's called when the style is changed. It should be propagated to children to make the style cached and available to children.\n"
#define OMNIUI_PYBIND_DOC_Menu_show \
"Create a popup window and show the menu in it. It's usually used for context menus that are typically invoked by some special keyboard key or by right-clicking.\n"
#define OMNIUI_PYBIND_DOC_Menu_showAt \
"Create a popup window and show the menu in it. This enable to popup the menu at specific position. X and Y are in points to make it easier to the Python users.\n"
#define OMNIUI_PYBIND_DOC_Menu_hide \
"Close the menu window. It only works for pop-up context menu and for teared off menu.\n"
#define OMNIUI_PYBIND_DOC_Menu_invalidate "Make Menu dirty so onBuild will be executed to replace the children.\n"
#define OMNIUI_PYBIND_DOC_Menu_shown "If the pulldown menu is shown on the screen.\n"
#define OMNIUI_PYBIND_DOC_Menu_tearable "The ability to tear the window off.\n"
#define OMNIUI_PYBIND_DOC_Menu_teared "If the window is teared off.\n"
#define OMNIUI_PYBIND_DOC_Menu_OnBuild "Called to re-create new children.\n"
#define OMNIUI_PYBIND_DOC_Menu_getCurrent "Return the menu that is currently shown.\n"
#define OMNIUI_PYBIND_DOC_Menu_Menu \
"Construct Menu.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `text :`\n" \
" The text for the menu.\n"
| 4,090 | C | 55.819444 | 257 | 0.518093 |
omniverse-code/kit/include/omni/ui/bind/DocStyle.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Style \
"A singleton that controls the global style of the session.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Style_getInstance "Get the instance of this singleton object.\n"
#define OMNIUI_PYBIND_DOC_Style_getDefaultStyle \
"Returns the default root style. It's the style that is preselected when no alternative is specified.\n"
#define OMNIUI_PYBIND_DOC_Style_setDefaultStyle \
"Set the default root style. It's the style that is preselected when no alternative is specified.\n"
#define OMNIUI_PYBIND_DOC_Style_setDefaultStyle01 \
"Set the default root style. It's the style that is preselected when no alternative is specified.\n"
#define OMNIUI_PYBIND_DOC_Style_connectToGlobalStyle "Connect the widget to the default root style.\n"
| 1,592 | C | 48.781248 | 120 | 0.602387 |
omniverse-code/kit/include/omni/ui/bind/DocMenuItemCollection.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MenuItemCollection \
"The MenuItemCollection is the menu that unchecks children when one of them is checked.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_MenuItemCollection_addChild \
"Adds the menu. We subscribe to the\n" \
"checked\n"
#define OMNIUI_PYBIND_DOC_MenuItemCollection_MenuItemCollection "Construct MenuItemCollection.\n"
| 1,066 | C | 47.499998 | 120 | 0.601313 |
omniverse-code/kit/include/omni/ui/bind/DocCheckBox.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_CheckBox \
"A CheckBox is an option button that can be switched on (checked) or off (unchecked). Checkboxes are typically used to represent features in an application that can be enabled or disabled without affecting others.\n" \
"The checkbox is implemented using the model-view pattern. The model is the central component of this system. It is the application's dynamic data structure independent of the widget. It directly manages the data, logic, and rules of the checkbox. If the model is not specified, the simple one is created automatically when the object is constructed.\n"
#define OMNIUI_PYBIND_DOC_CheckBox_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. Currently this widget can't be smaller than the size of the checkbox square.\n"
#define OMNIUI_PYBIND_DOC_CheckBox_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than the size of the checkbox square.\n"
#define OMNIUI_PYBIND_DOC_CheckBox_onModelUpdated \
"Reimplemented the method from ValueModelHelper that is called when the model is changed.\n"
#define OMNIUI_PYBIND_DOC_CheckBox_onStyleUpdated \
"Reimplemented. Something happened with the style or with the parent style. We need to gerenerate the cache.\n"
#define OMNIUI_PYBIND_DOC_CheckBox_CheckBox \
"CheckBox with specified model. If model is not specified, it's using the default one.\n"
| 2,556 | C | 74.20588 | 357 | 0.628717 |
omniverse-code/kit/include/omni/ui/bind/DocProgressBar.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ProgressBar \
"A progressbar is a classic widget for showing the progress of an operation.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ProgressBar_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_ProgressBar_onStyleUpdated \
"Reimplemented. Something happened with the style or with the parent style. We need to gerenerate the cache.\n"
#define OMNIUI_PYBIND_DOC_ProgressBar_onModelUpdated \
"Reimplemented the method from ValueModelHelper that is called when the model is changed.\n"
#define OMNIUI_PYBIND_DOC_ProgressBar_ProgressBar \
"Construct ProgressBar.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The model that determines if the button is checked.\n"
| 2,316 | C | 63.361109 | 120 | 0.424007 |
omniverse-code/kit/include/omni/ui/bind/DocPlacer.h | // Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Placer \
"The Placer class place a single widget to a particular position based on the offet.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Placer_addChild \
"Reimplemented adding a widget to this Placer. The Placer class can not contain multiple widgets.\n"
#define OMNIUI_PYBIND_DOC_Placer_clear "Reimplemented to simply set the single child to null.\n"
#define OMNIUI_PYBIND_DOC_Placer_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget. Currently this widget can't be smaller than the minimal size of the child widget.\n"
#define OMNIUI_PYBIND_DOC_Placer_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget. Currently this widget can't be smaller than the minimal size of the child widget.\n"
#define OMNIUI_PYBIND_DOC_Placer_cascadeStyle \
"It's called when the style is changed. It should be propagated to children to make the style cached and available to children.\n"
#define OMNIUI_PYBIND_DOC_Placer_forceRasterDirty "Next frame the content will be forced to re-bake.\n"
#define OMNIUI_PYBIND_DOC_Placer_offsetX \
"offsetX defines the offset placement for the child widget relative to the Placer\n"
#define OMNIUI_PYBIND_DOC_Placer_offsetY \
"offsetY defines the offset placement for the child widget relative to the Placer\n"
#define OMNIUI_PYBIND_DOC_Placer_draggable "Provides a convenient way to make an item draggable.\n"
#define OMNIUI_PYBIND_DOC_Placer_dragAxis "Sets if dragging can be horizontally or vertically.\n"
#define OMNIUI_PYBIND_DOC_Placer_stableSize "The placer size depends on the position of the child when false.\n"
#define OMNIUI_PYBIND_DOC_Placer_framesToStartDrag \
"Set number of frames to start dragging if drag is not detected the first frame.\n"
#define OMNIUI_PYBIND_DOC_Placer_Placer "Construct Placer.\n"
| 3,042 | C | 49.716666 | 192 | 0.622617 |
omniverse-code/kit/include/omni/ui/bind/DocBezierCurve.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_BezierCurve \
"Smooth curve that can be scaled infinitely.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_setMouseHoveredFn \
"Sets the function that will be called when the user use mouse enter/leave on the line. It's the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_setMousePressedFn \
"Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n" \
"It's the override to prevent the bounding box logic.\n" \
"Where button is the number of the mouse button pressed modifier is the flag for the keyboard modifier key\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_setMouseReleasedFn \
"Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_setMouseDoubleClickedFn \
"Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_startTangentWidth \
"This property holds the X coordinate of the start of the curve relative to the width bound of the curve.\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_startTangentHeight \
"This property holds the Y coordinate of the start of the curve relative to the width bound of the curve.\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_endTangentWidth \
"This property holds the X coordinate of the end of the curve relative to the width bound of the curve.\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_endTangentHeight \
"This property holds the Y coordinate of the end of the curve relative to the width bound of the curve.\n"
#define OMNIUI_PYBIND_DOC_BezierCurve_BezierCurve "Initialize the the curve.\n"
| 3,664 | C | 70.862744 | 278 | 0.581059 |
omniverse-code/kit/include/omni/ui/bind/DocAbstractSlider.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_AbstractSlider \
"The abstract widget that is base for drags and sliders.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_AbstractSlider_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_AbstractSlider_onStyleUpdated \
"Reimplemented. Something happened with the style or with the parent style. We need to gerenerate the cache.\n"
| 1,179 | C | 52.636361 | 120 | 0.615776 |
omniverse-code/kit/include/omni/ui/bind/BindWidget.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "DocWidget.h"
#include <omni/ui/Length.h>
#include <omni/ui/bind/Pybind.h>
#define OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_STYLES \
OMNIUI_PYBIND_INIT_CALL(width, setWidth, toLength) \
OMNIUI_PYBIND_INIT_CALL(height, setHeight, toLength) \
OMNIUI_PYBIND_INIT_CAST(name, setName, std::string) \
OMNIUI_PYBIND_INIT_CAST(style_type_name_override, setStyleTypeNameOverride, std::string) \
OMNIUI_PYBIND_INIT_CAST(visible, setVisible, bool) \
OMNIUI_PYBIND_INIT_CAST(visible_min, setVisibleMin, float) \
OMNIUI_PYBIND_INIT_CAST(visible_max, setVisibleMax, float) \
OMNIUI_PYBIND_INIT_CAST(tooltip, setTooltip, std::string) \
OMNIUI_PYBIND_INIT_CALLBACK(tooltip_fn, setTooltipFn, void()) \
OMNIUI_PYBIND_INIT_CAST(tooltip_offset_x, setTooltipOffsetX, float) \
OMNIUI_PYBIND_INIT_CAST(tooltip_offset_y, setTooltipOffsetY, float) \
OMNIUI_PYBIND_INIT_CAST(enabled, setEnabled, bool) \
OMNIUI_PYBIND_INIT_CAST(selected, setSelected, bool) \
OMNIUI_PYBIND_INIT_CAST(checked, setChecked, bool) \
OMNIUI_PYBIND_INIT_CAST(dragging, setDragging, bool) \
OMNIUI_PYBIND_INIT_CAST(opaque_for_mouse_events, setOpaqueForMouseEvents, bool) \
OMNIUI_PYBIND_INIT_CAST(skip_draw_when_clipped, setSkipDrawWhenClipped, bool) \
OMNIUI_PYBIND_INIT_CAST(scroll_only_window_hovered, setScrollOnlyWindowHovered, bool) \
OMNIUI_PYBIND_INIT_CAST(identifier, setIdentifier, std::string) \
OMNIUI_PYBIND_INIT_CALLBACK( \
mouse_moved_fn, setMouseMovedFn, void(float, float, carb::input::KeyboardModifierFlags, bool[3])) \
OMNIUI_PYBIND_INIT_CALLBACK( \
mouse_pressed_fn, setMousePressedFn, void(float, float, int32_t, carb::input::KeyboardModifierFlags)) \
OMNIUI_PYBIND_INIT_CALLBACK( \
mouse_released_fn, setMouseReleasedFn, void(float, float, int32_t, carb::input::KeyboardModifierFlags)) \
OMNIUI_PYBIND_INIT_CALLBACK(mouse_double_clicked_fn, setMouseDoubleClickedFn, \
void(float, float, int32_t, carb::input::KeyboardModifierFlags)) \
OMNIUI_PYBIND_INIT_CALLBACK(mouse_wheel_fn, setMouseWheelFn, void(float, float, carb::input::KeyboardModifierFlags)) \
OMNIUI_PYBIND_INIT_CALLBACK(mouse_hovered_fn, setMouseHoveredFn, void(bool)) \
OMNIUI_PYBIND_INIT_CALLBACK( \
key_pressed_fn, setKeyPressedFn, void(int32_t, carb::input::KeyboardModifierFlags, bool)) \
OMNIUI_PYBIND_INIT_CALLBACK(drag_fn, setDragFn, std::string()) \
OMNIUI_PYBIND_INIT_CALLBACK(accept_drop_fn, setAcceptDropFn, bool(const std::string&)) \
OMNIUI_PYBIND_INIT_CALLBACK(drop_fn, setDropFn, void(const Widget::MouseDropEvent&)) \
OMNIUI_PYBIND_INIT_CALLBACK(computed_content_size_changed_fn, setComputedContentSizeChangedFn, void()) \
OMNIUI_PYBIND_INIT_CALLBACK(checked_changed_fn, setCheckedChangedFn, void(bool))
// clang-format off
#define OMNIUI_PYBIND_KWARGS_DOC_Widget \
"\n `width : ui.Length`\n " \
OMNIUI_PYBIND_DOC_Widget_width \
"\n `height : ui.Length`\n " \
OMNIUI_PYBIND_DOC_Widget_height \
"\n `name : str`\n " \
OMNIUI_PYBIND_DOC_Widget_name \
"\n `style_type_name_override : str`\n " \
OMNIUI_PYBIND_DOC_Widget_styleTypeNameOverride \
"\n `identifier : str`\n " \
OMNIUI_PYBIND_DOC_Widget_identifier \
"\n `visible : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_visible \
"\n `visibleMin : float`\n " \
OMNIUI_PYBIND_DOC_Widget_visibleMin \
"\n `visibleMax : float`\n " \
OMNIUI_PYBIND_DOC_Widget_visibleMax \
"\n `tooltip : str`\n " \
OMNIUI_PYBIND_DOC_Widget_tooltip \
"\n `tooltip_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_Tooltip \
"\n `tooltip_offset_x : float`\n " \
OMNIUI_PYBIND_DOC_Widget_tooltipOffsetX \
"\n `tooltip_offset_y : float`\n " \
OMNIUI_PYBIND_DOC_Widget_tooltipOffsetY \
"\n `enabled : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_enabled \
"\n `selected : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_selected \
"\n `checked : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_checked \
"\n `dragging : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_dragging \
"\n `opaque_for_mouse_events : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_opaqueForMouseEvents \
"\n `skip_draw_when_clipped : bool`\n " \
OMNIUI_PYBIND_DOC_Widget_skipDrawWhenClipped \
"\n `mouse_moved_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MouseMoved \
"\n `mouse_pressed_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MousePressed \
"\n `mouse_released_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MouseReleased \
"\n `mouse_double_clicked_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MouseDoubleClicked \
"\n `mouse_wheel_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MouseWheel \
"\n `mouse_hovered_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_MouseHovered \
"\n `drag_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_Drag \
"\n `accept_drop_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_AcceptDrop \
"\n `drop_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_Drop \
"\n `computed_content_size_changed_fn : Callable`\n " \
OMNIUI_PYBIND_DOC_Widget_ComputedContentSizeChanged \
// clang-format on
OMNIUI_NAMESPACE_OPEN_SCOPE
inline Length toLength(pybind11::handle obj)
{
using namespace pybind11;
// Implicitly cast numbers into Pixel Length values:
if (isinstance<int_>(obj) || isinstance<float_>(obj))
{
return Pixel(obj.cast<float>());
}
return obj.cast<Length>();
}
OMNIUI_NAMESPACE_CLOSE_SCOPE
| 12,474 | C | 94.229007 | 122 | 0.3367 |
omniverse-code/kit/include/omni/ui/bind/DocSimpleStringModel.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_SimpleStringModel \
"A very simple value model that holds a single string.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_SimpleStringModel_getValueAsBool "Get the value.\n"
#define OMNIUI_PYBIND_DOC_SimpleStringModel_setValue "Set the value.\n"
| 860 | C | 42.049998 | 120 | 0.656977 |
omniverse-code/kit/include/omni/ui/bind/DocFloatSlider.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_FloatSlider \
"The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle's position into a float value within the legal range.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_onModelUpdated \
"Reimplemented the method from ValueModelHelper that is called when the model is changed.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_min "This property holds the slider's minimum value.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_max "This property holds the slider's maximum value.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_step "This property controls the steping speed on the drag.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_format "This property overrides automatic formatting if needed.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_precision "This property holds the slider value's float precision.\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_getFormatString \
"Get the format string for the given value. The number should be in the format of\n" \
"0.0\n"
#define OMNIUI_PYBIND_DOC_FloatSlider_FloatSlider "Construct FloatSlider.\n"
| 1,971 | C | 47.09756 | 219 | 0.645358 |
omniverse-code/kit/include/omni/ui/bind/BindFreeShape.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindBezierCurve.h"
#include "BindCircle.h"
#include "BindEllipse.h"
#include "BindLine.h"
#include "BindRectangle.h"
#include "BindShape.h"
#include "BindTriangle.h"
#include "BindUtils.h"
#include "DocFreeShape.h"
#define OMNIUI_PYBIND_DOC_FreeBezierCurve OMNIUI_PYBIND_DOC_BezierCurve OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeBezierCurve_FreeBezierCurve OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeBezierCurve OMNIUI_PYBIND_INIT_BezierCurve
#define OMNIUI_PYBIND_KWARGS_DOC_FreeBezierCurve OMNIUI_PYBIND_KWARGS_DOC_BezierCurve
#define OMNIUI_PYBIND_DOC_FreeCircle OMNIUI_PYBIND_DOC_Circle OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeCircle_FreeCircle OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeCircle OMNIUI_PYBIND_INIT_Circle
#define OMNIUI_PYBIND_KWARGS_DOC_FreeCircle OMNIUI_PYBIND_KWARGS_DOC_Circle
#define OMNIUI_PYBIND_DOC_FreeEllipse OMNIUI_PYBIND_DOC_Ellipse OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeEllipse_FreeEllipse OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeEllipse OMNIUI_PYBIND_INIT_Ellipse
#define OMNIUI_PYBIND_KWARGS_DOC_FreeEllipse OMNIUI_PYBIND_KWARGS_DOC_Ellipse
#define OMNIUI_PYBIND_DOC_FreeLine OMNIUI_PYBIND_DOC_Line OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeLine_FreeLine OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeLine OMNIUI_PYBIND_INIT_Line
#define OMNIUI_PYBIND_KWARGS_DOC_FreeLine OMNIUI_PYBIND_KWARGS_DOC_Line
#define OMNIUI_PYBIND_DOC_FreeRectangle OMNIUI_PYBIND_DOC_Rectangle OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeRectangle_FreeRectangle OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeRectangle OMNIUI_PYBIND_INIT_Rectangle
#define OMNIUI_PYBIND_KWARGS_DOC_FreeRectangle OMNIUI_PYBIND_KWARGS_DOC_Rectangle
#define OMNIUI_PYBIND_DOC_FreeTriangle OMNIUI_PYBIND_DOC_Triangle OMNIUI_PYBIND_DOC_FreeShape
#define OMNIUI_PYBIND_DOC_FreeTriangle_FreeTriangle OMNIUI_PYBIND_DOC_FreeShape_FreeShape
#define OMNIUI_PYBIND_INIT_FreeTriangle OMNIUI_PYBIND_INIT_Triangle
#define OMNIUI_PYBIND_KWARGS_DOC_FreeTriangle OMNIUI_PYBIND_KWARGS_DOC_Triangle
| 2,652 | C | 52.059999 | 99 | 0.83371 |
omniverse-code/kit/include/omni/ui/bind/DocMultiDragField.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_MultiDragField \
"The base class for MultiFloatDragField and MultiIntDragField. We need it because there classes are very similar, so we can template them.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `T :`\n" \
" FloatDrag or IntDrag\n" \
"\n" \
" `U :`\n" \
" float or Int\n"
#define OMNIUI_PYBIND_DOC_MultiDragField_onModelUpdated \
"Reimplemented. Called by the model when the model value is changed.\n"
#define OMNIUI_PYBIND_DOC_MultiDragField_min "This property holds the drag's minimum value.\n"
#define OMNIUI_PYBIND_DOC_MultiDragField_max "This property holds the drag's maximum value.\n"
#define OMNIUI_PYBIND_DOC_MultiDragField_step "This property controls the steping speed on the drag.\n"
#define OMNIUI_PYBIND_DOC_MultiDragField_MultiDragField \
"Constructs MultiDragField.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `model :`\n" \
" The widget's model. If the model is not assigned, the default model is created.\n"
| 3,408 | C | 74.755554 | 147 | 0.309566 |
omniverse-code/kit/include/omni/ui/bind/BindImageWithProvider.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindUtils.h"
#include "BindWidget.h"
#include "DocImageWithProvider.h"
// clang-format off
#define OMNIUI_PYBIND_INIT_ImageWithProvider \
OMNIUI_PYBIND_INIT_Widget \
OMNIUI_PYBIND_INIT_CAST(alignment, setAlignment, Alignment) \
OMNIUI_PYBIND_INIT_CAST(pixel_aligned, setPixelAligned, bool) \
OMNIUI_PYBIND_INIT_CAST(fill_policy, setFillPolicy, ImageWithProvider::FillPolicy)
#define OMNIUI_PYBIND_KWARGS_DOC_ImageWithProvider \
"\n `alignment : `\n " \
OMNIUI_PYBIND_DOC_ImageWithProvider_alignment \
"\n `fill_policy : `\n " \
OMNIUI_PYBIND_DOC_ImageWithProvider_fillPolicy \
"\n `pixel_aligned : `\n " \
OMNIUI_PYBIND_DOC_ImageWithProvider_pixelAligned \
OMNIUI_PYBIND_KWARGS_DOC_Widget
// clang-format on
| 2,029 | C | 64.483869 | 120 | 0.451947 |
omniverse-code/kit/include/omni/ui/bind/DocDockSpace.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_DockSpace \
"The DockSpace class represents Dock Space for the OS Window.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_DockSpace_dockFrame "This represents Styling opportunity for the Window background.\n"
#define OMNIUI_PYBIND_DOC_DockSpace_DockSpace \
"Construct the main window, add it to the underlying windowing system, and makes it appear.\n"
| 1,043 | C | 48.714283 | 120 | 0.622244 |
omniverse-code/kit/include/omni/ui/bind/DocArrowHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_ArrowHelper \
"The ArrowHelper widget provides a colored rectangle to display.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowWidth "This property holds the width of the begin arrow.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowHeight "This property holds the height of the begin arrow.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_beginArrowType \
"This property holds the type of the begin arrow can only be eNone or eRrrow. By default, the arrow type is eNone.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_endArrowWidth "This property holds the width of the end arrow.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_endArrowHeight "This property holds the height of the end arrow.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_endArrowType \
"This property holds the type of the end arrow can only be eNone or eRrrow. By default, the arrow type is eNone.\n"
#define OMNIUI_PYBIND_DOC_ArrowHelper_ArrowHelper "Constructs ArrowHelper.\n"
| 1,710 | C | 45.243242 | 121 | 0.660234 |
omniverse-code/kit/include/omni/ui/bind/BindFloatField.h | // Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "BindAbstractField.h"
#include "BindUtils.h"
#include "DocFloatField.h"
#define OMNIUI_PYBIND_INIT_FloatField \
OMNIUI_PYBIND_INIT_AbstractField \
OMNIUI_PYBIND_INIT_CAST(precision, setPrecision, uint32_t)
#define OMNIUI_PYBIND_KWARGS_DOC_FloatField \
"\n `precision : uint32_t`\n " \
OMNIUI_PYBIND_DOC_FloatField_precision \
OMNIUI_PYBIND_KWARGS_DOC_AbstractField
| 1,242 | C | 55.499997 | 120 | 0.527375 |
omniverse-code/kit/include/omni/ui/bind/DocGrid.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_Grid \
"Grid is a container that arranges its child views in a grid. The grid vertical/horizontal direction is the direction the grid size growing with creating more children.\n" \
"\n"
#define OMNIUI_PYBIND_DOC_Grid_CellSizeMode \
"The grid has two modes of working. When the current mode is eSizeFromCount, the grid computes the size of the cell using the number of columns/rows. When eCountFromSize, the size of the cells is always the same, but the number of columns varies depending on the grid's full size.\n"
#define OMNIUI_PYBIND_DOC_Grid_setComputedContentWidth \
"Reimplemented the method to indicate the width hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Grid_setComputedContentHeight \
"Reimplemented the method to indicate the height hint that represents the preferred size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Grid_columnWidth \
"The width of the column. It's only possible to set it if the grid is vertical. Once it's set, the column count depends on the size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Grid_rowHeight \
"The height of the row. It's only possible to set it if the grid is horizontal. Once it's set, the row count depends on the size of the widget.\n"
#define OMNIUI_PYBIND_DOC_Grid_columnCount \
"The number of columns. It's only possible to set it if the grid is vertical. Once it's set, the column width depends on the widget size.\n"
#define OMNIUI_PYBIND_DOC_Grid_rowCount \
"The number of rows. It's only possible to set it if the grid is horizontal. Once it's set, the row height depends on the widget size.\n"
#define OMNIUI_PYBIND_DOC_Grid_Grid \
"Constructor.\n" \
"\n" \
"\n" \
"### Arguments:\n" \
"\n" \
" `direction :`\n" \
" Determines the direction the widget grows when adding more children.\n"
| 3,714 | C | 70.442306 | 287 | 0.470652 |
omniverse-code/kit/include/omni/ui/bind/BindStyleContainer.h | // Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include <omni/ui/Api.h>
#include <omni/ui/StyleContainer.h>
#include <omni/ui/StyleStore.h>
#include <omni/ui/Widget.h>
#include <omni/ui/bind/Pybind.h>
OMNIUI_NAMESPACE_OPEN_SCOPE
/**
* @brief Converts the given python property and adds it to the style.
*
* Please see the description of setPythonStyle for the explanation why it's inline.
*/
inline void addPropertyToStyle(StyleContainer& style,
const std::string& scopeName,
const std::string& propertyName,
const pybind11::handle& propertyValue)
{
using namespace pybind11;
StyleFloatProperty floatEnum = StyleContainer::getPropertyEnumeration<StyleFloatProperty>(propertyName);
if (floatEnum != StyleFloatProperty::eCount)
{
if (isinstance<float_>(propertyValue) || isinstance<int_>(propertyValue))
{
style.merge({ scopeName, floatEnum, propertyValue.cast<float>() });
}
else if (isinstance<pybind11::str>(propertyValue))
{
style.merge({ scopeName, floatEnum, propertyValue.cast<std::string>().c_str() });
}
return;
}
StyleEnumProperty valueEnum = StyleContainer::getPropertyEnumeration<StyleEnumProperty>(propertyName);
if (valueEnum != StyleEnumProperty::eCount)
{
style.merge({ scopeName, valueEnum, propertyValue.cast<uint32_t>() });
return;
}
StyleStringProperty stringEnum = StyleContainer::getPropertyEnumeration<StyleStringProperty>(propertyName);
if (stringEnum != StyleStringProperty::eCount)
{
std::string value = propertyValue.cast<std::string>();
style.merge({ scopeName, stringEnum, value.c_str() });
return;
}
StyleColorProperty colorEnum = StyleContainer::getPropertyEnumeration<StyleColorProperty>(propertyName);
if (colorEnum != StyleColorProperty::eCount)
{
if (isinstance<int_>(propertyValue))
{
style.merge({ scopeName, colorEnum, propertyValue.cast<uint32_t>() });
}
else if (isinstance<pybind11::str>(propertyValue))
{
style.merge({ scopeName, colorEnum, propertyValue.cast<std::string>().c_str() });
}
}
}
inline StyleContainer getStyleContainer(const pybind11::handle& style)
{
using namespace pybind11;
StyleContainer convertedStyle;
for (const auto& scope : style.cast<dict>())
{
auto scopeName = scope.first.cast<std::string>();
const auto& scopeValue = scope.second;
if (isinstance<dict>(scopeValue))
{
/* It's a scope */
for (const auto& property : scopeValue.cast<dict>())
{
auto propertyName = property.first.cast<std::string>();
const auto& propertyValue = property.second;
addPropertyToStyle(convertedStyle, scopeName, propertyName, propertyValue);
}
}
else
{
/* It's a property */
addPropertyToStyle(convertedStyle, "", scopeName, scopeValue);
}
}
return convertedStyle;
}
/**
* @brief Converts Python style and applies it to the widget.
*
* In python we use regular dictionary as style. It can be like of this forms:
*
* {"Button::okButton:hovered": {"color": 0xff000000}}
* {"color": 0xff000000}
*
* Unlike C++ version, it supports multiple scopes at once:
*
* {"Button::red": {"color": 0xffff0000}, "Button::okButton:hovered": {"color": 0xff000000}}
*
* This function is inline because otherwise it would live in the omni.ui.python library and we would need to link all
* the python bindings libraries against omni.ui.python. We can't link python bindings to another python bindings. The
* best solution would be to create third library with this function.
*
* It's inline for OMNIUI_PYBIND_INIT_STYLES.
*/
inline void setWidgetStyle(Widget& widget, const pybind11::handle& style)
{
widget.setStyle(std::move(getStyleContainer(style)));
}
OMNIUI_API
pybind11::object convertStyleToPython(const std::shared_ptr<StyleContainer>& style);
/**
* @brief Opposite to setWidgetStyle. Returns python dict that represents the style.
*/
OMNIUI_API
pybind11::object getPythonStyle(Widget& widget);
/**
* @brief It returns the Python dict that is the style result of merging the
* styles of all the parents and the local style.
*/
OMNIUI_API
pybind11::object getResolvedPythonStyle(const std::shared_ptr<Widget>& widget);
OMNIUI_NAMESPACE_CLOSE_SCOPE
| 5,002 | C | 33.267123 | 118 | 0.671132 |
omniverse-code/kit/include/omni/ui/bind/DocCallbackHelper.h | // Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#define OMNIUI_PYBIND_DOC_CallbackHelper \
"Base class for the objects that should automatically clean up the callbacks. It collects all the callbacks created with OMNIUI_CALLBACK and is able to clean all of them. We use it to destroy the callbacks if the parent object is destroyed, and it helps to break circular references created by pybind11 because pybind11 can't use weak pointers.\n" \
"\n"
| 1,172 | C | 82.785708 | 353 | 0.578498 |
omniverse-code/kit/include/omni/ui/scene/DrawList.h | // Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "Api.h"
#include "DrawBuffer.h"
#include "DrawBufferIndex.h"
#include "Math.h"
#include <array>
#include <vector>
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
class AbstractDrawSystem;
struct DrawData
{
DrawBuffer** buffers = nullptr;
size_t bufferCount = 0;
operator bool() const
{
return buffers != nullptr && bufferCount != 0;
}
};
/**
* @brief The InvisibleButton widget provides a transparent command button.
*/
class OMNIUI_SCENE_CLASS_API DrawList
{
public:
enum LINE_FLAGS
{
LINE_FLAG_NONE = 0x0,
LINE_FLAG_BACK_CULLING = 0x1 << 0,
LINE_FLAG_FRONT_CULLING = 0x1 << 1,
};
OMNIUI_SCENE_API
DrawList();
OMNIUI_SCENE_API
~DrawList();
void destroy();
void addLine(const Vector3& begin, const Vector3& end, const Color4& color, float thickness);
void addRect(Float width, Float height, const Color4& color, const void* texture);
void addText(const char* text, const Vector3& point, const Color4& color, float size, uint32_t flag);
void addPolygonLines(const Vector3* points,
const Color4* colors,
const float* thicknesses,
const uint32_t* vertexIndices,
const uint32_t* vertexCounts,
const uint32_t* flags,
size_t vertexCountSize);
void addPolygonMesh(const Vector4* points,
const Color4* colors,
const uint32_t* vertexIndices,
const uint32_t* vertexCounts,
size_t vertexCountSize,
const Vector2* uvs = nullptr,
const void* const* textures = nullptr,
const void* const* resources = nullptr);
void addPolygonMesh(const Vector3* points,
const Color4* colors,
const uint32_t* vertexIndices,
const uint32_t* vertexCounts,
size_t vertexCountSize,
const Vector2* uvs = nullptr,
const void* const* textures = nullptr,
const void* const* resources = nullptr);
void addPoints(const Vector4* positions, const Color4* colors, const float* sizes, size_t pointCount);
void addPoints(const Vector4* positions, const Color4& color, float size, size_t pointCount);
void addPoints(const Vector3* positions, const Color4* colors, const float* sizes, size_t pointCount);
void addPoints(const Vector3* positions, const Color4& color, float size, size_t pointCount);
void beginTransform(const Matrix44& matrix,
const DrawBufferIndex& index,
std::shared_ptr<TransformBasis> basis = nullptr);
DrawBufferIndex endTransform();
void beginFrame();
void endFrame();
/**
* @brief Clears the buffers of the given index. We use it when destroying items.
*/
void clearBuffers(DrawBufferIndex& index);
const DrawData& getDrawData() const;
/**
* @brief Return the number of buffers used. Using for unit testing.
*/
size_t getBufferCount() const;
private:
size_t _getBufferIndex(DrawBuffer::BufferType bufferType);
std::vector<DrawBufferIndex> m_currentBufferStack;
size_t m_maxBufferIndex;
std::vector<Matrix44> m_transformStack;
std::vector<std::shared_ptr<TransformBasis>> m_basisStack;
std::vector<std::unique_ptr<DrawBuffer>> m_buffers;
std::vector<DrawBuffer*> m_outputBuffers;
DrawData m_outputData;
DrawBufferIndex m_rootBufferIndex;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 4,174 | C | 32.13492 | 106 | 0.630331 |
omniverse-code/kit/include/omni/ui/scene/AbstractDrawSystem.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "Api.h"
#include "Math.h"
#include <stdint.h>
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
class DrawBuffer;
/**
* @brief The InvisibleButton widget provides a transparent command button.
*/
class OMNIUI_SCENE_CLASS_API AbstractDrawSystem
{
public:
OMNIUI_SCENE_API
virtual ~AbstractDrawSystem();
virtual void setup() = 0;
virtual void beginFrame() = 0;
virtual void render(const DrawBuffer* const* buffers,
size_t bufferCount,
const Matrix44& projection,
const Matrix44& view,
float width,
float height,
float dpiScale) = 0;
virtual void endFrame() = 0;
virtual void destroy() = 0;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 1,248 | C | 27.386363 | 77 | 0.664263 |
omniverse-code/kit/include/omni/ui/scene/Label.h | // Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "AbstractShape.h"
#include "Math.h"
#include "Object.h"
#include <omni/ui/Alignment.h>
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
/**
* Defines a standard label for user interface items
*/
class OMNIUI_SCENE_CLASS_API Label : public AbstractShape
{
OMNIUI_SCENE_OBJECT(Label);
public:
OMNIUI_SCENE_API
virtual ~Label();
OMNIUI_SCENE_API
void intersect(const Vector3 origin,
const Vector3 direction,
const Vector2 mouse,
const Matrix44& projection,
const Matrix44& view,
GestureState state) override;
OMNIUI_SCENE_API
const AbstractGesture::GesturePayload* getGesturePayload() const override;
OMNIUI_SCENE_API
const AbstractGesture::GesturePayload* getGesturePayload(GestureState state) const override;
/**
* @brief This property holds the label's text.
*/
OMNIUI_PROPERTY(std::string, text, READ, getText, WRITE, setText, NOTIFY, setTextChangedFn);
/**
* @brief The color of the text
*/
OMNIUI_PROPERTY(Color4, color, DEFAULT, Color4{ 1.0 }, READ, getColor, WRITE, setColor);
/**
* @brief This property holds the alignment of the label's contents
* By default, the contents of the label are left-aligned and vertically-centered.
*/
OMNIUI_PROPERTY(Alignment, alignment, DEFAULT, Alignment::eLeftCenter, READ, getAlignment, WRITE, setAlignment);
/**
* @brief The font size
*/
OMNIUI_PROPERTY(float, size, DEFAULT, 12.0, READ, getSize, WRITE, setSize);
protected:
/**
* @brief A standard label for user interface items
*
* @param text The string with the text to display
*/
OMNIUI_SCENE_API
Label(const std::string& text);
OMNIUI_SCENE_API
void _drawContent(const Matrix44& projection, const Matrix44& view) override;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 2,372 | C | 28.6625 | 116 | 0.687605 |
omniverse-code/kit/include/omni/ui/scene/CameraModel.h | // Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "AbstractManipulatorModel.h"
#include "Math.h"
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
/**
* - A model that holds projection and view matrices
*/
class OMNIUI_SCENE_CLASS_API CameraModel : public AbstractManipulatorModel
{
public:
/**
* @brief Initialize the camera with the given projection/view matrices
*/
OMNIUI_SCENE_API
CameraModel(const Matrix44& projection, const Matrix44& view);
// TODO: perspective/ortho with origin, direction, fov
OMNIUI_SCENE_API
~CameraModel() override;
/**
* @brief Returns the items that represents the identifier.
*/
OMNIUI_SCENE_API
std::shared_ptr<const AbstractManipulatorItem> getItem(const std::string& identifier) override;
/**
* @brief Returns the float values of the item.
*/
OMNIUI_SCENE_API
std::vector<Float> getAsFloats(const std::shared_ptr<const AbstractManipulatorItem>& item) override;
/**
* @brief Returns the int values of the item.
*/
OMNIUI_SCENE_API
std::vector<int64_t> getAsInts(const std::shared_ptr<const AbstractManipulatorItem>& item) override;
/**
* @brief Sets the float values of the item.
*/
OMNIUI_SCENE_API
void setFloats(const std::shared_ptr<const AbstractManipulatorItem>& item, std::vector<Float> value) override;
/**
* @brief Sets the int values of the item.
*/
OMNIUI_SCENE_API
void setInts(const std::shared_ptr<const AbstractManipulatorItem>& item, std::vector<int64_t> value) override;
/**
* @brief The camera projection matrix.
*/
OMNIUI_SCENE_API
virtual Matrix44 getProjection() const;
/**
* @brief The camera view matrix.
*/
OMNIUI_SCENE_API
virtual Matrix44 getView() const;
/**
* @brief Set the camera projection matrix.
*/
OMNIUI_SCENE_API
virtual void setProjection(const Matrix44& projection);
/**
* @brief Set the camera view matrix.
*/
OMNIUI_SCENE_API
virtual void setView(const Matrix44& view);
private:
class MatrixItem : public AbstractManipulatorItem
{
public:
MatrixItem(const Matrix44& matrix);
~MatrixItem() override;
const std::vector<Float>& getAsFloats() const;
Matrix44 getAsMatrix() const;
void setFloats(std::vector<Float>&& value);
void setMatrix(const Matrix44& matrix);
private:
std::vector<Float> m_floats;
};
std::shared_ptr<MatrixItem> m_projection;
std::shared_ptr<MatrixItem> m_view;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 3,025 | C | 26.761468 | 114 | 0.682645 |
omniverse-code/kit/include/omni/ui/scene/Rectangle.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "AbstractShape.h"
#include "Math.h"
#include "Object.h"
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
class OMNIUI_SCENE_CLASS_API Rectangle : public AbstractShape
{
OMNIUI_SCENE_OBJECT(Rectangle);
public:
class RectangleGesturePayload : public AbstractGesture::GesturePayload
{
public:
Float s = 0.0;
Float t = 0.0;
Float movedS = 0.0;
Float movedT = 0.0;
Vector3 moved = Vector3{ 0.0 };
};
OMNIUI_SCENE_API
virtual ~Rectangle();
OMNIUI_SCENE_API
void intersect(const Vector3 origin,
const Vector3 direction,
const Vector2 mouse,
const Matrix44& projection,
const Matrix44& view,
GestureState state) override;
/**
* @brief Contains all the information about the intersection
*/
OMNIUI_SCENE_API
const RectangleGesturePayload* getGesturePayload() const override;
/**
* @brief Contains all the information about the intersection at the specific state
*/
OMNIUI_SCENE_API
const RectangleGesturePayload* getGesturePayload(GestureState state) const override;
/**
* @brief The distance in pixels from mouse pointer to the shape for the intersection.
*/
OMNIUI_SCENE_API
Float getIntersectionDistance() const override;
/**
* @brief The size of the rectangle
*/
OMNIUI_PROPERTY(Float, width, READ, getWidth, WRITE, setWidth, PROTECTED, NOTIFY, _setWidthChangedFn);
/**
* @brief The size of the rectangle
*/
OMNIUI_PROPERTY(Float, height, READ, getHeight, WRITE, setHeight, PROTECTED, NOTIFY, _setHeightChangedFn);
/**
* @brief The thickness of the line
*/
OMNIUI_PROPERTY(
float, thickness, DEFAULT, 1.0, READ, getThickness, WRITE, setThickness, PROTECTED, NOTIFY, _setThicknessChangedFn);
/**
* @brief The thickness of the line for the intersection
*/
OMNIUI_PROPERTY(float,
intersectionThickness,
DEFAULT,
0.0,
READ,
getIntersectionThickness,
WRITE,
setIntersectionThickness,
PROTECTED,
NOTIFY,
_setIntersectionThicknessChangedFn);
/**
* @brief The color of the line
*/
OMNIUI_PROPERTY(
Color4, color, DEFAULT, Color4{ 1.0 }, READ, getColor, WRITE, setColor, PROTECTED, NOTIFY, _setColorChangedFn);
/**
* @brief When true, it's a line. When false it's a mesh.
*/
OMNIUI_PROPERTY(
bool, wireframe, DEFAULT, false, READ, isWireframe, WRITE, setWireframe, PROTECTED, NOTIFY, _setWireframeChangedFn);
/**
* @brief The axis the rectangle is perpendicular to
*/
OMNIUI_PROPERTY(uint8_t, axis, DEFAULT, 2, READ, getAxis, WRITE, setAxis, PROTECTED, NOTIFY, _setAxisChangedFn);
protected:
/**
* @brief Construct a rectangle with predefined size.
*
* @param width The size of the rectangle
* @param height The size of the rectangle
*/
OMNIUI_SCENE_API
Rectangle(Float width = 1.0, Float height = 1.0);
OMNIUI_SCENE_API
void _drawContent(const Matrix44& projection, const Matrix44& view) override;
void _dirtyCache();
virtual void _rebuildCache();
std::unique_ptr<RectangleGesturePayload> m_lastGesturePayload;
std::array<std::unique_ptr<RectangleGesturePayload>, static_cast<uint32_t>(GestureState::eCount)> m_itersections;
// Cache to avoid computation every frame
std::vector<Vector3> m_cachedPoints;
std::vector<Color4> m_cachedColors;
std::vector<uint32_t> m_cachedVertexIndices;
std::vector<uint32_t> m_cachedVertexCounts;
std::vector<float> m_cachedThicknesses;
bool m_cacheIsDirty = true;
bool m_intersectionThicknessExplicitlyChanged = false;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 4,422 | C | 30.368794 | 124 | 0.651289 |
omniverse-code/kit/include/omni/ui/scene/Manipulator.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "AbstractContainer.h"
#include "AbstractGesture.h"
#include "AbstractManipulatorModel.h"
#include "ManipulatorModelHelper.h"
#include <unordered_map>
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
class ManipulatorGesture;
/**
* @brief The base object for the custom manipulators
*/
class OMNIUI_SCENE_CLASS_API Manipulator : public AbstractContainer, public ManipulatorModelHelper
{
OMNIUI_SCENE_OBJECT(Manipulator);
public:
OMNIUI_SCENE_API
virtual ~Manipulator();
/**
* @brief Called when Manipulator is dirty to build the content.
*/
OMNIUI_SCENE_API
virtual void onBuild();
/**
* @brief Make Manipulator dirty so onBuild will be executed in
* _preDrawContent
*/
OMNIUI_SCENE_API
void invalidate();
/**
* @brief Called by the model when the model value is changed. The class should react to the changes.
*
* @param item The item in the model that is changed. If it's NULL, the root is changed.
*/
OMNIUI_SCENE_API
void onModelUpdated(const std::shared_ptr<const AbstractManipulatorModel::AbstractManipulatorItem>& item) override;
/**
* @brief All the gestures assigned to this manipulator
*/
OMNIUI_SCENE_API
const std::vector<std::shared_ptr<ManipulatorGesture>>& getGestures() const;
/**
* @brief Replace the gestures of the manipulator
*/
OMNIUI_SCENE_API
void setGestures(const std::vector<std::shared_ptr<ManipulatorGesture>>& gestures);
/**
* @brief Add a single gesture to the manipulator
*/
OMNIUI_SCENE_API
void addGesture(const std::shared_ptr<ManipulatorGesture>& gesture);
/**
* @brief Called when Manipulator is dirty to build the content. It's
* another way to build the manipulator's content on the case the user
* doesn't want to reimplement the class.
*/
OMNIUI_CALLBACK(OnBuild, void, Manipulator const*);
protected:
/**
* @brief Constructor
*/
OMNIUI_SCENE_API
Manipulator();
OMNIUI_SCENE_API
void _preDrawContent(
const MouseInput& input, const Matrix44& projection, const Matrix44& view, float width, float height) override;
OMNIUI_SCENE_API
void _drawContent(const Matrix44& projection, const Matrix44& view) override;
OMNIUI_SCENE_API
void _postDrawContent(const Matrix44& projection, const Matrix44& view) override;
/**
* @brief Process the ManipulatorGestures that can be casted to the given type
*/
template <class Gesture>
void _processGesture(GestureState state, const std::shared_ptr<AbstractGesture::GesturePayload>& gesturePayload)
{
if (!gesturePayload)
{
return;
}
for (auto& gesture : m_gestures)
{
auto castedGesture = std::dynamic_pointer_cast<Gesture>(gesture);
if (castedGesture)
{
castedGesture->_processWithGesturePayload(this, state, gesturePayload);
}
}
}
std::vector<std::shared_ptr<ManipulatorGesture>> m_gestures;
private:
bool m_dirty = true;
// We need it to keep the old children. We remove them in _postDrawContent.
std::vector<std::shared_ptr<AbstractItem>> m_oldChildren;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 3,744 | C | 28.488189 | 119 | 0.68563 |
omniverse-code/kit/include/omni/ui/scene/Api.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#ifdef _WIN32
# define OMNIUI_SCENE_EXPORT __declspec(dllexport)
# define OMNIUI_SCENE_IMPORT __declspec(dllimport)
# define OMNIUI_SCENE_CLASS_EXPORT
#else
# define OMNIUI_SCENE_EXPORT __attribute__((visibility("default")))
# define OMNIUI_SCENE_IMPORT
# define OMNIUI_SCENE_CLASS_EXPORT __attribute__((visibility("default")))
#endif
#if defined(OMNIUI_SCENE_STATIC)
# define OMNIUI_SCENE_API
# define OMNIUI_SCENE_CLASS_API
#else
# if defined(OMNIUI_SCENE_EXPORTS)
# define OMNIUI_SCENE_API OMNIUI_SCENE_EXPORT
# define OMNIUI_SCENE_CLASS_API OMNIUI_SCENE_CLASS_EXPORT
# else
# define OMNIUI_SCENE_API OMNIUI_SCENE_IMPORT
# define OMNIUI_SCENE_CLASS_API
# endif
#endif
#define OMNIUI_SCENE_NS omni::ui::scene
#define OMNIUI_SCENE_NAMESPACE_USING_DIRECTIVE using namespace OMNIUI_SCENE_NS;
#define OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE \
namespace omni \
{ \
namespace ui \
{ \
namespace scene \
{
#define OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE \
} \
} \
}
| 2,403 | C | 50.148935 | 120 | 0.44819 |
omniverse-code/kit/include/omni/ui/scene/Curve.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "AbstractShape.h"
#include "Math.h"
#include "Object.h"
#include <array>
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
/**
* @brief Represents the curve.
*/
class OMNIUI_SCENE_CLASS_API Curve : public AbstractShape
{
OMNIUI_SCENE_OBJECT(Curve);
public:
class CurveGesturePayload : public AbstractGesture::GesturePayload
{
public:
// The normalized distance [0..1] along the curve from begin of the
// segment to itemClosestPoint
Float curveDistance = 0.0;
// The difference between rayClosestPoint in the previous frame and
// rayClosestPoint in current frame.
Vector3 moved = Vector3{ 0.0 };
// The difference between curveDistance in the previous frame and
// curveDistance in current frame.
Float movedDistance = 0.0;
};
OMNIUI_SCENE_API
virtual ~Curve();
enum class CurveType
{
linear,
cubic,
};
OMNIUI_SCENE_API
void intersect(const Vector3 origin,
const Vector3 direction,
const Vector2 mouse,
const Matrix44& projection,
const Matrix44& view,
GestureState state) override;
/**
* @brief Contains all the information about the intersection
*/
OMNIUI_SCENE_API
const CurveGesturePayload* getGesturePayload() const override;
/**
* @brief Contains all the information about the intersection at the specific state
*/
OMNIUI_SCENE_API
const CurveGesturePayload* getGesturePayload(GestureState state) const override;
/**
* @brief The distance in pixels from mouse pointer to the shape for the intersection.
*/
OMNIUI_SCENE_API
Float getIntersectionDistance() const override;
/**
* @brief The list of positions which defines the curve. It has at least two positions. The curve has
* `len(positions)-1` segments.
*/
OMNIUI_PROPERTY(std::vector<Vector3>, positions, READ, getPositions, WRITE, setPositions, NOTIFY, _setPositionsChangedFn);
/**
* @brief The list of colors which defines color per vertex. It has the same length as positions
*/
OMNIUI_PROPERTY(std::vector<Color4>, colors, READ, getColors, WRITE, setColors, NOTIFY, _setColorsChangedFn);
/**
* @brief The list of thicknesses which defines thickness per vertex. It has the same length as positions
*/
OMNIUI_PROPERTY(
std::vector<float>, thicknesses, READ, getThicknesses, WRITE, setThicknesses, NOTIFY, _setThicknessesChangedFn);
/**
* @brief The thickness of the line for the intersection
*/
OMNIUI_PROPERTY(float,
intersectionThickness,
DEFAULT,
0.0,
READ,
getIntersectionThickness,
WRITE,
setIntersectionThickness,
PROTECTED,
NOTIFY,
_setIntersectionThicknessChangedFn);
/**
* @brief The curve interpolation type
*/
OMNIUI_PROPERTY(CurveType,
curveType,
DEFAULT,
CurveType::cubic,
READ,
getCurveType,
WRITE,
setCurveType,
NOTIFY,
_setCurveTypeChangedFn);
/**
* @brief The number of points per curve segment. It can't be less than 2
*/
OMNIUI_PROPERTY(
uint16_t, tessellation, DEFAULT, 9, READ, getTessellation, WRITE, setTessellation, NOTIFY, _setTessellationChangedFn);
protected:
/**
* @brief Constructs Curve
* @param positions List of positions
*/
OMNIUI_SCENE_API
Curve(const std::vector<Vector3>& positions = {});
OMNIUI_SCENE_API
void _drawContent(const Matrix44& projection, const Matrix44& view) override;
void _dirtyCache();
void _rebuildCache();
/**
* @brief Compute curve positions with input 4 vertices and tessellation
* @param p0 start position
* @param p1 second control position
* @param p2 thrid constrol position
* @param p3 end position
* @param tessellation tessellation of the curve
*/
void _computeCurvePoses(const Vector3 p0,
const Vector3 p1,
const Vector3 p2,
const Vector3 p3,
const uint16_t tessellation,
std::vector<Vector3>& poses);
/**
* @brief Interpolate float with start and end floats into segment sized floats
* @param start start float
* @param end end float
* @param segment size of segment
* @param result the resulted vector of the interpolated floats. It includes the start, but not the end float
*/
void _interpolateFloat(float start, float end, size_t segment, std::vector<float>& result);
/**
* @brief Interpolate color with start and end colors into segment sized colors
* @param start start color
* @param end end color
* @param segment size of segment
* @param result the resulted vector of the interpolated colors. It includes the start, but not the end color
*/
void _interpolateColor(Color4 start, Color4 end, size_t segment, std::vector<Color4>& result);
// Cache to avoid computation every frame
std::vector<Vector3> m_cachedPositions;
std::vector<Color4> m_cachedColors;
std::vector<uint32_t> m_cachedVertexIndices;
std::vector<uint32_t> m_cachedVertexCounts;
std::vector<uint32_t> m_cachedFlags;
std::vector<float> m_cachedThicknesses;
// accumulated length from the start of the curve till the current vertex
std::vector<float> m_cachedLengths;
bool m_cacheIsDirty = true;
std::unique_ptr<CurveGesturePayload> m_lastGesturePayload;
std::array<std::unique_ptr<CurveGesturePayload>, static_cast<uint32_t>(GestureState::eCount)> m_itersections;
bool m_intersectionThicknessExplicitlyChanged = false;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 6,587 | C | 33.134715 | 126 | 0.63762 |
omniverse-code/kit/include/omni/ui/scene/TexturedMesh.h | // Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "ImageHelper.h"
#include "PolygonMesh.h"
#include "Object.h"
OMNIUI_NAMESPACE_OPEN_SCOPE
class ImageProvider;
OMNIUI_NAMESPACE_CLOSE_SCOPE
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
/**
* @brief The shape for free-form textures. It supports both ImageProvider and
* URL. Basically it's PolygonMesh with the ability to use images.
*
* TODO: Tiling:
* We use the tiling provided by ImGui. In the future we can implement it
* when we need it.
*
* TODO: Alpha behavior:
* It should behave exactly like sc.Image. We can add a property for it later if
* we need it.
*/
class OMNIUI_SCENE_CLASS_API TexturedMesh : public PolygonMesh, public ImageHelper
{
OMNIUI_SCENE_OBJECT(TexturedMesh);
public:
class TexturedMeshGesturePayload : public PolygonMesh::PolygonMeshGesturePayload
{
public:
// The coords of the intersection in the space of the texture.
Float u = 0.0;
Float v = 0.0;
};
OMNIUI_SCENE_API
virtual ~TexturedMesh();
OMNIUI_SCENE_API
void intersect(const Vector3 origin,
const Vector3 direction,
const Vector2 mouse,
const Matrix44& projection,
const Matrix44& view,
GestureState state) override;
/**
* @brief Contains all the information about the intersection
*/
OMNIUI_SCENE_API
const TexturedMeshGesturePayload* getGesturePayload() const override;
/**
* @brief Contains all the information about the intersection at the specific state
*/
OMNIUI_SCENE_API
const TexturedMeshGesturePayload* getGesturePayload(GestureState state) const override;
/**
* @brief The texture coordinates.
*
* The number of elements corresponds to the face-varying interpolation: One
* element for each of the face-vertices that define the mesh topology.
*/
OMNIUI_PROPERTY(std::vector<Vector2>, uvs, GET_VALUE, getUvs, WRITE, setUvs, PROTECTED, NOTIFY, _setUvsChangedFn);
/**
* @brief This property holds the image URL. It can be an `omni:` path, a `file:` path, a direct path or the path
* relative to the application root directory.
*/
OMNIUI_PROPERTY(
std::string, sourceUrl, READ, getSourceUrl, WRITE, setSourceUrl, PROTECTED, NOTIFY, _setSourceUrlChangedFn);
/**
* @brief This property holds the image provider. It can be an `omni:` path, a `file:` path, a direct path or the
* path relative to the application root directory.
*/
OMNIUI_PROPERTY(std::shared_ptr<ImageProvider>,
imageProvider,
READ,
getImageProvider,
WRITE,
setImageProvider,
PROTECTED,
NOTIFY,
_setImageProviderChangedFn);
protected:
/**
* @brief Create with the given URL
*/
OMNIUI_SCENE_API
TexturedMesh(const std::string& sourceUrl,
const std::vector<Vector2>& uvs,
const std::vector<Vector3>& positions,
const std::vector<Color4>& colors,
const std::vector<uint32_t>& vertexCounts,
const std::vector<uint32_t>& vertexIndices,
bool legacyFlippedV = true);
/**
* @brief Create with the given provider
*/
OMNIUI_SCENE_API
TexturedMesh(const std::shared_ptr<ImageProvider>& imageProvider,
const std::vector<Vector2>& uvs,
const std::vector<Vector3>& positions,
const std::vector<Color4>& colors,
const std::vector<uint32_t>& vertexCounts,
const std::vector<uint32_t>& vertexIndices,
bool legacyFlippedV = true);
OMNIUI_SCENE_API
void _drawContent(const Matrix44& projection, const Matrix44& view) override;
void _initialize(const std::vector<Vector2>& uvs);
void _uvsChanged();
std::unique_ptr<TexturedMeshGesturePayload> m_lastGesturePayload;
std::array<std::unique_ptr<TexturedMeshGesturePayload>, static_cast<uint32_t>(GestureState::eCount)> m_itersections;
const bool m_legacyFlippedV;
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 4,682 | C | 33.688889 | 120 | 0.652285 |
omniverse-code/kit/include/omni/ui/scene/DragGesture.h | // Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//
#pragma once
#include "Object.h"
#include "ShapeGesture.h"
OMNIUI_SCENE_NAMESPACE_OPEN_SCOPE
/**
* @brief The gesture that provides a way to capture click-and-drag mouse
* event.
*/
class OMNIUI_SCENE_CLASS_API DragGesture : public ShapeGesture
{
OMNIUI_GESTURE_OBJECT(DragGesture)
public:
OMNIUI_SCENE_API
~DragGesture();
/**
* @brief Called before processing to determine the state of the gesture.
*/
OMNIUI_SCENE_API
void preProcess(const Matrix44& projection, const Matrix44& view) override;
/**
* @brief Process the gesture and call callbacks if necessary.
*/
OMNIUI_SCENE_API
void process() override;
/**
* @brief Called if the callback is not set when the user clicks the mouse
* button.
*/
OMNIUI_SCENE_API
virtual void onBegan();
/**
* @brief Called if the callback is not set when the user moves the clicked
* button.
*/
OMNIUI_SCENE_API
virtual void onChanged();
/**
* @brief Called if the callback is not set when the user releases the mouse
* button.
*/
OMNIUI_SCENE_API
virtual void onEnded();
/**
* @brief Mouse button that should be active to start the gesture
*/
OMNIUI_PROPERTY(uint32_t, mouseButton, DEFAULT, 0, READ, getMouseButton, WRITE, setMouseButton);
/**
* @brief The keyboard modifier that should be active ti start the gesture
*/
OMNIUI_PROPERTY(uint32_t, modifiers, DEFAULT, UINT32_MAX, READ, getModifiers, WRITE, setModifiers);
/**
* @brief The check_mouse_moved property is a boolean flag that determines
* whether the DragGesture should verify if the 2D screen position of the
* mouse has changed before invoking the on_changed method. This property
* is essential in a 3D environment, as changes in the camera position can
* result in the mouse pointing to different locations in the 3D world even
* when the 2D screen position remains unchanged.
*
* Usage
*
* When check_mouse_moved is set to True, the DragGesture will only
* call the on_changed method if the actual 2D screen position of the
* mouse has changed. This can be useful when you want to ensure that the
* on_changed method is only triggered when there is a genuine change in
* the mouse's 2D screen position.
*
* If check_mouse_moved is set to False, the DragGesture will not
* check for changes in the mouse's 2D screen position before calling the
* on_changed method. This can be useful when you want the on_changed
* method to be invoked even if the mouse's 2D screen position hasn't
* changed, such as when the camera position is altered, and the mouse now
* points to a different location in the 3D world.
*/
OMNIUI_PROPERTY(bool, checkMouseMoved, DEFAULT, false, READ, isCheckMouseMoved, WRITE, setCheckMouseMoved);
/**
* @brief Called when the user starts drag
*/
OMNIUI_CALLBACK(OnBegan, void, AbstractShape const*);
/**
* @brief Called when the user is dragging
*/
OMNIUI_CALLBACK(OnChanged, void, AbstractShape const*);
/**
* @brief Called when the user releases the mouse and finishes the drag
*/
OMNIUI_CALLBACK(OnEnded, void, AbstractShape const*);
protected:
/**
* @brief Construct the gesture to track mouse drags.
*/
OMNIUI_SCENE_API
DragGesture();
private:
Vector3 m_itemLastPoint = Vector3{ 0.0 };
Vector3 m_rayLastPoint = Vector3{ 0.0 };
Vector2 m_mouseLast = Vector3{ 0.0 };
};
OMNIUI_SCENE_NAMESPACE_CLOSE_SCOPE
| 4,070 | C | 31.568 | 111 | 0.687961 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.