file_path
stringlengths 21
224
| content
stringlengths 0
80.8M
|
|---|---|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_mouse.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_mouse.h
*
* Include file for SDL mouse event handling.
*/
#ifndef SDL_mouse_h_
#define SDL_mouse_h_
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */
/**
* \brief Cursor types for SDL_CreateSystemCursor().
*/
typedef enum
{
SDL_SYSTEM_CURSOR_ARROW, /**< Arrow */
SDL_SYSTEM_CURSOR_IBEAM, /**< I-beam */
SDL_SYSTEM_CURSOR_WAIT, /**< Wait */
SDL_SYSTEM_CURSOR_CROSSHAIR, /**< Crosshair */
SDL_SYSTEM_CURSOR_WAITARROW, /**< Small wait cursor (or Wait if not available) */
SDL_SYSTEM_CURSOR_SIZENWSE, /**< Double arrow pointing northwest and southeast */
SDL_SYSTEM_CURSOR_SIZENESW, /**< Double arrow pointing northeast and southwest */
SDL_SYSTEM_CURSOR_SIZEWE, /**< Double arrow pointing west and east */
SDL_SYSTEM_CURSOR_SIZENS, /**< Double arrow pointing north and south */
SDL_SYSTEM_CURSOR_SIZEALL, /**< Four pointed arrow pointing north, south, east, and west */
SDL_SYSTEM_CURSOR_NO, /**< Slashed circle or crossbones */
SDL_SYSTEM_CURSOR_HAND, /**< Hand */
SDL_NUM_SYSTEM_CURSORS
} SDL_SystemCursor;
/**
* \brief Scroll direction types for the Scroll event
*/
typedef enum
{
SDL_MOUSEWHEEL_NORMAL, /**< The scroll direction is normal */
SDL_MOUSEWHEEL_FLIPPED /**< The scroll direction is flipped / natural */
} SDL_MouseWheelDirection;
/* Function prototypes */
/**
* \brief Get the window which currently has mouse focus.
*/
extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
/**
* \brief Retrieve the current state of the mouse.
*
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
* mouse cursor position relative to the focus window for the currently
* selected mouse. You can pass NULL for either x or y.
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y);
/**
* \brief Get the current state of the mouse, in relation to the desktop
*
* This works just like SDL_GetMouseState(), but the coordinates will be
* reported relative to the top-left of the desktop. This can be useful if
* you need to track the mouse outside of a specific window and
* SDL_CaptureMouse() doesn't fit your needs. For example, it could be
* useful if you need to track the mouse while dragging a window, where
* coordinates relative to a window might not be in sync at all times.
*
* \note SDL_GetMouseState() returns the mouse position as SDL understands
* it from the last pump of the event queue. This function, however,
* queries the OS for the current mouse position, and as such, might
* be a slightly less efficient function. Unless you know what you're
* doing and have a good reason to use this function, you probably want
* SDL_GetMouseState() instead.
*
* \param x Returns the current X coord, relative to the desktop. Can be NULL.
* \param y Returns the current Y coord, relative to the desktop. Can be NULL.
* \return The current button state as a bitmask, which can be tested using the SDL_BUTTON(X) macros.
*
* \sa SDL_GetMouseState
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(int *x, int *y);
/**
* \brief Retrieve the relative state of the mouse.
*
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
* mouse deltas since the last call to SDL_GetRelativeMouseState().
*/
extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
/**
* \brief Moves the mouse to the given position within the window.
*
* \param window The window to move the mouse into, or NULL for the current mouse focus
* \param x The x coordinate within the window
* \param y The y coordinate within the window
*
* \note This function generates a mouse motion event
*/
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
int x, int y);
/**
* \brief Moves the mouse to the given position in global screen space.
*
* \param x The x coordinate
* \param y The y coordinate
* \return 0 on success, -1 on error (usually: unsupported by a platform).
*
* \note This function generates a mouse motion event
*/
extern DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y);
/**
* \brief Set relative mouse mode.
*
* \param enabled Whether or not to enable relative mode
*
* \return 0 on success, or -1 if relative mode is not supported.
*
* While the mouse is in relative mode, the cursor is hidden, and the
* driver will try to report continuous motion in the current window.
* Only relative motion events will be delivered, the mouse position
* will not change.
*
* \note This function will flush any pending mouse motion.
*
* \sa SDL_GetRelativeMouseMode()
*/
extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
/**
* \brief Capture the mouse, to track input outside an SDL window.
*
* \param enabled Whether or not to enable capturing
*
* Capturing enables your app to obtain mouse events globally, instead of
* just within your window. Not all video targets support this function.
* When capturing is enabled, the current window will get all mouse events,
* but unlike relative mode, no change is made to the cursor and it is
* not restrained to your window.
*
* This function may also deny mouse input to other windows--both those in
* your application and others on the system--so you should use this
* function sparingly, and in small bursts. For example, you might want to
* track the mouse while the user is dragging something, until the user
* releases a mouse button. It is not recommended that you capture the mouse
* for long periods of time, such as the entire time your app is running.
*
* While captured, mouse events still report coordinates relative to the
* current (foreground) window, but those coordinates may be outside the
* bounds of the window (including negative values). Capturing is only
* allowed for the foreground window. If the window loses focus while
* capturing, the capture will be disabled automatically.
*
* While capturing is enabled, the current window will have the
* SDL_WINDOW_MOUSE_CAPTURE flag set.
*
* \return 0 on success, or -1 if not supported.
*/
extern DECLSPEC int SDLCALL SDL_CaptureMouse(SDL_bool enabled);
/**
* \brief Query whether relative mouse mode is enabled.
*
* \sa SDL_SetRelativeMouseMode()
*/
extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
/**
* \brief Create a cursor, using the specified bitmap data and
* mask (in MSB format).
*
* The cursor width must be a multiple of 8 bits.
*
* The cursor is created in black and white according to the following:
* <table>
* <tr><td> data </td><td> mask </td><td> resulting pixel on screen </td></tr>
* <tr><td> 0 </td><td> 1 </td><td> White </td></tr>
* <tr><td> 1 </td><td> 1 </td><td> Black </td></tr>
* <tr><td> 0 </td><td> 0 </td><td> Transparent </td></tr>
* <tr><td> 1 </td><td> 0 </td><td> Inverted color if possible, black
* if not. </td></tr>
* </table>
*
* \sa SDL_FreeCursor()
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
const Uint8 * mask,
int w, int h, int hot_x,
int hot_y);
/**
* \brief Create a color cursor.
*
* \sa SDL_FreeCursor()
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
int hot_x,
int hot_y);
/**
* \brief Create a system cursor.
*
* \sa SDL_FreeCursor()
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id);
/**
* \brief Set the active cursor.
*/
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
/**
* \brief Return the active cursor.
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
/**
* \brief Return the default cursor.
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void);
/**
* \brief Frees a cursor created with SDL_CreateCursor() or similar functions.
*
* \sa SDL_CreateCursor()
* \sa SDL_CreateColorCursor()
* \sa SDL_CreateSystemCursor()
*/
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
/**
* \brief Toggle whether or not the cursor is shown.
*
* \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current
* state.
*
* \return 1 if the cursor is shown, or 0 if the cursor is hidden.
*/
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
/**
* Used as a mask when testing buttons in buttonstate.
* - Button 1: Left mouse button
* - Button 2: Middle mouse button
* - Button 3: Right mouse button
*/
#define SDL_BUTTON(X) (1 << ((X)-1))
#define SDL_BUTTON_LEFT 1
#define SDL_BUTTON_MIDDLE 2
#define SDL_BUTTON_RIGHT 3
#define SDL_BUTTON_X1 4
#define SDL_BUTTON_X2 5
#define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT)
#define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE)
#define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT)
#define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
#define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_mouse_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_test_common.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_test_common.h
*
* Include file for SDL test framework.
*
* This code is a part of the SDL2_test library, not the main SDL library.
*/
/* Ported from original test\common.h file. */
#ifndef SDL_test_common_h_
#define SDL_test_common_h_
#include "SDL.h"
#if defined(__PSP__)
#define DEFAULT_WINDOW_WIDTH 480
#define DEFAULT_WINDOW_HEIGHT 272
#else
#define DEFAULT_WINDOW_WIDTH 640
#define DEFAULT_WINDOW_HEIGHT 480
#endif
#define VERBOSE_VIDEO 0x00000001
#define VERBOSE_MODES 0x00000002
#define VERBOSE_RENDER 0x00000004
#define VERBOSE_EVENT 0x00000008
#define VERBOSE_AUDIO 0x00000010
typedef struct
{
/* SDL init flags */
char **argv;
Uint32 flags;
Uint32 verbose;
/* Video info */
const char *videodriver;
int display;
const char *window_title;
const char *window_icon;
Uint32 window_flags;
int window_x;
int window_y;
int window_w;
int window_h;
int window_minW;
int window_minH;
int window_maxW;
int window_maxH;
int logical_w;
int logical_h;
float scale;
int depth;
int refresh_rate;
int num_windows;
SDL_Window **windows;
/* Renderer info */
const char *renderdriver;
Uint32 render_flags;
SDL_bool skip_renderer;
SDL_Renderer **renderers;
SDL_Texture **targets;
/* Audio info */
const char *audiodriver;
SDL_AudioSpec audiospec;
/* GL settings */
int gl_red_size;
int gl_green_size;
int gl_blue_size;
int gl_alpha_size;
int gl_buffer_size;
int gl_depth_size;
int gl_stencil_size;
int gl_double_buffer;
int gl_accum_red_size;
int gl_accum_green_size;
int gl_accum_blue_size;
int gl_accum_alpha_size;
int gl_stereo;
int gl_multisamplebuffers;
int gl_multisamplesamples;
int gl_retained_backing;
int gl_accelerated;
int gl_major_version;
int gl_minor_version;
int gl_debug;
int gl_profile_mask;
} SDLTest_CommonState;
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/* Function prototypes */
/**
* \brief Parse command line parameters and create common state.
*
* \param argv Array of command line parameters
* \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
*
* \returns Returns a newly allocated common state object.
*/
SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
/**
* \brief Process one common argument.
*
* \param state The common state describing the test window to create.
* \param index The index of the argument to process in argv[].
*
* \returns The number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
*/
int SDLTest_CommonArg(SDLTest_CommonState * state, int index);
/**
* \brief Returns common usage information
*
* \param state The common state describing the test window to create.
*
* \returns String with usage information
*/
const char *SDLTest_CommonUsage(SDLTest_CommonState * state);
/**
* \brief Open test window.
*
* \param state The common state describing the test window to create.
*
* \returns True if initialization succeeded, false otherwise
*/
SDL_bool SDLTest_CommonInit(SDLTest_CommonState * state);
/**
* \brief Common event handler for test windows.
*
* \param state The common state used to create test window.
* \param event The event to handle.
* \param done Flag indicating we are done.
*
*/
void SDLTest_CommonEvent(SDLTest_CommonState * state, SDL_Event * event, int *done);
/**
* \brief Close test window.
*
* \param state The common state used to create test window.
*
*/
void SDLTest_CommonQuit(SDLTest_CommonState * state);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_test_common_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_opengles2.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_opengles2.h
*
* This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
*/
#include "SDL_config.h"
#ifndef _MSC_VER
#ifdef __IPHONEOS__
#include <OpenGLES/ES2/gl.h>
#include <OpenGLES/ES2/glext.h>
#else
#include <GLES2/gl2platform.h>
#include <GLES2/gl2.h>
#include <GLES2/gl2ext.h>
#endif
#else /* _MSC_VER */
/* OpenGL ES2 headers for Visual Studio */
#include "SDL_opengles2_khrplatform.h"
#include "SDL_opengles2_gl2platform.h"
#include "SDL_opengles2_gl2.h"
#include "SDL_opengles2_gl2ext.h"
#endif /* _MSC_VER */
#ifndef APIENTRY
#define APIENTRY GL_APIENTRY
#endif
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_power.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#ifndef SDL_power_h_
#define SDL_power_h_
/**
* \file SDL_power.h
*
* Header for the SDL power management routines.
*/
#include "SDL_stdinc.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
* \brief The basic state for the system's power supply.
*/
typedef enum
{
SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */
SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
SDL_POWERSTATE_NO_BATTERY, /**< Plugged in, no battery available */
SDL_POWERSTATE_CHARGING, /**< Plugged in, charging battery */
SDL_POWERSTATE_CHARGED /**< Plugged in, battery charged */
} SDL_PowerState;
/**
* \brief Get the current power supply details.
*
* \param secs Seconds of battery life left. You can pass a NULL here if
* you don't care. Will return -1 if we can't determine a
* value, or we're not running on a battery.
*
* \param pct Percentage of battery life left, between 0 and 100. You can
* pass a NULL here if you don't care. Will return -1 if we
* can't determine a value, or we're not running on a battery.
*
* \return The state of the battery (if any).
*/
extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_power_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_rwops.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_rwops.h
*
* This file provides a general interface for SDL to read and write
* data streams. It can easily be extended to files, memory, etc.
*/
#ifndef SDL_rwops_h_
#define SDL_rwops_h_
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/* RWops Types */
#define SDL_RWOPS_UNKNOWN 0U /**< Unknown stream type */
#define SDL_RWOPS_WINFILE 1U /**< Win32 file */
#define SDL_RWOPS_STDFILE 2U /**< Stdio file */
#define SDL_RWOPS_JNIFILE 3U /**< Android asset */
#define SDL_RWOPS_MEMORY 4U /**< Memory stream */
#define SDL_RWOPS_MEMORY_RO 5U /**< Read-Only memory stream */
/**
* This is the read/write operation structure -- very basic.
*/
typedef struct SDL_RWops
{
/**
* Return the size of the file in this rwops, or -1 if unknown
*/
Sint64 (SDLCALL * size) (struct SDL_RWops * context);
/**
* Seek to \c offset relative to \c whence, one of stdio's whence values:
* RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
*
* \return the final offset in the data stream, or -1 on error.
*/
Sint64 (SDLCALL * seek) (struct SDL_RWops * context, Sint64 offset,
int whence);
/**
* Read up to \c maxnum objects each of size \c size from the data
* stream to the area pointed at by \c ptr.
*
* \return the number of objects read, or 0 at error or end of file.
*/
size_t (SDLCALL * read) (struct SDL_RWops * context, void *ptr,
size_t size, size_t maxnum);
/**
* Write exactly \c num objects each of size \c size from the area
* pointed at by \c ptr to data stream.
*
* \return the number of objects written, or 0 at error or end of file.
*/
size_t (SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
size_t size, size_t num);
/**
* Close and free an allocated SDL_RWops structure.
*
* \return 0 if successful or -1 on write error when flushing data.
*/
int (SDLCALL * close) (struct SDL_RWops * context);
Uint32 type;
union
{
#if defined(__ANDROID__)
struct
{
void *fileNameRef;
void *inputStreamRef;
void *readableByteChannelRef;
void *readMethod;
void *assetFileDescriptorRef;
long position;
long size;
long offset;
int fd;
} androidio;
#elif defined(__WIN32__)
struct
{
SDL_bool append;
void *h;
struct
{
void *data;
size_t size;
size_t left;
} buffer;
} windowsio;
#endif
#ifdef HAVE_STDIO_H
struct
{
SDL_bool autoclose;
FILE *fp;
} stdio;
#endif
struct
{
Uint8 *base;
Uint8 *here;
Uint8 *stop;
} mem;
struct
{
void *data1;
void *data2;
} unknown;
} hidden;
} SDL_RWops;
/**
* \name RWFrom functions
*
* Functions to create SDL_RWops structures from various data streams.
*/
/* @{ */
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFile(const char *file,
const char *mode);
#ifdef HAVE_STDIO_H
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(FILE * fp,
SDL_bool autoclose);
#else
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(void * fp,
SDL_bool autoclose);
#endif
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size);
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem,
int size);
/* @} *//* RWFrom functions */
extern DECLSPEC SDL_RWops *SDLCALL SDL_AllocRW(void);
extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area);
#define RW_SEEK_SET 0 /**< Seek from the beginning of data */
#define RW_SEEK_CUR 1 /**< Seek relative to current read point */
#define RW_SEEK_END 2 /**< Seek relative to the end of data */
/**
* \name Read/write macros
*
* Macros to easily read and write from an SDL_RWops structure.
*/
/* @{ */
#define SDL_RWsize(ctx) (ctx)->size(ctx)
#define SDL_RWseek(ctx, offset, whence) (ctx)->seek(ctx, offset, whence)
#define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, RW_SEEK_CUR)
#define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n)
#define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n)
#define SDL_RWclose(ctx) (ctx)->close(ctx)
/* @} *//* Read/write macros */
/**
* Load all the data from an SDL data stream.
*
* The data is allocated with a zero byte at the end (null terminated)
*
* If \c datasize is not NULL, it is filled with the size of the data read.
*
* If \c freesrc is non-zero, the stream will be closed after being read.
*
* The data should be freed with SDL_free().
*
* \return the data, or NULL if there was an error.
*/
extern DECLSPEC void *SDLCALL SDL_LoadFile_RW(SDL_RWops * src, size_t *datasize,
int freesrc);
/**
* Load an entire file.
*
* Convenience macro.
*/
#define SDL_LoadFile(file, datasize) SDL_LoadFile_RW(SDL_RWFromFile(file, "rb"), datasize, 1)
/**
* \name Read endian functions
*
* Read an item of the specified endianness and return in native format.
*/
/* @{ */
extern DECLSPEC Uint8 SDLCALL SDL_ReadU8(SDL_RWops * src);
extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops * src);
extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops * src);
extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops * src);
extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops * src);
extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops * src);
extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops * src);
/* @} *//* Read endian functions */
/**
* \name Write endian functions
*
* Write an item of native format to the specified endianness.
*/
/* @{ */
extern DECLSPEC size_t SDLCALL SDL_WriteU8(SDL_RWops * dst, Uint8 value);
extern DECLSPEC size_t SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value);
extern DECLSPEC size_t SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value);
extern DECLSPEC size_t SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE64(SDL_RWops * dst, Uint64 value);
/* @} *//* Write endian functions */
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_rwops_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_shape.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#ifndef SDL_shape_h_
#define SDL_shape_h_
#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_surface.h"
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/** \file SDL_shape.h
*
* Header file for the shaped window API.
*/
#define SDL_NONSHAPEABLE_WINDOW -1
#define SDL_INVALID_SHAPE_ARGUMENT -2
#define SDL_WINDOW_LACKS_SHAPE -3
/**
* \brief Create a window that can be shaped with the specified position, dimensions, and flags.
*
* \param title The title of the window, in UTF-8 encoding.
* \param x The x position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param y The y position of the window, ::SDL_WINDOWPOS_CENTERED, or
* ::SDL_WINDOWPOS_UNDEFINED.
* \param w The width of the window.
* \param h The height of the window.
* \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following:
* ::SDL_WINDOW_OPENGL, ::SDL_WINDOW_INPUT_GRABBED,
* ::SDL_WINDOW_HIDDEN, ::SDL_WINDOW_RESIZABLE,
* ::SDL_WINDOW_MAXIMIZED, ::SDL_WINDOW_MINIMIZED,
* ::SDL_WINDOW_BORDERLESS is always set, and ::SDL_WINDOW_FULLSCREEN is always unset.
*
* \return The window created, or NULL if window creation failed.
*
* \sa SDL_DestroyWindow()
*/
extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
/**
* \brief Return whether the given window is a shaped window.
*
* \param window The window to query for being shaped.
*
* \return SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if the window is unshaped or NULL.
*
* \sa SDL_CreateShapedWindow
*/
extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
/** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
typedef enum {
/** \brief The default mode, a binarized alpha cutoff of 1. */
ShapeModeDefault,
/** \brief A binarized alpha cutoff with a given integer value. */
ShapeModeBinarizeAlpha,
/** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
ShapeModeReverseBinarizeAlpha,
/** \brief A color key is applied. */
ShapeModeColorKey
} WindowShapeMode;
#define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
/** \brief A union containing parameters for shaped windows. */
typedef union {
/** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */
Uint8 binarizationCutoff;
SDL_Color colorKey;
} SDL_WindowShapeParams;
/** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
typedef struct SDL_WindowShapeMode {
/** \brief The mode of these window-shape parameters. */
WindowShapeMode mode;
/** \brief Window-shape parameters. */
SDL_WindowShapeParams parameters;
} SDL_WindowShapeMode;
/**
* \brief Set the shape and parameters of a shaped window.
*
* \param window The shaped window whose parameters should be set.
* \param shape A surface encoding the desired shape for the window.
* \param shape_mode The parameters to set for the shaped window.
*
* \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW
* if the SDL_Window given does not reference a valid shaped window.
*
* \sa SDL_WindowShapeMode
* \sa SDL_GetShapedWindowMode.
*/
extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
/**
* \brief Get the shape parameters of a shaped window.
*
* \param window The shaped window whose parameters should be retrieved.
* \param shape_mode An empty shape-mode structure to fill, or NULL to check whether the window has a shape.
*
* \return 0 if the window has a shape and, provided shape_mode was not NULL, shape_mode has been filled with the mode
* data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if
* the SDL_Window given is a shapeable window currently lacking a shape.
*
* \sa SDL_WindowShapeMode
* \sa SDL_SetWindowShape
*/
extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_shape_h_ */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_gamecontroller.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_gamecontroller.h
*
* Include file for SDL game controller event handling
*/
#ifndef SDL_gamecontroller_h_
#define SDL_gamecontroller_h_
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_rwops.h"
#include "SDL_joystick.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
* \file SDL_gamecontroller.h
*
* In order to use these functions, SDL_Init() must have been called
* with the ::SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system
* for game controllers, and load appropriate drivers.
*
* If you would like to receive controller updates while the application
* is in the background, you should set the following hint before calling
* SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
*/
/**
* The gamecontroller structure used to identify an SDL game controller
*/
struct _SDL_GameController;
typedef struct _SDL_GameController SDL_GameController;
typedef enum
{
SDL_CONTROLLER_BINDTYPE_NONE = 0,
SDL_CONTROLLER_BINDTYPE_BUTTON,
SDL_CONTROLLER_BINDTYPE_AXIS,
SDL_CONTROLLER_BINDTYPE_HAT
} SDL_GameControllerBindType;
/**
* Get the SDL joystick layer binding for this controller button/axis mapping
*/
typedef struct SDL_GameControllerButtonBind
{
SDL_GameControllerBindType bindType;
union
{
int button;
int axis;
struct {
int hat;
int hat_mask;
} hat;
} value;
} SDL_GameControllerButtonBind;
/**
* To count the number of game controllers in the system for the following:
* int nJoysticks = SDL_NumJoysticks();
* int nGameControllers = 0;
* for (int i = 0; i < nJoysticks; i++) {
* if (SDL_IsGameController(i)) {
* nGameControllers++;
* }
* }
*
* Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping() you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is:
* guid,name,mappings
*
* Where GUID is the string value from SDL_JoystickGetGUIDString(), name is the human readable string for the device and mappings are controller mappings to joystick ones.
* Under Windows there is a reserved GUID of "xinput" that covers any XInput devices.
* The mapping format for joystick is:
* bX - a joystick button, index X
* hX.Y - hat X with value Y
* aX - axis X of the joystick
* Buttons can be used as a controller axis and vice versa.
*
* This string shows an example of a valid mapping for a controller
* "03000000341a00003608000000000000,PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7",
*
*/
/**
* Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current SDL_GetPlatform()
* A community sourced database of controllers is available at https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt
*
* If \c freerw is non-zero, the stream will be closed after being read.
*
* \return number of mappings added, -1 on error
*/
extern DECLSPEC int SDLCALL SDL_GameControllerAddMappingsFromRW(SDL_RWops * rw, int freerw);
/**
* Load a set of mappings from a file, filtered by the current SDL_GetPlatform()
*
* Convenience macro.
*/
#define SDL_GameControllerAddMappingsFromFile(file) SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)
/**
* Add or update an existing mapping configuration
*
* \return 1 if mapping is added, 0 if updated, -1 on error
*/
extern DECLSPEC int SDLCALL SDL_GameControllerAddMapping(const char* mappingString);
/**
* Get the number of mappings installed
*
* \return the number of mappings
*/
extern DECLSPEC int SDLCALL SDL_GameControllerNumMappings(void);
/**
* Get the mapping at a particular index.
*
* \return the mapping string. Must be freed with SDL_free(). Returns NULL if the index is out of range.
*/
extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForIndex(int mapping_index);
/**
* Get a mapping string for a GUID
*
* \return the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available
*/
extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID(SDL_JoystickGUID guid);
/**
* Get a mapping string for an open GameController
*
* \return the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available
*/
extern DECLSPEC char * SDLCALL SDL_GameControllerMapping(SDL_GameController * gamecontroller);
/**
* Is the joystick on this index supported by the game controller interface?
*/
extern DECLSPEC SDL_bool SDLCALL SDL_IsGameController(int joystick_index);
/**
* Get the implementation dependent name of a game controller.
* This can be called before any controllers are opened.
* If no name can be found, this function returns NULL.
*/
extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_index);
/**
* Open a game controller for use.
* The index passed as an argument refers to the N'th game controller on the system.
* This index is not the value which will identify this controller in future
* controller events. The joystick's instance id (::SDL_JoystickID) will be
* used there instead.
*
* \return A controller identifier, or NULL if an error occurred.
*/
extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerOpen(int joystick_index);
/**
* Return the SDL_GameController associated with an instance id.
*/
extern DECLSPEC SDL_GameController *SDLCALL SDL_GameControllerFromInstanceID(SDL_JoystickID joyid);
/**
* Return the name for this currently opened controller
*/
extern DECLSPEC const char *SDLCALL SDL_GameControllerName(SDL_GameController *gamecontroller);
/**
* Get the USB vendor ID of an opened controller, if available.
* If the vendor ID isn't available this function returns 0.
*/
extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetVendor(SDL_GameController * gamecontroller);
/**
* Get the USB product ID of an opened controller, if available.
* If the product ID isn't available this function returns 0.
*/
extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProduct(SDL_GameController * gamecontroller);
/**
* Get the product version of an opened controller, if available.
* If the product version isn't available this function returns 0.
*/
extern DECLSPEC Uint16 SDLCALL SDL_GameControllerGetProductVersion(SDL_GameController * gamecontroller);
/**
* Returns SDL_TRUE if the controller has been opened and currently connected,
* or SDL_FALSE if it has not.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_GameControllerGetAttached(SDL_GameController *gamecontroller);
/**
* Get the underlying joystick object used by a controller
*/
extern DECLSPEC SDL_Joystick *SDLCALL SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller);
/**
* Enable/disable controller event polling.
*
* If controller events are disabled, you must call SDL_GameControllerUpdate()
* yourself and check the state of the controller when you want controller
* information.
*
* The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
*/
extern DECLSPEC int SDLCALL SDL_GameControllerEventState(int state);
/**
* Update the current state of the open game controllers.
*
* This is called automatically by the event loop if any game controller
* events are enabled.
*/
extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
/**
* The list of axes available from a controller
*
* Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX,
* and are centered within ~8000 of zero, though advanced UI will allow users to set
* or autodetect the dead zone, which varies between controllers.
*
* Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
*/
typedef enum
{
SDL_CONTROLLER_AXIS_INVALID = -1,
SDL_CONTROLLER_AXIS_LEFTX,
SDL_CONTROLLER_AXIS_LEFTY,
SDL_CONTROLLER_AXIS_RIGHTX,
SDL_CONTROLLER_AXIS_RIGHTY,
SDL_CONTROLLER_AXIS_TRIGGERLEFT,
SDL_CONTROLLER_AXIS_TRIGGERRIGHT,
SDL_CONTROLLER_AXIS_MAX
} SDL_GameControllerAxis;
/**
* turn this string into a axis mapping
*/
extern DECLSPEC SDL_GameControllerAxis SDLCALL SDL_GameControllerGetAxisFromString(const char *pchString);
/**
* turn this axis enum into a string mapping
*/
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForAxis(SDL_GameControllerAxis axis);
/**
* Get the SDL joystick layer binding for this controller button mapping
*/
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
SDL_GameControllerGetBindForAxis(SDL_GameController *gamecontroller,
SDL_GameControllerAxis axis);
/**
* Get the current state of an axis control on a game controller.
*
* The state is a value ranging from -32768 to 32767 (except for the triggers,
* which range from 0 to 32767).
*
* The axis indices start at index 0.
*/
extern DECLSPEC Sint16 SDLCALL
SDL_GameControllerGetAxis(SDL_GameController *gamecontroller,
SDL_GameControllerAxis axis);
/**
* The list of buttons available from a controller
*/
typedef enum
{
SDL_CONTROLLER_BUTTON_INVALID = -1,
SDL_CONTROLLER_BUTTON_A,
SDL_CONTROLLER_BUTTON_B,
SDL_CONTROLLER_BUTTON_X,
SDL_CONTROLLER_BUTTON_Y,
SDL_CONTROLLER_BUTTON_BACK,
SDL_CONTROLLER_BUTTON_GUIDE,
SDL_CONTROLLER_BUTTON_START,
SDL_CONTROLLER_BUTTON_LEFTSTICK,
SDL_CONTROLLER_BUTTON_RIGHTSTICK,
SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
SDL_CONTROLLER_BUTTON_DPAD_UP,
SDL_CONTROLLER_BUTTON_DPAD_DOWN,
SDL_CONTROLLER_BUTTON_DPAD_LEFT,
SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
SDL_CONTROLLER_BUTTON_MAX
} SDL_GameControllerButton;
/**
* turn this string into a button mapping
*/
extern DECLSPEC SDL_GameControllerButton SDLCALL SDL_GameControllerGetButtonFromString(const char *pchString);
/**
* turn this button enum into a string mapping
*/
extern DECLSPEC const char* SDLCALL SDL_GameControllerGetStringForButton(SDL_GameControllerButton button);
/**
* Get the SDL joystick layer binding for this controller button mapping
*/
extern DECLSPEC SDL_GameControllerButtonBind SDLCALL
SDL_GameControllerGetBindForButton(SDL_GameController *gamecontroller,
SDL_GameControllerButton button);
/**
* Get the current state of a button on a game controller.
*
* The button indices start at index 0.
*/
extern DECLSPEC Uint8 SDLCALL SDL_GameControllerGetButton(SDL_GameController *gamecontroller,
SDL_GameControllerButton button);
/**
* Close a controller previously opened with SDL_GameControllerOpen().
*/
extern DECLSPEC void SDLCALL SDL_GameControllerClose(SDL_GameController *gamecontroller);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_gamecontroller_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/begin_code.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file begin_code.h
*
* This file sets things up for C dynamic library function definitions,
* static inlined functions, and structures aligned at 4-byte alignment.
* If you don't like ugly C preprocessor code, don't look at this file. :)
*/
/* This shouldn't be nested -- included it around code only. */
#ifdef _begin_code_h
#error Nested inclusion of begin_code.h
#endif
#define _begin_code_h
#ifndef SDL_DEPRECATED
# if (__GNUC__ >= 4) /* technically, this arrived in gcc 3.1, but oh well. */
# define SDL_DEPRECATED __attribute__((deprecated))
# else
# define SDL_DEPRECATED
# endif
#endif
#ifndef SDL_UNUSED
# ifdef __GNUC__
# define SDL_UNUSED __attribute__((unused))
# else
# define SDL_UNUSED
# endif
#endif
/* Some compilers use a special export keyword */
#ifndef DECLSPEC
# if defined(__WIN32__) || defined(__WINRT__)
# ifdef __BORLANDC__
# ifdef BUILD_SDL
# define DECLSPEC
# else
# define DECLSPEC __declspec(dllimport)
# endif
# else
# define DECLSPEC __declspec(dllexport)
# endif
# elif defined(__OS2__)
# ifdef BUILD_SDL
# define DECLSPEC __declspec(dllexport)
# else
# define DECLSPEC
# endif
# else
# if defined(__GNUC__) && __GNUC__ >= 4
# define DECLSPEC __attribute__ ((visibility("default")))
# else
# define DECLSPEC
# endif
# endif
#endif
/* By default SDL uses the C calling convention */
#ifndef SDLCALL
#if (defined(__WIN32__) || defined(__WINRT__)) && !defined(__GNUC__)
#define SDLCALL __cdecl
#elif defined(__OS2__) || defined(__EMX__)
#define SDLCALL _System
# if defined (__GNUC__) && !defined(_System)
# define _System /* for old EMX/GCC compat. */
# endif
#else
#define SDLCALL
#endif
#endif /* SDLCALL */
/* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
#ifdef __SYMBIAN32__
#undef DECLSPEC
#define DECLSPEC
#endif /* __SYMBIAN32__ */
/* Force structure packing at 4 byte alignment.
This is necessary if the header is included in code which has structure
packing set to an alternate value, say for loading structures from disk.
The packing is reset to the previous value in close_code.h
*/
#if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
#ifdef _MSC_VER
#pragma warning(disable: 4103)
#endif
#ifdef __BORLANDC__
#pragma nopackwarning
#endif
#ifdef _M_X64
/* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
#pragma pack(push,8)
#else
#pragma pack(push,4)
#endif
#endif /* Compiler needs structure packing set */
#ifndef SDL_INLINE
#if defined(__GNUC__)
#define SDL_INLINE __inline__
#elif defined(_MSC_VER) || defined(__BORLANDC__) || \
defined(__DMC__) || defined(__SC__) || \
defined(__WATCOMC__) || defined(__LCC__) || \
defined(__DECC) || defined(__CC_ARM)
#define SDL_INLINE __inline
#ifndef __inline__
#define __inline__ __inline
#endif
#else
#define SDL_INLINE inline
#ifndef __inline__
#define __inline__ inline
#endif
#endif
#endif /* SDL_INLINE not defined */
#ifndef SDL_FORCE_INLINE
#if defined(_MSC_VER)
#define SDL_FORCE_INLINE __forceinline
#elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
#define SDL_FORCE_INLINE __attribute__((always_inline)) static __inline__
#else
#define SDL_FORCE_INLINE static SDL_INLINE
#endif
#endif /* SDL_FORCE_INLINE not defined */
#ifndef SDL_NORETURN
#if defined(__GNUC__)
#define SDL_NORETURN __attribute__((noreturn))
#elif defined(_MSC_VER)
#define SDL_NORETURN __declspec(noreturn)
#else
#define SDL_NORETURN
#endif
#endif /* SDL_NORETURN not defined */
/* Apparently this is needed by several Windows compilers */
#if !defined(__MACH__)
#ifndef NULL
#ifdef __cplusplus
#define NULL 0
#else
#define NULL ((void *)0)
#endif
#endif /* NULL */
#endif /* ! Mac OS X - breaks precompiled headers */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_mutex.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#ifndef SDL_mutex_h_
#define SDL_mutex_h_
/**
* \file SDL_mutex.h
*
* Functions to provide thread synchronization primitives.
*/
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
* Synchronization functions which can time out return this value
* if they time out.
*/
#define SDL_MUTEX_TIMEDOUT 1
/**
* This is the timeout value which corresponds to never time out.
*/
#define SDL_MUTEX_MAXWAIT (~(Uint32)0)
/**
* \name Mutex functions
*/
/* @{ */
/* The SDL mutex structure, defined in SDL_sysmutex.c */
struct SDL_mutex;
typedef struct SDL_mutex SDL_mutex;
/**
* Create a mutex, initialized unlocked.
*/
extern DECLSPEC SDL_mutex *SDLCALL SDL_CreateMutex(void);
/**
* Lock the mutex.
*
* \return 0, or -1 on error.
*/
#define SDL_mutexP(m) SDL_LockMutex(m)
extern DECLSPEC int SDLCALL SDL_LockMutex(SDL_mutex * mutex);
/**
* Try to lock the mutex
*
* \return 0, SDL_MUTEX_TIMEDOUT, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_TryLockMutex(SDL_mutex * mutex);
/**
* Unlock the mutex.
*
* \return 0, or -1 on error.
*
* \warning It is an error to unlock a mutex that has not been locked by
* the current thread, and doing so results in undefined behavior.
*/
#define SDL_mutexV(m) SDL_UnlockMutex(m)
extern DECLSPEC int SDLCALL SDL_UnlockMutex(SDL_mutex * mutex);
/**
* Destroy a mutex.
*/
extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex * mutex);
/* @} *//* Mutex functions */
/**
* \name Semaphore functions
*/
/* @{ */
/* The SDL semaphore structure, defined in SDL_syssem.c */
struct SDL_semaphore;
typedef struct SDL_semaphore SDL_sem;
/**
* Create a semaphore, initialized with value, returns NULL on failure.
*/
extern DECLSPEC SDL_sem *SDLCALL SDL_CreateSemaphore(Uint32 initial_value);
/**
* Destroy a semaphore.
*/
extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem * sem);
/**
* This function suspends the calling thread until the semaphore pointed
* to by \c sem has a positive count. It then atomically decreases the
* semaphore count.
*/
extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem * sem);
/**
* Non-blocking variant of SDL_SemWait().
*
* \return 0 if the wait succeeds, ::SDL_MUTEX_TIMEDOUT if the wait would
* block, and -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem * sem);
/**
* Variant of SDL_SemWait() with a timeout in milliseconds.
*
* \return 0 if the wait succeeds, ::SDL_MUTEX_TIMEDOUT if the wait does not
* succeed in the allotted time, and -1 on error.
*
* \warning On some platforms this function is implemented by looping with a
* delay of 1 ms, and so should be avoided if possible.
*/
extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem * sem, Uint32 ms);
/**
* Atomically increases the semaphore's count (not blocking).
*
* \return 0, or -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem * sem);
/**
* Returns the current count of the semaphore.
*/
extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem * sem);
/* @} *//* Semaphore functions */
/**
* \name Condition variable functions
*/
/* @{ */
/* The SDL condition variable structure, defined in SDL_syscond.c */
struct SDL_cond;
typedef struct SDL_cond SDL_cond;
/**
* Create a condition variable.
*
* Typical use of condition variables:
*
* Thread A:
* SDL_LockMutex(lock);
* while ( ! condition ) {
* SDL_CondWait(cond, lock);
* }
* SDL_UnlockMutex(lock);
*
* Thread B:
* SDL_LockMutex(lock);
* ...
* condition = true;
* ...
* SDL_CondSignal(cond);
* SDL_UnlockMutex(lock);
*
* There is some discussion whether to signal the condition variable
* with the mutex locked or not. There is some potential performance
* benefit to unlocking first on some platforms, but there are some
* potential race conditions depending on how your code is structured.
*
* In general it's safer to signal the condition variable while the
* mutex is locked.
*/
extern DECLSPEC SDL_cond *SDLCALL SDL_CreateCond(void);
/**
* Destroy a condition variable.
*/
extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond * cond);
/**
* Restart one of the threads that are waiting on the condition variable.
*
* \return 0 or -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond * cond);
/**
* Restart all threads that are waiting on the condition variable.
*
* \return 0 or -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond * cond);
/**
* Wait on the condition variable, unlocking the provided mutex.
*
* \warning The mutex must be locked before entering this function!
*
* The mutex is re-locked once the condition variable is signaled.
*
* \return 0 when it is signaled, or -1 on error.
*/
extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond * cond, SDL_mutex * mutex);
/**
* Waits for at most \c ms milliseconds, and returns 0 if the condition
* variable is signaled, ::SDL_MUTEX_TIMEDOUT if the condition is not
* signaled in the allotted time, and -1 on error.
*
* \warning On some platforms this function is implemented by looping with a
* delay of 1 ms, and so should be avoided if possible.
*/
extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond * cond,
SDL_mutex * mutex, Uint32 ms);
/* @} *//* Condition variable functions */
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_mutex_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/sources/thirdparty/sdl2/SDL2/SDL_render.h | /*
Simple DirectMedia Layer
Copyright (C) 1997-2018 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/**
* \file SDL_render.h
*
* Header file for SDL 2D rendering functions.
*
* This API supports the following features:
* * single pixel points
* * single pixel lines
* * filled rectangles
* * texture images
*
* The primitives may be drawn in opaque, blended, or additive modes.
*
* The texture images may be drawn in opaque, blended, or additive modes.
* They can have an additional color tint or alpha modulation applied to
* them, and may also be stretched with linear interpolation.
*
* This API is designed to accelerate simple 2D operations. You may
* want more functionality such as polygons and particle effects and
* in that case you should use SDL's OpenGL/Direct3D support or one
* of the many good 3D engines.
*
* These functions must be called from the main thread.
* See this bug for details: http://bugzilla.libsdl.org/show_bug.cgi?id=1995
*/
#ifndef SDL_render_h_
#define SDL_render_h_
#include "SDL_stdinc.h"
#include "SDL_rect.h"
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
* \brief Flags used when creating a rendering context
*/
typedef enum
{
SDL_RENDERER_SOFTWARE = 0x00000001, /**< The renderer is a software fallback */
SDL_RENDERER_ACCELERATED = 0x00000002, /**< The renderer uses hardware
acceleration */
SDL_RENDERER_PRESENTVSYNC = 0x00000004, /**< Present is synchronized
with the refresh rate */
SDL_RENDERER_TARGETTEXTURE = 0x00000008 /**< The renderer supports
rendering to texture */
} SDL_RendererFlags;
/**
* \brief Information on the capabilities of a render driver or context.
*/
typedef struct SDL_RendererInfo
{
const char *name; /**< The name of the renderer */
Uint32 flags; /**< Supported ::SDL_RendererFlags */
Uint32 num_texture_formats; /**< The number of available texture formats */
Uint32 texture_formats[16]; /**< The available texture formats */
int max_texture_width; /**< The maximum texture width */
int max_texture_height; /**< The maximum texture height */
} SDL_RendererInfo;
/**
* \brief The access pattern allowed for a texture.
*/
typedef enum
{
SDL_TEXTUREACCESS_STATIC, /**< Changes rarely, not lockable */
SDL_TEXTUREACCESS_STREAMING, /**< Changes frequently, lockable */
SDL_TEXTUREACCESS_TARGET /**< Texture can be used as a render target */
} SDL_TextureAccess;
/**
* \brief The texture channel modulation used in SDL_RenderCopy().
*/
typedef enum
{
SDL_TEXTUREMODULATE_NONE = 0x00000000, /**< No modulation */
SDL_TEXTUREMODULATE_COLOR = 0x00000001, /**< srcC = srcC * color */
SDL_TEXTUREMODULATE_ALPHA = 0x00000002 /**< srcA = srcA * alpha */
} SDL_TextureModulate;
/**
* \brief Flip constants for SDL_RenderCopyEx
*/
typedef enum
{
SDL_FLIP_NONE = 0x00000000, /**< Do not flip */
SDL_FLIP_HORIZONTAL = 0x00000001, /**< flip horizontally */
SDL_FLIP_VERTICAL = 0x00000002 /**< flip vertically */
} SDL_RendererFlip;
/**
* \brief A structure representing rendering state
*/
struct SDL_Renderer;
typedef struct SDL_Renderer SDL_Renderer;
/**
* \brief An efficient driver-specific representation of pixel data
*/
struct SDL_Texture;
typedef struct SDL_Texture SDL_Texture;
/* Function prototypes */
/**
* \brief Get the number of 2D rendering drivers available for the current
* display.
*
* A render driver is a set of code that handles rendering and texture
* management on a particular display. Normally there is only one, but
* some drivers may have several available with different capabilities.
*
* \sa SDL_GetRenderDriverInfo()
* \sa SDL_CreateRenderer()
*/
extern DECLSPEC int SDLCALL SDL_GetNumRenderDrivers(void);
/**
* \brief Get information about a specific 2D rendering driver for the current
* display.
*
* \param index The index of the driver to query information about.
* \param info A pointer to an SDL_RendererInfo struct to be filled with
* information on the rendering driver.
*
* \return 0 on success, -1 if the index was out of range.
*
* \sa SDL_CreateRenderer()
*/
extern DECLSPEC int SDLCALL SDL_GetRenderDriverInfo(int index,
SDL_RendererInfo * info);
/**
* \brief Create a window and default renderer
*
* \param width The width of the window
* \param height The height of the window
* \param window_flags The flags used to create the window
* \param window A pointer filled with the window, or NULL on error
* \param renderer A pointer filled with the renderer, or NULL on error
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_CreateWindowAndRenderer(
int width, int height, Uint32 window_flags,
SDL_Window **window, SDL_Renderer **renderer);
/**
* \brief Create a 2D rendering context for a window.
*
* \param window The window where rendering is displayed.
* \param index The index of the rendering driver to initialize, or -1 to
* initialize the first one supporting the requested flags.
* \param flags ::SDL_RendererFlags.
*
* \return A valid rendering context or NULL if there was an error.
*
* \sa SDL_CreateSoftwareRenderer()
* \sa SDL_GetRendererInfo()
* \sa SDL_DestroyRenderer()
*/
extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window * window,
int index, Uint32 flags);
/**
* \brief Create a 2D software rendering context for a surface.
*
* \param surface The surface where rendering is done.
*
* \return A valid rendering context or NULL if there was an error.
*
* \sa SDL_CreateRenderer()
* \sa SDL_DestroyRenderer()
*/
extern DECLSPEC SDL_Renderer * SDLCALL SDL_CreateSoftwareRenderer(SDL_Surface * surface);
/**
* \brief Get the renderer associated with a window.
*/
extern DECLSPEC SDL_Renderer * SDLCALL SDL_GetRenderer(SDL_Window * window);
/**
* \brief Get information about a rendering context.
*/
extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer * renderer,
SDL_RendererInfo * info);
/**
* \brief Get the output size in pixels of a rendering context.
*/
extern DECLSPEC int SDLCALL SDL_GetRendererOutputSize(SDL_Renderer * renderer,
int *w, int *h);
/**
* \brief Create a texture for a rendering context.
*
* \param renderer The renderer.
* \param format The format of the texture.
* \param access One of the enumerated values in ::SDL_TextureAccess.
* \param w The width of the texture in pixels.
* \param h The height of the texture in pixels.
*
* \return The created texture is returned, or NULL if no rendering context was
* active, the format was unsupported, or the width or height were out
* of range.
*
* \note The contents of the texture are not defined at creation.
*
* \sa SDL_QueryTexture()
* \sa SDL_UpdateTexture()
* \sa SDL_DestroyTexture()
*/
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTexture(SDL_Renderer * renderer,
Uint32 format,
int access, int w,
int h);
/**
* \brief Create a texture from an existing surface.
*
* \param renderer The renderer.
* \param surface The surface containing pixel data used to fill the texture.
*
* \return The created texture is returned, or NULL on error.
*
* \note The surface is not modified or freed by this function.
*
* \sa SDL_QueryTexture()
* \sa SDL_DestroyTexture()
*/
extern DECLSPEC SDL_Texture * SDLCALL SDL_CreateTextureFromSurface(SDL_Renderer * renderer, SDL_Surface * surface);
/**
* \brief Query the attributes of a texture
*
* \param texture A texture to be queried.
* \param format A pointer filled in with the raw format of the texture. The
* actual format may differ, but pixel transfers will use this
* format.
* \param access A pointer filled in with the actual access to the texture.
* \param w A pointer filled in with the width of the texture in pixels.
* \param h A pointer filled in with the height of the texture in pixels.
*
* \return 0 on success, or -1 if the texture is not valid.
*/
extern DECLSPEC int SDLCALL SDL_QueryTexture(SDL_Texture * texture,
Uint32 * format, int *access,
int *w, int *h);
/**
* \brief Set an additional color value used in render copy operations.
*
* \param texture The texture to update.
* \param r The red color value multiplied into copy operations.
* \param g The green color value multiplied into copy operations.
* \param b The blue color value multiplied into copy operations.
*
* \return 0 on success, or -1 if the texture is not valid or color modulation
* is not supported.
*
* \sa SDL_GetTextureColorMod()
*/
extern DECLSPEC int SDLCALL SDL_SetTextureColorMod(SDL_Texture * texture,
Uint8 r, Uint8 g, Uint8 b);
/**
* \brief Get the additional color value used in render copy operations.
*
* \param texture The texture to query.
* \param r A pointer filled in with the current red color value.
* \param g A pointer filled in with the current green color value.
* \param b A pointer filled in with the current blue color value.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureColorMod()
*/
extern DECLSPEC int SDLCALL SDL_GetTextureColorMod(SDL_Texture * texture,
Uint8 * r, Uint8 * g,
Uint8 * b);
/**
* \brief Set an additional alpha value used in render copy operations.
*
* \param texture The texture to update.
* \param alpha The alpha value multiplied into copy operations.
*
* \return 0 on success, or -1 if the texture is not valid or alpha modulation
* is not supported.
*
* \sa SDL_GetTextureAlphaMod()
*/
extern DECLSPEC int SDLCALL SDL_SetTextureAlphaMod(SDL_Texture * texture,
Uint8 alpha);
/**
* \brief Get the additional alpha value used in render copy operations.
*
* \param texture The texture to query.
* \param alpha A pointer filled in with the current alpha value.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureAlphaMod()
*/
extern DECLSPEC int SDLCALL SDL_GetTextureAlphaMod(SDL_Texture * texture,
Uint8 * alpha);
/**
* \brief Set the blend mode used for texture copy operations.
*
* \param texture The texture to update.
* \param blendMode ::SDL_BlendMode to use for texture blending.
*
* \return 0 on success, or -1 if the texture is not valid or the blend mode is
* not supported.
*
* \note If the blend mode is not supported, the closest supported mode is
* chosen.
*
* \sa SDL_GetTextureBlendMode()
*/
extern DECLSPEC int SDLCALL SDL_SetTextureBlendMode(SDL_Texture * texture,
SDL_BlendMode blendMode);
/**
* \brief Get the blend mode used for texture copy operations.
*
* \param texture The texture to query.
* \param blendMode A pointer filled in with the current blend mode.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \sa SDL_SetTextureBlendMode()
*/
extern DECLSPEC int SDLCALL SDL_GetTextureBlendMode(SDL_Texture * texture,
SDL_BlendMode *blendMode);
/**
* \brief Update the given texture rectangle with new pixel data.
*
* \param texture The texture to update
* \param rect A pointer to the rectangle of pixels to update, or NULL to
* update the entire texture.
* \param pixels The raw pixel data in the format of the texture.
* \param pitch The number of bytes in a row of pixel data, including padding between lines.
*
* The pixel data must be in the format of the texture. The pixel format can be
* queried with SDL_QueryTexture.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \note This is a fairly slow function.
*/
extern DECLSPEC int SDLCALL SDL_UpdateTexture(SDL_Texture * texture,
const SDL_Rect * rect,
const void *pixels, int pitch);
/**
* \brief Update a rectangle within a planar YV12 or IYUV texture with new pixel data.
*
* \param texture The texture to update
* \param rect A pointer to the rectangle of pixels to update, or NULL to
* update the entire texture.
* \param Yplane The raw pixel data for the Y plane.
* \param Ypitch The number of bytes between rows of pixel data for the Y plane.
* \param Uplane The raw pixel data for the U plane.
* \param Upitch The number of bytes between rows of pixel data for the U plane.
* \param Vplane The raw pixel data for the V plane.
* \param Vpitch The number of bytes between rows of pixel data for the V plane.
*
* \return 0 on success, or -1 if the texture is not valid.
*
* \note You can use SDL_UpdateTexture() as long as your pixel data is
* a contiguous block of Y and U/V planes in the proper order, but
* this function is available if your pixel data is not contiguous.
*/
extern DECLSPEC int SDLCALL SDL_UpdateYUVTexture(SDL_Texture * texture,
const SDL_Rect * rect,
const Uint8 *Yplane, int Ypitch,
const Uint8 *Uplane, int Upitch,
const Uint8 *Vplane, int Vpitch);
/**
* \brief Lock a portion of the texture for write-only pixel access.
*
* \param texture The texture to lock for access, which was created with
* ::SDL_TEXTUREACCESS_STREAMING.
* \param rect A pointer to the rectangle to lock for access. If the rect
* is NULL, the entire texture will be locked.
* \param pixels This is filled in with a pointer to the locked pixels,
* appropriately offset by the locked area.
* \param pitch This is filled in with the pitch of the locked pixels.
*
* \return 0 on success, or -1 if the texture is not valid or was not created with ::SDL_TEXTUREACCESS_STREAMING.
*
* \sa SDL_UnlockTexture()
*/
extern DECLSPEC int SDLCALL SDL_LockTexture(SDL_Texture * texture,
const SDL_Rect * rect,
void **pixels, int *pitch);
/**
* \brief Unlock a texture, uploading the changes to video memory, if needed.
*
* \sa SDL_LockTexture()
*/
extern DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture * texture);
/**
* \brief Determines whether a window supports the use of render targets
*
* \param renderer The renderer that will be checked
*
* \return SDL_TRUE if supported, SDL_FALSE if not.
*/
extern DECLSPEC SDL_bool SDLCALL SDL_RenderTargetSupported(SDL_Renderer *renderer);
/**
* \brief Set a texture as the current rendering target.
*
* \param renderer The renderer.
* \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
*
* \return 0 on success, or -1 on error
*
* \sa SDL_GetRenderTarget()
*/
extern DECLSPEC int SDLCALL SDL_SetRenderTarget(SDL_Renderer *renderer,
SDL_Texture *texture);
/**
* \brief Get the current render target or NULL for the default render target.
*
* \return The current render target
*
* \sa SDL_SetRenderTarget()
*/
extern DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *renderer);
/**
* \brief Set device independent resolution for rendering
*
* \param renderer The renderer for which resolution should be set.
* \param w The width of the logical resolution
* \param h The height of the logical resolution
*
* This function uses the viewport and scaling functionality to allow a fixed logical
* resolution for rendering, regardless of the actual output resolution. If the actual
* output resolution doesn't have the same aspect ratio the output rendering will be
* centered within the output display.
*
* If the output display is a window, mouse events in the window will be filtered
* and scaled so they seem to arrive within the logical resolution.
*
* \note If this function results in scaling or subpixel drawing by the
* rendering backend, it will be handled using the appropriate
* quality hints.
*
* \sa SDL_RenderGetLogicalSize()
* \sa SDL_RenderSetScale()
* \sa SDL_RenderSetViewport()
*/
extern DECLSPEC int SDLCALL SDL_RenderSetLogicalSize(SDL_Renderer * renderer, int w, int h);
/**
* \brief Get device independent resolution for rendering
*
* \param renderer The renderer from which resolution should be queried.
* \param w A pointer filled with the width of the logical resolution
* \param h A pointer filled with the height of the logical resolution
*
* \sa SDL_RenderSetLogicalSize()
*/
extern DECLSPEC void SDLCALL SDL_RenderGetLogicalSize(SDL_Renderer * renderer, int *w, int *h);
/**
* \brief Set whether to force integer scales for resolution-independent rendering
*
* \param renderer The renderer for which integer scaling should be set.
* \param enable Enable or disable integer scaling
*
* This function restricts the logical viewport to integer values - that is, when
* a resolution is between two multiples of a logical size, the viewport size is
* rounded down to the lower multiple.
*
* \sa SDL_RenderSetLogicalSize()
*/
extern DECLSPEC int SDLCALL SDL_RenderSetIntegerScale(SDL_Renderer * renderer,
SDL_bool enable);
/**
* \brief Get whether integer scales are forced for resolution-independent rendering
*
* \param renderer The renderer from which integer scaling should be queried.
*
* \sa SDL_RenderSetIntegerScale()
*/
extern DECLSPEC SDL_bool SDLCALL SDL_RenderGetIntegerScale(SDL_Renderer * renderer);
/**
* \brief Set the drawing area for rendering on the current target.
*
* \param renderer The renderer for which the drawing area should be set.
* \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
*
* The x,y of the viewport rect represents the origin for rendering.
*
* \return 0 on success, or -1 on error
*
* \note If the window associated with the renderer is resized, the viewport is automatically reset.
*
* \sa SDL_RenderGetViewport()
* \sa SDL_RenderSetLogicalSize()
*/
extern DECLSPEC int SDLCALL SDL_RenderSetViewport(SDL_Renderer * renderer,
const SDL_Rect * rect);
/**
* \brief Get the drawing area for the current target.
*
* \sa SDL_RenderSetViewport()
*/
extern DECLSPEC void SDLCALL SDL_RenderGetViewport(SDL_Renderer * renderer,
SDL_Rect * rect);
/**
* \brief Set the clip rectangle for the current target.
*
* \param renderer The renderer for which clip rectangle should be set.
* \param rect A pointer to the rectangle to set as the clip rectangle, or
* NULL to disable clipping.
*
* \return 0 on success, or -1 on error
*
* \sa SDL_RenderGetClipRect()
*/
extern DECLSPEC int SDLCALL SDL_RenderSetClipRect(SDL_Renderer * renderer,
const SDL_Rect * rect);
/**
* \brief Get the clip rectangle for the current target.
*
* \param renderer The renderer from which clip rectangle should be queried.
* \param rect A pointer filled in with the current clip rectangle, or
* an empty rectangle if clipping is disabled.
*
* \sa SDL_RenderSetClipRect()
*/
extern DECLSPEC void SDLCALL SDL_RenderGetClipRect(SDL_Renderer * renderer,
SDL_Rect * rect);
/**
* \brief Get whether clipping is enabled on the given renderer.
*
* \param renderer The renderer from which clip state should be queried.
*
* \sa SDL_RenderGetClipRect()
*/
extern DECLSPEC SDL_bool SDLCALL SDL_RenderIsClipEnabled(SDL_Renderer * renderer);
/**
* \brief Set the drawing scale for rendering on the current target.
*
* \param renderer The renderer for which the drawing scale should be set.
* \param scaleX The horizontal scaling factor
* \param scaleY The vertical scaling factor
*
* The drawing coordinates are scaled by the x/y scaling factors
* before they are used by the renderer. This allows resolution
* independent drawing with a single coordinate system.
*
* \note If this results in scaling or subpixel drawing by the
* rendering backend, it will be handled using the appropriate
* quality hints. For best results use integer scaling factors.
*
* \sa SDL_RenderGetScale()
* \sa SDL_RenderSetLogicalSize()
*/
extern DECLSPEC int SDLCALL SDL_RenderSetScale(SDL_Renderer * renderer,
float scaleX, float scaleY);
/**
* \brief Get the drawing scale for the current target.
*
* \param renderer The renderer from which drawing scale should be queried.
* \param scaleX A pointer filled in with the horizontal scaling factor
* \param scaleY A pointer filled in with the vertical scaling factor
*
* \sa SDL_RenderSetScale()
*/
extern DECLSPEC void SDLCALL SDL_RenderGetScale(SDL_Renderer * renderer,
float *scaleX, float *scaleY);
/**
* \brief Set the color used for drawing operations (Rect, Line and Clear).
*
* \param renderer The renderer for which drawing color should be set.
* \param r The red value used to draw on the rendering target.
* \param g The green value used to draw on the rendering target.
* \param b The blue value used to draw on the rendering target.
* \param a The alpha value used to draw on the rendering target, usually
* ::SDL_ALPHA_OPAQUE (255).
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_SetRenderDrawColor(SDL_Renderer * renderer,
Uint8 r, Uint8 g, Uint8 b,
Uint8 a);
/**
* \brief Get the color used for drawing operations (Rect, Line and Clear).
*
* \param renderer The renderer from which drawing color should be queried.
* \param r A pointer to the red value used to draw on the rendering target.
* \param g A pointer to the green value used to draw on the rendering target.
* \param b A pointer to the blue value used to draw on the rendering target.
* \param a A pointer to the alpha value used to draw on the rendering target,
* usually ::SDL_ALPHA_OPAQUE (255).
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_GetRenderDrawColor(SDL_Renderer * renderer,
Uint8 * r, Uint8 * g, Uint8 * b,
Uint8 * a);
/**
* \brief Set the blend mode used for drawing operations (Fill and Line).
*
* \param renderer The renderer for which blend mode should be set.
* \param blendMode ::SDL_BlendMode to use for blending.
*
* \return 0 on success, or -1 on error
*
* \note If the blend mode is not supported, the closest supported mode is
* chosen.
*
* \sa SDL_GetRenderDrawBlendMode()
*/
extern DECLSPEC int SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer * renderer,
SDL_BlendMode blendMode);
/**
* \brief Get the blend mode used for drawing operations.
*
* \param renderer The renderer from which blend mode should be queried.
* \param blendMode A pointer filled in with the current blend mode.
*
* \return 0 on success, or -1 on error
*
* \sa SDL_SetRenderDrawBlendMode()
*/
extern DECLSPEC int SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer * renderer,
SDL_BlendMode *blendMode);
/**
* \brief Clear the current rendering target with the drawing color
*
* This function clears the entire rendering target, ignoring the viewport and
* the clip rectangle.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderClear(SDL_Renderer * renderer);
/**
* \brief Draw a point on the current rendering target.
*
* \param renderer The renderer which should draw a point.
* \param x The x coordinate of the point.
* \param y The y coordinate of the point.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawPoint(SDL_Renderer * renderer,
int x, int y);
/**
* \brief Draw multiple points on the current rendering target.
*
* \param renderer The renderer which should draw multiple points.
* \param points The points to draw
* \param count The number of points to draw
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawPoints(SDL_Renderer * renderer,
const SDL_Point * points,
int count);
/**
* \brief Draw a line on the current rendering target.
*
* \param renderer The renderer which should draw a line.
* \param x1 The x coordinate of the start point.
* \param y1 The y coordinate of the start point.
* \param x2 The x coordinate of the end point.
* \param y2 The y coordinate of the end point.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawLine(SDL_Renderer * renderer,
int x1, int y1, int x2, int y2);
/**
* \brief Draw a series of connected lines on the current rendering target.
*
* \param renderer The renderer which should draw multiple lines.
* \param points The points along the lines
* \param count The number of points, drawing count-1 lines
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawLines(SDL_Renderer * renderer,
const SDL_Point * points,
int count);
/**
* \brief Draw a rectangle on the current rendering target.
*
* \param renderer The renderer which should draw a rectangle.
* \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawRect(SDL_Renderer * renderer,
const SDL_Rect * rect);
/**
* \brief Draw some number of rectangles on the current rendering target.
*
* \param renderer The renderer which should draw multiple rectangles.
* \param rects A pointer to an array of destination rectangles.
* \param count The number of rectangles.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderDrawRects(SDL_Renderer * renderer,
const SDL_Rect * rects,
int count);
/**
* \brief Fill a rectangle on the current rendering target with the drawing color.
*
* \param renderer The renderer which should fill a rectangle.
* \param rect A pointer to the destination rectangle, or NULL for the entire
* rendering target.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderFillRect(SDL_Renderer * renderer,
const SDL_Rect * rect);
/**
* \brief Fill some number of rectangles on the current rendering target with the drawing color.
*
* \param renderer The renderer which should fill multiple rectangles.
* \param rects A pointer to an array of destination rectangles.
* \param count The number of rectangles.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderFillRects(SDL_Renderer * renderer,
const SDL_Rect * rects,
int count);
/**
* \brief Copy a portion of the texture to the current rendering target.
*
* \param renderer The renderer which should copy parts of a texture.
* \param texture The source texture.
* \param srcrect A pointer to the source rectangle, or NULL for the entire
* texture.
* \param dstrect A pointer to the destination rectangle, or NULL for the
* entire rendering target.
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderCopy(SDL_Renderer * renderer,
SDL_Texture * texture,
const SDL_Rect * srcrect,
const SDL_Rect * dstrect);
/**
* \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center
*
* \param renderer The renderer which should copy parts of a texture.
* \param texture The source texture.
* \param srcrect A pointer to the source rectangle, or NULL for the entire
* texture.
* \param dstrect A pointer to the destination rectangle, or NULL for the
* entire rendering target.
* \param angle An angle in degrees that indicates the rotation that will be applied to dstrect, rotating it in a clockwise direction
* \param center A pointer to a point indicating the point around which dstrect will be rotated (if NULL, rotation will be done around dstrect.w/2, dstrect.h/2).
* \param flip An SDL_RendererFlip value stating which flipping actions should be performed on the texture
*
* \return 0 on success, or -1 on error
*/
extern DECLSPEC int SDLCALL SDL_RenderCopyEx(SDL_Renderer * renderer,
SDL_Texture * texture,
const SDL_Rect * srcrect,
const SDL_Rect * dstrect,
const double angle,
const SDL_Point *center,
const SDL_RendererFlip flip);
/**
* \brief Read pixels from the current rendering target.
*
* \param renderer The renderer from which pixels should be read.
* \param rect A pointer to the rectangle to read, or NULL for the entire
* render target.
* \param format The desired format of the pixel data, or 0 to use the format
* of the rendering target
* \param pixels A pointer to be filled in with the pixel data
* \param pitch The pitch of the pixels parameter.
*
* \return 0 on success, or -1 if pixel reading is not supported.
*
* \warning This is a very slow operation, and should not be used frequently.
*/
extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
const SDL_Rect * rect,
Uint32 format,
void *pixels, int pitch);
/**
* \brief Update the screen with rendering performed.
*/
extern DECLSPEC void SDLCALL SDL_RenderPresent(SDL_Renderer * renderer);
/**
* \brief Destroy the specified texture.
*
* \sa SDL_CreateTexture()
* \sa SDL_CreateTextureFromSurface()
*/
extern DECLSPEC void SDLCALL SDL_DestroyTexture(SDL_Texture * texture);
/**
* \brief Destroy the rendering context for a window and free associated
* textures.
*
* \sa SDL_CreateRenderer()
*/
extern DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer * renderer);
/**
* \brief Bind the texture to the current OpenGL/ES/ES2 context for use with
* OpenGL instructions.
*
* \param texture The SDL texture to bind
* \param texw A pointer to a float that will be filled with the texture width
* \param texh A pointer to a float that will be filled with the texture height
*
* \return 0 on success, or -1 if the operation is not supported
*/
extern DECLSPEC int SDLCALL SDL_GL_BindTexture(SDL_Texture *texture, float *texw, float *texh);
/**
* \brief Unbind a texture from the current OpenGL/ES/ES2 context.
*
* \param texture The SDL texture to unbind
*
* \return 0 on success, or -1 if the operation is not supported
*/
extern DECLSPEC int SDLCALL SDL_GL_UnbindTexture(SDL_Texture *texture);
/**
* \brief Get the CAMetalLayer associated with the given Metal renderer
*
* \param renderer The renderer to query
*
* \return CAMetalLayer* on success, or NULL if the renderer isn't a Metal renderer
*
* \sa SDL_RenderGetMetalCommandEncoder()
*/
extern DECLSPEC void *SDLCALL SDL_RenderGetMetalLayer(SDL_Renderer * renderer);
/**
* \brief Get the Metal command encoder for the current frame
*
* \param renderer The renderer to query
*
* \return id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer
*
* \sa SDL_RenderGetMetalLayer()
*/
extern DECLSPEC void *SDLCALL SDL_RenderGetMetalCommandEncoder(SDL_Renderer * renderer);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* SDL_render_h_ */
/* vi: set ts=4 sw=4 expandtab: */
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr/__init__.py | from .scripts.extension import *
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr/openxr.py | from typing import Union, Callable
import os
import sys
import ctypes
import cv2
import numpy
import numpy as np
if __name__ != "__main__":
import pxr
import omni
from pxr import UsdGeom, Gf, Usd
from omni.syntheticdata import sensors, _syntheticdata
else:
class pxr:
class Gf:
Vec3d = lambda x,y,z: (x,y,z)
Quatd = lambda w,x,y,z: (w,x,y,z)
class Usd:
Prim = None
class UsdGeom:
pass
class Sdf:
Path = None
Gf = pxr.Gf
# constants
XR_KHR_OPENGL_ENABLE_EXTENSION_NAME = "XR_KHR_opengl_enable"
XR_KHR_OPENGL_ES_ENABLE_EXTENSION_NAME = "XR_KHR_opengl_es_enable"
XR_KHR_VULKAN_ENABLE_EXTENSION_NAME = "XR_KHR_vulkan_enable"
XR_KHR_D3D11_ENABLE_EXTENSION_NAME = "XR_KHR_D3D11_enable"
XR_KHR_D3D12_ENABLE_EXTENSION_NAME = "XR_KHR_D3D12_enable"
XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY = 1
XR_FORM_FACTOR_HANDHELD_DISPLAY = 2
XR_ENVIRONMENT_BLEND_MODE_OPAQUE = 1
XR_ENVIRONMENT_BLEND_MODE_ADDITIVE = 2
XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND = 3
XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO = 1
XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO = 2
XR_REFERENCE_SPACE_TYPE_VIEW = 1 # +Y up, +X to the right, and -Z forward
XR_REFERENCE_SPACE_TYPE_LOCAL = 2 # +Y up, +X to the right, and -Z forward
XR_REFERENCE_SPACE_TYPE_STAGE = 3 # +Y up, and the X and Z axes aligned with the rectangle edges
XR_ACTION_TYPE_BOOLEAN_INPUT = 1
XR_ACTION_TYPE_FLOAT_INPUT = 2
XR_ACTION_TYPE_VECTOR2F_INPUT = 3
XR_ACTION_TYPE_POSE_INPUT = 4
XR_ACTION_TYPE_VIBRATION_OUTPUT = 100
XR_NO_DURATION = 0
XR_INFINITE_DURATION = 2**32
XR_MIN_HAPTIC_DURATION = -1
XR_FREQUENCY_UNSPECIFIED = 0
def acquire_openxr_interface(disable_openxr: bool = False):
return OpenXR(disable_openxr)
def release_openxr_interface(xr):
if xr is not None:
xr.destroy()
xr = None
# structures (ctypes)
XrActionType = ctypes.c_int
XrStructureType = ctypes.c_int
class XrQuaternionf(ctypes.Structure):
_fields_ = [('x', ctypes.c_float), ('y', ctypes.c_float), ('z', ctypes.c_float), ('w', ctypes.c_float)]
class XrVector3f(ctypes.Structure):
_fields_ = [('x', ctypes.c_float), ('y', ctypes.c_float), ('z', ctypes.c_float)]
class XrPosef(ctypes.Structure):
_fields_ = [('orientation', XrQuaternionf), ('position', XrVector3f)]
class XrFovf(ctypes.Structure):
_fields_ = _fields_ = [('angleLeft', ctypes.c_float), ('angleRight', ctypes.c_float), ('angleUp', ctypes.c_float), ('angleDown', ctypes.c_float)]
class XrView(ctypes.Structure):
_fields_ = [('type', XrStructureType), ('next', ctypes.c_void_p), ('pose', XrPosef), ('fov', XrFovf)]
class XrViewConfigurationView(ctypes.Structure):
_fields_ = [('type', XrStructureType), ('next', ctypes.c_void_p),
('recommendedImageRectWidth', ctypes.c_uint32), ('maxImageRectWidth', ctypes.c_uint32),
('recommendedImageRectHeight', ctypes.c_uint32), ('maxImageRectHeight', ctypes.c_uint32),
('recommendedSwapchainSampleCount', ctypes.c_uint32), ('maxSwapchainSampleCount', ctypes.c_uint32)]
class ActionState(ctypes.Structure):
_fields_ = [('type', XrActionType),
('path', ctypes.c_char_p),
('isActive', ctypes.c_bool),
('stateBool', ctypes.c_bool),
('stateFloat', ctypes.c_float),
('stateVectorX', ctypes.c_float),
('stateVectorY', ctypes.c_float)]
class ActionPoseState(ctypes.Structure):
_fields_ = [('type', XrActionType),
('path', ctypes.c_char_p),
('isActive', ctypes.c_bool),
('pose', XrPosef)]
class OpenXR:
def __init__(self, disable_openxr: bool = False) -> None:
self._disable_openxr = disable_openxr
if self._disable_openxr:
print("[WARNING] Extension launched with OpenXR support disabled")
self._lib = None
self._app = None
self._graphics = None
self._use_ctypes = False
# views
self._prim_left = None
self._prim_right = None
self._frame_left = None
self._frame_right = None
self._viewport_window_left = None
self._viewport_window_right = None
self._meters_per_unit = 1.0
self._reference_position = Gf.Vec3d(0, 0, 0)
self._reference_rotation = Gf.Vec3d(0, 0, 0)
self._rectification_quat_left = Gf.Quatd(1, 0, 0, 0)
self._rectification_quat_right = Gf.Quatd(1, 0, 0, 0)
self._viewport_interface = None
self._transform_fit = None
self._transform_flip = None
# callbacks
self._callback_action_events = {}
self._callback_action_pose_events = {}
self._callback_middle_render = None
self._callback_render = None
def init(self, graphics: str = "OpenGL", use_ctypes: bool = False) -> bool:
"""
Init OpenXR application by loading the related libraries
Parameters
----------
graphics: str
OpenXR graphics API supported by the runtime (OpenGL, OpenGLES, Vulkan, D3D11, D3D12).
Note: At the moment only OpenGL is available
use_ctypes: bool, optional
If true, use ctypes as C/C++ interface instead of pybind11 (default)
Returns
-------
bool
True if initialization was successful, otherwise False
"""
# get viewport interface
try:
self._viewport_interface = omni.kit.viewport.get_viewport_interface()
except Exception as e:
print("[INFO] Using legacy viewport interface")
self._viewport_interface = omni.kit.viewport_legacy.get_viewport_interface()
# TODO: what about no graphic API (only controllers for example)?
self._use_ctypes = use_ctypes
# graphics API
if graphics in ["OpenGL", XR_KHR_OPENGL_ENABLE_EXTENSION_NAME]:
self._graphics = XR_KHR_OPENGL_ENABLE_EXTENSION_NAME
elif graphics in ["OpenGLES", XR_KHR_OPENGL_ES_ENABLE_EXTENSION_NAME]:
self._graphics = XR_KHR_OPENGL_ES_ENABLE_EXTENSION_NAME
raise NotImplementedError("OpenGLES graphics API is not implemented yet")
elif graphics in ["Vulkan", XR_KHR_VULKAN_ENABLE_EXTENSION_NAME]:
self._graphics = XR_KHR_VULKAN_ENABLE_EXTENSION_NAME
raise NotImplementedError("Vulkan graphics API is not implemented yet")
elif graphics in ["D3D11", XR_KHR_D3D11_ENABLE_EXTENSION_NAME]:
self._graphics = XR_KHR_D3D11_ENABLE_EXTENSION_NAME
raise NotImplementedError("D3D11 graphics API is not implemented yet")
elif graphics in ["D3D12", XR_KHR_D3D12_ENABLE_EXTENSION_NAME]:
self._graphics = XR_KHR_D3D12_ENABLE_EXTENSION_NAME
raise NotImplementedError("D3D12 graphics API is not implemented yet")
else:
raise ValueError("Invalid graphics API ({}). Valid graphics APIs are OpenGL, OpenGLES, Vulkan, D3D11, D3D12".format(graphics))
# libraries path
if __name__ == "__main__":
extension_path = os.getcwd()[:os.getcwd().find("/semu/xr/openxr")]
else:
extension_path = __file__[:__file__.find("/semu/xr/openxr")]
if self._disable_openxr:
return True
try:
# ctypes
if self._use_ctypes:
ctypes.PyDLL(os.path.join(extension_path, "bin", "libGL.so"), mode = ctypes.RTLD_GLOBAL)
ctypes.PyDLL(os.path.join(extension_path, "bin", "libSDL2.so"), mode = ctypes.RTLD_GLOBAL)
ctypes.PyDLL(os.path.join(extension_path, "bin", "libopenxr_loader.so"), mode = ctypes.RTLD_GLOBAL)
self._lib = ctypes.PyDLL(os.path.join(extension_path, "bin", "xrlib_c.so"), mode = ctypes.RTLD_GLOBAL)
self._app = self._lib.openXrApplication()
print("[INFO] OpenXR initialized using ctypes interface")
# pybind11
else:
sys.setdlopenflags(os.RTLD_GLOBAL | os.RTLD_LAZY)
sys.path.append(os.path.join(extension_path, "bin"))
# change cwd
tmp_dir= os.getcwd()
os.chdir(extension_path)
#import library
import xrlib_p
#restore cwd
os.chdir(tmp_dir)
self._lib = xrlib_p
self._app = xrlib_p.OpenXrApplication()
print("[INFO] OpenXR initialized using pybind11 interface")
except Exception as e:
print("[ERROR] OpenXR initialization:", e)
return False
return True
def destroy(self) -> bool:
"""
Destroy OpenXR application
Returns
-------
bool
True if destruction was successful, otherwise False
"""
if self._app is not None:
if self._use_ctypes:
return bool(self._lib.destroy(self._app))
else:
return self._app.destroy()
self._lib = None
self._app = None
return True
def is_session_running(self) -> bool:
"""
OpenXR session's running status
Returns
-------
bool
Return True if the OpenXR session is running, False otherwise
"""
if self._disable_openxr:
return True
if self._use_ctypes:
return bool(self._lib.isSessionRunning(self._app))
else:
return self._app.isSessionRunning()
def create_instance(self, application_name: str = "Omniverse (XR)", engine_name: str = "", api_layers: list = [], extensions: list = []) -> bool:
"""
Create an OpenXR instance to allow communication with an OpenXR runtime
OpenXR internal function calls:
- xrEnumerateApiLayerProperties
- xrEnumerateInstanceExtensionProperties
- xrCreateInstance
Parameters
----------
application_name: str, optional
Name of the OpenXR application (default: 'Omniverse (VR)')
engine_name: str, optional
Name of the engine (if any) used to create the application (empty by default)
api_layers: list of str, optional
[API layers](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#api-layers) to be inserted between the OpenXR application and the runtime implementation.
extensions: list of str, optional
[Extensions](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#extensions) to be loaded.
Note: At the moment only the graphic extensions are configured.
Note: The graphics API selected during initialization (init) is automatically included in the extensions to be loaded.
Returns
-------
bool
True if the instance has been created successfully, otherwise False
"""
if self._disable_openxr:
return True
if self._graphics not in extensions:
extensions += [self._graphics]
if self._use_ctypes:
# format API layes
requested_api_layers = (ctypes.c_char_p * len(api_layers))()
requested_api_layers[:] = [layer.encode('utf-8') for layer in api_layers]
# format extensions
requested_extensions = (ctypes.c_char_p * len(extensions))()
requested_extensions[:] = [extension.encode('utf-8') for extension in extensions]
return bool(self._lib.createInstance(self._app,
ctypes.create_string_buffer(application_name.encode('utf-8')),
ctypes.create_string_buffer(engine_name.encode('utf-8')),
requested_api_layers,
len(api_layers),
requested_extensions,
len(extensions)))
else:
return self._app.createInstance(application_name, engine_name, api_layers, extensions)
def get_system(self, form_factor: int = 1, blend_mode: int = 1, view_configuration_type: int = 2) -> bool:
"""
Obtain the system represented by a collection of related devices at runtime
OpenXR internal function calls:
- xrGetSystem
- xrGetInstanceProperties
- xrGetSystemProperties
- xrEnumerateViewConfigurations
- xrGetViewConfigurationProperties
- xrEnumerateViewConfigurationViews
- xrEnumerateEnvironmentBlendModes
- xrCreateActionSet (actionSetName: 'actionset', localizedActionSetName: 'localized_actionset')
Parameters
----------
form_factor: {XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY, XR_FORM_FACTOR_HANDHELD_DISPLAY}, optional
Desired [form factor](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#form_factor_description) from XrFormFactor enum (default: XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY)
blend_mode: {XR_ENVIRONMENT_BLEND_MODE_OPAQUE, XR_ENVIRONMENT_BLEND_MODE_ADDITIVE, XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND}, optional
Desired environment [blend mode](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#environment_blend_mode) from XrEnvironmentBlendMode enum (default: XR_ENVIRONMENT_BLEND_MODE_OPAQUE)
view_configuration_type: {XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO, XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO}, optional
Primary [view configuration](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#view_configurations) type from XrViewConfigurationType enum (default: XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO)
Returns
-------
bool
True if the system has been obtained successfully, otherwise False
"""
# check form_factor
if not form_factor in [XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY, XR_FORM_FACTOR_HANDHELD_DISPLAY]:
raise ValueError("Invalid form factor ({}). Valid form factors are XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY ({}), XR_FORM_FACTOR_HANDHELD_DISPLAY ({})" \
.format(form_factor, XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY, XR_FORM_FACTOR_HANDHELD_DISPLAY))
# check blend_mode
if not blend_mode in [XR_ENVIRONMENT_BLEND_MODE_OPAQUE, XR_ENVIRONMENT_BLEND_MODE_ADDITIVE, XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND]:
raise ValueError("Invalid blend mode ({}). Valid blend modes are XR_ENVIRONMENT_BLEND_MODE_OPAQUE ({}), XR_ENVIRONMENT_BLEND_MODE_ADDITIVE ({}), XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND ({})" \
.format(blend_mode, XR_ENVIRONMENT_BLEND_MODE_OPAQUE, XR_ENVIRONMENT_BLEND_MODE_ADDITIVE, XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND))
# check view_configuration_type
if not view_configuration_type in [XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO, XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO]:
raise ValueError("Invalid view configuration type ({}). Valid view configuration types are XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO ({}), XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO ({})" \
.format(view_configuration_type, XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO, XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO))
if self._disable_openxr:
return True
if self._use_ctypes:
return bool(self._lib.getSystem(self._app, form_factor, blend_mode, view_configuration_type))
else:
return self._app.getSystem(form_factor, blend_mode, view_configuration_type)
def create_session(self) -> bool:
"""
Create an OpenXR session that represents an application's intention to display XR content
OpenXR internal function calls:
- xrCreateSession
- xrEnumerateReferenceSpaces
- xrCreateReferenceSpace
- xrGetReferenceSpaceBoundsRect
- xrSuggestInteractionProfileBindings
- xrAttachSessionActionSets
- xrCreateActionSpace
- xrEnumerateSwapchainFormats
- xrCreateSwapchain
- xrEnumerateSwapchainImages
Returns
-------
bool
True if the session has been created successfully, otherwise False
"""
if self._disable_openxr:
return True
if self._use_ctypes:
return bool(self._lib.createSession(self._app))
else:
return self._app.createSession()
def poll_events(self) -> bool:
"""
[Event polling](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#event-polling) and processing
OpenXR internal function calls:
- xrPollEvent
- xrBeginSession
- xrEndSession
Returns
-------
bool
False if the running session needs to end (due to the user closing or switching the application, etc.), otherwise False
"""
if self._disable_openxr:
return True
if self._use_ctypes:
exit_loop = ctypes.c_bool(False)
result = bool(self._lib.pollEvents(self._app, ctypes.byref(exit_loop)))
return result and not exit_loop.value
else:
result = self._app.pollEvents()
return result[0] and not result[1]
def poll_actions(self) -> bool:
"""
[Action](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_action_overview) polling
OpenXR internal function calls:
- xrSyncActions
- xrGetActionStateBoolean
- xrGetActionStateFloat
- xrGetActionStateVector2f
- xrGetActionStatePose
Returns
-------
bool
True if there is no error during polling, otherwise False
"""
if self._disable_openxr:
return True
if self._use_ctypes:
requested_action_states = (ActionState * len(self._callback_action_events.keys()))()
result = bool(self._lib.pollActions(self._app, requested_action_states, len(requested_action_states)))
for state in requested_action_states:
value = None
if not state.type:
break
if state.type == XR_ACTION_TYPE_BOOLEAN_INPUT:
value = state.stateBool
elif state.type == XR_ACTION_TYPE_FLOAT_INPUT:
value = state.stateFloat
elif state.type == XR_ACTION_TYPE_VECTOR2F_INPUT:
value = (state.stateVectorX, state.stateVectorY)
elif state.type == XR_ACTION_TYPE_POSE_INPUT:
continue
elif state.type == XR_ACTION_TYPE_VIBRATION_OUTPUT:
continue
self._callback_action_events[state.path.decode("utf-8")](state.path.decode("utf-8"), value)
return result
else:
result = self._app.pollActions()
for state in result[1]:
value = None
if state["type"] == XR_ACTION_TYPE_BOOLEAN_INPUT:
value = state["stateBool"]
elif state["type"] == XR_ACTION_TYPE_FLOAT_INPUT:
value = state["stateFloat"]
elif state["type"] == XR_ACTION_TYPE_VECTOR2F_INPUT:
value = (state["stateVectorX"], state["stateVectorY"])
elif state["type"] == XR_ACTION_TYPE_POSE_INPUT:
continue
elif state["type"] == XR_ACTION_TYPE_VIBRATION_OUTPUT:
continue
self._callback_action_events[state["path"]](state["path"], value)
return result[0]
def render_views(self, reference_space: int = 2) -> bool:
"""
Present rendered images to the user's views according to the selected reference space
OpenXR internal function calls:
- xrWaitFrame
- xrBeginFrame
- xrLocateSpace
- xrLocateViews
- xrAcquireSwapchainImage
- xrWaitSwapchainImage
- xrReleaseSwapchainImage
- xrEndFrame
Parameters
----------
reference_space: {XR_REFERENCE_SPACE_TYPE_VIEW, XR_REFERENCE_SPACE_TYPE_LOCAL, XR_REFERENCE_SPACE_TYPE_STAGE}, optional
Desired [reference space](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#reference-spaces) type from XrReferenceSpaceType enum used to render the images (default: XR_REFERENCE_SPACE_TYPE_LOCAL)
Returns
-------
bool
True if there is no error during rendering, otherwise False
"""
if self._callback_render is None:
print("[INFO] No callback has been established for rendering events. Internal callback will be used")
self.subscribe_render_event()
if self._disable_openxr:
# test sensor reading
if self._viewport_window_left is not None:
frame_left = sensors.get_rgb(self._viewport_window_left)
cv2.imshow("frame_left {}".format(frame_left.shape), frame_left)
cv2.waitKey(1)
if self._viewport_window_right is not None:
frame_right = sensors.get_rgb(self._viewport_window_right)
cv2.imshow("frame_right {}".format(frame_right.shape), frame_right)
cv2.waitKey(1)
return True
if self._use_ctypes:
requested_action_pose_states = (ActionPoseState * len(self._callback_action_pose_events.keys()))()
result = bool(self._lib.renderViews(self._app, reference_space, requested_action_pose_states, len(requested_action_pose_states)))
for state in requested_action_pose_states:
value = None
if state.type == XR_ACTION_TYPE_POSE_INPUT and state.isActive:
value = (Gf.Vec3d(state.pose.position.x, -state.pose.position.z, state.pose.position.y) / self._meters_per_unit,
Gf.Quatd(state.pose.orientation.w, state.pose.orientation.x, state.pose.orientation.y, state.pose.orientation.z))
self._callback_action_pose_events[state.path.decode("utf-8")](state.path.decode("utf-8"), value)
return result
else:
result = self._app.renderViews(reference_space)
for state in result[1]:
value = None
if state["type"] == XR_ACTION_TYPE_POSE_INPUT and state["isActive"]:
value = (Gf.Vec3d(state["pose"]["position"]["x"], -state["pose"]["position"]["z"], state["pose"]["position"]["y"]) / self._meters_per_unit,
Gf.Quatd(state["pose"]["orientation"]["w"], state["pose"]["orientation"]["x"], state["pose"]["orientation"]["y"], state["pose"]["orientation"]["z"]))
self._callback_action_pose_events[state["path"]](state["path"], value)
return result[0]
# action utilities
def subscribe_action_event(self, path: str, callback: Union[Callable[[str, object], None], None] = None, action_type: Union[int, None] = None, reference_space: Union[int, None] = 2) -> bool:
"""
Create an action given a path and subscribe a callback function to the update event of this action
If action_type is None the action type will be automatically defined by parsing the last segment of the path according to the following policy:
- XR_ACTION_TYPE_BOOLEAN_INPUT: /click, /touch
- XR_ACTION_TYPE_FLOAT_INPUT: /value, /force
- XR_ACTION_TYPE_VECTOR2F_INPUT: /x, /y
- XR_ACTION_TYPE_POSE_INPUT: /pose
- XR_ACTION_TYPE_VIBRATION_OUTPUT: /haptic, /haptic_left, /haptic_right, /haptic_left_trigger, /haptic_right_trigger
The callback function (a callable object) should have only the following 2 parameters:
- path: str
The complete path (user path and subpath) of the action that invokes the callback
- value: bool, float, tuple(float, float), tuple(pxr.Gf.Vec3d, pxr.Gf.Quatd)
The current state of the action according to its type
- XR_ACTION_TYPE_BOOLEAN_INPUT: bool
- XR_ACTION_TYPE_FLOAT_INPUT: float
- XR_ACTION_TYPE_VECTOR2F_INPUT (x, y): tuple(float, float)
- XR_ACTION_TYPE_POSE_INPUT (position (in stage unit), rotation as quaternion): tuple(pxr.Gf.Vec3d, pxr.Gf.Quatd)
XR_ACTION_TYPE_VIBRATION_OUTPUT actions will not invoke their callback function. In this case the callback must be None
XR_ACTION_TYPE_POSE_INPUT also specifies, through the definition of the reference_space parameter, the reference space used to retrieve the pose
The collection of available paths corresponds to the following [interaction profiles](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-interaction-profiles):
- [Khronos Simple Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_khronos_simple_controller_profile)
- [Google Daydream Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_google_daydream_controller_profile)
- [HTC Vive Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_htc_vive_controller_profile)
- [HTC Vive Pro](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_htc_vive_pro_profile)
- [Microsoft Mixed Reality Motion Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_microsoft_mixed_reality_motion_controller_profile)
- [Microsoft Xbox Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_microsoft_xbox_controller_profile)
- [Oculus Go Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_oculus_go_controller_profile)
- [Oculus Touch Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_oculus_touch_controller_profile)
- [Valve Index Controller](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_valve_index_controller_profile)
OpenXR internal function calls:
- xrCreateAction
Parameters
----------
path: str
Complete [path](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved) (user path and subpath) referring to the action
callback: callable object (2 parameters) or None for XR_ACTION_TYPE_VIBRATION_OUTPUT
Callback invoked when the state of the action changes
action_type: {XR_ACTION_TYPE_BOOLEAN_INPUT, XR_ACTION_TYPE_FLOAT_INPUT, XR_ACTION_TYPE_VECTOR2F_INPUT, XR_ACTION_TYPE_POSE_INPUT, XR_ACTION_TYPE_VIBRATION_OUTPUT} or None, optional
Action [type](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrActionType) from XrActionType enum (default: None)
reference_space: {XR_REFERENCE_SPACE_TYPE_VIEW, XR_REFERENCE_SPACE_TYPE_LOCAL, XR_REFERENCE_SPACE_TYPE_STAGE}, optional
Desired [reference space](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#reference-spaces) type from XrReferenceSpaceType enum used to retrieve the pose (default: XR_REFERENCE_SPACE_TYPE_LOCAL)
Returns
-------
bool
True if there is no error during action creation, otherwise False
"""
if action_type is None:
if path.split("/")[-1] in ["click", "touch"]:
action_type = XR_ACTION_TYPE_BOOLEAN_INPUT
elif path.split("/")[-1] in ["value", "force"]:
action_type = XR_ACTION_TYPE_FLOAT_INPUT
elif path.split("/")[-1] in ["x", "y"]:
action_type = XR_ACTION_TYPE_VECTOR2F_INPUT
elif path.split("/")[-1] in ["pose"]:
action_type = XR_ACTION_TYPE_POSE_INPUT
elif path.split("/")[-1] in ["haptic", "haptic_left", "haptic_right", "haptic_left_trigger", "haptic_right_trigger"]:
action_type = XR_ACTION_TYPE_VIBRATION_OUTPUT
else:
raise ValueError("The action type cannot be retrieved from the path {}".format(path))
if callback is None and action_type != XR_ACTION_TYPE_VIBRATION_OUTPUT:
raise ValueError("The callback was not defined")
self._callback_action_events[path] = callback
if action_type == XR_ACTION_TYPE_POSE_INPUT:
self._callback_action_pose_events[path] = callback
if self._disable_openxr:
return True
if self._use_ctypes:
return bool(self._lib.addAction(self._app, ctypes.create_string_buffer(path.encode('utf-8')), action_type, reference_space))
else:
return self._app.addAction(path, action_type, reference_space)
def apply_haptic_feedback(self, path: str, haptic_feedback: dict = {}) -> bool:
"""
Apply a [haptic feedback](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_output_actions_and_haptics) to a device defined by a path (user path and subpath)
OpenXR internal function calls:
- xrApplyHapticFeedback
Parameters
----------
path: str
Complete [path](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved) (user path and subpath) referring to the action
haptic_feedback: dict
A python dictionary containing the field names and value of a XrHapticBaseHeader-based structure.
Note: At the moment the only haptics type supported is the unextended OpenXR [XrHapticVibration](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrHapticVibration)
Returns
-------
bool
True if there is no error during the haptic feedback application, otherwise False
"""
amplitude = haptic_feedback.get("amplitude", 0.5)
duration = haptic_feedback.get("duration", XR_MIN_HAPTIC_DURATION)
frequency = haptic_feedback.get("frequency", XR_FREQUENCY_UNSPECIFIED)
if self._disable_openxr:
return True
if self._use_ctypes:
amplitude = ctypes.c_float(amplitude)
duration = ctypes.c_int64(duration)
frequency = ctypes.c_float(frequency)
return bool(self._lib.applyHapticFeedback(self._app, ctypes.create_string_buffer(path.encode('utf-8')), amplitude, duration, frequency))
else:
return self._app.applyHapticFeedback(path, amplitude, duration, frequency)
def stop_haptic_feedback(self, path: str) -> bool:
"""
Stop a [haptic feedback](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#_output_actions_and_haptics) applied to a device defined by a path (user path and subpath)
OpenXR internal function calls:
- xrStopHapticFeedback
Parameters
----------
path: str
Complete [path](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved) (user path and subpath) referring to the action
Returns
-------
bool
True if there is no error during the haptic feedback stop, otherwise False
"""
if self._disable_openxr:
return True
if self._use_ctypes:
return bool(self._lib.stopHapticFeedback(self._app, ctypes.create_string_buffer(path.encode('utf-8'))))
else:
return self._app.stopHapticFeedback(path)
# view utilities
def setup_mono_view(self, camera: Union[str, pxr.Sdf.Path, pxr.Usd.Prim] = "/OpenXR/Cameras/camera", camera_properties: dict = {"focalLength": 10}) -> None:
"""
Setup Omniverse viewport and camera for monoscopic rendering
This method obtains the viewport window for the given camera. If the viewport window does not exist, a new one is created and the camera is set as active. If the given camera does not exist, a new camera is created with the same path and set to the recommended resolution of the display device
Parameters
----------
camera: str, pxr.Sdf.Path or pxr.Usd.Prim, optional
Omniverse camera prim or path (default: '/OpenXR/Cameras/camera')
camera_properties: dict
Dictionary containing the [camera properties](https://docs.omniverse.nvidia.com/app_create/prod_materials-and-rendering/cameras.html#camera-properties) supported by the Omniverse kit to be set (default: {"focalLength": 10})
"""
self.setup_stereo_view(camera, None, camera_properties)
def setup_stereo_view(self, left_camera: Union[str, pxr.Sdf.Path, pxr.Usd.Prim] = "/OpenXR/Cameras/left_camera", right_camera: Union[str, pxr.Sdf.Path, pxr.Usd.Prim, None] = "/OpenXR/Cameras/right_camera", camera_properties: dict = {"focalLength": 10}) -> None:
"""
Setup Omniverse viewports and cameras for stereoscopic rendering
This method obtains the viewport window for each camera. If the viewport window does not exist, a new one is created and the camera is set as active. If the given cameras do not exist, new cameras are created with the same path and set to the recommended resolution of the display device
Parameters
----------
left_camera: str, pxr.Sdf.Path or pxr.Usd.Prim, optional
Omniverse left camera prim or path (default: '/OpenXR/Cameras/left_camera')
right_camera: str, pxr.Sdf.Path or pxr.Usd.Prim, optional
Omniverse right camera prim or path (default: '/OpenXR/Cameras/right_camera')
camera_properties: dict
Dictionary containing the [camera properties](https://docs.omniverse.nvidia.com/app_create/prod_materials-and-rendering/cameras.html#camera-properties) supported by the Omniverse kit to be set (default: {"focalLength": 10})
"""
def get_or_create_vieport_window(camera, teleport=True, window_size=(400, 300), resolution=(1280, 720)):
window = None
camera = str(camera.GetPath() if type(camera) is Usd.Prim else camera)
# get viewport window
for interface in self._viewport_interface.get_instance_list():
w = self._viewport_interface.get_viewport_window(interface)
if camera == w.get_active_camera():
window = w
# check visibility
if not w.is_visible():
w.set_visible(True)
break
# create viewport window if not exist
if window is None:
window = self._viewport_interface.get_viewport_window(self._viewport_interface.create_instance())
window.set_window_size(*window_size)
window.set_active_camera(camera)
window.set_texture_resolution(*resolution)
if teleport:
window.set_camera_position(camera, 1.0, 1.0, 1.0, True)
window.set_camera_target(camera, 0.0, 0.0, 0.0, True)
return window
stage = omni.usd.get_context().get_stage()
# left camera
teleport_camera = False
self._prim_left = None
if type(left_camera) is Usd.Prim:
self._prim_left = left_camera
elif stage.GetPrimAtPath(left_camera).IsValid():
self._prim_left = stage.GetPrimAtPath(left_camera)
else:
teleport_camera = True
self._prim_left = stage.DefinePrim(omni.usd.get_stage_next_free_path(stage, left_camera, False), "Camera")
self._viewport_window_left = get_or_create_vieport_window(self._prim_left, teleport=teleport_camera)
# right camera
teleport_camera = False
self._prim_right = None
if right_camera is not None:
if type(right_camera) is Usd.Prim:
self._prim_right = right_camera
elif stage.GetPrimAtPath(right_camera).IsValid():
self._prim_right = stage.GetPrimAtPath(right_camera)
else:
teleport_camera = True
self._prim_right = stage.DefinePrim(omni.usd.get_stage_next_free_path(stage, right_camera, False), "Camera")
self._viewport_window_right = get_or_create_vieport_window(self._prim_right, teleport=teleport_camera)
# set recommended resolution
resolutions = self.get_recommended_resolutions()
if len(resolutions) and self._viewport_window_left is not None:
self._viewport_window_left.set_texture_resolution(*resolutions[0])
if len(resolutions) == 2 and self._viewport_window_right is not None:
self._viewport_window_right.set_texture_resolution(*resolutions[1])
# set camera properties
for property in camera_properties:
self._prim_left.GetAttribute(property).Set(camera_properties[property])
if right_camera is not None:
self._prim_right.GetAttribute(property).Set(camera_properties[property])
# enable sensors
if self._viewport_window_left is not None:
sensors.enable_sensors(self._viewport_window_left, [_syntheticdata.SensorType.Rgb])
if self._viewport_window_right is not None:
sensors.enable_sensors(self._viewport_window_right, [_syntheticdata.SensorType.Rgb])
def get_recommended_resolutions(self) -> tuple:
"""
Get the recommended resolution of the display device
Returns
-------
tuple
Tuple containing the recommended resolutions (width, height) of each device view.
If the tuple length is 2, index 0 represents the left eye and index 1 represents the right eye
"""
if self._disable_openxr:
return ([512, 512], [1024, 1024])
if self._use_ctypes:
num_views = self._lib.getViewConfigurationViewsSize(self._app)
views = (XrViewConfigurationView * num_views)()
if self._lib.getViewConfigurationViews(self._app, views, num_views):
return [(view.recommendedImageRectWidth, view.recommendedImageRectHeight) for view in views]
else:
return tuple([])
else:
return tuple([(view["recommendedImageRectWidth"], view["recommendedImageRectHeight"]) for view in self._app.getViewConfigurationViews()])
def set_reference_system_pose(self, position: Union[pxr.Gf.Vec3d, None] = None, rotation: Union[pxr.Gf.Vec3d, None] = None) -> None:
"""
Set the pose of the origin of the reference system
Parameters
----------
position: pxr.Gf.Vec3d or None, optional
Cartesian position (in stage unit) (default: None)
rotation: pxr.Gf.Vec3d or None, optional
Rotation (in degress) on each axis (default: None)
"""
self._reference_position = position
self._reference_rotation = rotation
def set_stereo_rectification(self, x: float = 0, y: float = 0, z: float = 0) -> None:
"""
Set the angle (in radians) of the rotation axes for stereoscopic view rectification
Parameters
----------
x: float, optional
Angle (in radians) of the X-axis (default: 0)
y: float, optional
Angle (in radians) of the Y-axis (default: 0)
x: float, optional
Angle (in radians) of the Z-axis (default: 0)
"""
self._rectification_quat_left = pxr.Gf.Quatd(1, 0, 0, 0)
self._rectification_quat_right = pxr.Gf.Quatd(1, 0, 0, 0)
if x: # w,x,y,z = cos(a/2), sin(a/2), 0, 0
self._rectification_quat_left *= pxr.Gf.Quatd(np.cos(x/2), np.sin(x/2), 0, 0)
self._rectification_quat_right *= pxr.Gf.Quatd(np.cos(-x/2), np.sin(-x/2), 0, 0)
if y: # w,x,y,z = cos(a/2), 0, sin(a/2), 0
self._rectification_quat_left *= pxr.Gf.Quatd(np.cos(y/2), 0, np.sin(y/2), 0)
self._rectification_quat_right *= pxr.Gf.Quatd(np.cos(-y/2), 0, np.sin(-y/2), 0)
if z: # w,x,y,z = cos(a/2), 0, 0, sin(a/2)
self._rectification_quat_left *= pxr.Gf.Quatd(np.cos(z/2), 0, 0, np.sin(z/2))
self._rectification_quat_right *= pxr.Gf.Quatd(np.cos(-z/2), 0, 0, np.sin(-z/2))
def set_meters_per_unit(self, meters_per_unit: float):
"""
Specify the meters per unit to be applied to transformations
E.g. 1 meter: 1.0, 1 centimeter: 0.01
Parameters
----------
meters_per_unit: float
Meters per unit
"""
assert meters_per_unit != 0
self._meters_per_unit = meters_per_unit
def set_frame_transformations(self, fit: bool = False, flip: Union[int, tuple, None] = None) -> None:
"""
Specify the transformations to be applied to the rendered images
Parameters
----------
fit: bool, optional
Adjust each rendered image to the recommended resolution of the display device by cropping and scaling the image from its center (default: False)
OpenCV.resize method with INTER_LINEAR interpolation will be used to scale the image to the recommended resolution
flip: int, tuple or None, optional
Flip each image around vertical (0), horizontal (1), or both axes (0,1) (default: None)
"""
self._transform_fit = fit
self._transform_flip = flip
def teleport_prim(self, prim: pxr.Usd.Prim, position: pxr.Gf.Vec3d, rotation: pxr.Gf.Quatd, reference_position: Union[pxr.Gf.Vec3d, None] = None, reference_rotation: Union[pxr.Gf.Vec3d, None] = None) -> None:
"""
Teleport the prim specified by the given transformation (position and rotation)
Parameters
----------
prim: pxr.Usd.Prim
Target prim
position: pxr.Gf.Vec3d
Cartesian position (in stage unit) used to transform the prim
rotation: pxr.Gf.Quatd
Rotation (as quaternion) used to transform the prim
reference_position: pxr.Gf.Vec3d or None, optional
Cartesian position (in stage unit) used as reference system (default: None)
reference_rotation: pxr.Gf.Vec3d or None, optional
Rotation (in degress) on each axis used as reference system (default: None)
"""
properties = prim.GetPropertyNames()
# reference position
if reference_position is not None:
if "xformOp:translate" in properties or "xformOp:translation" in properties:
prim.GetAttribute("xformOp:translate").Set(reference_position + position)
else:
print("[INFO] Create UsdGeom.XformOp.TypeTranslate for", prim.GetPath())
UsdGeom.Xformable(prim).AddXformOp(UsdGeom.XformOp.TypeTranslate, UsdGeom.XformOp.PrecisionDouble, "").Set(reference_position + position)
else:
if "xformOp:translate" in properties or "xformOp:translation" in properties:
prim.GetAttribute("xformOp:translate").Set(position)
else:
print("[INFO] Create UsdGeom.XformOp.TypeTranslate for", prim.GetPath())
UsdGeom.Xformable(prim).AddXformOp(UsdGeom.XformOp.TypeTranslate, UsdGeom.XformOp.PrecisionDouble, "").Set(position)
# reference rotation
if reference_rotation is not None:
if "xformOp:rotate" in properties:
prim.GetAttribute("xformOp:rotate").Set(reference_rotation)
elif "xformOp:rotateXYZ" in properties:
try:
prim.GetAttribute("xformOp:rotateXYZ").Set(reference_rotation)
except:
prim.GetAttribute("xformOp:rotateXYZ").Set(Gf.Vec3f(reference_rotation))
else:
print("[INFO] Create UsdGeom.XformOp.TypeRotateXYZ for", prim.GetPath())
UsdGeom.Xformable(prim).AddXformOp(UsdGeom.XformOp.TypeRotateXYZ, UsdGeom.XformOp.PrecisionDouble, "").Set(reference_rotation)
# transform
transform_matrix = Gf.Matrix4d()
transform_matrix.SetIdentity()
# transform_matrix.SetTranslateOnly(position)
transform_matrix.SetRotateOnly(Gf.Rotation(rotation))
if "xformOp:transform" in properties:
prim.GetAttribute("xformOp:transform").Set(transform_matrix)
else:
print("[INFO] Create UsdGeom.XformOp.TypeTransform for", prim.GetPath())
UsdGeom.Xformable(prim).AddXformOp(UsdGeom.XformOp.TypeTransform, UsdGeom.XformOp.PrecisionDouble, "").Set(transform_matrix)
def subscribe_render_event(self, callback=None) -> None:
"""
Subscribe a callback function to the render event
The callback function (a callable object) should have only the following 3 parameters:
- num_views: int
The number of views to render: mono (1), stereo (2)
- views: tuple of XrView structure
A [XrView](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrView) structure contains the view pose and projection state necessary to render a image.
The length of the tuple corresponds to the number of views (if the tuple length is 2, index 0 represents the left eye and index 1 represents the right eye)
- configuration_views: tuple of XrViewConfigurationView structure
A [XrViewConfigurationView](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrViewConfigurationView) structure specifies properties related to rendering of a view (e.g. the optimal width and height to be used when rendering the view).
The length of the tuple corresponds to the number of views (if the tuple length is 2, index 0 represents the left eye and index 1 represents the right eye)
The callback function must call the set_frames function to pass to the selected graphics API the image or images to be rendered
If the callback is None, an internal callback will be used to render the views. This internal callback updates the pose of the cameras according to the specified reference system, gets the images from the previously configured viewports and invokes the set_frames function to render the views.
Parameters
----------
callback: callable object (3 parameters) or None, optional
Callback invoked on each render event (default: None)
"""
def _middle_callback(num_views, views, configuration_views):
_views = []
for v in views:
tmp = XrView()
tmp.type = v["type"]
tmp.next = None
tmp.pose = XrPosef()
tmp.pose.position.x = v["pose"]["position"]["x"]
tmp.pose.position.y = v["pose"]["position"]["y"]
tmp.pose.position.z = v["pose"]["position"]["z"]
tmp.pose.orientation.x = v["pose"]["orientation"]["x"]
tmp.pose.orientation.y = v["pose"]["orientation"]["y"]
tmp.pose.orientation.z = v["pose"]["orientation"]["z"]
tmp.pose.orientation.w = v["pose"]["orientation"]["w"]
tmp.fov = XrFovf()
tmp.fov.angleLeft = v["fov"]["angleLeft"]
tmp.fov.angleRight = v["fov"]["angleRight"]
tmp.fov.angleUp = v["fov"]["angleUp"]
tmp.fov.angleDown = v["fov"]["angleDown"]
_views.append(tmp)
_configuration_views = []
for v in configuration_views:
tmp = XrViewConfigurationView()
tmp.type = v["type"]
tmp.next = None
tmp.recommendedImageRectWidth = v["recommendedImageRectWidth"]
tmp.recommendedImageRectHeight = v["recommendedImageRectHeight"]
tmp.maxImageRectWidth = v["maxImageRectWidth"]
tmp.maxImageRectHeight = v["maxImageRectHeight"]
tmp.recommendedSwapchainSampleCount = v["recommendedSwapchainSampleCount"]
tmp.maxSwapchainSampleCount = v["maxSwapchainSampleCount"]
_configuration_views.append(tmp)
self._callback_render(num_views, _views, _configuration_views)
def _internal_render(num_views, views, configuration_views):
# teleport left camera
position = views[0].pose.position
rotation = views[0].pose.orientation
position = Gf.Vec3d(position.x, -position.z, position.y) / self._meters_per_unit
rotation = Gf.Quatd(rotation.w, rotation.x, rotation.y, rotation.z) * self._rectification_quat_left
self.teleport_prim(self._prim_left, position, rotation, self._reference_position, self._reference_rotation)
# teleport right camera
if num_views == 2:
position = views[1].pose.position
rotation = views[1].pose.orientation
position = Gf.Vec3d(position.x, -position.z, position.y) / self._meters_per_unit
rotation = Gf.Quatd(rotation.w, rotation.x, rotation.y, rotation.z) * self._rectification_quat_right
self.teleport_prim(self._prim_right, position, rotation, self._reference_position, self._reference_rotation)
# set frames
try:
frame_left = sensors.get_rgb(self._viewport_window_left)
frame_right = sensors.get_rgb(self._viewport_window_right) if num_views == 2 else None
self.set_frames(configuration_views, frame_left, frame_right)
except Exception as e:
print("[ERROR]", str(e))
self._callback_render = callback
if callback is None:
self._callback_render = _internal_render
if self._disable_openxr:
return
if self._use_ctypes:
self._callback_middle_render = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.POINTER(XrView), ctypes.POINTER(XrViewConfigurationView))(self._callback_render)
self._lib.setRenderCallback(self._app, self._callback_middle_render)
else:
self._callback_middle_render = _middle_callback
self._app.setRenderCallback(self._callback_middle_render)
def set_frames(self, configuration_views: list, left: numpy.ndarray, right: numpy.ndarray = None) -> bool:
"""
Pass to the selected graphics API the images to be rendered in the views
In the case of stereoscopic devices, the parameters left and right represent the left eye and right eye respectively.
To pass an image to the graphic API of monoscopic devices only the parameter left should be used (the parameter right must be None)
This function will apply to each image the transformations defined by the set_frame_transformations function if they were specified
Parameters
----------
configuration_views: tuple of XrViewConfigurationView structure
A [XrViewConfigurationView](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrViewConfigurationView) structure specifies properties related to rendering of a view (e.g. the optimal width and height to be used when rendering the view)
left: numpy.ndarray
RGB or RGBA image (numpy.uint8)
right: numpy.ndarray or None
RGB or RGBA image (numpy.uint8)
Returns
-------
bool
True if there is no error during the passing to the selected graphics API, otherwise False
"""
use_rgba = True if left.shape[2] == 4 else False
if self._disable_openxr:
return True
if self._use_ctypes:
self._frame_left = self._transform(configuration_views[0], left)
if right is None:
return bool(self._lib.setFrames(self._app,
self._frame_left.shape[1], self._frame_left.shape[0], self._frame_left.ctypes.data_as(ctypes.c_void_p),
0, 0, None,
use_rgba))
else:
self._frame_right = self._transform(configuration_views[1], right)
return bool(self._lib.setFrames(self._app,
self._frame_left.shape[1], self._frame_left.shape[0], self._frame_left.ctypes.data_as(ctypes.c_void_p),
self._frame_right.shape[1], self._frame_right.shape[0], self._frame_right.ctypes.data_as(ctypes.c_void_p),
use_rgba))
else:
self._frame_left = self._transform(configuration_views[0], left)
if right is None:
return self._app.setFrames(self._frame_left, np.array(None), use_rgba)
else:
self._frame_right = self._transform(configuration_views[1], right)
return self._app.setFrames(self._frame_left, self._frame_right, use_rgba)
def _transform(self, configuration_view: XrViewConfigurationView, frame: np.ndarray) -> np.ndarray:
transformed = False
if self._transform_flip is not None:
transformed = True
frame = np.flip(frame, axis=self._transform_flip)
if self._transform_fit:
transformed = True
current_ratio = frame.shape[1] / frame.shape[0]
recommended_ratio = configuration_view.recommendedImageRectWidth / configuration_view.recommendedImageRectHeight
recommended_size = (configuration_view.recommendedImageRectWidth, configuration_view.recommendedImageRectHeight)
if current_ratio > recommended_ratio:
m = int(abs(recommended_ratio * frame.shape[0] - frame.shape[1]) / 2)
frame = cv2.resize(frame[:, m:-m] if m else frame, recommended_size, interpolation=cv2.INTER_LINEAR)
else:
m = int(abs(frame.shape[1] / recommended_ratio - frame.shape[0]) / 2)
frame = cv2.resize(frame[m:-m, :] if m else frame, recommended_size, interpolation=cv2.INTER_LINEAR)
return np.array(frame, copy=True) if transformed else frame
if __name__ == "__main__":
import cv2
import time
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--ctypes', default=False, action="store_true", help='use ctypes instead of pybind11')
args = parser.parse_args()
_xr = acquire_openxr_interface()
_xr.init(use_ctypes=args.ctypes)
ready = False
end = False
def callback_action_pose(path, value):
print(path, value)
return
def callback_action(path, value):
if path in ["/user/hand/left/input/menu/click", "/user/hand/right/input/menu/click"]:
# print(path, value)
print(_xr.apply_haptic_feedback("/user/hand/left/output/haptic", {"duration": 1000000}))
print(_xr.apply_haptic_feedback("/user/hand/right/output/haptic", {"duration": 1000000}))
if _xr.create_instance():
if _xr.get_system():
_xr.subscribe_action_event("/user/head/input/volume_up/click", callback=callback_action)
_xr.subscribe_action_event("/user/head/input/volume_down/click", callback=callback_action)
_xr.subscribe_action_event("/user/head/input/mute_mic/click", callback=callback_action)
_xr.subscribe_action_event("/user/hand/left/input/trigger/value", callback=callback_action)
_xr.subscribe_action_event("/user/hand/right/input/trigger/value", callback=callback_action)
_xr.subscribe_action_event("/user/hand/left/input/menu/click", callback=callback_action)
_xr.subscribe_action_event("/user/hand/right/input/menu/click", callback=callback_action)
_xr.subscribe_action_event("/user/hand/left/input/grip/pose", callback=callback_action_pose, reference_space=XR_REFERENCE_SPACE_TYPE_LOCAL)
_xr.subscribe_action_event("/user/hand/right/input/grip/pose", callback=callback_action_pose, reference_space=XR_REFERENCE_SPACE_TYPE_LOCAL)
_xr.subscribe_action_event("/user/hand/left/output/haptic", callback=callback_action)
_xr.subscribe_action_event("/user/hand/right/output/haptic", callback=callback_action)
if _xr.create_session():
ready = True
else:
print("[ERROR]:", "createSession")
else:
print("[ERROR]:", "getSystem")
else:
print("[ERROR]:", "createInstance")
if ready:
cap = cv2.VideoCapture("/home/argus/Videos/xr/xr/sample.mp4")
def callback_render(num_views, views, configuration_views):
pass
# global end
# ret, frame = cap.read()
# if ret:
# if num_views == 2:
# frame1 = cv2.cvtColor(frame, cv2.COLOR_BGR2RGB)
# _xr.set_frames(configuration_views, frame, frame1)
# # show frame
# k = 0.25
# frame = cv2.resize(np.hstack((frame, frame1)), (int(2*k*frame.shape[1]), int(k*frame.shape[0])))
# cv2.imshow('frame', frame)
# if cv2.waitKey(1) & 0xFF == ord('q'):
# exit()
# else:
# end = True
_xr.subscribe_render_event(callback_render)
# while(cap.isOpened() or not end):
for i in range(10000000):
if _xr.poll_events():
if _xr.is_session_running():
if not _xr.poll_actions():
print("[ERROR]:", "pollActions")
break
if not _xr.render_views():
print("[ERROR]:", "renderViews")
break
else:
print("wait for is_session_running()")
time.sleep(0.1)
else:
break
print("END") |
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr/scripts/extension.py | import gc
import carb
import omni.ext
try:
import cv2
except:
omni.kit.pipapi.install("opencv-python")
try:
from .. import _openxr as _openxr
except:
print(">>>> [DEVELOPMENT] import openxr")
from .. import openxr as _openxr
__all__ = ["Extension", "_openxr"]
class Extension(omni.ext.IExt):
def on_startup(self, ext_id):
# get extension settings
self._settings = carb.settings.get_settings()
disable_openxr = self._settings.get("/exts/semu.xr.openxr/disable_openxr")
self._xr = _openxr.acquire_openxr_interface(disable_openxr=disable_openxr)
def on_shutdown(self):
_openxr.release_openxr_interface(self._xr)
gc.collect()
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr/tests/__init__.py | from .test_openxr import *
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr/tests/test_openxr.py | # NOTE:
# omni.kit.test - std python's unittest module with additional wrapping to add suport for async/await tests
# For most things refer to unittest docs: https://docs.python.org/3/library/unittest.html
import omni.kit.test
# Import extension python module we are testing with absolute import path, as if we are external user (other extension)
from semu.xr.openxr import _openxr
import cv2
import time
import numpy as np
# Having a test class dervived from omni.kit.test.AsyncTestCase declared on the root of module will make it auto-discoverable by omni.kit.test
class TestOpenXR(omni.kit.test.AsyncTestCaseFailOnLogError):
# Before running each test
async def setUp(self):
pass
# After running each test
async def tearDown(self):
pass
def render(self, num_frames, width, height, color):
self._frame = np.ones((height, width, 3), dtype=np.uint8)
self._frame = cv2.circle(self._frame, (int(width / 2), int(height / 2)),
int(np.min([width, height]) / 4), color, int(0.05 * np.min([width, height])))
self._frame = cv2.circle(self._frame, (int(width / 3), int(height / 3)),
int(0.1 * np.min([width, height])), color, -1)
start_time = time.clock()
for i in range(num_frames):
if self._xr.poll_events():
if self._xr.is_session_running():
if not self._xr.poll_actions():
print("[ERROR]:", "pollActions")
return
if not self._xr.render_views():
print("[ERROR]:", "renderViews")
return
end_time = time.clock()
delta = end_time - start_time
print("----------")
print("FPS: {} ({} frames / {} seconds)".format(num_frames / delta, num_frames, delta))
print("RESOLUTION: {} x {}".format(self._frame.shape[1], self._frame.shape[0]))
# Actual test, notice it is "async" function, so "await" can be used if needed
async def test_openxr(self):
self._xr = _openxr.acquire_openxr_interface()
self._xr.init()
ready = False
if self._xr.create_instance():
if self._xr.get_system():
if self._xr.create_action_set():
if self._xr.create_session():
ready = True
else:
print("[ERROR]:", "createSession")
else:
print("[ERROR]:", "createActionSet")
else:
print("[ERROR]:", "getSystem")
else:
print("[ERROR]:", "createInstance")
if ready:
for i in range(1000):
if self._xr.poll_events():
if self._xr.is_session_running():
if not self._xr.poll_actions():
print("[ERROR]:", "pollActions")
break
# if ready:
# def callback_render(num_views, views, configuration_views):
# self._xr.set_frames(configuration_views, self._frame, self._frame, self._transform)
# self._xr.subscribe_render_event(callback_render)
# num_frames = 100
# print("")
# print("transform = True")
# self._transform = True
# self.render(num_frames=num_frames, width=1560, height=1732, color=(255,0,0))
# self.render(num_frames=num_frames, width=1280, height=720, color=(0,255,0))
# self.render(num_frames=num_frames, width=500, height=500, color=(0,0,255))
# print("")
# print("transform = False")
# self._transform = False
# self.render(num_frames=num_frames, width=1560, height=1732, color=(255,0,0))
# self.render(num_frames=num_frames, width=1280, height=720, color=(0,255,0))
# self.render(num_frames=num_frames, width=500, height=500, color=(0,0,255))
# print("")
# _openxr.release_openxr_interface(self._xr)
# self._xr = None
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr_ui/__init__.py | from .scripts.extension import *
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/semu/xr/openxr_ui/scripts/extension.py | import math
import weakref
import pxr
import omni
import carb
import omni.ext
import omni.ui as ui
from pxr import UsdGeom
from omni.kit.menu.utils import add_menu_items, remove_menu_items, MenuItemDescription
from semu.xr.openxr import _openxr
class Extension(omni.ext.IExt):
def on_startup(self, ext_id):
# get extension settings
self._settings = carb.settings.get_settings()
self._disable_openxr = self._settings.get("/exts/semu.xr.openxr/disable_openxr")
self._window = None
self._menu_items = [MenuItemDescription(name="OpenXR UI", onclick_fn=lambda a=weakref.proxy(self): a._menu_callback())]
add_menu_items(self._menu_items, "Add-ons")
self._xr = None
self._ready = False
self._timeline = omni.timeline.get_timeline_interface()
self._physx_subs = omni.physx.get_physx_interface().subscribe_physics_step_events(self._on_simulation_step)
def on_shutdown(self):
self._physx_subs = None
remove_menu_items(self._menu_items, "Add-ons")
self._window = None
def _get_reference_space(self):
reference_space = [_openxr.XR_REFERENCE_SPACE_TYPE_VIEW, _openxr.XR_REFERENCE_SPACE_TYPE_LOCAL, _openxr.XR_REFERENCE_SPACE_TYPE_STAGE]
return reference_space[self._xr_settings_reference_space.model.get_item_value_model().as_int]
def _get_origin_pose(self):
space_origin_position = [self._xr_settings_space_origin_position.model.get_item_value_model(i).as_float for i in self._xr_settings_space_origin_position.model.get_item_children()]
space_origin_rotation = [self._xr_settings_space_origin_rotation.model.get_item_value_model(i).as_int for i in self._xr_settings_space_origin_rotation.model.get_item_children()]
return {"position": pxr.Gf.Vec3d(*space_origin_position), "rotation": pxr.Gf.Vec3d(*space_origin_rotation)}
def _get_frame_transformations(self):
transform_fit = self._xr_settings_transform_fit.model.get_value_as_bool()
transform_flip = [None, 0, 1, (0,1)]
transform_flip = transform_flip[self._xr_settings_transform_flip.model.get_item_value_model().as_int]
return {"fit": transform_fit, "flip": transform_flip}
def _get_stereo_rectification(self):
return [self._xr_settings_stereo_rectification.model.get_item_value_model(i).as_float * math.pi / 180.0 for i in self._xr_settings_stereo_rectification.model.get_item_children()]
def _menu_callback(self):
self._build_ui()
def _on_start_openxr(self):
# get parameters from ui
graphics = [_openxr.XR_KHR_OPENGL_ENABLE_EXTENSION_NAME]
graphics = graphics[self._xr_settings_graphics_api.model.get_item_value_model().as_int]
form_factor = [_openxr.XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY, _openxr.XR_FORM_FACTOR_HANDHELD_DISPLAY]
form_factor = form_factor[self._xr_settings_form_factor.model.get_item_value_model().as_int]
blend_mode = [_openxr.XR_ENVIRONMENT_BLEND_MODE_OPAQUE, _openxr.XR_ENVIRONMENT_BLEND_MODE_ADDITIVE, _openxr.XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND]
blend_mode = blend_mode[self._xr_settings_blend_mode.model.get_item_value_model().as_int]
view_configuration_type = [_openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO, _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO]
view_configuration_type = view_configuration_type[self._xr_settings_view_configuration_type.model.get_item_value_model().as_int]
# disable static parameters ui
self._xr_settings_graphics_api.enabled = False
self._xr_settings_form_factor.enabled = False
self._xr_settings_blend_mode.enabled = False
self._xr_settings_view_configuration_type.enabled = False
if self._xr is None:
self._xr = _openxr.acquire_openxr_interface(disable_openxr=self._disable_openxr)
if not self._xr.init(graphics=graphics, use_ctypes=False):
print("[ERROR] OpenXR.init with graphics: {}".format(graphics))
# set stage unit
stage = omni.usd.get_context().get_stage()
self._xr.set_meters_per_unit(UsdGeom.GetStageMetersPerUnit(stage))
# setup OpenXR application using default and ui parameters
if self._xr.create_instance():
if self._xr.get_system(form_factor=form_factor, blend_mode=blend_mode, view_configuration_type=view_configuration_type):
# create session and define interaction profiles
if self._xr.create_session():
# setup cameras and viewports and prepare rendering using the internal callback
if view_configuration_type == _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO:
self._xr.setup_mono_view()
elif view_configuration_type == _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO:
self._xr.setup_stereo_view()
# enable/disable buttons
self._ui_start_xr.enabled = False
self._ui_stop_xr.enabled = True
# play
self._timeline.play()
self._ready = True
return
else:
print("[ERROR] OpenXR.create_session")
else:
print("[ERROR] OpenXR.get_system with form_factor: {}, blend_mode: {}, view_configuration_type: {}".format(form_factor, blend_mode, view_configuration_type))
else:
print("[ERROR] OpenXR.create_instance")
self._on_stop_openxr()
def _on_stop_openxr(self):
self._ready = False
_openxr.release_openxr_interface(self._xr)
self._xr = None
# enable static parameters ui
self._xr_settings_graphics_api.enabled = True
self._xr_settings_form_factor.enabled = True
self._xr_settings_blend_mode.enabled = True
self._xr_settings_view_configuration_type.enabled = True
# enable/disable buttons
self._ui_start_xr.enabled = True
self._ui_stop_xr.enabled = False
def _on_simulation_step(self, step):
if self._ready and self._xr is not None:
# origin
self._xr.set_reference_system_pose(**self._get_origin_pose())
# transformation and rectification
self._xr.set_stereo_rectification(*self._get_stereo_rectification())
self._xr.set_frame_transformations(**self._get_frame_transformations())
# action and rendering loop
if not self._xr.poll_events():
self._on_stop_openxr()
return
if self._xr.is_session_running():
if not self._xr.poll_actions():
self._on_stop_openxr()
return
if not self._xr.render_views(self._get_reference_space()):
self._on_stop_openxr()
return
def _build_ui(self):
if not self._window:
self._window = ui.Window(title="OpenXR UI", width=300, height=375, visible=True, dockPreference=ui.DockPreference.LEFT_BOTTOM)
with self._window.frame:
with ui.VStack():
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Graphics API:", width=85, tooltip="OpenXR graphics API supported by the runtime")
self._xr_settings_graphics_api = ui.ComboBox(0, "OpenGL")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Form factor:", width=80, tooltip="XrFormFactor enum. HEAD_MOUNTED_DISPLAY: the tracked display is attached to the user's head. HANDHELD_DISPLAY: the tracked display is held in the user's hand, independent from the user's head")
self._xr_settings_form_factor = ui.ComboBox(0, "Head Mounted Display", "Handheld Display")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Blend mode:", width=80, tooltip="XrEnvironmentBlendMode enum. OPAQUE: display the composition layers with no view of the physical world behind them. ADDITIVE: additively blend the composition layers with the real world behind the display. ALPHA BLEND: alpha-blend the composition layers with the real world behind the display")
self._xr_settings_blend_mode = ui.ComboBox(0, "Opaque", "Additive", "Alpha blend")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("View configuration type:", width=145, tooltip="XrViewConfigurationType enum. MONO: one primary display (e.g. an AR phone's screen). STEREO: two primary displays, which map to a left-eye and right-eye view")
self._xr_settings_view_configuration_type = ui.ComboBox(1, "Mono", "Stereo")
ui.Spacer(height=5)
ui.Separator(height=1, width=0)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Space origin:", width=85)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Position (in stage unit):", width=165, tooltip="Cartesian position (in stage unit) used as reference origin")
self._xr_settings_space_origin_position = ui.MultiFloatDragField(0.0, 0.0, 0.0, step=0.1)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Rotation (XYZ):", width=110, tooltip="Rotation (in degress) on each axis used as reference origin")
self._xr_settings_space_origin_rotation = ui.MultiIntDragField(0, 0, 0, min=-180, max=180)
ui.Spacer(height=5)
with ui.HStack(height=0):
style = {"Tooltip": {"width": 50, "word-wrap": "break-word"}}
ui.Label("Reference space (views):", width=145, tooltip="XrReferenceSpaceType enum. VIEW: track the view origin for the primary viewer. LOCAL: establish a world-locked origin. STAGE: runtime-defined space that can be walked around on", style=style)
self._xr_settings_reference_space = ui.ComboBox(1, "View", "Local", "Stage")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Stereo rectification (x,y,z):", width=150, tooltip="Angle (in degrees) on each rotation axis for stereoscopic rectification")
self._xr_settings_stereo_rectification = ui.MultiFloatDragField(0.0, 0.0, 0.0, min=-10, max=10, step=0.1)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Frame transformations:")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Fit:", width=45, tooltip="Adjust each rendered image to the recommended resolution of the display device by cropping and scaling the image from its center")
self._xr_settings_transform_fit = ui.CheckBox()
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Flip:", width=45, tooltip="Flip each image with respect to its view")
self._xr_settings_transform_flip = ui.ComboBox(0, "None", "Vertical", "Horizontal", "Both")
ui.Spacer(height=5)
ui.Separator(height=1, width=0)
ui.Spacer(height=5)
with ui.HStack(height=0):
self._ui_start_xr = ui.Button("Start OpenXR", height=0, clicked_fn=self._on_start_openxr)
self._ui_stop_xr = ui.Button("Stop OpenXR", height=0, clicked_fn=self._on_stop_openxr)
self._ui_stop_xr.enabled = False
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/config/extension.toml | [core]
reloadable = true
order = 0
[package]
version = "0.0.4-beta"
category = "Other"
feature = false
app = false
title = "OpenXR (compact binding)"
description = "OpenXR compact binding for Omniverse"
authors = ["Toni-SM"]
repository = "https://github.com/Toni-SM/semu.xr.openxr"
keywords = ["OpenXR", "XR", "VR", "AR"]
changelog = "docs/CHANGELOG.md"
readme = "docs/README.md"
preview_image = "data/preview.png"
icon = "data/icon.png"
[package.target]
config = ["release"]
platform = ["linux-x86_64"]
python = ["py37", "cp37"]
[dependencies]
"omni.ui" = {}
"omni.physx" = {}
"omni.kit.uiapp" = {}
"omni.kit.pipapi" = {}
"omni.syntheticdata" = {}
"omni.kit.menu.utils" = {}
"omni.kit.window.viewport" = {}
[[python.module]]
name = "semu.xr.openxr"
[[python.module]]
name = "semu.xr.openxr_ui"
[[python.module]]
name = "semu.xr.openxr.tests"
[python.pipapi]
requirements = ["opencv-python"]
use_online_index = true
[settings]
exts."semu.xr.openxr".disable_openxr = false
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [0.0.4-beta] - 2022-09-14
### Added
- Add `set_meters_per_unit` method for specifying the unit factor to be applied to transformations
### Changed
- Use float input field for getting the reference position from UI
## [0.0.3-beta] - 2022-09-09
### Added
- Add `disable_openxr` flag to configuration settings for testing the extension
### Fixed
- Enable RGB sensors when setting up mono/stereo views
## [0.0.2-beta] - 2022-05-22
### Added
- Source code (src folder)
### Changed
- Rename the extension to `semu.xr.openxr`
## [0.0.1-beta] - 2021-10-01
### Added
- Create OpenXR compact binding with OpenGL support
|
Toni-SM/semu.xr.openxr/src/semu.xr.openxr/docs/README.md | # semu.xr.openxr
This extension provides a compact python binding (on top of the open standard OpenXR for augmented reality (AR) and virtual reality (VR)) to create extended reality applications taking advantage of NVIDIA Omniverse rendering capabilities
Visit https://github.com/Toni-SM/semu.xr.openxr to read more about its use
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr/__init__.py | from .scripts.extension import *
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr/scripts/extension.py | import gc
import carb
import omni.ext
try:
import cv2
except:
omni.kit.pipapi.install("opencv-python")
try:
from .. import _openxr as _openxr
except:
print(">>>> [DEVELOPMENT] import openxr")
from .. import openxr as _openxr
__all__ = ["Extension", "_openxr"]
class Extension(omni.ext.IExt):
def on_startup(self, ext_id):
# get extension settings
self._settings = carb.settings.get_settings()
disable_openxr = self._settings.get("/exts/semu.xr.openxr/disable_openxr")
self._xr = _openxr.acquire_openxr_interface(disable_openxr=disable_openxr)
def on_shutdown(self):
_openxr.release_openxr_interface(self._xr)
gc.collect()
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr/tests/__init__.py | from .test_openxr import *
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr/tests/test_openxr.py | # NOTE:
# omni.kit.test - std python's unittest module with additional wrapping to add suport for async/await tests
# For most things refer to unittest docs: https://docs.python.org/3/library/unittest.html
import omni.kit.test
# Import extension python module we are testing with absolute import path, as if we are external user (other extension)
from semu.xr.openxr import _openxr
import cv2
import time
import numpy as np
# Having a test class dervived from omni.kit.test.AsyncTestCase declared on the root of module will make it auto-discoverable by omni.kit.test
class TestOpenXR(omni.kit.test.AsyncTestCaseFailOnLogError):
# Before running each test
async def setUp(self):
pass
# After running each test
async def tearDown(self):
pass
def render(self, num_frames, width, height, color):
self._frame = np.ones((height, width, 3), dtype=np.uint8)
self._frame = cv2.circle(self._frame, (int(width / 2), int(height / 2)),
int(np.min([width, height]) / 4), color, int(0.05 * np.min([width, height])))
self._frame = cv2.circle(self._frame, (int(width / 3), int(height / 3)),
int(0.1 * np.min([width, height])), color, -1)
start_time = time.clock()
for i in range(num_frames):
if self._xr.poll_events():
if self._xr.is_session_running():
if not self._xr.poll_actions():
print("[ERROR]:", "pollActions")
return
if not self._xr.render_views():
print("[ERROR]:", "renderViews")
return
end_time = time.clock()
delta = end_time - start_time
print("----------")
print("FPS: {} ({} frames / {} seconds)".format(num_frames / delta, num_frames, delta))
print("RESOLUTION: {} x {}".format(self._frame.shape[1], self._frame.shape[0]))
# Actual test, notice it is "async" function, so "await" can be used if needed
async def test_openxr(self):
self._xr = _openxr.acquire_openxr_interface()
self._xr.init()
ready = False
if self._xr.create_instance():
if self._xr.get_system():
if self._xr.create_action_set():
if self._xr.create_session():
ready = True
else:
print("[ERROR]:", "createSession")
else:
print("[ERROR]:", "createActionSet")
else:
print("[ERROR]:", "getSystem")
else:
print("[ERROR]:", "createInstance")
if ready:
for i in range(1000):
if self._xr.poll_events():
if self._xr.is_session_running():
if not self._xr.poll_actions():
print("[ERROR]:", "pollActions")
break
# if ready:
# def callback_render(num_views, views, configuration_views):
# self._xr.set_frames(configuration_views, self._frame, self._frame, self._transform)
# self._xr.subscribe_render_event(callback_render)
# num_frames = 100
# print("")
# print("transform = True")
# self._transform = True
# self.render(num_frames=num_frames, width=1560, height=1732, color=(255,0,0))
# self.render(num_frames=num_frames, width=1280, height=720, color=(0,255,0))
# self.render(num_frames=num_frames, width=500, height=500, color=(0,0,255))
# print("")
# print("transform = False")
# self._transform = False
# self.render(num_frames=num_frames, width=1560, height=1732, color=(255,0,0))
# self.render(num_frames=num_frames, width=1280, height=720, color=(0,255,0))
# self.render(num_frames=num_frames, width=500, height=500, color=(0,0,255))
# print("")
# _openxr.release_openxr_interface(self._xr)
# self._xr = None
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr_ui/__init__.py | from .scripts.extension import *
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/semu/xr/openxr_ui/scripts/extension.py | import math
import weakref
import pxr
import omni
import carb
import omni.ext
import omni.ui as ui
from pxr import UsdGeom
from omni.kit.menu.utils import add_menu_items, remove_menu_items, MenuItemDescription
from semu.xr.openxr import _openxr
class Extension(omni.ext.IExt):
def on_startup(self, ext_id):
# get extension settings
self._settings = carb.settings.get_settings()
self._disable_openxr = self._settings.get("/exts/semu.xr.openxr/disable_openxr")
self._window = None
self._menu_items = [MenuItemDescription(name="OpenXR UI", onclick_fn=lambda a=weakref.proxy(self): a._menu_callback())]
add_menu_items(self._menu_items, "Add-ons")
self._xr = None
self._ready = False
self._timeline = omni.timeline.get_timeline_interface()
self._physx_subs = omni.physx.get_physx_interface().subscribe_physics_step_events(self._on_simulation_step)
def on_shutdown(self):
self._physx_subs = None
remove_menu_items(self._menu_items, "Add-ons")
self._window = None
def _get_reference_space(self):
reference_space = [_openxr.XR_REFERENCE_SPACE_TYPE_VIEW, _openxr.XR_REFERENCE_SPACE_TYPE_LOCAL, _openxr.XR_REFERENCE_SPACE_TYPE_STAGE]
return reference_space[self._xr_settings_reference_space.model.get_item_value_model().as_int]
def _get_origin_pose(self):
space_origin_position = [self._xr_settings_space_origin_position.model.get_item_value_model(i).as_float for i in self._xr_settings_space_origin_position.model.get_item_children()]
space_origin_rotation = [self._xr_settings_space_origin_rotation.model.get_item_value_model(i).as_int for i in self._xr_settings_space_origin_rotation.model.get_item_children()]
return {"position": pxr.Gf.Vec3d(*space_origin_position), "rotation": pxr.Gf.Vec3d(*space_origin_rotation)}
def _get_frame_transformations(self):
transform_fit = self._xr_settings_transform_fit.model.get_value_as_bool()
transform_flip = [None, 0, 1, (0,1)]
transform_flip = transform_flip[self._xr_settings_transform_flip.model.get_item_value_model().as_int]
return {"fit": transform_fit, "flip": transform_flip}
def _get_stereo_rectification(self):
return [self._xr_settings_stereo_rectification.model.get_item_value_model(i).as_float * math.pi / 180.0 for i in self._xr_settings_stereo_rectification.model.get_item_children()]
def _menu_callback(self):
self._build_ui()
def _on_start_openxr(self):
# get parameters from ui
graphics = [_openxr.XR_KHR_OPENGL_ENABLE_EXTENSION_NAME]
graphics = graphics[self._xr_settings_graphics_api.model.get_item_value_model().as_int]
form_factor = [_openxr.XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY, _openxr.XR_FORM_FACTOR_HANDHELD_DISPLAY]
form_factor = form_factor[self._xr_settings_form_factor.model.get_item_value_model().as_int]
blend_mode = [_openxr.XR_ENVIRONMENT_BLEND_MODE_OPAQUE, _openxr.XR_ENVIRONMENT_BLEND_MODE_ADDITIVE, _openxr.XR_ENVIRONMENT_BLEND_MODE_ALPHA_BLEND]
blend_mode = blend_mode[self._xr_settings_blend_mode.model.get_item_value_model().as_int]
view_configuration_type = [_openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO, _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO]
view_configuration_type = view_configuration_type[self._xr_settings_view_configuration_type.model.get_item_value_model().as_int]
# disable static parameters ui
self._xr_settings_graphics_api.enabled = False
self._xr_settings_form_factor.enabled = False
self._xr_settings_blend_mode.enabled = False
self._xr_settings_view_configuration_type.enabled = False
if self._xr is None:
self._xr = _openxr.acquire_openxr_interface(disable_openxr=self._disable_openxr)
if not self._xr.init(graphics=graphics, use_ctypes=False):
print("[ERROR] OpenXR.init with graphics: {}".format(graphics))
# set stage unit
stage = omni.usd.get_context().get_stage()
self._xr.set_meters_per_unit(UsdGeom.GetStageMetersPerUnit(stage))
# setup OpenXR application using default and ui parameters
if self._xr.create_instance():
if self._xr.get_system(form_factor=form_factor, blend_mode=blend_mode, view_configuration_type=view_configuration_type):
# create session and define interaction profiles
if self._xr.create_session():
# setup cameras and viewports and prepare rendering using the internal callback
if view_configuration_type == _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_MONO:
self._xr.setup_mono_view()
elif view_configuration_type == _openxr.XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO:
self._xr.setup_stereo_view()
# enable/disable buttons
self._ui_start_xr.enabled = False
self._ui_stop_xr.enabled = True
# play
self._timeline.play()
self._ready = True
return
else:
print("[ERROR] OpenXR.create_session")
else:
print("[ERROR] OpenXR.get_system with form_factor: {}, blend_mode: {}, view_configuration_type: {}".format(form_factor, blend_mode, view_configuration_type))
else:
print("[ERROR] OpenXR.create_instance")
self._on_stop_openxr()
def _on_stop_openxr(self):
self._ready = False
_openxr.release_openxr_interface(self._xr)
self._xr = None
# enable static parameters ui
self._xr_settings_graphics_api.enabled = True
self._xr_settings_form_factor.enabled = True
self._xr_settings_blend_mode.enabled = True
self._xr_settings_view_configuration_type.enabled = True
# enable/disable buttons
self._ui_start_xr.enabled = True
self._ui_stop_xr.enabled = False
def _on_simulation_step(self, step):
if self._ready and self._xr is not None:
# origin
self._xr.set_reference_system_pose(**self._get_origin_pose())
# transformation and rectification
self._xr.set_stereo_rectification(*self._get_stereo_rectification())
self._xr.set_frame_transformations(**self._get_frame_transformations())
# action and rendering loop
if not self._xr.poll_events():
self._on_stop_openxr()
return
if self._xr.is_session_running():
if not self._xr.poll_actions():
self._on_stop_openxr()
return
if not self._xr.render_views(self._get_reference_space()):
self._on_stop_openxr()
return
def _build_ui(self):
if not self._window:
self._window = ui.Window(title="OpenXR UI", width=300, height=375, visible=True, dockPreference=ui.DockPreference.LEFT_BOTTOM)
with self._window.frame:
with ui.VStack():
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Graphics API:", width=85, tooltip="OpenXR graphics API supported by the runtime")
self._xr_settings_graphics_api = ui.ComboBox(0, "OpenGL")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Form factor:", width=80, tooltip="XrFormFactor enum. HEAD_MOUNTED_DISPLAY: the tracked display is attached to the user's head. HANDHELD_DISPLAY: the tracked display is held in the user's hand, independent from the user's head")
self._xr_settings_form_factor = ui.ComboBox(0, "Head Mounted Display", "Handheld Display")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Blend mode:", width=80, tooltip="XrEnvironmentBlendMode enum. OPAQUE: display the composition layers with no view of the physical world behind them. ADDITIVE: additively blend the composition layers with the real world behind the display. ALPHA BLEND: alpha-blend the composition layers with the real world behind the display")
self._xr_settings_blend_mode = ui.ComboBox(0, "Opaque", "Additive", "Alpha blend")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("View configuration type:", width=145, tooltip="XrViewConfigurationType enum. MONO: one primary display (e.g. an AR phone's screen). STEREO: two primary displays, which map to a left-eye and right-eye view")
self._xr_settings_view_configuration_type = ui.ComboBox(1, "Mono", "Stereo")
ui.Spacer(height=5)
ui.Separator(height=1, width=0)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Space origin:", width=85)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Position (in stage unit):", width=165, tooltip="Cartesian position (in stage unit) used as reference origin")
self._xr_settings_space_origin_position = ui.MultiFloatDragField(0.0, 0.0, 0.0, step=0.1)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Rotation (XYZ):", width=110, tooltip="Rotation (in degress) on each axis used as reference origin")
self._xr_settings_space_origin_rotation = ui.MultiIntDragField(0, 0, 0, min=-180, max=180)
ui.Spacer(height=5)
with ui.HStack(height=0):
style = {"Tooltip": {"width": 50, "word-wrap": "break-word"}}
ui.Label("Reference space (views):", width=145, tooltip="XrReferenceSpaceType enum. VIEW: track the view origin for the primary viewer. LOCAL: establish a world-locked origin. STAGE: runtime-defined space that can be walked around on", style=style)
self._xr_settings_reference_space = ui.ComboBox(1, "View", "Local", "Stage")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Stereo rectification (x,y,z):", width=150, tooltip="Angle (in degrees) on each rotation axis for stereoscopic rectification")
self._xr_settings_stereo_rectification = ui.MultiFloatDragField(0.0, 0.0, 0.0, min=-10, max=10, step=0.1)
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label("Frame transformations:")
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Fit:", width=45, tooltip="Adjust each rendered image to the recommended resolution of the display device by cropping and scaling the image from its center")
self._xr_settings_transform_fit = ui.CheckBox()
ui.Spacer(height=5)
with ui.HStack(height=0):
ui.Label(" |-- Flip:", width=45, tooltip="Flip each image with respect to its view")
self._xr_settings_transform_flip = ui.ComboBox(0, "None", "Vertical", "Horizontal", "Both")
ui.Spacer(height=5)
ui.Separator(height=1, width=0)
ui.Spacer(height=5)
with ui.HStack(height=0):
self._ui_start_xr = ui.Button("Start OpenXR", height=0, clicked_fn=self._on_start_openxr)
self._ui_stop_xr = ui.Button("Stop OpenXR", height=0, clicked_fn=self._on_stop_openxr)
self._ui_stop_xr.enabled = False
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/config/extension.toml | [core]
reloadable = true
order = 0
[package]
version = "0.0.4-beta"
category = "Other"
feature = false
app = false
title = "OpenXR (compact binding)"
description = "OpenXR compact binding for Omniverse"
authors = ["Toni-SM"]
repository = "https://github.com/Toni-SM/semu.xr.openxr"
keywords = ["OpenXR", "XR", "VR", "AR"]
changelog = "docs/CHANGELOG.md"
readme = "docs/README.md"
preview_image = "data/preview.png"
icon = "data/icon.png"
[package.target]
config = ["release"]
platform = ["linux-x86_64"]
python = ["py37", "cp37"]
[dependencies]
"omni.ui" = {}
"omni.physx" = {}
"omni.kit.uiapp" = {}
"omni.kit.pipapi" = {}
"omni.syntheticdata" = {}
"omni.kit.menu.utils" = {}
"omni.kit.window.viewport" = {}
[[python.module]]
name = "semu.xr.openxr"
[[python.module]]
name = "semu.xr.openxr_ui"
[[python.module]]
name = "semu.xr.openxr.tests"
[python.pipapi]
requirements = ["opencv-python"]
use_online_index = true
[settings]
exts."semu.xr.openxr".disable_openxr = false
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [0.0.4-beta] - 2022-09-14
### Added
- Add `set_meters_per_unit` method for specifying the unit factor to be applied to transformations
### Changed
- Use float input field for getting the reference position from UI
## [0.0.3-beta] - 2022-09-09
### Added
- Add `disable_openxr` flag to configuration settings for testing the extension
### Fixed
- Enable RGB sensors when setting up mono/stereo views
## [0.0.2-beta] - 2022-05-22
### Added
- Source code (src folder)
### Changed
- Rename the extension to `semu.xr.openxr`
## [0.0.1-beta] - 2021-10-01
### Added
- Create OpenXR compact binding with OpenGL support
|
Toni-SM/semu.xr.openxr/exts/semu.xr.openxr/docs/README.md | # semu.xr.openxr
This extension provides a compact python binding (on top of the open standard OpenXR for augmented reality (AR) and virtual reality (VR)) to create extended reality applications taking advantage of NVIDIA Omniverse rendering capabilities
Visit https://github.com/Toni-SM/semu.xr.openxr to read more about its use
|
Toni-SM/semu.xr.openxr/PACKAGE-LICENSES/dependencies/OpenXR-LICENSE.txt |
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
Toni-SM/semu.xr.openxr/PACKAGE-LICENSES/dependencies/pybind11-LICENSE.txt | Copyright (c) 2016 Wenzel Jakob <[email protected]>, All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Please also refer to the file CONTRIBUTING.md, which clarifies licensing of
external contributions to this project including patches, pull requests, etc.
|
Toni-SM/semu.xr.openxr/PACKAGE-LICENSES/dependencies/SDL2-LICENSE.txt | Copyright (C) 1997-2021 Sam Lantinga <[email protected]>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
|
Toni-SM/semu.xr.openxr/PACKAGE-LICENSES/dependencies/Mesa-LICENSE.txt | Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
omniverse-code/kit/gsl/README.packman.md | * Package: gsl
* Version: 3.1.0.1
* From: ssh://[email protected]:12051/omniverse/externals/gsl.git
* Branch: master
* Commit: 5e0543eb9d231a0d3ccd7f5789aa51d1c896f6ae
* Time: Fri Nov 06 14:03:26 2020
* Computername: KPICOTT-LT
* Packman: 5.13.2
|
omniverse-code/kit/gsl/PACKAGE-INFO.yaml | Package : gsl
|
omniverse-code/kit/gsl/appveyor.yml | shallow_clone: true
platform:
- x86
- x64
configuration:
- Debug
- Release
image:
- Visual Studio 2017
- Visual Studio 2019
environment:
NINJA_TAG: v1.8.2
NINJA_SHA512: 9B9CE248240665FCD6404B989F3B3C27ED9682838225E6DC9B67B551774F251E4FF8A207504F941E7C811E7A8BE1945E7BCB94472A335EF15E23A0200A32E6D5
NINJA_PATH: C:\Tools\ninja\ninja-%NINJA_TAG%
VCVAR2017: 'C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat'
VCVAR2019: 'C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat'
matrix:
- GSL_CXX_STANDARD: 14
USE_TOOLSET: MSVC
USE_GENERATOR: MSBuild
- GSL_CXX_STANDARD: 17
USE_TOOLSET: MSVC
USE_GENERATOR: MSBuild
- GSL_CXX_STANDARD: 14
USE_TOOLSET: LLVM
USE_GENERATOR: Ninja
- GSL_CXX_STANDARD: 17
USE_TOOLSET: LLVM
USE_GENERATOR: Ninja
cache:
- C:\cmake-3.14.4-win32-x86
- C:\Tools\ninja
install:
- ps: |
if (![IO.File]::Exists("$env:NINJA_PATH\ninja.exe")) {
Start-FileDownload `
"https://github.com/ninja-build/ninja/releases/download/$env:NINJA_TAG/ninja-win.zip"
$hash = (Get-FileHash ninja-win.zip -Algorithm SHA512).Hash
if ($env:NINJA_SHA512 -eq $hash) {
7z e -y -bso0 ninja-win.zip -o"$env:NINJA_PATH"
} else { Write-Warning "Ninja download hash changed!"; Write-Output "$hash" }
}
if ([IO.File]::Exists("$env:NINJA_PATH\ninja.exe")) {
$env:PATH = "$env:NINJA_PATH;$env:PATH"
} else { Write-Warning "Failed to find ninja.exe in expected location." }
if ($env:USE_TOOLSET -ne "LLVM") {
if (![IO.File]::Exists("C:\cmake-3.14.0-win32-x86\bin\cmake.exe")) {
Start-FileDownload 'https://cmake.org/files/v3.14/cmake-3.14.4-win32-x86.zip'
7z x -y -bso0 cmake-3.14.4-win32-x86.zip -oC:\
}
$env:PATH="C:\cmake-3.14.4-win32-x86\bin;$env:PATH"
}
before_build:
- ps: |
if ("$env:USE_GENERATOR" -eq "Ninja") {
$GeneratorFlags = '-k 10'
$Architecture = $env:PLATFORM
if ("$env:APPVEYOR_BUILD_WORKER_IMAGE" -eq "Visual Studio 2017") {
$env:VCVARSALL = "`"$env:VCVAR2017`" $Architecture"
} else {
$env:VCVARSALL = "`"$env:VCVAR2019`" $Architecture"
}
$env:CMakeGenFlags = "-G Ninja -DGSL_CXX_STANDARD=$env:GSL_CXX_STANDARD"
} else {
$GeneratorFlags = '/m /v:minimal'
if ("$env:APPVEYOR_BUILD_WORKER_IMAGE" -eq "Visual Studio 2017") {
$Generator = 'Visual Studio 15 2017'
} else {
$Generator = 'Visual Studio 16 2019'
}
if ("$env:PLATFORM" -eq "x86") {
$Architecture = "Win32"
} else {
$Architecture = "x64"
}
if ("$env:USE_TOOLSET" -eq "LLVM") {
$env:CMakeGenFlags = "-G `"$Generator`" -A $Architecture -T llvm -DGSL_CXX_STANDARD=$env:GSL_CXX_STANDARD"
} else {
$env:CMakeGenFlags = "-G `"$Generator`" -A $Architecture -DGSL_CXX_STANDARD=$env:GSL_CXX_STANDARD"
}
}
if ("$env:USE_TOOLSET" -eq "LLVM") {
$env:CC = "clang-cl"
$env:CXX = "clang-cl"
if ("$env:PLATFORM" -eq "x86") {
$env:CFLAGS = "-m32";
$env:CXXFLAGS = "-m32";
} else {
$env:CFLAGS = "-m64";
$env:CXXFLAGS = "-m64";
}
}
$env:CMakeBuildFlags = "--config $env:CONFIGURATION -- $GeneratorFlags"
- mkdir build
- cd build
- if %USE_GENERATOR%==Ninja (call %VCVARSALL%)
- echo %CMakeGenFlags%
- cmake .. %CMakeGenFlags%
build_script:
- echo %CMakeBuildFlags%
- cmake --build . %CMakeBuildFlags%
test_script:
- ctest -j2
deploy: off
|
omniverse-code/kit/gsl/CMakeLists.txt | cmake_minimum_required(VERSION 3.1.3...3.16)
project(GSL VERSION 3.1.0 LANGUAGES CXX)
include(ExternalProject)
find_package(Git)
# Use GNUInstallDirs to provide the right locations on all platforms
include(GNUInstallDirs)
# creates a library GSL which is an interface (header files only)
add_library(GSL INTERFACE)
# determine whether this is a standalone project or included by other projects
set(GSL_STANDALONE_PROJECT OFF)
if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
set(GSL_STANDALONE_PROJECT ON)
endif ()
set(GSL_CXX_STANDARD "14" CACHE STRING "Use c++ standard")
set(GSL_CXX_STD "cxx_std_${GSL_CXX_STANDARD}")
if (MSVC)
set(GSL_CXX_STD_OPT "-std:c++${GSL_CXX_STANDARD}")
else()
set(GSL_CXX_STD_OPT "-std=c++${GSL_CXX_STANDARD}")
endif()
# when minimum version required is 3.8.0 remove if below
# both branches do exactly the same thing
if (CMAKE_VERSION VERSION_LESS 3.7.9)
include(CheckCXXCompilerFlag)
CHECK_CXX_COMPILER_FLAG("${GSL_CXX_STD_OPT}" COMPILER_SUPPORTS_CXX_STANDARD)
if(COMPILER_SUPPORTS_CXX_STANDARD)
target_compile_options(GSL INTERFACE "${GSL_CXX_STD_OPT}")
else()
message(FATAL_ERROR "The compiler ${CMAKE_CXX_COMPILER} has no c++${GSL_CXX_STANDARD} support. Please use a different C++ compiler.")
endif()
else ()
target_compile_features(GSL INTERFACE "${GSL_CXX_STD}")
# on *nix systems force the use of -std=c++XX instead of -std=gnu++XX (default)
set(CMAKE_CXX_EXTENSIONS OFF)
endif()
# add definitions to the library and targets that consume it
target_compile_definitions(GSL INTERFACE
$<$<CXX_COMPILER_ID:MSVC>:
# remove unnecessary warnings about unchecked iterators
_SCL_SECURE_NO_WARNINGS
# remove deprecation warnings about std::uncaught_exception() (from catch)
_SILENCE_CXX17_UNCAUGHT_EXCEPTION_DEPRECATION_WARNING
>
)
# add include folders to the library and targets that consume it
# the SYSTEM keyword suppresses warnings for users of the library
if(GSL_STANDALONE_PROJECT)
target_include_directories(GSL INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
)
else()
target_include_directories(GSL SYSTEM INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
)
endif()
if (CMAKE_VERSION VERSION_GREATER 3.7.8)
if (MSVC_IDE)
option(VS_ADD_NATIVE_VISUALIZERS "Configure project to use Visual Studio native visualizers" TRUE)
else()
set(VS_ADD_NATIVE_VISUALIZERS FALSE CACHE INTERNAL "Native visualizers are Visual Studio extension" FORCE)
endif()
# add natvis file to the library so it will automatically be loaded into Visual Studio
if(VS_ADD_NATIVE_VISUALIZERS)
target_sources(GSL INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/GSL.natvis>
)
endif()
endif()
install(TARGETS GSL EXPORT Microsoft.GSLConfig)
install(
DIRECTORY include/gsl
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)
# Make library importable by other projects
install(EXPORT Microsoft.GSLConfig NAMESPACE Microsoft.GSL:: DESTINATION ${CMAKE_INSTALL_DATADIR}/cmake/Microsoft.GSL)
export(TARGETS GSL NAMESPACE Microsoft.GSL:: FILE Microsoft.GSLConfig.cmake)
# Add find_package() versioning support. The version for
# generated Microsoft.GSLConfigVersion.cmake will be used from
# last project() command. The version's compatibility is set between all
# minor versions (as it was in prev. GSL releases).
include(CMakePackageConfigHelpers)
if(${CMAKE_VERSION} VERSION_LESS "3.14.0")
write_basic_package_version_file(
${CMAKE_CURRENT_BINARY_DIR}/Microsoft.GSLConfigVersion.cmake
COMPATIBILITY SameMajorVersion
)
else()
write_basic_package_version_file(
${CMAKE_CURRENT_BINARY_DIR}/Microsoft.GSLConfigVersion.cmake
COMPATIBILITY SameMajorVersion
ARCH_INDEPENDENT
)
endif()
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/Microsoft.GSLConfigVersion.cmake DESTINATION ${CMAKE_INSTALL_DATADIR}/cmake/Microsoft.GSL)
# Add Microsoft.GSL::GSL alias for GSL so that dependents can be agnostic about
# whether GSL was added via `add_subdirectory` or `find_package`
add_library(Microsoft.GSL::GSL ALIAS GSL)
option(GSL_TEST "Generate tests." ${GSL_STANDALONE_PROJECT})
if (GSL_TEST)
enable_testing()
if(IOS)
add_compile_definitions(
GTEST_HAS_DEATH_TEST=1
)
endif()
add_subdirectory(tests)
endif ()
|
omniverse-code/kit/gsl/CMakeSettings.json | {
"configurations": [
{
"name": "x64-Debug",
"generator": "Ninja",
"configurationType": "Debug",
"inheritEnvironments": [
"msvc_x64_x64"
],
"buildRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build\\${name}",
"installRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\install\\${name}",
"cmakeCommandArgs": "-DGSL_CXX_STANDARD=17",
"buildCommandArgs": "-v",
"ctestCommandArgs": "",
"codeAnalysisRuleset": "CppCoreCheckRules.ruleset"
}
]
} |
omniverse-code/kit/gsl/README.md | # GSL: Guidelines Support Library
[](https://travis-ci.org/Microsoft/GSL) [](https://ci.appveyor.com/project/neilmacintosh/GSL)
The Guidelines Support Library (GSL) contains functions and types that are suggested for use by the
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) maintained by the [Standard C++ Foundation](https://isocpp.org).
This repo contains Microsoft's implementation of GSL.
The library includes types like `span<T>`, `string_span`, `owner<>` and others.
The entire implementation is provided inline in the headers under the [gsl](./include/gsl) directory. The implementation generally assumes a platform that implements C++14 support.
While some types have been broken out into their own headers (e.g. [gsl/span](./include/gsl/span)),
it is simplest to just include [gsl/gsl](./include/gsl/gsl) and gain access to the entire library.
> NOTE: We encourage contributions that improve or refine any of the types in this library as well as ports to
other platforms. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing.
# Project Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
# Usage of Third Party Libraries
This project makes use of the [Google Test](https://github.com/google/googletest) testing library. Please see the [ThirdPartyNotices.txt](./ThirdPartyNotices.txt) file for details regarding the licensing of Google Test.
# Quick Start
## Supported Compilers
The GSL officially supports the current and previous major release of MSVC, GCC, Clang, and XCode's Apple-Clang.
See our latest test results for the most up-to-date list of supported configurations.
Compiler |Toolset Versions Currently Tested| Build Status
:------- |:--|------------:
XCode |11.4 & 10.3 | [](https://travis-ci.org/Microsoft/GSL)
GCC |9 & 8| [](https://travis-ci.org/Microsoft/GSL)
Clang |11 & 10| [](https://travis-ci.org/Microsoft/GSL)
Visual Studio with MSVC | VS2017 (15.9) & VS2019 (16.4) | [](https://ci.appveyor.com/project/neilmacintosh/GSL)
Visual Studio with LLVM | VS2017 (Clang 9) & VS2019 (Clang 10) | [](https://ci.appveyor.com/project/neilmacintosh/GSL)
Note: For `gsl::byte` to work correctly with Clang and GCC you might have to use the ` -fno-strict-aliasing` compiler option.
---
If you successfully port GSL to another platform, we would love to hear from you!
- Submit an issue specifying the platform and target.
- Consider contributing your changes by filing a pull request with any necessary changes.
- If at all possible, add a CI/CD step and add the button to the table below!
Target | CI/CD Status
:------- | -----------:
iOS | 
Android | 
Note: These CI/CD steps are run with each pull request, however failures in them are non-blocking.
## Building the tests
To build the tests, you will require the following:
* [CMake](http://cmake.org), version 3.1.3 (3.2.3 for AppleClang) or later to be installed and in your PATH.
These steps assume the source code of this repository has been cloned into a directory named `c:\GSL`.
1. Create a directory to contain the build outputs for a particular architecture (we name it c:\GSL\build-x86 in this example).
cd GSL
md build-x86
cd build-x86
2. Configure CMake to use the compiler of your choice (you can see a list by running `cmake --help`).
cmake -G "Visual Studio 15 2017" c:\GSL
3. Build the test suite (in this case, in the Debug configuration, Release is another good choice).
cmake --build . --config Debug
4. Run the test suite.
ctest -C Debug
All tests should pass - indicating your platform is fully supported and you are ready to use the GSL types!
## Building GSL - Using vcpkg
You can download and install GSL using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
vcpkg install ms-gsl
The GSL port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
## Using the libraries
As the types are entirely implemented inline in headers, there are no linking requirements.
You can copy the [gsl](./include/gsl) directory into your source tree so it is available
to your compiler, then include the appropriate headers in your program.
Alternatively set your compiler's *include path* flag to point to the GSL development folder (`c:\GSL\include` in the example above) or installation folder (after running the install). Eg.
MSVC++
/I c:\GSL\include
GCC/clang
-I$HOME/dev/GSL/include
Include the library using:
#include <gsl/gsl>
## Usage in CMake
The library provides a Config file for CMake, once installed it can be found via
find_package(Microsoft.GSL CONFIG)
Which, when successful, will add library target called `Microsoft.GSL::GSL` which you can use via the usual
`target_link_libraries` mechanism.
## Debugging visualization support
For Visual Studio users, the file [GSL.natvis](./GSL.natvis) in the root directory of the repository can be added to your project if you would like more helpful visualization of GSL types in the Visual Studio debugger than would be offered by default.
|
omniverse-code/kit/gsl/PACKAGE-LICENSES/gsl-LICENSE.md | Copyright (c) 2015 Microsoft Corporation. All rights reserved.
This code is licensed under the MIT License (MIT).
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
|
omniverse-code/kit/exts/omni.kit.material.library/docs/index.rst | omni.kit.material.library
###########################
Material Library
.. toctree::
:maxdepth: 1
CHANGELOG
Python API Reference
*********************
.. automodule:: omni.kit.material.library
:platform: Windows-x86_64, Linux-x86_64
:members:
:undoc-members:
:imported-members:
:exclude-members: chain
:noindex: omni.usd._impl.utils.PrimCaching
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/PACKAGE-LICENSES/omni.kit.window.imageviewer-LICENSE.md | Copyright (c) 2020, 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. |
omniverse-code/kit/exts/omni.kit.window.imageviewer/config/extension.toml | [package]
version = "1.0.6"
category = "Internal"
feature = true
title = "Image Viewer"
description="Adds context menu in the Content Browser that allows to view images."
authors = ["NVIDIA"]
changelog = "docs/CHANGELOG.md"
preview_image = "data/preview.png"
icon = "data/icon.png"
readme = "docs/README.md"
[dependencies]
"omni.ui" = {}
"omni.kit.widget.imageview" = {}
"omni.kit.window.content_browser" = { optional=true }
"omni.kit.test" = {}
"omni.usd.libs" = {}
[[python.module]]
name = "omni.kit.window.imageviewer"
# Additional python module with tests, to make them discoverable by test system.
[[python.module]]
name = "omni.kit.window.imageviewer.tests"
[[test]]
args = ["--/app/window/dpiScaleOverride=1.0", "--/app/window/scaleToMonitor=false"]
dependencies = [
"omni.kit.mainwindow",
"omni.kit.renderer.capture",
]
pythonTests.unreliable = [
"*test_general" # OM-49017
]
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/imageviewer.py | # Copyright (c) 2018-2020, 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.
#
import omni.kit.widget.imageview as imageview
import omni.ui as ui
from .singleton import singleton
@singleton
class ViewerWindows:
"""This object keeps all the Image Viewper windows"""
def __init__(self):
self.__windows = {}
def open_window(self, filepath: str) -> ui.Window:
"""Open ImageViewer window with the image file opened in it"""
if filepath in self.__windows:
window = self.__windows[filepath]
window.visible = True
else:
window = ImageViewer(filepath)
# When window is closed, remove it from the list
window.set_visibility_changed_fn(lambda _, f=filepath: self.close(f))
self.__windows[filepath] = window
return window
def close(self, filepath):
"""Close and remove spacific window"""
del self.__windows[filepath]
def close_all(self):
"""Close and remove all windows"""
self.__windows = {}
class ImageViewer(ui.Window):
"""The window with Image Viewer"""
def __init__(self, filename: str, **kwargs):
if "width" not in kwargs:
kwargs["width"] = 640
if "height" not in kwargs:
kwargs["height"] = 480
super().__init__(filename, **kwargs)
self.frame.set_style({"Window": {"background_color": 0xFF000000, "border_width": 0}})
self.frame.set_build_fn(self.__build_window)
self.__filename = filename
def __build_window(self):
"""Called to build the widgets of the window"""
# For now it's only one single widget
imageview.ImageView(self.__filename, smooth_zoom=True, style={"ImageView": {"background_color": 0xFF000000}})
def destroy(self):
pass
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/__init__.py | # Copyright (c) 2018-2020, 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.
#
from .imageviewer import ImageViewer
from .imageviewer_extension import ImageViewerExtension
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/imageviewer_utils.py | # Copyright (c) 2018-2020, 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.
#
import omni.kit.app
def is_extension_loaded(extansion_name: str) -> bool:
"""
Returns True if the extension with the given name is loaded.
"""
def is_ext(ext_id: str, extension_name: str) -> bool:
id_name = omni.ext.get_extension_name(ext_id)
return id_name == extension_name
app = omni.kit.app.get_app_interface()
ext_manager = app.get_extension_manager()
extensions = ext_manager.get_extensions()
loaded = next((ext for ext in extensions if is_ext(ext["id"], extansion_name) and ext["enabled"]), None)
return bool(loaded)
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/content_menu.py | # Copyright (c) 2018-2020, 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.
#
from .imageviewer import ViewerWindows
from .imageviewer_utils import is_extension_loaded
def content_available():
"""
Returns True if the extension "omni.kit.window.content_browser" is loaded.
"""
return is_extension_loaded("omni.kit.window.content_browser")
class ContentMenu:
"""
When this object is alive, Content Browser has the additional context menu
with the items that allow to view image files.
"""
def __init__(self, version: int = 2):
if version != 2:
raise RuntimeError("Only version 2 is supported")
content_window = self._get_content_window()
if content_window:
view_menu_name = "Show Image"
self.__view_menu_subscription = content_window.add_file_open_handler(
view_menu_name,
lambda file_path: self._on_show_triggered(view_menu_name, file_path),
self._is_show_visible,
)
else:
self.__view_menu_subscription = None
def _get_content_window(self):
try:
import omni.kit.window.content_browser as content
except ImportError:
return None
return content.get_content_window()
def _is_show_visible(self, content_url):
"""True if we can show the menu item View Image"""
# List of available formats: carb/source/plugins/carb.imaging/Imaging.cpp
return any(
content_url.endswith(f".{ext}")
for ext in ["bmp", "dds", "exr", "gif", "hdr", "jpeg", "jpg", "png", "psd", "svg", "tga"]
)
def _on_show_triggered(self, menu, value):
"""Start watching for the layer and run the editor"""
ViewerWindows().open_window(value)
def destroy(self):
"""Stop all watchers and remove the menu from the content browser"""
if self.__view_menu_subscription:
content_window = self._get_content_window()
if content_window:
content_window.delete_file_open_handler(self.__view_menu_subscription)
self.__view_menu_subscription = None
ViewerWindows().close_all()
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/imageviewer_extension.py | # Copyright (c) 2018-2020, 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.
#
import omni.ext
from .content_menu import content_available
from .content_menu import ContentMenu
class ImageViewerExtension(omni.ext.IExt):
def __init__(self):
super().__init__()
self.__imageviewer = None
self.__extensions_subscription = None # noqa: PLW0238
self.__content_menu = None
def on_startup(self, ext_id):
# Setup a callback when any extension is loaded/unloaded
app = omni.kit.app.get_app_interface()
ext_manager = app.get_extension_manager()
self.__extensions_subscription = ( # noqa: PLW0238
ext_manager.get_change_event_stream().create_subscription_to_pop(
self._on_event, name="omni.kit.window.imageviewer"
)
)
self.__content_menu = None
self._on_event(None)
def _on_event(self, event):
"""Called when any extension is loaded/unloaded"""
if self.__content_menu:
if not content_available():
self.__content_menu.destroy()
self.__content_menu = None
else:
if content_available():
self.__content_menu = ContentMenu()
def on_shutdown(self):
if self.__imageviewer:
self.__imageviewer.destroy()
self.__imageviewer = None
self.__extensions_subscription = None # noqa: PLW0238
if self.__content_menu:
self.__content_menu.destroy()
self.__content_menu = None
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/singleton.py | # Copyright (c) 2018-2020, 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.
#
def singleton(class_):
"""A singleton decorator"""
instances = {}
def getinstance(*args, **kwargs):
if class_ not in instances:
instances[class_] = class_(*args, **kwargs)
return instances[class_]
return getinstance
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/tests/__init__.py | # 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.
#
from .imageviewer_test import TestImageViewer
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/omni/kit/window/imageviewer/tests/imageviewer_test.py | # 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.
#
from pathlib import Path
from omni.ui.tests.test_base import OmniUiTest
import omni.kit
import omni.ui as ui
from ..imageviewer import ViewerWindows
class TestImageViewer(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
self._golden_img_dir = Path(extension_path).joinpath("data").joinpath("tests").absolute()
# After running each test
async def tearDown(self):
self._golden_img_dir = None
await super().tearDown()
async def test_general(self):
window = await self.create_test_window() # noqa: PLW0612, F841
await omni.kit.app.get_app().next_update_async()
viewer = ViewerWindows().open_window(f"{self._golden_img_dir.joinpath('lenna.png')}")
viewer.flags = ui.WINDOW_FLAGS_NO_SCROLLBAR | ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE
viewer.position_x = 0
viewer.position_y = 0
viewer.width = 256
viewer.height = 256
# One frame to show the window and another to build the frame
# And a dozen frames more to let the asset load
for _ in range(20):
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir)
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [1.0.6] - 2022-06-17
### Changed
- Properly linted
## [1.0.5] - 2021-09-20
### Changed
- Fixed unittest path to golden image.
## [1.0.4] - 2021-08-18
### Changed
- Fixed console_browser leak
## [1.0.3] - 2020-12-08
### Added
- Description, preview image and icon
### Changed
- Fixed crash on exit
## [1.0.2] - 2020-11-25
### Changed
- Pasting an image URL into the content window's browser bar or double clicking opens the file.
## [1.0.1] - 2020-11-12
### Changed
- Fixed exception in Create
## [1.0.0] - 2020-07-19
### Added
- Adds context menu in the Content Browser
|
omniverse-code/kit/exts/omni.kit.window.imageviewer/docs/README.md | # Image Viewer [omni.kit.window.imageviewer]
It's The extension that can display stored graphical images in a new window.
It can handle various graphics file formats.
|
omniverse-code/kit/exts/omni.kit.window.audiorecorder/PACKAGE-LICENSES/omni.kit.window.audiorecorder-LICENSE.md | Copyright (c) 2020, 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. |
omniverse-code/kit/exts/omni.kit.window.audiorecorder/config/extension.toml | [package]
title = "Kit Audio Recorder Window"
category = "Audio"
version = "1.0.1"
description = "A simple audio recorder window"
detailedDescription = """This adds a window for recording audio to file from an audio
capture device.
"""
preview_image = "data/preview.png"
authors = ["NVIDIA"]
keywords = ["audio", "capture", "recording"]
[dependencies]
"omni.kit.audiodeviceenum" = {}
"omni.audiorecorder" = {}
"omni.ui" = {}
"omni.kit.window.content_browser" = { optional=true }
"omni.kit.window.filepicker" = {}
"omni.kit.pip_archive" = {}
"omni.usd" = {}
"omni.kit.menu.utils" = {}
[python.pipapi]
requirements = ["numpy"]
[[python.module]]
name = "omni.kit.window.audiorecorder"
[[test]]
args = [
"--/renderer/enabled=pxr",
"--/renderer/active=pxr",
"--/renderer/multiGpu/enabled=false",
"--/renderer/multiGpu/autoEnable=false", # Disable mGPU with PXR due to OM-51026, OM-53611
"--/renderer/multiGpu/maxGpuCount=1",
"--/app/asyncRendering=false",
"--/app/window/dpiScaleOverride=1.0",
"--/app/window/scaleToMonitor=false",
"--no-window",
# Use the null device backend.
# We need this to ensure the captured data is consistent.
# We could use the capture test patterns mode, but there's no way to
# synchronize the image capture with the audio capture right now, so we'll
# have to just capture silence.
"--/audio/deviceBackend=null",
# needed for the UI test stuff
"--/app/menu/legacy_mode=false",
]
dependencies = [
"omni.hydra.pxr",
"omni.kit.mainwindow",
"omni.kit.ui_test",
"carb.audio",
]
stdoutFailPatterns.exclude = [
"*" # I don't want these but OmniUiTest forces me to use them
]
|
omniverse-code/kit/exts/omni.kit.window.audiorecorder/omni/kit/window/audiorecorder/__init__.py | from .audio_recorder_window import *
|
omniverse-code/kit/exts/omni.kit.window.audiorecorder/omni/kit/window/audiorecorder/audio_recorder_window.py | # Copyright (c) 2020, 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.
#
import carb.audio
import omni.audiorecorder
import omni.kit.ui
import omni.ui
import threading
import time
import re
import asyncio
from typing import Callable
from omni.kit.window.filepicker import FilePickerDialog
class AudioRecorderWindowExtension(omni.ext.IExt):
"""Audio Recorder Window Extension"""
class ComboModel(omni.ui.AbstractItemModel):
class ComboItem(omni.ui.AbstractItem):
def __init__(self, text):
super().__init__()
self.model = omni.ui.SimpleStringModel(text)
def __init__(self):
super().__init__()
self._options = [
["16 bit PCM", carb.audio.SampleFormat.PCM16],
["24 bit PCM", carb.audio.SampleFormat.PCM24],
["32 bit PCM", carb.audio.SampleFormat.PCM32],
["float PCM", carb.audio.SampleFormat.PCM_FLOAT],
["Vorbis", carb.audio.SampleFormat.VORBIS],
["FLAC", carb.audio.SampleFormat.FLAC],
["Opus", carb.audio.SampleFormat.OPUS],
]
self._current_index = omni.ui.SimpleIntModel()
self._current_index.add_value_changed_fn(lambda a: self._item_changed(None))
self._items = [AudioRecorderWindowExtension.ComboModel.ComboItem(text) for (text, value) in self._options]
def get_item_children(self, item):
return self._items
def get_item_value_model(self, item, column_id):
if item is None:
return self._current_index
return item.model
def set_value(self, value):
for i in range(0, len(self._options)):
if self._options[i][1] == value:
self._current_index.as_int = i
break
def get_value(self):
return self._options[self._current_index.as_int][1]
class FieldModel(omni.ui.AbstractValueModel):
def __init__(self):
super(AudioRecorderWindowExtension.FieldModel, self).__init__()
self._value = ""
def get_value_as_string(self):
return self._value
def begin_edit(self):
pass
def set_value(self, value):
self._value = value
self._value_changed()
def end_edit(self):
pass
def get_value(self):
return self._value
def _choose_file_clicked(self): # pragma: no cover
dialog = FilePickerDialog(
"Select File",
apply_button_label="Select",
click_apply_handler=lambda filename, dirname: self._on_file_pick(dialog, filename, dirname),
)
dialog.show()
def _on_file_pick(self, dialog: FilePickerDialog, filename: str, dirname: str): # pragma: no cover
path = ""
if dirname:
path = f"{dirname}/{filename}"
elif filename:
path = filename
dialog.hide()
self._file_field.model.set_value(path)
def _menu_callback(self, a, b):
self._window.visible = not self._window.visible
def _read_callback(self, data): # pragma: no cover
self._display_buffer[self._display_buffer_index] = data
self._display_buffer_index = (self._display_buffer_index + 1) % self._display_len
buf = []
for i in range(self._display_len):
buf += self._display_buffer[(self._display_buffer_index + i) % self._display_len]
width = 512
height = 128
img = omni.audiorecorder.draw_waveform_from_blob_int16(
input=buf,
channels=1,
width=width,
height=height,
fg_color=[0.89, 0.54, 0.14, 1.0],
bg_color=[0.0, 0.0, 0.0, 0.0],
)
self._waveform_image_provider.set_bytes_data(img, [width, height])
def _close_error_window(self):
self._error_window.visible = False
def _record_clicked(self):
if self._recording:
self._record_button.set_style({"image_url": "resources/glyphs/audio_record.svg"})
self._recorder.stop_recording()
self._recording = False
else:
result = self._recorder.begin_recording_int16(
filename=self._file_field_model.get_value(),
callback=self._read_callback,
output_format=self._format_model.get_value(),
buffer_length=200,
period=25,
length_type=carb.audio.UnitType.MILLISECONDS,
)
if result:
self._record_button.set_style({"image_url": "resources/glyphs/timeline_stop.svg"})
self._recording = True
else: # pragma: no cover
self._error_window = omni.ui.Window(
"Audio Recorder Error", width=400, height=0, flags=omni.ui.WINDOW_FLAGS_NO_DOCKING
)
with self._error_window.frame:
with omni.ui.VStack():
with omni.ui.HStack():
omni.ui.Spacer()
self._error_window_label = omni.ui.Label(
"Failed to start recording. The file path may be incorrect or the device may be inaccessible.",
word_wrap=True,
width=380,
alignment=omni.ui.Alignment.CENTER,
)
omni.ui.Spacer()
with omni.ui.HStack():
omni.ui.Spacer()
self._error_window_ok_button = omni.ui.Button(
width=64, height=32, clicked_fn=self._close_error_window, text="ok"
)
omni.ui.Spacer()
def _stop_clicked(self):
pass
def _create_tooltip(self, text):
"""Create a tooltip in a fixed style"""
with omni.ui.VStack(width=400):
omni.ui.Label(text, word_wrap=True)
def on_startup(self):
self._display_len = 8
self._display_buffer = [[0] for i in range(self._display_len)]
self._display_buffer_index = 0
# self._ticker_pos = 0;
self._recording = False
self._recorder = omni.audiorecorder.create_audio_recorder()
self._window = omni.ui.Window("Audio Recorder", width=600, height=240)
with self._window.frame:
with omni.ui.VStack(height=0, spacing=8):
# file dialogue
with omni.ui.HStack():
omni.ui.Button(
width=32,
height=32,
clicked_fn=self._choose_file_clicked,
style={"image_url": "resources/glyphs/folder.svg"},
)
self._file_field_model = AudioRecorderWindowExtension.FieldModel()
self._file_field = omni.ui.StringField(self._file_field_model, height=32)
# waveform
with omni.ui.HStack(height=128):
omni.ui.Spacer()
self._waveform_image_provider = omni.ui.ByteImageProvider()
self._waveform_image = omni.ui.ImageWithProvider(
self._waveform_image_provider,
width=omni.ui.Percent(95),
height=omni.ui.Percent(100),
fill_policy=omni.ui.IwpFillPolicy.IWP_STRETCH,
)
omni.ui.Spacer()
# buttons
with omni.ui.HStack():
with omni.ui.ZStack():
omni.ui.Spacer()
self._anim_label = omni.ui.Label("", alignment=omni.ui.Alignment.CENTER)
with omni.ui.VStack():
omni.ui.Spacer()
self._format_model = AudioRecorderWindowExtension.ComboModel()
self._format = omni.ui.ComboBox(
self._format_model,
height=0,
tooltip_fn=lambda: self._create_tooltip(
"The format for the output file."
+ "The PCM formats will output as a WAVE file (.wav)."
+ "FLAC will output as a FLAC file (.flac)."
+ "Vorbis and Opus will output as an Ogg file (.ogg/.oga)."
),
)
omni.ui.Spacer()
self._record_button = omni.ui.Button(
width=32,
height=32,
clicked_fn=self._record_clicked,
style={"image_url": "resources/glyphs/audio_record.svg"},
)
omni.ui.Spacer()
# add a callback to open the window
self._menuEntry = omni.kit.ui.get_editor_menu().add_item("Window/Audio Recorder", self._menu_callback)
self._window.visible = False
def on_shutdown(self): # pragma: no cover
self._recorder = None
self._window = None
self._menuEntry = None
|
omniverse-code/kit/exts/omni.kit.window.audiorecorder/omni/kit/window/audiorecorder/tests/__init__.py | from .test_audiorecorder_window import * # pragma: no cover
|
omniverse-code/kit/exts/omni.kit.window.audiorecorder/omni/kit/window/audiorecorder/tests/test_audiorecorder_window.py | ## 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.
##
import omni.kit.app
import omni.kit.test
import omni.ui as ui
import omni.usd
import omni.timeline
import carb.tokens
import carb.audio
from omni.ui.tests.test_base import OmniUiTest
from omni.kit import ui_test
#from omni.ui_query import OmniUIQuery
import pathlib
import asyncio
import tempfile
import os
import platform
class TestAudioRecorderWindow(OmniUiTest): # pragma: no cover
async def _dock_window(self, win):
await self.docked_test_window(
window=win._window,
width=600,
height=240)
#def _dump_ui_tree(self, root):
# print("DUMP UI TREE START")
# #windows = omni.ui.Workspace.get_windows()
# #children = [windows[0].frame]
# children = [root.frame]
# print(str(dir(root.frame)))
# def recurse(children, path=""):
# for c in children:
# name = path + "/" + type(c).__name__
# print(name)
# if isinstance(c, omni.ui.ComboBox):
# print(str(dir(c)))
# recurse(omni.ui.Inspector.get_children(c), name)
# recurse(children)
# print("DUMP UI TREE END")
# Before running each test
async def setUp(self):
await super().setUp()
extension_path = carb.tokens.get_tokens_interface().resolve("${omni.kit.window.audiorecorder}")
self._test_path = pathlib.Path(extension_path).joinpath("data").joinpath("tests").absolute()
self._golden_img_dir = self._test_path.joinpath("golden")
# open the dropdown
window_menu = omni.kit.ui_test.get_menubar().find_menu("Window")
self.assertIsNotNone(window_menu)
await window_menu.click()
# click the Audio Recorder entry to open it
rec_menu = omni.kit.ui_test.get_menubar().find_menu("Audio Recorder")
self.assertIsNotNone(rec_menu)
await rec_menu.click()
#self._dump_ui_tree(omni.kit.ui_test.find("Audio Recorder").window)
# After running each test
async def tearDown(self):
await super().tearDown()
self._rec = None
async def _test_just_opened(self):
win = omni.kit.ui_test.find("Audio Recorder")
self.assertIsNotNone(win)
await self._dock_window(win)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_just_opened.png")
async def _test_recording(self):
# wait for docking to finish. To prevent ui_test getting widgets as while window is being rebuilt
await ui_test.human_delay(50)
iface = carb.audio.acquire_data_interface()
self.assertIsNotNone(iface)
win = omni.kit.ui_test.find("Audio Recorder")
self.assertIsNotNone(win)
file_name_textbox = win.find("**/StringField[*]")
self.assertIsNotNone(file_name_textbox)
record_button = win.find("**/HStack[2]/Button[0]")
self.assertIsNotNone(record_button)
with tempfile.TemporaryDirectory() as temp_dir:
path = os.path.join(temp_dir, "test.wav")
# type our file path into the textbox
await file_name_textbox.click()
await file_name_textbox.input(str(path))
# the user hit the record button
await record_button.click()
await asyncio.sleep(1.0)
# change the text in the textbox so we'll have something constant
# for the image comparison
await file_name_textbox.input("soundstorm_song.wav")
await self._dock_window(win)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_recording.png")
# wait for docking to finish. To prevent ui_test getting widgets as while window is being rebuilt
await ui_test.human_delay(50)
# grab these again just in case window docking broke it
win = omni.kit.ui_test.find("Audio Recorder")
self.assertIsNotNone(win)
record_button = win.find("**/HStack[2]/Button[0]")
self.assertIsNotNone(record_button)
# the user hit the stop button
await record_button.click()
await self._dock_window(win)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_stopped.png")
# wait for docking to finish. To prevent ui_test getting widgets as while window is being rebuilt
await ui_test.human_delay(50)
# grab these again just in case window docking broke it
win = omni.kit.ui_test.find("Audio Recorder")
self.assertIsNotNone(win)
file_name_textbox = win.find("**/StringField[*]")
self.assertIsNotNone(file_name_textbox)
record_button = win.find("**/HStack[2]/Button[0]")
self.assertIsNotNone(record_button)
format_combobox = win.find("**/ComboBox[*]")
self.assertIsNotNone(format_combobox)
# analyze the data
sound = iface.create_sound_from_file(path, streaming=True)
self.assertIsNotNone(sound)
fmt = sound.get_format()
self.assertEqual(fmt.format, carb.audio.SampleFormat.PCM16)
pcm = sound.get_buffer_as_int16()
for i in range(len(pcm)):
self.assertEqual(pcm[i], 0);
sound = None # close it
# try again with a different format
# FIXME: We should not be manipulating the model directly, but ui_test
# doesn't have a way to find any of the box item to click on,
# and ComboBoxes don't respond to keyboard input either.
format_combobox.model.set_value(carb.audio.SampleFormat.VORBIS)
path2 = os.path.join(temp_dir, "test.oga")
await file_name_textbox.input(str(path2))
# the user hit the record button
await record_button.click()
await asyncio.sleep(1.0)
# the user hit the stop button
await record_button.click()
# analyze the data
sound = iface.create_sound_from_file(str(path2), streaming=True)
self.assertIsNotNone(sound)
fmt = sound.get_format()
self.assertEqual(fmt.format, carb.audio.SampleFormat.VORBIS)
pcm = sound.get_buffer_as_int16()
for i in range(len(pcm)):
self.assertEqual(pcm[i], 0);
sound = None # close it
async def test_all(self):
await self._test_just_opened()
await self._test_recording()
|
omniverse-code/kit/exts/omni.command.usd/PACKAGE-LICENSES/omni.command.usd-LICENSE.md | Copyright (c) 2020, 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. |
omniverse-code/kit/exts/omni.command.usd/config/extension.toml | [package]
title = "Command USD"
description = "Usefull command for USD."
category = "Internal"
version = "1.0.2"
readme = "docs/README.md"
changelog="docs/CHANGELOG.md"
preview_image = "data/preview.png"
icon = "data/icon.png"
[[python.module]]
name = "omni.command.usd"
[dependencies]
"omni.kit.commands" = {}
"omni.usd" = {}
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/__init__.py | from .commands.usd_commands import *
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/commands/__init__.py | from .usd_commands import *
from .parenting_commands import *
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/commands/parenting_commands.py | import omni.kit.commands
import omni.usd
from typing import List
from pxr import Sdf
class ParentPrimsCommand(omni.kit.commands.Command):
def __init__(
self,
parent_path: str,
child_paths: List[str],
on_move_fn: callable = None,
keep_world_transform: bool = True
):
"""
Move prims into children of "parent" primitives undoable **Command**.
Args:
parent_path: prim path to become parent of child_paths
child_paths: prim paths to become children of parent_prim
keep_world_transform: If it needs to keep the world transform after parenting.
"""
self._parent_path = parent_path
self._child_paths = child_paths.copy()
self._on_move_fn = on_move_fn
self._keep_world_transform = keep_world_transform
def do(self):
with omni.kit.undo.group():
for path in self._child_paths:
path_to = self._parent_path + "/" + Sdf.Path(path).name
omni.kit.commands.execute(
"MovePrim",
path_from=path,
path_to=path_to,
on_move_fn=self._on_move_fn,
destructive=False,
keep_world_transform=self._keep_world_transform
)
def undo(self):
pass
class UnparentPrimsCommand(omni.kit.commands.Command):
def __init__(
self,
paths: List[str],
on_move_fn: callable = None,
keep_world_transform: bool = True
):
"""
Move prims into "/" primitives undoable **Command**.
Args:
paths: prim path to become parent of child_paths
keep_world_transform: If it needs to keep the world transform after parenting.
"""
self._paths = paths.copy()
self._on_move_fn = on_move_fn
self._keep_world_transform = keep_world_transform
def do(self):
with omni.kit.undo.group():
for path in self._paths:
path_to = "/" + Sdf.Path(path).name
omni.kit.commands.execute(
"MovePrim",
path_from=path,
path_to=path_to,
on_move_fn=self._on_move_fn,
destructive=False,
keep_world_transform=self._keep_world_transform
)
def undo(self):
pass
omni.kit.commands.register_all_commands_in_module(__name__)
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/commands/usd_commands.py | import omni.kit.commands
import omni.usd
from typing import List
from pxr import Sdf
class TogglePayLoadLoadSelectedPrimsCommand(omni.kit.commands.Command):
def __init__(self, selected_paths: List[str]):
"""
Toggles the load/unload payload of the selected primitives undoable **Command**.
Args:
selected_paths: Old selected prim paths.
"""
self._stage = omni.usd.get_context().get_stage()
self._selected_paths = selected_paths.copy()
def _toggle_load(self):
for selected_path in self._selected_paths:
selected_prim = self._stage.GetPrimAtPath(selected_path)
if selected_prim.IsLoaded():
selected_prim.Unload()
else:
selected_prim.Load()
def do(self):
self._toggle_load()
def undo(self):
self._toggle_load()
class SetPayLoadLoadSelectedPrimsCommand(omni.kit.commands.Command):
def __init__(self, selected_paths: List[str], value: bool):
"""
Set the load/unload payload of the selected primitives undoable **Command**.
Args:
selected_paths: Old selected prim paths.
value: True = load, False = unload
"""
self._stage = omni.usd.get_context().get_stage()
self._selected_paths = selected_paths.copy()
self._processed_path = set()
self._value = value
self._is_undo = False
def _set_load(self):
if self._is_undo:
paths = self._processed_path
else:
paths = self._selected_paths
for selected_path in paths:
selected_prim = self._stage.GetPrimAtPath(selected_path)
if (selected_prim.IsLoaded() and self._value) or (not selected_prim.IsLoaded() and not self._value):
if selected_path in self._processed_path:
self._processed_path.remove(selected_path)
continue
if self._value:
selected_prim.Load()
else:
selected_prim.Unload()
self._processed_path.add(selected_path)
def do(self):
self._set_load()
def undo(self):
self._is_undo = True
self._value = not self._value
self._set_load()
self._value = not self._value
self._processed_path = set()
self._is_undo = False
omni.kit.commands.register_all_commands_in_module(__name__)
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/tests/__init__.py | from .test_command_usd import *
|
omniverse-code/kit/exts/omni.command.usd/omni/command/usd/tests/test_command_usd.py | import carb
import omni.kit.test
import omni.kit.undo
import omni.kit.commands
import omni.usd
from pxr import Sdf, Usd
def get_stage_default_prim_path(stage):
if stage.HasDefaultPrim():
return stage.GetDefaultPrim().GetPath()
else:
return Sdf.Path.absoluteRootPath
class TestCommandUsd(omni.kit.test.AsyncTestCase):
async def test_toggle_payload_selected(self):
carb.log_info("Test TogglePayLoadLoadSelectedPrimsCommand")
await omni.usd.get_context().new_stage_async()
usd_context = omni.usd.get_context()
selection = usd_context.get_selection()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
payload1 = Usd.Stage.CreateInMemory("payload1.usd")
payload1.DefinePrim("/payload1/scope1", "Xform")
payload1.DefinePrim("/payload1/scope1/xform", "Cube")
payload2 = Usd.Stage.CreateInMemory("payload2.usd")
payload2.DefinePrim("/payload2/scope2", "Xform")
payload2.DefinePrim("/payload2/scope2/xform", "Cube")
payload3 = Usd.Stage.CreateInMemory("payload3.usd")
payload3.DefinePrim("/payload3/scope3", "Xform")
payload3.DefinePrim("/payload3/scope3/xform", "Cube")
payload4 = Usd.Stage.CreateInMemory("payload4.usd")
payload4.DefinePrim("/payload4/scope4", "Xform")
payload4.DefinePrim("/payload4/scope4/xform", "Cube")
ps1 = stage.DefinePrim(default_prim_path.AppendChild("payload1"), "Xform")
ps1.GetPayloads().AddPayload(
Sdf.Payload(payload1.GetRootLayer().identifier, "/payload1"))
ps2 = stage.DefinePrim(default_prim_path.AppendChild("payload2"), "Xform")
ps2.GetPayloads().AddPayload(
Sdf.Payload(payload2.GetRootLayer().identifier, "/payload2"))
ps3 = stage.DefinePrim(default_prim_path.AppendChild("payload3"), "Xform")
ps3.GetPayloads().AddPayload(
Sdf.Payload(payload3.GetRootLayer().identifier, "/payload3"))
ps4 = stage.DefinePrim(ps3.GetPath().AppendChild("payload4"), "Xform")
ps4.GetPayloads().AddPayload(
Sdf.Payload(payload4.GetRootLayer().identifier, "/payload4"))
# unload everything
stage.Unload()
self.assertTrue(not ps1.IsLoaded())
self.assertTrue(not ps2.IsLoaded())
self.assertTrue(not ps3.IsLoaded())
self.assertTrue(not ps4.IsLoaded())
# if nothing selected, payload state should not change.
selection.clear_selected_prim_paths()
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("TogglePayLoadLoadSelectedPrims", selected_paths=paths)
self.assertTrue(not ps1.IsLoaded())
self.assertTrue(not ps2.IsLoaded())
self.assertTrue(not ps3.IsLoaded())
self.assertTrue(not ps4.IsLoaded())
# load payload1
selection.set_selected_prim_paths(
[
ps1.GetPath().pathString
],
False,
)
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("TogglePayLoadLoadSelectedPrims", selected_paths=paths)
self.assertTrue(ps1.IsLoaded())
# unload payload1
omni.kit.commands.execute("TogglePayLoadLoadSelectedPrims", selected_paths=paths)
self.assertTrue(not ps1.IsLoaded())
# load payload1, 2 and 3. 4 will load
selection.set_selected_prim_paths(
[
ps1.GetPath().pathString,
ps2.GetPath().pathString,
ps3.GetPath().pathString,
],
False,
)
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("TogglePayLoadLoadSelectedPrims", selected_paths=paths)
self.assertTrue(ps1.IsLoaded())
self.assertTrue(ps2.IsLoaded())
self.assertTrue(ps3.IsLoaded())
self.assertTrue(ps4.IsLoaded())
# unload 4
selection.set_selected_prim_paths(
[
ps4.GetPath().pathString
],
False,
)
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("TogglePayLoadLoadSelectedPrims", selected_paths=paths)
self.assertTrue(not ps4.IsLoaded())
# undo
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded())
# redo
omni.kit.undo.redo()
self.assertTrue(not ps4.IsLoaded())
async def test_set_payload_selected(self):
carb.log_info("Test SetPayLoadLoadSelectedPrimsCommand")
await omni.usd.get_context().new_stage_async()
usd_context = omni.usd.get_context()
selection = usd_context.get_selection()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
payload1 = Usd.Stage.CreateInMemory("payload1.usd")
payload1.DefinePrim("/payload1/scope1", "Xform")
payload1.DefinePrim("/payload1/scope1/xform", "Cube")
payload2 = Usd.Stage.CreateInMemory("payload2.usd")
payload2.DefinePrim("/payload2/scope2", "Xform")
payload2.DefinePrim("/payload2/scope2/xform", "Cube")
payload3 = Usd.Stage.CreateInMemory("payload3.usd")
payload3.DefinePrim("/payload3/scope3", "Xform")
payload3.DefinePrim("/payload3/scope3/xform", "Cube")
payload4 = Usd.Stage.CreateInMemory("payload4.usd")
payload4.DefinePrim("/payload4/scope4", "Xform")
payload4.DefinePrim("/payload4/scope4/xform", "Cube")
ps1 = stage.DefinePrim(default_prim_path.AppendChild("payload1"), "Xform")
ps1.GetPayloads().AddPayload(
Sdf.Payload(payload1.GetRootLayer().identifier, "/payload1"))
ps2 = stage.DefinePrim(default_prim_path.AppendChild("payload2"), "Xform")
ps2.GetPayloads().AddPayload(
Sdf.Payload(payload2.GetRootLayer().identifier, "/payload2"))
ps3 = stage.DefinePrim(default_prim_path.AppendChild("payload3"), "Xform")
ps3.GetPayloads().AddPayload(
Sdf.Payload(payload3.GetRootLayer().identifier, "/payload3"))
ps4 = stage.DefinePrim(ps3.GetPath().AppendChild("payload4"), "Xform")
ps4.GetPayloads().AddPayload(
Sdf.Payload(payload4.GetRootLayer().identifier, "/payload4"))
# unload everything
stage.Unload()
self.assertTrue(not ps1.IsLoaded())
self.assertTrue(not ps2.IsLoaded())
self.assertTrue(not ps3.IsLoaded())
self.assertTrue(not ps4.IsLoaded())
# if nothing selected, payload state should not change.
selection.clear_selected_prim_paths()
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True)
self.assertTrue(not ps1.IsLoaded())
self.assertTrue(not ps2.IsLoaded())
self.assertTrue(not ps3.IsLoaded())
self.assertTrue(not ps4.IsLoaded())
# load payload1
selection.set_selected_prim_paths(
[
ps1.GetPath().pathString
],
False,
)
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True)
self.assertTrue(ps1.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True)
self.assertTrue(ps1.IsLoaded())
# unload payload1
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False)
self.assertTrue(not ps1.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False)
self.assertTrue(not ps1.IsLoaded())
# load payload1, 2 and 3. 4 will load
selection.set_selected_prim_paths(
[
ps1.GetPath().pathString,
ps2.GetPath().pathString,
ps3.GetPath().pathString,
],
False,
)
paths = selection.get_selected_prim_paths()
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True)
self.assertTrue(ps1.IsLoaded())
self.assertTrue(ps2.IsLoaded())
self.assertTrue(ps3.IsLoaded())
self.assertTrue(ps4.IsLoaded())
selection.set_selected_prim_paths(
[
ps4.GetPath().pathString
],
False,
)
paths = selection.get_selected_prim_paths()
# reload 4
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True)
self.assertTrue(ps4.IsLoaded())
# unload 4
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False)
self.assertTrue(not ps4.IsLoaded())
# undo
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded())
# redo
omni.kit.undo.redo()
self.assertTrue(not ps4.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False)
self.assertTrue(not ps4.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False)
self.assertTrue(not ps4.IsLoaded())
omni.kit.undo.undo()
self.assertTrue(not ps4.IsLoaded())
omni.kit.undo.redo()
self.assertTrue(not ps4.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True) # -1
self.assertTrue(ps4.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True) # 0
self.assertTrue(ps4.IsLoaded())
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded())
omni.kit.undo.redo()
self.assertTrue(ps4.IsLoaded())
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False) # 1
self.assertTrue(not ps4.IsLoaded()) # 1
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # 0
omni.kit.undo.redo()
self.assertTrue(not ps4.IsLoaded()) # 1
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # 0
# triple undo
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True) # 2
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True) # 3
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=False) # 4
omni.kit.commands.execute("SetPayLoadLoadSelectedPrims", selected_paths=paths, value=True) # 5
self.assertTrue(ps4.IsLoaded()) # 5
omni.kit.undo.undo()
self.assertTrue(not ps4.IsLoaded()) # 4
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # 3
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # 2
# more undo
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # 0
omni.kit.undo.undo()
self.assertTrue(ps4.IsLoaded()) # -1
|
omniverse-code/kit/exts/omni.command.usd/docs/CHANGELOG.md |
## [1.0.2] - 2022-11-10
### Removed
- Removed dependency on omni.kit.test
## [1.0.1] - 2021-03-15
### Changed
- Added "ParentPrimsCommand" and "UnparentPrimsCommand"
## [0.1.0] - 2021-02-17
### Changed
- Add "TogglePayLoadLoadSelectedPrimsCommand" and "SetPayLoadLoadSelectedPrimsCommand"
|
omniverse-code/kit/exts/omni.command.usd/docs/README.md | # Command USD [omni.command.usd]
Usefull command for USD.
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/style.py | # Copyright (c) 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.
#
__all__ = ["welcome_widget_style"]
from omni.ui import color as cl
from omni.ui import constant as fl
from omni.ui import url
import omni.kit.app
import omni.ui as ui
import pathlib
EXTENSION_FOLDER_PATH = pathlib.Path(
omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
)
# Pre-defined constants. It's possible to change them runtime.
cl.welcome_widget_attribute_bg = cl("#1f2124")
cl.welcome_widget_attribute_fg = cl("#0f1115")
cl.welcome_widget_hovered = cl("#FFFFFF")
cl.welcome_widget_text = cl("#CCCCCC")
fl.welcome_widget_attr_hspacing = 10
fl.welcome_widget_attr_spacing = 1
fl.welcome_widget_group_spacing = 2
url.welcome_widget_icon_closed = f"{EXTENSION_FOLDER_PATH}/data/closed.svg"
url.welcome_widget_icon_opened = f"{EXTENSION_FOLDER_PATH}/data/opened.svg"
# The main style dict
welcome_widget_style = {
"Label::attribute_name": {
"alignment": ui.Alignment.RIGHT_CENTER,
"margin_height": fl.welcome_widget_attr_spacing,
"margin_width": fl.welcome_widget_attr_hspacing,
},
"Label::title": {"alignment": ui.Alignment.CENTER, "color": cl.welcome_widget_text, "font_size": 30},
"Label::attribute_name:hovered": {"color": cl.welcome_widget_hovered},
"Label::collapsable_name": {"alignment": ui.Alignment.LEFT_CENTER},
"Slider::attribute_int:hovered": {"color": cl.welcome_widget_hovered},
"Slider": {
"background_color": cl.welcome_widget_attribute_bg,
"draw_mode": ui.SliderDrawMode.HANDLE,
},
"Slider::attribute_float": {
"draw_mode": ui.SliderDrawMode.FILLED,
"secondary_color": cl.welcome_widget_attribute_fg,
},
"Slider::attribute_float:hovered": {"color": cl.welcome_widget_hovered},
"Slider::attribute_vector:hovered": {"color": cl.welcome_widget_hovered},
"Slider::attribute_color:hovered": {"color": cl.welcome_widget_hovered},
"CollapsableFrame::group": {"margin_height": fl.welcome_widget_group_spacing},
"Image::collapsable_opened": {"color": cl.welcome_widget_text, "image_url": url.welcome_widget_icon_opened},
"Image::collapsable_closed": {"color": cl.welcome_widget_text, "image_url": url.welcome_widget_icon_closed},
}
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/extension.py | # Copyright (c) 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.
#
__all__ = ["WelcomeWindowExtension"]
import asyncio
import carb
import omni.ext
import omni.ui as ui
from typing import Optional
class WelcomeWindowExtension(omni.ext.IExt):
"""The entry point for Welcome Window"""
WINDOW_NAME = "Welcome Window"
# MENU_PATH = f"Window/{WINDOW_NAME}"
def on_startup(self):
self.__window: Optional["WelcomeWindow"] = None
self.__widget: Optional["WelcomeWidget"] = None
self.__render_loading: Optional["ViewportReady"] = None
self.show_welcome(True)
def on_shutdown(self):
self._menu = None
if self.__window:
self.__window.destroy()
self.__window = None
if self.__widget:
self.__widget.destroy()
self.__widget = None
def show_welcome(self, visible: bool):
in_viewport = carb.settings.get_settings().get("/exts/omni.kit.window.welcome/embedInViewport")
if in_viewport and not self.__window:
self.__show_widget(visible)
else:
self.__show_window(visible)
if not visible and self.__render_loading:
self.__render_loading = None
def __get_buttons(self) -> dict:
return {
"Create Empty Scene": self.__create_empty_scene,
"Open Last Saved Scene": None,
"Browse Scenes": None
}
def __destroy_object(self, object):
# Hide it immediately
object.visible = False
# And destroy it in the future
async def destroy_object(object):
await omni.kit.app.get_app().next_update_async()
object.destroy()
asyncio.ensure_future(destroy_object(object))
def __show_window(self, visible: bool):
if visible and self.__window is None:
from .window import WelcomeWindow
self.__window = WelcomeWindow(WelcomeWindowExtension.WINDOW_NAME, width=500, height=300, buttons=self.__get_buttons())
elif self.__window and not visible:
self.__destroy_object(self.__window)
self.__window = None
elif self.__window:
self.__window.visible = True
def __show_widget(self, visible: bool):
if visible and self.__widget is None:
async def add_to_viewport():
try:
from omni.kit.viewport.utility import get_active_viewport_window
from .widget import WelcomeWidget
viewport_window = get_active_viewport_window()
with viewport_window.get_frame("omni.kit.window.welcome"):
self.__widget = WelcomeWidget(self.__get_buttons(), add_background=True)
except (ImportError, AttributeError):
# Fallback to Welcome window
self.__show_window(visible)
asyncio.ensure_future(add_to_viewport())
elif self.__widget and not visible:
self.__destroy_object(self.__widget)
self.__widget = None
elif self.__widget:
self.__widget.visible = True
def __button_clicked(self):
self.show_welcome(False)
def __create_empty_scene(self, renderer: Optional[str] = None):
self.__button_clicked()
settings = carb.settings.get_settings()
ext_manager = omni.kit.app.get_app().get_extension_manager()
if renderer is None:
renderer = settings.get("/exts/omni.app.setup/backgroundRendererLoad/renderer")
if not renderer:
return
ext_manager.set_extension_enabled_immediate("omni.kit.viewport.bundle", True)
if renderer == "iray":
ext_manager.set_extension_enabled_immediate(f"omni.hydra.rtx", True)
ext_manager.set_extension_enabled_immediate(f"omni.hydra.{renderer}", True)
else:
ext_manager.set_extension_enabled_immediate(f"omni.kit.viewport.{renderer}", True)
async def _new_stage_async():
if settings.get("/exts/omni.kit.window.welcome/showRenderLoading"):
from .render_loading import start_render_loading_ui
self.__render_loading = start_render_loading_ui(ext_manager, renderer)
await omni.kit.app.get_app().next_update_async()
import omni.kit.stage_templates as stage_templates
stage_templates.new_stage(template=None)
await omni.kit.app.get_app().next_update_async()
from omni.kit.viewport.utility import get_active_viewport
get_active_viewport().set_hd_engine(renderer)
asyncio.ensure_future(_new_stage_async())
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/__init__.py | # Copyright (c) 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.
#
__all__ = ["WelcomeWindowExtension"]
from .extension import WelcomeWindowExtension
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/render_loading.py | # Copyright (c) 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.
#
__all__ = ["start_render_loading_ui"]
def start_render_loading_ui(ext_manager, renderer: str):
import carb
import time
time_begin = time.time()
carb.settings.get_settings().set("/exts/omni.kit.viewport.ready/startup/enabled", False)
ext_manager.set_extension_enabled_immediate("omni.kit.viewport.ready", True)
from omni.kit.viewport.ready.viewport_ready import ViewportReady, ViewportReadyDelegate
class TimerDelegate(ViewportReadyDelegate):
def __init__(self, time_begin):
super().__init__()
self.__timer_start = time.time()
self.__vp_ready_cost = self.__timer_start - time_begin
@property
def font_size(self) -> float:
return 48
@property
def message(self) -> str:
rtx_mode = {
"RaytracedLighting": "Real-Time",
"PathTracing": "Interactive (Path Tracing)",
"LightspeedAperture": "Aperture (Game Path Tracer)"
}.get(carb.settings.get_settings().get("/rtx/rendermode"), "Real-Time")
renderer_label = {
"rtx": f"RTX - {rtx_mode}",
"iray": "RTX - Accurate (Iray)",
"pxr": "Pixar Storm",
"index": "RTX - Scientific (IndeX)"
}.get(renderer, renderer)
return f"Waiting for {renderer_label} to start"
def on_complete(self):
rtx_load_time = time.time() - self.__timer_start
super().on_complete()
print(f"Time until pixel: {rtx_load_time}")
print(f"ViewportReady cost: {self.__vp_ready_cost}")
return ViewportReady(TimerDelegate(time_begin))
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/widget.py | # Copyright (c) 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.
#
__all__ = ["WelcomeWidget"]
import carb
import omni.kit.app
import omni.ui as ui
from typing import Callable, Optional
class WelcomeWidget():
"""The class that represents the window"""
def __init__(self, buttons: dict, style: Optional[dict] = None, button_size: Optional[tuple] = None, add_background: bool = False):
if style is None:
from .style import welcome_widget_style
style = welcome_widget_style
if button_size is None:
button_size = (150, 100)
self.__add_background = add_background
# Save the button_size for later use
self.__buttons = buttons
self.__button_size = button_size
# Create the top-level ui.Frame
self.__frame: ui.Frame = ui.Frame()
# Apply the style to all the widgets of this window
self.__frame.style = style
# Set the function that is called to build widgets when the window is visible
self.__frame.set_build_fn(self.create_ui)
def destroy(self):
# It will destroy all the children
if self.__frame:
self.__frame.destroy()
self.__frame = None
def create_label(self):
ui.Label("Select Stage", name="title")
def create_button(self, label: str, width: float, height: float, clicked_fn: Callable):
ui.Button(label, width=width, height=height, clicked_fn=clicked_fn)
def create_buttons(self, width: float, height: float):
for label, clicked_fn in self.__buttons.items():
self.create_button(label, width=width, height=height, clicked_fn=clicked_fn)
def create_background(self):
bg_color = carb.settings.get_settings().get('/exts/omni.kit.viewport.ready/background_color')
if bg_color:
omni.ui.Rectangle(style={"background_color": bg_color})
def create_ui(self):
with ui.ZStack():
if self.__add_background:
self.create_background()
with ui.HStack():
ui.Spacer(width=20)
with ui.VStack():
ui.Spacer()
self.create_label()
ui.Spacer(height=20)
with ui.HStack(height=100):
ui.Spacer()
self.create_buttons(self.__button_size[0], self.__button_size[1])
ui.Spacer()
ui.Spacer()
ui.Spacer(width=20)
@property
def visible(self):
return self.__frame.visible if self.__frame else None
@visible.setter
def visible(self, visible: bool):
if self.__frame:
self.__frame.visible = visible
elif visible:
import carb
carb.log_error("Cannot make WelcomeWidget visible after it was destroyed")
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/window.py | # Copyright (c) 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.
#
__all__ = ["WelcomeWindow"]
from .widget import WelcomeWidget
from typing import Optional
import omni.ui as ui
class WelcomeWindow(ui.Window):
"""The class that represents the window"""
def __init__(self, title: str, buttons: dict, *args, **kwargs):
super().__init__(title, *args, **kwargs)
self.__buttons = buttons
self.__widget: Optional[WelcomeWidget] = None
# Set the function that is called to build widgets when the window is visible
self.frame.set_build_fn(self.__build_fn)
def __destroy_widget(self):
if self.__widget:
self.__widget.destroy()
self.__widget = None
def __build_fn(self):
# Destroy any existing WelcomeWidget
self.__destroy_widget()
# Add the Welcomwidget
self.__widget = WelcomeWidget(self.__buttons)
def destroy(self):
# It will destroy all the children
self.__destroy_widget()
super().destroy()
@property
def wlcome_widget(self):
return self.__widget
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/tests/test_widget.py | # Copyright (c) 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.
#
__all__ = ["TestWidget"]
from omni.kit.window.welcome.widget import WelcomeWidget
import omni.kit.app
import omni.kit.test
import omni.ui as ui
class TestWidget(omni.kit.test.AsyncTestCase):
async def test_general(self):
"""Create a widget and make sure there are no errors"""
window = ui.Window("Test")
with window.frame:
WelcomeWidget(buttons={})
await omni.kit.app.get_app().next_update_async()
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/tests/__init__.py | # Copyright (c) 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.
#
from .test_widget import TestWidget
from .test_window import TestWindow
|
omniverse-code/kit/exts/omni.kit.window.welcome/omni/kit/window/welcome/tests/test_window.py | # Copyright (c) 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.
#
__all__ = ["TestWindow"]
from omni.kit.window.welcome.window import WelcomeWindow
import omni.kit.app
import omni.kit.test
class TestWindow(omni.kit.test.AsyncTestCase):
async def test_general(self):
"""Create a window and make sure there are no errors"""
window = WelcomeWindow("Welcome Window Test", buttons={})
await omni.kit.app.get_app().next_update_async()
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/delegate.py | # Copyright (c) 2018-2020, 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.
#
import abc
class SearchDelegate:
def __init__(self):
self._search_dir = None
@property
def visible(self):
return True # pragma: no cover
@property
def enabled(self):
"""Enable/disable Widget"""
return True # pragma: no cover
@property
def search_dir(self):
return self._search_dir # pragma: no cover
@search_dir.setter
def search_dir(self, search_dir: str):
self._search_dir = search_dir # pragma: no cover
@abc.abstractmethod
def build_ui(self):
pass # pragma: no cover
@abc.abstractmethod
def destroy(self):
pass # pragma: no cover
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/style.py | # Copyright (c) 2018-2020, 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.
#
import carb
import omni.ui as ui
from pathlib import Path
try:
THEME = carb.settings.get_settings().get_as_string("/persistent/app/window/uiStyle")
except Exception:
THEME = None
finally:
THEME = THEME or "NvidiaDark"
CURRENT_PATH = Path(__file__).parent.absolute()
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath(f"icons/{THEME}")
THUMBNAIL_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath("data").joinpath("thumbnails")
def get_style():
if THEME == "NvidiaLight":
BACKGROUND_COLOR = 0xFF535354
BACKGROUND_SELECTED_COLOR = 0xFF6E6E6E
BACKGROUND_HOVERED_COLOR = 0xFF6E6E6E
BACKGROUND_DISABLED_COLOR = 0xFF666666
TEXT_COLOR = 0xFF8D760D
TEXT_HINT_COLOR = 0xFFD6D6D6
SEARCH_BORDER_COLOR = 0xFFC9974C
SEARCH_HOVER_COLOR = 0xFFB8B8B8
SEARCH_CLOSE_COLOR = 0xFF858585
SEARCH_TEXT_BACKGROUND_COLOR = 0xFFD9D4BC
else:
BACKGROUND_COLOR = 0xFF23211F
BACKGROUND_SELECTED_COLOR = 0xFF8A8777
BACKGROUND_HOVERED_COLOR = 0xFF3A3A3A
BACKGROUND_DISABLED_COLOR = 0xFF666666
TEXT_COLOR = 0xFF9E9E9E
TEXT_HINT_COLOR = 0xFF4A4A4A
SEARCH_BORDER_COLOR = 0xFFC9974C
SEARCH_HOVER_COLOR = 0xFF3A3A3A
SEARCH_CLOSE_COLOR = 0xFF858585
SEARCH_TEXT_BACKGROUND_COLOR = 0xFFD9D4BC
style = {
"Button": {
"background_color": BACKGROUND_COLOR,
"selected_color": BACKGROUND_SELECTED_COLOR,
"color": TEXT_COLOR,
"margin": 0,
"padding": 0
},
"Button:hovered": {"background_color": BACKGROUND_HOVERED_COLOR},
"Button.Label": {"color": TEXT_COLOR},
"Field": {"background_color": 0x0, "selected_color": BACKGROUND_SELECTED_COLOR, "color": TEXT_COLOR, "alignment": ui.Alignment.LEFT_CENTER},
"Label": {"background_color": 0x0, "color": TEXT_COLOR},
"Rectangle": {"background_color": 0x0},
"SearchField": {
"background_color": 0,
"border_radius": 0,
"border_width": 0,
"background_selected_color": BACKGROUND_COLOR,
"margin": 0,
"padding": 4,
"alignment": ui.Alignment.LEFT_CENTER,
},
"SearchField.Frame": {
"background_color": BACKGROUND_COLOR,
"border_radius": 0.0,
"border_color": 0,
"border_width": 2,
},
"SearchField.Frame:selected": {
"background_color": BACKGROUND_COLOR,
"border_radius": 0,
"border_color": SEARCH_BORDER_COLOR,
"border_width": 2,
},
"SearchField.Frame:disabled": {
"background_color": BACKGROUND_DISABLED_COLOR,
},
"SearchField.Hint": {"color": TEXT_HINT_COLOR},
"SearchField.Button": {"background_color": 0x0, "margin_width": 2, "padding": 4},
"SearchField.Button.Image": {"color": TEXT_HINT_COLOR},
"SearchField.Clear": {"background_color": 0x0, "padding": 4},
"SearchField.Clear:hovered": {"background_color": SEARCH_HOVER_COLOR},
"SearchField.Clear.Image": {"image_url": f"{ICON_PATH}/close.svg", "color": SEARCH_CLOSE_COLOR},
"SearchField.Word": {"background_color": SEARCH_TEXT_BACKGROUND_COLOR},
"SearchField.Word.Label": {"color": TEXT_COLOR},
"SearchField.Word.Button": {"background_color": 0, "padding": 2},
"SearchField.Word.Button.Image": {"image_url": f"{ICON_PATH}/close.svg", "color": TEXT_COLOR},
}
return style
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/__init__.py | # Copyright (c) 2018-2020, 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.
#
"""
A UI widget to search for files in a filesystem.
"""
from .widget import SearchField
from .delegate import SearchDelegate
from .model import SearchResultsModel, SearchResultsItem
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/model.py | # Copyright (c) 2018-2020, 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.
#
import omni.ui as ui
import omni.client
from typing import Dict
from datetime import datetime
from omni.kit.widget.filebrowser import FileBrowserModel, FileBrowserItem, find_thumbnails_for_files_async
from omni.kit.widget.filebrowser.model import FileBrowserItemFields
from omni.kit.search_core import AbstractSearchModel, AbstractSearchItem
class SearchResultsItem(FileBrowserItem):
_thumbnail_dict: Dict = {}
def __init__(self, path: str, fields: FileBrowserItemFields, is_folder: bool = False):
super().__init__(path, fields, is_folder=is_folder)
class _RedirectModel(ui.AbstractValueModel):
def __init__(self, search_model, field):
super().__init__()
self._search_model = search_model
self._field = field
def get_value_as_string(self):
return str(self._search_model[self._field])
def set_value(self, value):
pass
async def get_custom_thumbnails_for_folder_async(self) -> Dict:
"""
Returns the thumbnail dictionary for this (folder) item.
Returns:
Dict: With children url's as keys, and url's to thumbnail files as values.
"""
if not self.is_folder:
return {}
# Files in the root folder only
file_urls = []
for _, item in self.children.items():
if item.is_folder or item.path in self._thumbnail_dict:
# Skip if folder or thumbnail previously found
pass
else:
file_urls.append(item.path)
thumbnail_dict = await find_thumbnails_for_files_async(file_urls)
for url, thumbnail_url in thumbnail_dict.items():
if url and thumbnail_url:
self._thumbnail_dict[url] = thumbnail_url
return self._thumbnail_dict
class SearchResultsItemFactory:
@staticmethod
def create_item(search_item: AbstractSearchItem) -> SearchResultsItem:
if not search_item:
return None
access = omni.client.AccessFlags.READ | omni.client.AccessFlags.WRITE
fields = FileBrowserItemFields(search_item.name, search_item.date, search_item.size, access)
item = SearchResultsItem(search_item.path, fields, is_folder=search_item.is_folder)
item._models = (
SearchResultsItem._RedirectModel(search_item, "name"),
SearchResultsItem._RedirectModel(search_item, "date"),
SearchResultsItem._RedirectModel(search_item, "size"),
)
return item
@staticmethod
def create_group_item(name: str, path: str) -> SearchResultsItem:
access = omni.client.AccessFlags.READ | omni.client.AccessFlags.WRITE
fields = FileBrowserItemFields(name, datetime.now(), 0, access)
item = SearchResultsItem(path, fields, is_folder=True)
return item
class SearchResultsModel(FileBrowserModel):
def __init__(self, search_model: AbstractSearchModel, **kwargs):
super().__init__(**kwargs)
self._root = SearchResultsItemFactory.create_group_item("Search Results", "search_results://")
self._search_model = search_model
# Circular dependency
self._dirty_item_subscription = self._search_model.subscribe_item_changed(self.__on_item_changed)
def destroy(self):
# Remove circular dependency
self._dirty_item_subscription = None
if self._search_model:
self._search_model.destroy()
self._search_model = None
def get_item_children(self, item: SearchResultsItem) -> [SearchResultsItem]:
if self._search_model is None or item is not None:
return []
# OM-92499: Skip populate for empty search model items
if not self._root.populated and self._search_model.items:
for search_item in self._search_model.items:
self._root.add_child(SearchResultsItemFactory.create_item(search_item))
self._root.populated = True
children = list(self._root.children.values())
if self._filter_fn:
return list(filter(self._filter_fn, children))
else:
return children
def __on_item_changed(self, item):
self._item_changed(item)
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/widget.py | # Copyright (c) 2018-2020, 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.
#
from omni import ui
from carb import log_warn
from typing import Callable, List
from omni.kit.search_core import SearchEngineRegistry
from .delegate import SearchDelegate
from .model import SearchResultsModel
from .style import get_style, ICON_PATH
class SearchWordButton:
"""
Represents a search word widget, combined with a label to show the word and a close button to remove it.
Args:
word (str): String of word.
Keyword args:
on_close_fn (callable): Function called when close button clicked. Function signure:
void on_close_fn(widget: SearchWordButton)
"""
def __init__(self, word: str, on_close_fn: callable = None):
self._container = ui.ZStack(width=0)
with self._container:
with ui.VStack():
ui.Spacer(height=5)
ui.Rectangle(style_type_name_override="SearchField.Word")
ui.Spacer(height=5)
with ui.HStack():
ui.Spacer(width=3)
ui.Label(word, width=0, style_type_name_override="SearchField.Word.Label")
ui.Spacer(width=3)
ui.Button(
image_width=8,
style_type_name_override="SearchField.Word.Button",
clicked_fn=lambda: on_close_fn(self) if on_close_fn is not None else None,
identifier="search_word_button",
)
@property
def visible(self) -> None:
"""Widget visibility"""
return self._container.visible
@visible.setter
def visible(self, value: bool) -> None:
self._container.visible = value
class SearchField(SearchDelegate):
"""
A search field to input search words
Args:
callback (callable): Function called after search done. Function signature: void callback(model: SearchResultsModel)
Keyword Args:
width (Optional[ui.Length]): Widget widthl. Default None, means auto.
height (Optional[ui.Length]): Widget height. Default ui.Pixel(26). Use None for auto.
subscribe_edit_changed (bool): True to retreive on_search_fn called when input changed. Default False only retreive on_search_fn called when input ended.
show_tokens (bool): Default True to show tokens if end edit. Do nothing if False.
Properties:
visible (bool): Widget visibility.
enabled (bool): Enable/Disable widget.
"""
SEARCH_IMAGE_SIZE = 16
CLOSE_IMAGE_SIZE = 12
def __init__(self, callback: Callable, **kwargs):
super().__init__(**kwargs)
self._callback = callback
self._container_args = {"style": get_style()}
if kwargs.get("width") is not None:
self._container_args["width"] = kwargs.get("width")
self._container_args["height"] = kwargs.get("height", ui.Pixel(26))
self._subscribe_edit_changed = kwargs.get("subscribe_edit_changed", False)
self._show_tokens = kwargs.get("show_tokens", True)
self._search_field: ui.StringField = None
self._search_engine = None
self._search_engine_menu = None
self._search_words: List[str] = []
self._in_searching = False
self._search_label = None
# OM-76011:subscribe to engine changed
self.__search_engine_changed_sub = SearchEngineRegistry().subscribe_engines_changed(self._on_search_engines_changed)
@property
def visible(self):
"""
Widget visibility
"""
return self._container.visible
@visible.setter
def visible(self, value):
self._container.visible = value
@property
def enabled(self):
"""
Enable/disable Widget
"""
return self._container.enabled
@enabled.setter
def enabled(self, value):
self._container.enabled = value
if value:
self._search_label.text = "Search"
else:
self._search_label.text = "Search disabled. Please install a search extension."
@property
def search_dir(self):
return self._search_dir
@search_dir.setter
def search_dir(self, search_dir: str):
dir_changed = search_dir != self._search_dir
self._search_dir = search_dir
if self._in_searching and dir_changed:
self.search(self._search_words)
def build_ui(self):
self._container = ui.ZStack(**self._container_args)
with self._container:
# background
self._background = ui.Rectangle(style_type_name_override="SearchField.Frame")
with ui.HStack():
with ui.VStack(width=0):
# Search "magnifying glass" button
search_button = ui.Button(
image_url=f"{ICON_PATH}/search.svg",
image_width=SearchField.SEARCH_IMAGE_SIZE,
image_height=SearchField.SEARCH_IMAGE_SIZE,
style_type_name_override="SearchField.Button",
identifier="show_engine_menu",
)
search_button.set_clicked_fn(
lambda b=search_button: self._show_engine_menu(
b.screen_position_x, b.screen_position_y + b.computed_height
)
)
with ui.HStack():
with ui.ZStack():
with ui.HStack():
# Individual word widgets
if self._show_tokens:
self._words_container = ui.HStack()
self._build_search_words()
# String field to accept user input, here ui.Spacer for border of SearchField.Frame
with ui.VStack():
ui.Spacer()
with ui.HStack(height=0):
self._search_field = ui.StringField(
ui.SimpleStringModel(),
mouse_double_clicked_fn=lambda x, y, btn, m: self._convert_words_to_string(),
style_type_name_override="SearchField",
)
ui.Spacer()
self._hint_container = ui.HStack(spacing=4)
with self._hint_container:
# Hint label
self._search_label = ui.Label("Search", width=275,
style_type_name_override="SearchField.Hint")
# Close icon
with ui.VStack(width=20):
ui.Spacer(height=2)
self._clear_button = ui.Button(
image_width=SearchField.CLOSE_IMAGE_SIZE,
style_type_name_override="SearchField.Clear",
clicked_fn=self._on_clear_clicked,
)
ui.Spacer(height=2)
ui.Spacer(width=2)
self._clear_button.visible = False
self._sub_begin_edit = self._search_field.model.subscribe_begin_edit_fn(self._on_begin_edit)
self._sub_end_edit = self._search_field.model.subscribe_end_edit_fn(self._on_end_edit)
if self._subscribe_edit_changed:
self._sub_text_edit = self._search_field.model.subscribe_value_changed_fn(self._on_text_edit)
else:
self._sub_text_edit = None
# check on init for if we have available search engines
self._on_search_engines_changed()
def destroy(self):
self._callback = None
self._search_field = None
self._sub_begin_edit = None
self._sub_end_edit = None
self._sub_text_edit = None
self._background = None
self._hint_container = None
self._clear_button = None
self._search_label = None
self._container = None
self.__search_engine_changed_sub = None
def _show_engine_menu(self, x, y):
self._search_engine_menu = ui.Menu("Engines")
search_names = SearchEngineRegistry().get_available_search_names(self._search_dir)
if not search_names:
return
# TODO: We need to have predefined default search
if self._search_engine is None or self._search_engine not in search_names:
self._search_engine = search_names[0]
def set_current_engine(engine_name):
self._search_engine = engine_name
with self._search_engine_menu:
for name in search_names:
ui.MenuItem(
name,
checkable=True,
checked=self._search_engine == name,
triggered_fn=lambda n=name: set_current_engine(n),
)
self._search_engine_menu.show_at(x, y)
def _get_search_words(self) -> List[str]:
# Split the input string to words and filter invalid
search_string = self._search_field.model.get_value_as_string()
search_words = [word for word in search_string.split(" ") if word]
if len(search_words) == 0:
return None
elif len(search_words) == 1 and search_words[0] == "":
# If empty input, regard as clear
return None
else:
return search_words
def _on_begin_edit(self, model):
self._set_in_searching(True)
def _on_end_edit(self, model: ui.AbstractValueModel) -> None:
search_words = self._get_search_words()
if search_words is None:
# Filter empty(hidden) word
filter_words = [word for word in self._search_words if word]
if len(filter_words) == 0:
self._set_in_searching(False)
else:
if self._show_tokens:
self._search_words.extend(search_words)
self._build_search_words()
self._search_field.model.set_value("")
else:
self._search_words = search_words
self.search(self._search_words)
def _on_text_edit(self, model: ui.AbstractValueModel) -> None:
new_search_words = self._get_search_words()
if new_search_words is not None:
# Add current input to search words
search_words = []
search_words.extend(self._search_words)
search_words.extend(new_search_words)
self._search_words = search_words
self.search(self._search_words)
def _convert_words_to_string(self) -> None:
if self._show_tokens:
# convert existing search words back to string
filter_words = [word for word in self._search_words if word]
seperator = " "
self._search_words = []
self._build_search_words()
original_string = seperator.join(filter_words)
# Append current input
input_string = self._search_field.model.get_value_as_string()
if input_string:
original_string = original_string + seperator + input_string
self._search_field.model.set_value(original_string)
def _on_clear_clicked(self) -> None:
# Update UI
self._set_in_searching(False)
self._search_field.model.set_value("")
self._search_words.clear()
self._build_search_words()
# Notification
self.search(None)
def _set_in_searching(self, in_searching: bool) -> None:
self._in_searching = in_searching
# Background outline
self._background.selected = in_searching
# Show/Hide hint frame (search icon and hint lable)
self._hint_container.visible = not in_searching
# Show/Hide close image
self._clear_button.visible = in_searching
def _build_search_words(self):
if self._show_tokens:
self._words_container.clear()
if len(self._search_words) == 0:
return
with self._words_container:
ui.Spacer(width=4)
for index, word in enumerate(self._search_words):
if word:
SearchWordButton(word, on_close_fn=lambda widget, idx=index: self._hide_search_word(idx, widget))
def _hide_search_word(self, index: int, widget: SearchWordButton) -> None:
# Here cannot remove the widget since this function is called by the widget
# So just set invisible and change to empty word
# It will be removed later if clear or edit end.
widget.visible = False
if index >= 0 and index < len(self._search_words):
self._search_words[index] = ""
self.search(self._search_words)
def search(self, search_words: List[str]):
"""
Search using selected search engine.
Args:
search_words (List[str]): List of search terms.
"""
# TODO: We need to have predefined default search
if self._search_engine is None:
search_names = SearchEngineRegistry().get_search_names()
self._search_engine = search_names[0] if search_names else None
if self._search_engine:
SearchModel = SearchEngineRegistry().get_search_model(self._search_engine)
else:
log_warn("No search engines registered! Please import a search extension.")
return
if not SearchModel:
log_warn(f"Search engine '{self._search_engine}' not found.")
return
search_words = [word for word in search_words or [] if word] # Filter empty(hidden) word
if len(search_words) > 0:
search_results = SearchModel(search_text=" ".join(search_words), current_dir=self._search_dir)
model = SearchResultsModel(search_results)
else:
model = None
if self._callback:
self._callback(model)
def _on_search_engines_changed(self):
search_names = SearchEngineRegistry().get_search_names()
self.enabled = bool(search_names)
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/tests/__init__.py | ## Copyright (c) 2018-2020, 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.
##
from .test_search_field import *
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/omni/kit/widget/search_delegate/tests/test_search_field.py | ## Copyright (c) 2018-2019, 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.
##
from unittest.mock import patch, MagicMock
import omni.kit.ui_test as ui_test
from omni.kit.ui_test.query import MenuRef
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.search_core import AbstractSearchModel, AbstractSearchItem, SearchEngineRegistry
from ..widget import SearchField
from ..model import SearchResultsModel
class MockSearchEngineRegistry(MagicMock):
def get_search_names():
return "test_search"
def get_search_model(_: str):
return MockSearchModel
class MockSearchItem(AbstractSearchItem):
def __init__(self, name: str, path: str):
super().__init__()
self._name = name
self._path = path
@property
def name(self):
return self._name
@property
def path(self):
return self._path
class MockSearchModel(AbstractSearchModel):
def __init__(self, search_text: str, current_dir: str):
super().__init__()
self._items = []
search_words = search_text.split(" ")
# Return mock results from input search text
for search_word in search_words:
name = f"{search_word}.usd"
self._items.append(MockSearchItem(name, f"{current_dir}/{name}"))
@property
def items(self):
return self._items
class TestSearchField(OmniUiTest):
async def setUp(self):
self._search_results = None
async def tearDown(self):
if self._search_results:
self._search_results.destroy()
self._search_results = None
def _on_search(self, search_results: SearchResultsModel):
self._search_results = search_results
async def test_search_succeeds(self):
"""Testing search function successfully returns search results"""
window = await self.create_test_window()
with window.frame:
under_test = SearchField(self._on_search)
under_test.build_ui()
search_words = ["foo", "bar"]
with patch("omni.kit.widget.search_delegate.widget.SearchEngineRegistry", return_value=MockSearchEngineRegistry):
under_test.search_dir = "C:/my_search_dir"
under_test.search(search_words)
# Assert the the search generated the expected results
results = self._search_results.get_item_children(None)
self.assertEqual(
[f"{under_test.search_dir}/{w}.usd" for w in search_words],
[result.path for result in results]
)
for result in results:
thumbnail = await result.get_custom_thumbnails_for_folder_async()
self.assertEqual(thumbnail, {})
self.assertTrue(under_test.visible)
under_test.destroy()
async def test_setting_search_dir_triggers_search(self):
"""Testing that when done editing the search field, executes the search"""
window = await self.create_test_window()
mock_search = MagicMock()
with window.frame:
with patch.object(SearchField, "search") as mock_search:
under_test = SearchField(None)
under_test.build_ui()
# Procedurally set search directory and search field
search_words = ["foo", "bar"]
under_test.search_dir = "C:/my_search_dir"
under_test._on_begin_edit(None)
under_test._search_field.model.set_value(" ".join(search_words))
under_test._on_end_edit(None)
# Assert that the search is executed
mock_search.assert_called_once_with(search_words)
under_test.destroy()
async def test_engine_menu(self):
window = await self.create_test_window(block_devices=False)
with window.frame:
under_test = SearchField(None)
under_test.build_ui()
self._subscription = SearchEngineRegistry().register_search_model("TEST_SEARCH", MockSearchModel)
window_ref = ui_test.WindowRef(window, "")
button_ref = window_ref.find_all("**/Button[*].identifier=='show_engine_menu'")[0]
await button_ref.click()
self.assertTrue(under_test.enabled)
self.assertIsNotNone(under_test._search_engine_menu)
self.assertTrue(under_test._search_engine_menu.shown)
menu_ref = MenuRef(under_test._search_engine_menu, "")
menu_items = menu_ref.find_all("**/")
self.assertEqual(len(menu_items), 1)
self.assertEqual(menu_items[0].widget.text, "TEST_SEARCH")
under_test.destroy()
self._subscription = None
async def test_edit_search(self):
window = await self.create_test_window(block_devices=False)
with window.frame:
under_test = SearchField(self._on_search)
under_test.build_ui()
self._subscription = SearchEngineRegistry().register_search_model("TEST_SEARCH", MockSearchModel)
search_words = ["foo", "bar"]
under_test.search_dir = "C:/my_search_dir"
under_test._on_begin_edit(None)
under_test._search_field.model.set_value(" ".join(search_words))
under_test._on_end_edit(None)
results = self._search_results.get_item_children(None)
self.assertEqual(len(results), 2)
# Remove first search
window_ref = ui_test.WindowRef(window, "")
close_ref = window_ref.find_all(f"**/Button[*].identifier=='search_word_button'")[0]
await close_ref.click()
results = self._search_results.get_item_children(None)
self.assertEqual(len(results), 1)
# Clear search
await self.wait_n_updates()
clear_ref = ui_test.WidgetRef(under_test._clear_button, "", window=window)
await clear_ref.click()
self.assertIsNone(self._search_results)
self._subscription = None
under_test.destroy()
|
omniverse-code/kit/exts/omni.kit.widget.search_delegate/docs/index.rst | omni.kit.widget.search_delegate
###############################
Base module that provides a search widget for searching the file system
.. toctree::
:maxdepth: 1
CHANGELOG
.. automodule:: omni.kit.widget.search_delegate
:platform: Windows-x86_64, Linux-x86_64
:members:
:show-inheritance:
:undoc-members:
.. autoclass:: SearchField
:members:
|
omniverse-code/kit/exts/omni.graph/PACKAGE-LICENSES/omni.graph-LICENSE.md | Copyright (c) 2020, 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. |
omniverse-code/kit/exts/omni.graph/config/extension.toml | [package]
title = "OmniGraph Python"
version = "1.50.2"
category = "Graph"
readme = "docs/README.md"
description = "Contains the implementation of the OmniGraph core (Python Support)."
preview_image = "data/preview.png"
repository = ""
keywords = ["kit", "omnigraph", "core"]
# Main Python module, available as "import omni.graph.core"
[[python.module]]
name = "omni.graph.core"
# Other extensions on which this one relies
[dependencies]
"omni.graph.core" = {}
"omni.graph.tools" = {}
"omni.kit.test" = {}
"omni.kit.commands" = {}
"omni.kit.usd_undo" = {}
"omni.usd" = {}
"omni.client" = {}
"omni.kit.async_engine" = {}
"omni.kit.stage_templates" = {}
"omni.kit.pip_archive" = {}
[python.pipapi]
requirements = ["numpy"] # SWIPAT filed under: http://nvbugs/3193231
[[test]]
stdoutFailPatterns.exclude = [
"*Ignore this error/warning*",
]
pyCoverageFilter = ["omni.graph"] # Restrict coverage to omni.graph only
[documentation]
deps = [
["kit-sdk", "_build/docs/kit-sdk/latest"], # WAR to include omni.graph.core refs until that workflow is moved
]
pages = [
"docs/Overview.md",
"docs/commands.rst",
"docs/omni.graph.core.bindings.rst",
"docs/autonode.rst",
"docs/controller.rst",
"docs/running_one_script.rst",
"docs/runtimeInitialize.rst",
"docs/testing.rst",
"docs/CHANGELOG.md",
]
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/_omni_graph_core.pyi | """pybind11 omni.graph.core bindings"""
from __future__ import annotations
import omni.graph.core._omni_graph_core
import typing
import carb.events._events
import numpy
import omni.core._core
import omni.graph.core._omni_graph_core._internal
import omni.graph.core._omni_graph_core._og_unstable
import omni.inspect._omni_inspect
_Shape = typing.Tuple[int, ...]
__all__ = [
"ACCORDING_TO_CONTEXT_GRAPH_INDEX",
"APPLIED_SCHEMA",
"ASSET",
"AUTHORING_GRAPH_INDEX",
"Attribute",
"AttributeData",
"AttributePortType",
"AttributeRole",
"AttributeType",
"BOOL",
"BUNDLE",
"BaseDataType",
"BucketId",
"BundleChangeType",
"COLOR",
"CONNECTION",
"ComputeGraph",
"ConnectionInfo",
"ConnectionType",
"DOUBLE",
"ERROR",
"EXECUTION",
"ExecutionAttributeState",
"ExtendedAttributeType",
"FLOAT",
"FRAME",
"FileFormatVersion",
"Graph",
"GraphBackingType",
"GraphContext",
"GraphEvaluationMode",
"GraphEvent",
"GraphPipelineStage",
"GraphRegistry",
"GraphRegistryEvent",
"HALF",
"IBundle2",
"IBundleChanges",
"IBundleFactory",
"IBundleFactory2",
"IConstBundle2",
"INFO",
"INSTANCING_GRAPH_TARGET_PATH",
"INT",
"INT64",
"INodeCategories",
"ISchedulingHints",
"ISchedulingHints2",
"IVariable",
"MATRIX",
"MemoryType",
"NONE",
"NORMAL",
"Node",
"NodeEvent",
"NodeType",
"OBJECT_ID",
"OmniGraphBindingError",
"PATH",
"POSITION",
"PRIM",
"PRIM_TYPE_NAME",
"PtrToPtrKind",
"QUATERNION",
"RELATIONSHIP",
"Severity",
"TAG",
"TARGET",
"TEXCOORD",
"TEXT",
"TIMECODE",
"TOKEN",
"TRANSFORM",
"Type",
"UCHAR",
"UINT",
"UINT64",
"UNKNOWN",
"VECTOR",
"WARNING",
"acquire_interface",
"attach",
"deregister_node_type",
"deregister_post_load_file_format_upgrade_callback",
"deregister_pre_load_file_format_upgrade_callback",
"detach",
"eAccessLocation",
"eAccessType",
"eComputeRule",
"ePurityStatus",
"eThreadSafety",
"eVariableScope",
"get_all_graphs",
"get_all_graphs_and_subgraphs",
"get_bundle_tree_factory_interface",
"get_compute_graph_contexts",
"get_global_orchestration_graphs",
"get_global_orchestration_graphs_in_pipeline_stage",
"get_graph_by_path",
"get_graphs_in_pipeline_stage",
"get_node_by_path",
"get_node_categories_interface",
"get_node_type",
"get_registered_nodes",
"is_global_graph_prim",
"on_shutdown",
"register_node_type",
"register_post_load_file_format_upgrade_callback",
"register_pre_load_file_format_upgrade_callback",
"register_python_node",
"release_interface",
"set_test_failure",
"shutdown_compute_graph",
"test_failure_count",
"update"
]
class Attribute():
"""
An attribute, defining a data type and value that belongs to a node
"""
def __bool__(self) -> bool: ...
def __eq__(self, arg0: Attribute) -> bool: ...
def __hash__(self) -> int: ...
def __repr__(self) -> str: ...
def connect(self, path: Attribute, modify_usd: bool) -> bool:
"""
Connects this attribute with another attribute. Assumes regular connection type.
Args:
path (omni.graph.core.Attribute): The destination attr
modify_usd (bool): Whether to create USD.
Returns:
bool: True for success, False for fail
"""
@staticmethod
def connectEx(*args, **kwargs) -> typing.Any:
"""
Connects this attribute with another attribute. Allows for different connection types.
Args:
info (omni.graph.core.ConnectionInfo): The ConnectionInfo object that contains both the attribute and the connection type
modify_usd (bool): Whether to modify the underlying USD with this connection
Returns:
bool: True for success, False for fail
"""
def connectPrim(self, path: str, modify_usd: bool, write: bool) -> bool:
"""
Connects this attribute to a prim that can represent a bundle connection or just a plain prim relationship
Args:
path (str): The path to the prim
modify_usd (bool): Whether to modify USD.
write (bool): Whether this connection represents a bundle
Returns:
bool: True for success, False for fail
"""
def deprecation_message(self) -> str:
"""
Gets the deprecation message on an attribute, if it is deprecated.
Typically this message gives guidance as to what the user should do instead of using the deprecated attribute.
Returns:
str: The message associated with a deprecated attribute
"""
def disconnect(self, attribute: Attribute, modify_usd: bool) -> bool:
"""
Disconnects this attribute from another attribute.
Args:
attribute (omni.graph.core.Attribute): The destination attribute of the connection to remove
modify_usd (bool): Whether to modify USD
Returns:
bool: True for success, False for fail
"""
def disconnectPrim(self, path: str, modify_usd: bool, write: bool) -> bool:
"""
Disconnects this attribute to a prim that can represent a bundle connection or just a plain prim relationship
Args:
path (str): The path to the prim
modify_usd (bool): Whether to modify USD.
write (bool): Whether this connection represents a bundle
Returns:
bool: True for success, False for fail
"""
@staticmethod
def ensure_port_type_in_name(name: str, port_type: AttributePortType, is_bundle: bool) -> str:
"""
Return the attribute name with the port type namespace prepended if it isn't already present.
Args:
name (str): The attribute name, with or without the port prefix
port_type (omni.graph.core.AttributePortType): The port type of the attribute
is_bundle (bool): true if the attribute name is to be used in a bundle. Note that colon is an illegal character
in bundled attributes so an underscore is used instead.
Returns:
str: The name with the proper prefix for the given port type
"""
def get(self, on_gpu: bool = False, instance: int = 18446744073709551614) -> object:
"""
Get the value of the attribute
Args:
on_gpu (bool): Is the data to be retrieved from the GPU?
instance (int): an instance index when getting value on an instantiated graph
Returns:
Any: Value of the attribute's data
"""
def get_all_metadata(self) -> dict:
"""
Gets the attribute's metadata
Returns:
dict[str,str]: A dictionary of name:value metadata on the attribute
"""
@staticmethod
def get_array(*args, **kwargs) -> typing.Any:
"""
Gets the value of an array attribute
Args:
on_gpu (bool): Is the data to be retrieved from the GPU?
get_for_write (bool): Should the data be retrieved for writing?
reserved_element_count (int): If the data is to be retrieved for writing, preallocate this many elements
instance (int): an instance index when getting value on an instantiated graph
Returns:
list[Any]: Value of the array attribute's data
"""
@staticmethod
def get_attribute_data(*args, **kwargs) -> typing.Any:
"""
Get the AttributeData object that can access the attribute's data
Args:
instance (int): an instance index when getting value on an instantiated graph
Returns:
omni.graph.core.AttributeData: The underlying attribute data accessor object for this attribute
"""
def get_disable_dynamic_downstream_work(self) -> bool:
"""
Where we have dynamic scheduling, downstream nodes can have their execution disabled by turning on the flag
in the upstream attribute. Note you also have to call setDynamicDownstreamControl on the node to enable
this feature. See setDynamicDownstreamControl on INode for further information.
Returns:
bool: True if downstream nodes are disabled in dynamic scheduling, False otherwise
"""
def get_downstream_connection_count(self) -> int:
"""
Gets the number of downstream connections to this attribute
Returns:
int: the number of downstream connections on this attribute.
"""
def get_downstream_connections(self) -> typing.List[Attribute]:
"""
Gets the list of downstream connections to this attribute
Returns:
list[omni.graph.core.Attribute]: The list of downstream connections for this attribute.
"""
@staticmethod
def get_downstream_connections_info(*args, **kwargs) -> typing.Any:
"""
Returns the list of downstream connections for this attribute, with detailed connection information
such as the connection type.
Returns:
list[omni.graph.core.ConnectionInfo]: A list of the downstream ConnectionInfo objects
"""
def get_extended_type(self) -> ExtendedAttributeType:
"""
Get the extended type of the attribute
Returns:
omni.graph.core.ExtendedAttributeType: Extended type of the attribute data object
"""
def get_handle(self) -> int:
"""
Get a handle to the attribute
Returns:
int: An opaque handle to the attribute
"""
def get_metadata(self, key: str) -> str:
"""
Returns the metadata value for the given key.
Args:
key: (str) The metadata keyword
Returns:
str: Metadata value for the given keyword, or None if it is not defined
"""
def get_metadata_count(self) -> int:
"""
Gets the number of metadata values on the attribute
Returns:
int: the number of metadata values currently defined on the attribute.
"""
def get_name(self) -> str:
"""
Get the attribute's name
Returns:
str: The name of the current attribute.
"""
@staticmethod
def get_node(*args, **kwargs) -> typing.Any:
"""
Gets the node to which this attribute belongs
Returns:
omni.graph.core.Node: The node associated with the attribute
"""
def get_path(self) -> str:
"""
Get the path to the attribute
Returns:
str: The full path to the attribute, including the node path.
"""
def get_port_type(self) -> AttributePortType:
"""
Gets the attribute's port type (input, output, or state)
Returns:
omni.graph.core.AttributePortType: The port type of the attribute.
"""
@staticmethod
def get_port_type_from_name(name: str) -> AttributePortType:
"""
Parse the port type from the given attribute name if present. The port type is indicated by a prefix seperated by
a colon or underscore in the case of bundled attributes.
Args:
name The attribute name
Returns:
omni.graph.core.AttributePortType: The port type indicated by the attribute prefix if present.
AttributePortType.UNKNOWN if there is no recognized prefix.
"""
@staticmethod
def get_resolved_type(*args, **kwargs) -> typing.Any:
"""
Get the resolved type of the attribute
Returns:
omni.graph.core.Type: Resolved type of the attribute data object, or the hardcoded type for regular attributes
"""
def get_type_name(self) -> str:
"""
Get the name of the attribute's type
Returns:
str: The type name of the current attribute.
"""
def get_union_types(self) -> object:
"""
Get the list of types accepted by a union attribute
Returns:
list[str]: The list of accepted types for the attribute if it is an extended union type, else None
"""
def get_upstream_connection_count(self) -> int:
"""
Gets the number of upstream connections to this attribute
Returns:
int: the number of upstream connections on this attribute.
"""
def get_upstream_connections(self) -> typing.List[Attribute]:
"""
Gets the list of upstream connections to this attribute
Returns:
list[omni.graph.core.Attribute]: The list of upstream connections for this attribute.
"""
@staticmethod
def get_upstream_connections_info(*args, **kwargs) -> typing.Any:
"""
Returns the list of upstream connections for this attribute, with detailed connection information
such as the connection type.
Returns:
list[omni.graph.core.ConnectionInfo]: A list of the upstream ConnectionInfo objects
"""
def is_array(self) -> bool:
"""
Checks if the attribute is an array type.
Returns:
bool: True if the attribute data type is an array
"""
def is_compatible(self, attribute: Attribute) -> bool:
"""
Checks to see if this attribute is compatible with another one, in particular the data types they use
Args:
attribute (omni.graph.core.Attribute): Attribute for which compatibility is to be checked
Returns:
bool: True if this attribute is compatible with "attribute"
"""
def is_connected(self, attribute: Attribute) -> bool:
"""
Checks to see if this attribute has a connection to another attribute
Args:
attribute (Attribute): Attribute for which the connection is to be checked
Returns:
bool: True if this attribute is connected to another, either as source or destination
"""
def is_deprecated(self) -> bool:
"""
Checks whether an attribute is deprecated. Deprecated attributes should not be used as
they will be removed in a future version.
Returns:
bool: True if the attribute is deprecated
"""
def is_dynamic(self) -> bool:
"""
Checks to see if an attribute is dynamic
Returns:
bool: True if the current attribute is a dynamic attribute (not in the node type definition).
"""
def is_runtime_constant(self) -> bool:
"""
Checks is this attribute is a runtime constant.
Runtime constants will keep the same value every frame, for every instance.
This property can be taken advantage of in vectorized compute.
Returns:
bool: True if the attribute is a runtime constant
"""
def is_valid(self) -> bool:
"""
Checks if the current attribute is valid.
Returns:
bool: True if the attribute reference points to a valid attribute object
"""
def register_value_changed_callback(self, func: object) -> None:
"""
Registers a function that will be invoked when the value of the given attribute changes.
Note that an attribute can have one and only one callback. Subsequent calls will replace
previously set callbacks. Passing None for the function argument will clear the existing
callback.
Args:
func (callable): A function with one argument representing the attribute that changed.
"""
@staticmethod
def remove_port_type_from_name(name: str, is_bundle: bool) -> str:
"""
Find the attribute name with the port type removed if it is present. For example "inputs:attr" becomes "attr"
Args:
name (str): The attribute name, with or without the port prefix
is_bundle (bool): True if the attribute name is to be used in a bundle. Note that colon is an illegal character
in bundled attributes so an underscore is used instead.
Returns:
str: The name with the port type prefix removed
"""
def set(self, value: object, on_gpu: bool = False, instance: int = 18446744073709551614) -> bool:
"""
Sets the value of the attribute's data
Args:
value (Any): New value of the attribute's data
on_gpu (bool): Is the data to be set on the GPU?
instance (int): an instance index when setting value on an instantiated graph
Returns:
bool: True if the value was successfully set
"""
def set_default(self, value: object, on_gpu: bool = False) -> bool:
"""
Sets the default value of the attribute's data (value when not connected)
Args:
value (Any): New value of the default attribute's data
on_gpu (bool): Is the data to be set on the GPU?
Returns:
bool: True if the value was successfully set
"""
def set_disable_dynamic_downstream_work(self, disable: bool) -> None:
"""
Where we have dynamic scheduling, downstream nodes can have their execution disabled by turning on the flag
in the upstream attribute. Note you also have to call setDynamicDownstreamControl on the node to enable
this feature. This function allows you to set the flag on the attribute that will disable the downstream
node. See setDynamicDownstreamControl on INode for further information.
Args:
disable (bool): Whether to disable downstream connected nodes in dynamic scheduling.
"""
def set_metadata(self, key: str, value: str) -> bool:
"""
Sets the metadata value for the given key
Args:
key (str): The metadata keyword
value (str): The value of the metadata
"""
@staticmethod
def set_resolved_type(*args, **kwargs) -> typing.Any:
"""
Sets the resolved type for the extended attribute.
Only valid for attributes with union/any extended types, who's
type has not yet been resolved. Should only be called from on_connection_type_resolve() callback. This operation
is async and may fail if the type cannot be resolved as requested.
Args:
resolved_type (omni.graph.core.Type): The type to resolve the attribute to
"""
def update_attribute_value(self, update_immediately: bool) -> bool:
"""
Requests the value of an attribute. In the cases of lazy evaluation systems, this
generates the "pull" that causes the attribute to update its value.
Args:
update_immediately (bool): Whether to update the attribute value immediately. If True, the function
will block until the attribute is update and then return. If False, the
attribute will be updated in the next update loop.
Returns:
Any: The value of the attribute
"""
@staticmethod
def write_complete(attributes: typing.Sequence) -> None:
"""
Warn the framework that writing to the provided attributes is done, so it can trigger callbacks attached to them
Args:
attributes (list[omni.graph.core.Attribute]): List of attributes that are done writing
"""
@property
def gpu_ptr_kind(self) -> omni::fabric::PtrToPtrKind:
"""
Defines the memory space that GPU array data pointers live in
:type: omni::fabric::PtrToPtrKind
"""
@gpu_ptr_kind.setter
def gpu_ptr_kind(self, arg1: omni::fabric::PtrToPtrKind) -> None:
"""
Defines the memory space that GPU array data pointers live in
"""
@property
def is_optional_for_compute(self) -> bool:
"""
Flag that is set when an attribute need not be valid for compute() to happen. bool:
:type: bool
"""
@is_optional_for_compute.setter
def is_optional_for_compute(self, arg1: bool) -> None:
"""
Flag that is set when an attribute need not be valid for compute() to happen. bool:
"""
resolved_prefix = '__resolved_'
pass
class AttributeData():
"""
Reference to data defining an attribute's value
"""
def __bool__(self) -> bool: ...
def __eq__(self, arg0: AttributeData) -> bool: ...
def __hash__(self) -> int: ...
def as_read_only(self) -> AttributeData:
"""
Returns read-only variant of the attribute data.
Returns:
AttributeData: Read-only variant of the attribute data.
"""
def copy_data(self, rhs: AttributeData) -> bool:
"""
Copies the AttributeData data into this object's data.
Args:
rhs (omni.graph.core.AttributeData): Attribute data to be copied - must be the same type as the current object to work
Returns:
bool: True if the data was successfully copied, else False.
"""
def cpu_valid(self) -> bool:
"""
Returns whether this attribute data object is currently valid on the cpu.
Returns:
bool: True if the data represented by this object currently has a valid value in CPU memory
"""
def get(self, on_gpu: bool = False) -> object:
"""
Gets the current value of the attribute data
Args:
on_gpu (bool): Is the data to be retrieved from the GPU?
Returns:
Any: Value of the attribute data
"""
@staticmethod
def get_array(*args, **kwargs) -> typing.Any:
"""
Gets the current value of the attribute data.
Args:
on_gpu (bool): Is the data to be retrieved from the GPU?
get_for_write (bool): Should the data be retrieved for writing?
reserved_element_count (int): If the data is to be retrieved for writing, preallocate this many elements
Returns:
Any: Value of the array attribute data
"""
def get_extended_type(self) -> ExtendedAttributeType:
"""
Returns the extended type of the current attribute data.
Returns:
omni.graph.core.ExtendedAttributeType: Extended type of the attribute data object
"""
def get_name(self) -> str:
"""
Returns the name of the current attribute data.
Returns:
str: Name of the attribute data object
"""
def get_resolved_type(self) -> Type:
"""
Returns the resolved type of the extended attribute data. Only valid for attributes with union/any extended types.
Returns:
omni.graph.core.Type: Resolved type of the attribute data object
"""
def get_type(self) -> Type:
"""
Returns the type of the current attribute data.
Returns:
omni.graph.core.Type: Type of the attribute data object
"""
def gpu_valid(self) -> bool:
"""
Returns whether this attribute data object is currently valid on the gpu.
Returns:
bool: True if the data represented by this object currently has a valid value in GPU memory
"""
def is_read_only(self) -> bool:
"""
Returns whether this attribute data object is read-only or not.
Returns:
bool: True if the data represented by this object is read-only
"""
def is_valid(self) -> bool:
"""
Returns whether this attribute data object is valid or not.
Returns:
bool: True if the data represented by this object is valid
"""
def resize(self, element_count: int) -> bool:
"""
Sets the number of elements in the array represented by this object.
Args:
element_count (int): Number of elements to reserve in the array
Returns:
bool: True if the array was resized, False if not (e.g. if the attribute data was not an array type)
"""
def set(self, value: object, on_gpu: bool = False) -> bool:
"""
Sets the value of the attribute data
Args:
value (Any): New value of the attribute data
on_gpu (bool): Is the data to be set on the GPU?
Returns:
bool: True if the value was successfully set
"""
def size(self) -> int:
"""
Returns the size of the data represented by this object (1 if it's not an array).
Returns:
int: Number of elements in the data
"""
@property
def gpu_ptr_kind(self) -> PtrToPtrKind:
"""
Defines the memory space that GPU array data pointers live in
:type: PtrToPtrKind
"""
@gpu_ptr_kind.setter
def gpu_ptr_kind(self, arg1: PtrToPtrKind) -> None:
"""
Defines the memory space that GPU array data pointers live in
"""
pass
class AttributePortType():
"""
Port side of the attribute on its node
Members:
ATTRIBUTE_PORT_TYPE_INPUT : Deprecated: use og.AttributePortType.INPUT
ATTRIBUTE_PORT_TYPE_OUTPUT : Deprecated: use og.AttributePortType.OUTPUT
ATTRIBUTE_PORT_TYPE_STATE : Deprecated: use og.AttributePortType.STATE
ATTRIBUTE_PORT_TYPE_UNKNOWN : Deprecated: use og.AttributePortType.UNKNOWN
INPUT : Attribute is an input
OUTPUT : Attribute is an output
STATE : Attribute is state
UNKNOWN : Attribute port type is unknown
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ATTRIBUTE_PORT_TYPE_INPUT: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: 0>
ATTRIBUTE_PORT_TYPE_OUTPUT: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: 1>
ATTRIBUTE_PORT_TYPE_STATE: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: 2>
ATTRIBUTE_PORT_TYPE_UNKNOWN: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: 3>
INPUT: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: 0>
OUTPUT: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: 1>
STATE: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: 2>
UNKNOWN: omni.graph.core._omni_graph_core.AttributePortType # value = <AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: 3>
__members__: dict # value = {'ATTRIBUTE_PORT_TYPE_INPUT': <AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: 0>, 'ATTRIBUTE_PORT_TYPE_OUTPUT': <AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: 1>, 'ATTRIBUTE_PORT_TYPE_STATE': <AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: 2>, 'ATTRIBUTE_PORT_TYPE_UNKNOWN': <AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: 3>, 'INPUT': <AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: 0>, 'OUTPUT': <AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: 1>, 'STATE': <AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: 2>, 'UNKNOWN': <AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: 3>}
pass
class AttributeRole():
"""
Interpretation applied to the attribute data
Members:
APPLIED_SCHEMA : Data is to be interpreted as an applied schema
BUNDLE : Data is to be interpreted as an OmniGraph Bundle
COLOR : Data is to be interpreted as RGB or RGBA color
EXECUTION : Data is to be interpreted as an Action Graph execution pin
FRAME : Data is to be interpreted as a 4x4 matrix representing a reference frame
MATRIX : Data is to be interpreted as a square matrix of values
NONE : Data has no special role
NORMAL : Data is to be interpreted as a normal vector
OBJECT_ID : Data is to be interpreted as a unique object identifier
PATH : Data is to be interpreted as a path to a USD element
POSITION : Data is to be interpreted as a position or point vector
PRIM_TYPE_NAME : Data is to be interpreted as the name of a prim type
QUATERNION : Data is to be interpreted as a rotational quaternion
TARGET : Data is to be interpreted as a relationship target path
TEXCOORD : Data is to be interpreted as texture coordinates
TEXT : Data is to be interpreted as a text string
TIMECODE : Data is to be interpreted as a time code
TRANSFORM : Deprecated
VECTOR : Data is to be interpreted as a simple vector
UNKNOWN : Data role is currently unknown
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
APPLIED_SCHEMA: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.APPLIED_SCHEMA: 11>
BUNDLE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.BUNDLE: 16>
COLOR: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.COLOR: 4>
EXECUTION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.EXECUTION: 13>
FRAME: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.FRAME: 8>
MATRIX: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.MATRIX: 14>
NONE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.NONE: 0>
NORMAL: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.NORMAL: 2>
OBJECT_ID: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.OBJECT_ID: 15>
PATH: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.PATH: 17>
POSITION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.POSITION: 3>
PRIM_TYPE_NAME: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.PRIM_TYPE_NAME: 12>
QUATERNION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.QUATERNION: 6>
TARGET: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TARGET: 20>
TEXCOORD: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TEXCOORD: 5>
TEXT: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TEXT: 10>
TIMECODE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TIMECODE: 9>
TRANSFORM: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TRANSFORM: 7>
UNKNOWN: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.UNKNOWN: 21>
VECTOR: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.VECTOR: 1>
__members__: dict # value = {'APPLIED_SCHEMA': <AttributeRole.APPLIED_SCHEMA: 11>, 'BUNDLE': <AttributeRole.BUNDLE: 16>, 'COLOR': <AttributeRole.COLOR: 4>, 'EXECUTION': <AttributeRole.EXECUTION: 13>, 'FRAME': <AttributeRole.FRAME: 8>, 'MATRIX': <AttributeRole.MATRIX: 14>, 'NONE': <AttributeRole.NONE: 0>, 'NORMAL': <AttributeRole.NORMAL: 2>, 'OBJECT_ID': <AttributeRole.OBJECT_ID: 15>, 'PATH': <AttributeRole.PATH: 17>, 'POSITION': <AttributeRole.POSITION: 3>, 'PRIM_TYPE_NAME': <AttributeRole.PRIM_TYPE_NAME: 12>, 'QUATERNION': <AttributeRole.QUATERNION: 6>, 'TARGET': <AttributeRole.TARGET: 20>, 'TEXCOORD': <AttributeRole.TEXCOORD: 5>, 'TEXT': <AttributeRole.TEXT: 10>, 'TIMECODE': <AttributeRole.TIMECODE: 9>, 'TRANSFORM': <AttributeRole.TRANSFORM: 7>, 'VECTOR': <AttributeRole.VECTOR: 1>, 'UNKNOWN': <AttributeRole.UNKNOWN: 21>}
pass
class AttributeType():
"""
Utilities for operating with the attribute data type class omni.graph.core.Type and related types
"""
@staticmethod
def base_data_size(type: Type) -> int:
"""
Figure out how much space a base data type occupies in memory inside Fabric.
This will not necessarily be the same as the space occupied by the Python data, which is only transient.
Multiply by the tuple count and the array element count to get the full size of any given piece of data.
Args:
type (omni.graph.core.Type): The type object whose base data type size is to be found
Returns:
int: Number of bytes one instance of the base data type occupies in Fabric
"""
@staticmethod
def get_unions() -> dict:
"""
Returns a dictionary containing the names and contents of the ogn attribute union types.
Returns:
dict[str, list[str]]: Dictionary that maps the attribute union names to list of associated ogn types
"""
@staticmethod
def is_legal_ogn_type(type: Type) -> bool:
"""
Check to see if the type combination has a legal representation in OGN.
Args:
type (omni.graph.core.Type): The type object to be checked
Returns:
bool: True if the type represents a legal OGN type, otherwise False
"""
@staticmethod
def sdf_type_name_from_type(type: Type) -> object:
"""
Given an attribute type find the corresponding SDF type name for it, None if there is none, e.g. a 'bundle'
Args:
type (omni.graph.core.Type): The type to be converted
Returns:
str: The SDF type name of the type, or None if there is no corresponding SDF type
"""
@staticmethod
def type_from_ogn_type_name(ogn_type_name: str) -> Type:
"""
Parse an OGN attribute type name into the corresponding omni.graph.core.Type description.
Args:
ogn_type_name (str): The OGN-style attribute type name to be converted
Returns:
omni.graph.core.Type: Type corresponding to the attribute type name in OGN format.
Type object will be the unknown type if the type name could be be parsed.
"""
@staticmethod
def type_from_sdf_type_name(sdf_type_name: str) -> Type:
"""
Parse an SDF attribute type name into the corresponding omni.graph.core.Type description.
Note that SDF types are not capable of representing some of the valid types - use typeFromOgnTypeName()
for a more comprehensive type name description.
Args:
sdf_type_name (str): The SDF-style attribute type name to be converted
Returns:
omni.graph.core.Type: Type corresponding to the attribute type name in SDF format.
Type object will be the unknown type if the type name could be be parsed.
"""
pass
class BaseDataType():
"""
Basic data type for attribute data
Members:
ASSET : Data represents an Asset
BOOL : Data is a boolean
CONNECTION : Data is a special value representing a connection
DOUBLE : Data is a double precision floating point value
FLOAT : Data is a single precision floating point value
HALF : Data is a half precision floating point value
INT : Data is a 32-bit integer
INT64 : Data is a 64-bit integer
PRIM : Data is a reference to a USD prim
RELATIONSHIP : Data is a relationship to a USD prim
TAG : Data is a special Fabric tag
TOKEN : Data is a reference to a unique shared string
UCHAR : Data is an 8-bit unsigned character
UINT : Data is a 32-bit unsigned integer
UINT64 : Data is a 64-bit unsigned integer
UNKNOWN : Data type is currently unknown
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ASSET: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.ASSET: 12>
BOOL: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.BOOL: 1>
CONNECTION: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.CONNECTION: 14>
DOUBLE: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.DOUBLE: 9>
FLOAT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.FLOAT: 8>
HALF: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.HALF: 7>
INT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.INT: 3>
INT64: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.INT64: 5>
PRIM: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.PRIM: 13>
RELATIONSHIP: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.RELATIONSHIP: 11>
TAG: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.TAG: 15>
TOKEN: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.TOKEN: 10>
UCHAR: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UCHAR: 2>
UINT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UINT: 4>
UINT64: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UINT64: 6>
UNKNOWN: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UNKNOWN: 0>
__members__: dict # value = {'ASSET': <BaseDataType.ASSET: 12>, 'BOOL': <BaseDataType.BOOL: 1>, 'CONNECTION': <BaseDataType.CONNECTION: 14>, 'DOUBLE': <BaseDataType.DOUBLE: 9>, 'FLOAT': <BaseDataType.FLOAT: 8>, 'HALF': <BaseDataType.HALF: 7>, 'INT': <BaseDataType.INT: 3>, 'INT64': <BaseDataType.INT64: 5>, 'PRIM': <BaseDataType.PRIM: 13>, 'RELATIONSHIP': <BaseDataType.RELATIONSHIP: 11>, 'TAG': <BaseDataType.TAG: 15>, 'TOKEN': <BaseDataType.TOKEN: 10>, 'UCHAR': <BaseDataType.UCHAR: 2>, 'UINT': <BaseDataType.UINT: 4>, 'UINT64': <BaseDataType.UINT64: 6>, 'UNKNOWN': <BaseDataType.UNKNOWN: 0>}
pass
class BucketId():
"""
Internal Use - Unique identifier of the bucket of Fabric data
"""
def __init__(self, id: int) -> None:
"""
Set up the initial value of the bucket id
Args:
id (int): Unique identifier of a bucket of Fabric data
"""
@property
def id(self) -> int:
"""
Internal Use - Unique identifier of a bucket of Fabric data
:type: int
"""
@id.setter
def id(self, arg0: int) -> None:
"""
Internal Use - Unique identifier of a bucket of Fabric data
"""
pass
class BundleChangeType():
"""
Enumeration representing the type of change that occurred in a bundle.
This enumeration is used to identify the kind of modification that has taken place in a bundle or attribute.
It's used as the return type for functions that check bundles and attributes, signaling whether those have been
modified or not.
Members:
NONE : Indicates that no change has occurred in the bundle.
MODIFIED : Indicates that the bundle has been modified.
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
MODIFIED: omni.graph.core._omni_graph_core.BundleChangeType # value = <BundleChangeType.MODIFIED: 1>
NONE: omni.graph.core._omni_graph_core.BundleChangeType # value = <BundleChangeType.NONE: 0>
__members__: dict # value = {'NONE': <BundleChangeType.NONE: 0>, 'MODIFIED': <BundleChangeType.MODIFIED: 1>}
pass
class ComputeGraph():
"""
Main OmniGraph interface registered with the extension system
"""
pass
class ConnectionInfo():
"""
Attribute and connection type in a given graph connection
"""
def __init__(self, attr: Attribute, connection_type: ConnectionType) -> None:
"""
Set up the connection info data
Args:
attr (omni.graph.core.Attribute): Attribute in the connection
connection_type (omni.graph.core.ConnectionType): Type of connection
"""
@property
def attr(self) -> Attribute:
"""
Attribute being connected
:type: Attribute
"""
@attr.setter
def attr(self, arg0: Attribute) -> None:
"""
Attribute being connected
"""
@property
def connection_type(self) -> ConnectionType:
"""
Type of connection
:type: ConnectionType
"""
@connection_type.setter
def connection_type(self, arg0: ConnectionType) -> None:
"""
Type of connection
"""
pass
class ConnectionType():
"""
Type of connection)
Members:
CONNECTION_TYPE_REGULAR : Normal connection
CONNECTION_TYPE_DATA_ONLY : Connection only represents data access, not execution flow
CONNECTION_TYPE_EXECUTION : Connection only represents execution flow, not data access
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
CONNECTION_TYPE_DATA_ONLY: omni.graph.core._omni_graph_core.ConnectionType # value = <ConnectionType.CONNECTION_TYPE_DATA_ONLY: 1>
CONNECTION_TYPE_EXECUTION: omni.graph.core._omni_graph_core.ConnectionType # value = <ConnectionType.CONNECTION_TYPE_EXECUTION: 2>
CONNECTION_TYPE_REGULAR: omni.graph.core._omni_graph_core.ConnectionType # value = <ConnectionType.CONNECTION_TYPE_REGULAR: 0>
__members__: dict # value = {'CONNECTION_TYPE_REGULAR': <ConnectionType.CONNECTION_TYPE_REGULAR: 0>, 'CONNECTION_TYPE_DATA_ONLY': <ConnectionType.CONNECTION_TYPE_DATA_ONLY: 1>, 'CONNECTION_TYPE_EXECUTION': <ConnectionType.CONNECTION_TYPE_EXECUTION: 2>}
pass
class ExecutionAttributeState():
"""
Current execution state of an attribute [DEPRECATED: See omni.graph.action.IActionGraph]
Members:
DISABLED : Execution is disabled
ENABLED : Execution is enabled
ENABLED_AND_PUSH : Output attribute connection is enabled and the node is pushed to the evaluation stack
LATENT_PUSH : Push this node as a latent event for the current entry point
LATENT_FINISH : Output attribute connection is enabled and the latent state is finished for this node
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
DISABLED: omni.graph.core._omni_graph_core.ExecutionAttributeState # value = <ExecutionAttributeState.DISABLED: 0>
ENABLED: omni.graph.core._omni_graph_core.ExecutionAttributeState # value = <ExecutionAttributeState.ENABLED: 1>
ENABLED_AND_PUSH: omni.graph.core._omni_graph_core.ExecutionAttributeState # value = <ExecutionAttributeState.ENABLED_AND_PUSH: 2>
LATENT_FINISH: omni.graph.core._omni_graph_core.ExecutionAttributeState # value = <ExecutionAttributeState.LATENT_FINISH: 4>
LATENT_PUSH: omni.graph.core._omni_graph_core.ExecutionAttributeState # value = <ExecutionAttributeState.LATENT_PUSH: 3>
__members__: dict # value = {'DISABLED': <ExecutionAttributeState.DISABLED: 0>, 'ENABLED': <ExecutionAttributeState.ENABLED: 1>, 'ENABLED_AND_PUSH': <ExecutionAttributeState.ENABLED_AND_PUSH: 2>, 'LATENT_PUSH': <ExecutionAttributeState.LATENT_PUSH: 3>, 'LATENT_FINISH': <ExecutionAttributeState.LATENT_FINISH: 4>}
pass
class ExtendedAttributeType():
"""
Extended attribute type, if any
Members:
EXTENDED_ATTR_TYPE_REGULAR : Deprecated: use og.ExtendedAttributeType.REGULAR
EXTENDED_ATTR_TYPE_UNION : Deprecated: use og.ExtendedAttributeType.UNION
EXTENDED_ATTR_TYPE_ANY : Deprecated: use og.ExtendedAttributeType.ANY
REGULAR : Attribute has a fixed data type
UNION : Attribute has a list of allowable types of data
ANY : Attribute can take any type of data
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ANY: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY: 2>
EXTENDED_ATTR_TYPE_ANY: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY: 2>
EXTENDED_ATTR_TYPE_REGULAR: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_REGULAR: 0>
EXTENDED_ATTR_TYPE_UNION: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION: 1>
REGULAR: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_REGULAR: 0>
UNION: omni.graph.core._omni_graph_core.ExtendedAttributeType # value = <ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION: 1>
__members__: dict # value = {'EXTENDED_ATTR_TYPE_REGULAR': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_REGULAR: 0>, 'EXTENDED_ATTR_TYPE_UNION': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION: 1>, 'EXTENDED_ATTR_TYPE_ANY': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY: 2>, 'REGULAR': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_REGULAR: 0>, 'UNION': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION: 1>, 'ANY': <ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY: 2>}
pass
class FileFormatVersion():
"""
Version number for the OmniGraph file format
"""
def __eq__(self, arg0: FileFormatVersion) -> bool: ...
def __gt__(self, arg0: FileFormatVersion) -> bool: ...
def __init__(self, major_version: int, minor_version: int) -> None:
"""
Set up the values defining the file format version
Args:
major_version (int): Major version, introduces incompatibilities
minor_version (int): Minor version, introduces compatible changes only
"""
def __lt__(self, arg0: FileFormatVersion) -> bool: ...
def __neq__(self, arg0: FileFormatVersion) -> bool: ...
def __str__(self) -> str: ...
@property
def majorVersion(self) -> int:
"""
Major version, introduces incompatibilities
:type: int
"""
@majorVersion.setter
def majorVersion(self, arg0: int) -> None:
"""
Major version, introduces incompatibilities
"""
@property
def minorVersion(self) -> int:
"""
Minor version, introduces compatible changes only
:type: int
"""
@minorVersion.setter
def minorVersion(self, arg0: int) -> None:
"""
Minor version, introduces compatible changes only
"""
__hash__ = None
pass
class Graph():
"""
Object containing everything necessary to execute a connected set of nodes.
"""
def __bool__(self) -> bool: ...
def __eq__(self, arg0: Graph) -> bool: ...
def __hash__(self) -> int: ...
def __repr__(self) -> str: ...
def change_pipeline_stage(self, newPipelineStage: GraphPipelineStage) -> None:
"""
Change the pipeline stage that this graph is in (simulation, pre-render, post-render, on-demand)
Args:
newPipelineStage (omni.graph.core.GraphPipelineStage): The new pipeline stage of the graph
"""
def create_graph_as_node(self, name: str, path: str, evaluator: str, is_global_graph: bool, is_backed_by_usd: bool, backing_type: GraphBackingType, pipeline_stage: GraphPipelineStage, evaluation_mode: GraphEvaluationMode = GraphEvaluationMode.GRAPH_EVALUATION_MODE_AUTOMATIC) -> Node:
"""
Creates a graph that is wrapped by a node in the current graph.
Args:
name (str): The name of the node
path (str): The path to the graph
evaluator (str): The name of the evaluator to use for the graph
is_global_graph (bool): Whether this is a global graph
is_backed_by_usd (bool): Whether the constructs are to be backed by USD
backing_type (omni.graph.core.GraphBackingType): The kind of cache backing this graph
pipeline_stage (omni.graph.core.GraphPipelineStage): What stage in the pipeline the global graph is at
(simulation, pre-render, post-render)
evaluation_mode (omni.graph.core.GraphEvaluationMode): What mode to use when evaluating the graph
Returns:
omni.graph.core.Node: Node wrapping the graph that was created
"""
def create_node(self, path: str, node_type: str, use_usd: bool) -> Node:
"""
Given the path to the node and the type of the node, creates a node of that type at that path.
Args:
path (str): The path to the node
node_type (str): The type of the node
use_usd (bool): Whether or not to create the USD backing for the node
Returns:
omni.graph.core.Node: The newly created node
"""
def create_subgraph(self, subgraphPath: str, evaluator: str = '', createUsd: bool = True) -> Graph:
"""
Given the path to the subgraph, create the subgraph at that path.
Args:
subgraphPath (str): The path to the subgraph
evaluator (str): The evaluator type
createUsd (bool): Whether or not to create the USD backing for the node
Returns:
omni.graph.core.Graph: Subgraph object created for the given path.
"""
@staticmethod
def create_variable(*args, **kwargs) -> typing.Any:
"""
Creates a variable on the graph.
Args:
name (str): The name of the variable
type (omni.graph.core.Type): The type of the variable to create.
Returns:
omni.graph.core.IVariable: A reference to the newly created variable, or None if the variable could not be created.
"""
def deregister_error_status_change_callback(self, status_change_handle: int) -> None:
"""
De-registers the error status change callback to be invoked when the error status of nodes change during evaluation.
Args:
status_change_handle (int): The handle that was returned during the register_error_status_change_callback call
"""
def destroy_node(self, node_path: str, update_usd: bool) -> bool:
"""
Given the path to the node, destroys the node at that path.
Args:
node_path (str): The path to the node
update_usd (bool): Whether or not to destroy the USD backing for the node
Returns:
bool: True if the node was successfully destroyed
"""
def evaluate(self) -> None:
"""
Tick the graph by causing it to evaluate.
"""
def find_variable(self, name: str) -> IVariable:
"""
Find the variable with the given name in the graph.
Args:
name (str): The name of the variable to find.
Returns:
omni.graph.core.IVariable | None: The variable with the given name, or None if not found.
"""
@staticmethod
def get_context(*args, **kwargs) -> typing.Any:
"""
Gets the context associated to the graph
Returns:
omni.graph.core.GraphContext: The context associated to the graph
"""
@staticmethod
def get_default_graph_context(*args, **kwargs) -> typing.Any:
"""
Gets the default context associated with this graph
Returns:
omni.graph.core.GraphContext: The default graph context associated with this graph.
"""
def get_evaluator_name(self) -> str:
"""
Gets the name of the evaluator being used on this graph
Returns:
str: The name of the graph evaluator (dirty_push, push, execution)
"""
def get_event_stream(self) -> carb.events._events.IEventStream:
"""
Get the event stream the graph uses for notification of changes.
Returns:
carb.events.IEventStream: Event stream to monitor for graph changes
"""
def get_graph_backing_type(self) -> GraphBackingType:
"""
Gets the data type backing this graph
Returns:
omni.graph.core.GraphBackingType: Returns the type of data structure backing this graph
"""
def get_handle(self) -> int:
"""
Gets a unique handle identifier for this graph
Returns:
int: Unique handle identifier for this graph
"""
def get_instance_count(self) -> int:
"""
Gets the number of instances this graph has
Returns:
int: The number of instances the graph has (0 if the graph is standalone).
"""
def get_node(self, path: str) -> Node:
"""
Given a path to the node, returns the object for the node.
Args:
path (str): The path to the node
Returns:
omni.graph.core.Node: Node object for the given path, None if it does not exist
"""
def get_nodes(self) -> typing.List[Node]:
"""
Gets the list of nodes currently in this graph
Returns:
list[omni.graph.core.Node]: The nodes in this graph.
"""
def get_owning_compound_node(self) -> Node:
"""
Returns the compound node for which this graph is the compound subgraph of.
Returns:
(og.Node) If this graph is a compound graph, the owning compound node. Otherwise, this an invalid node is returned.
"""
def get_parent_graph(self) -> object:
"""
Gets the immediate parent graph of this graph
Returns:
omni.graph.core.Graph | None: The immediate parent graph of this graph (may be None)
"""
def get_path_to_graph(self) -> str:
"""
Gets the path to this graph
Returns:
str: The path to this graph (may be empty).
"""
def get_pipeline_stage(self) -> GraphPipelineStage:
"""
Gets the pipeline stage to which this graph belongs
Returns:
omni.graph.core.PipelineStage: The type of pipeline stage of this graph (simulation, pre-render, post-render)
"""
def get_subgraph(self, path: str) -> Graph:
"""
Gets the subgraph living at the given path below this graph
Args:
path (str): Path to the subgraph to find
Returns:
omni.graph.core.Graph | None: Subgraph at the path, or None if not found
"""
def get_subgraphs(self) -> typing.List[Graph]:
"""
Gets the list of subgraphs under this graph
Returns:
list[omni.graph.core.Graph]: List of graphs that are subgraphs of this graph
"""
def get_variables(self) -> typing.List[IVariable]:
"""
Returns the list of variables defined on the graph.
Returns:
list[omni.graph.core.IVariable]: The current list of variables on the graph.
"""
def inspect(self, inspector: omni.inspect._omni_inspect.IInspector) -> bool:
"""
Runs the inspector on the graph
Args:
inspector (omni.inspect.Inspector): The inspector to run
Returns:
bool: True if the inspector was successfully run on the graph, False if it is not supported
"""
def is_auto_instanced(self) -> bool:
"""
Returns whether this graph is an auto instance or not. An auto instance is a graph that got merged as an instance with all other similar graphs in the stage.
Returns:
bool: True if this graph is an auto instance
"""
def is_compound_graph(self) -> bool:
"""
Returns whether this graph is a compound graph. A compound graph is subgraph that controlled by a compound node.
Returns:
bool: True if this graph is a compound graph
"""
def is_disabled(self) -> bool:
"""
Checks to see if the graph is disabled
Returns:
bool: True if this graph object is disabled.
"""
def is_valid(self) -> bool:
"""
Checks to see if the graph object is valid
Returns:
bool: True if this graph object is valid.
"""
def register_error_status_change_callback(self, callback: object) -> int:
"""
Registers a callback to be invoked after graph evaluation for all the nodes whose error status changed
during the evaluation. The callback receives a list of the nodes whose error status changed.
Args:
callback (callable): The callback function
Returns:
int: A handle that can be used for deregistration. Note the calling module is responsible for deregistration
of the callback in all circumstances, including where the extension is hot-reloaded.
"""
def reload_from_stage(self) -> None:
"""
Force the graph to reload by deleting it and re-parsing from the stage.
This is potentially destructive if you have internal state information in any nodes.
"""
def reload_settings(self) -> None:
"""
Reload the graph settings.
"""
def remove_variable(self, variable: IVariable) -> bool:
"""
Removes the given variable from the graph.
Args:
variable (omni.graph.core.IVariable): The variable to remove.
Returns:
bool: True if the variable was successfully removed, False otherwise.
"""
def rename_node(self, path: str, new_path: str) -> bool:
"""
Given the path to the node, renames the node at that path.
Args:
path (str): The path to the node
new_path (str): The new path
Returns:
bool: True if the node was successfully renamed
"""
def rename_subgraph(self, path: str, new_path: str) -> bool:
"""
Renames the path of a subgraph
Args:
path (str): Path to the subgraph being renamed
new_path (str): New path for the subgraph
"""
def set_auto_instancing_allowed(self, arg0: bool) -> bool:
"""
Allows (or not) this graph to be an auto-instance, ie. to be executed vectorized as an instance amongst all other identical graph
Args:
allowed (bool): Whether this graph is allowed to be an auto instance.
Returns:
bool: Whether this graph was allowed to be an auto instance before this call.
"""
def set_disabled(self, disable: bool) -> None:
"""
Sets whether this graph object is to be disabled or not.
Args:
disable (bool): True if the graph is to be disabled
"""
def set_usd_notice_handling_enabled(self, enable: bool) -> None:
"""
Sets whether this graph object has USD notice handling enabled.
Args:
enable (bool): True to enable USD notice handling, False to disable.
"""
def usd_notice_handling_enabled(self) -> bool:
"""
Checks whether this graph has USD notice handling enabled.
Returns:
bool: True if USD notice handling is enabled on this graph.
"""
@property
def evaluation_mode(self) -> GraphEvaluationMode:
"""
omni.graph.core.GraphEvaluationMode: The evaluation mode sets how the graph will be evaluated.
GRAPH_EVALUATION_MODE_AUTOMATIC - Evaluate the graph in Standalone mode when there are no relationships to it,
otherwise it will be evaluated in Instanced mode.
GRAPH_EVALUATION_MODE_STANDALONE - Evaluates the graph with the graph Prim as the graph target, and ignore Prims with relationships
to the graph Prim. Use this mode when constructing self-contained graphs that evaluate independently.
GRAPH_EVALUATION_MODE_INSTANCED - Evaluates only when the graph there are relationships from OmniGraphAPI interfaces. Each Prim with
a relationship to the graph Prim will cause an evaluation, with the Graph Target set to path of Prim with the OmniGraphAPI interface.
Use this mode when the graph represents as an asset or template that can be applied to multiple Prims.
:type: GraphEvaluationMode
"""
@evaluation_mode.setter
def evaluation_mode(self, arg1: GraphEvaluationMode) -> None:
"""
omni.graph.core.GraphEvaluationMode: The evaluation mode sets how the graph will be evaluated.
GRAPH_EVALUATION_MODE_AUTOMATIC - Evaluate the graph in Standalone mode when there are no relationships to it,
otherwise it will be evaluated in Instanced mode.
GRAPH_EVALUATION_MODE_STANDALONE - Evaluates the graph with the graph Prim as the graph target, and ignore Prims with relationships
to the graph Prim. Use this mode when constructing self-contained graphs that evaluate independently.
GRAPH_EVALUATION_MODE_INSTANCED - Evaluates only when the graph there are relationships from OmniGraphAPI interfaces. Each Prim with
a relationship to the graph Prim will cause an evaluation, with the Graph Target set to path of Prim with the OmniGraphAPI interface.
Use this mode when the graph represents as an asset or template that can be applied to multiple Prims.
"""
pass
class GraphBackingType():
"""
Location of the data backing the graph
Members:
GRAPH_BACKING_TYPE_FLATCACHE_SHARED : Deprecated: Use GRAPH_BACKING_TYPE_FABRIC_SHARED
GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY : Deprecated: Use GRAPH_BACKING_TYPE_FABRIC_WITH_HISTORY
GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY : Deprecated: Use GRAPH_BACKING_TYPE_FABRIC_WITHOUT_HISTORY
GRAPH_BACKING_TYPE_FABRIC_SHARED : Data is a regular Fabric instance
GRAPH_BACKING_TYPE_FABRIC_WITH_HISTORY : Data is a Fabric instance without any history
GRAPH_BACKING_TYPE_FABRIC_WITHOUT_HISTORY : Data is a Fabric instance with a ring buffer of history
GRAPH_BACKING_TYPE_NONE : No data is stored for the graph
GRAPH_BACKING_TYPE_UNKNOWN : The data backing is not currently known
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
GRAPH_BACKING_TYPE_FABRIC_SHARED: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_SHARED: 0>
GRAPH_BACKING_TYPE_FABRIC_WITHOUT_HISTORY: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY: 2>
GRAPH_BACKING_TYPE_FABRIC_WITH_HISTORY: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY: 1>
GRAPH_BACKING_TYPE_FLATCACHE_SHARED: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_SHARED: 0>
GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY: 2>
GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY: 1>
GRAPH_BACKING_TYPE_NONE: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_NONE: 4>
GRAPH_BACKING_TYPE_UNKNOWN: omni.graph.core._omni_graph_core.GraphBackingType # value = <GraphBackingType.GRAPH_BACKING_TYPE_UNKNOWN: 3>
__members__: dict # value = {'GRAPH_BACKING_TYPE_FLATCACHE_SHARED': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_SHARED: 0>, 'GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY: 1>, 'GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY: 2>, 'GRAPH_BACKING_TYPE_FABRIC_SHARED': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_SHARED: 0>, 'GRAPH_BACKING_TYPE_FABRIC_WITH_HISTORY': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITH_HISTORY: 1>, 'GRAPH_BACKING_TYPE_FABRIC_WITHOUT_HISTORY': <GraphBackingType.GRAPH_BACKING_TYPE_FLATCACHE_WITHOUT_HISTORY: 2>, 'GRAPH_BACKING_TYPE_NONE': <GraphBackingType.GRAPH_BACKING_TYPE_NONE: 4>, 'GRAPH_BACKING_TYPE_UNKNOWN': <GraphBackingType.GRAPH_BACKING_TYPE_UNKNOWN: 3>}
pass
class GraphContext():
"""
Execution context for a graph
"""
def __bool__(self) -> bool: ...
def __eq__(self, arg0: GraphContext) -> bool: ...
def __hash__(self) -> int: ...
def get_attribute_as_bool(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> bool:
"""
get_attribute_as_bool is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_boolarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[bool]:
"""
get_attribute_as_boolarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_double(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> float:
"""
get_attribute_as_double is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_doublearray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float64]:
"""
get_attribute_as_doublearray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_float(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> float:
"""
get_attribute_as_float is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_floatarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float32]:
"""
get_attribute_as_floatarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_half(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> float:
"""
get_attribute_as_half is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_halfarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float32]:
"""
get_attribute_as_halfarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_int(self, arg0: Attribute, arg1: bool, arg2: bool, arg3: int) -> int:
"""
get_attribute_as_int is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_int64(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> int:
"""
get_attribute_as_int64 is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_int64array(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.int64]:
"""
get_attribute_as_int64array is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_intarray(self, arg0: Attribute, arg1: bool, arg2: bool, arg3: int) -> numpy.ndarray[numpy.int32]:
"""
get_attribute_as_intarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_nested_doublearray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float64]:
"""
get_attribute_as_nested_doublearray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_nested_floatarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float32]:
"""
get_attribute_as_nested_floatarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_nested_halfarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.float32]:
"""
get_attribute_as_nested_halfarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_nested_intarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.int32]:
"""
get_attribute_as_nested_intarray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_string(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> str:
"""
get_attribute_as_string is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uchar(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> int:
"""
get_attribute_as_uchar is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uchararray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.uint8]:
"""
get_attribute_as_uchararray is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uint(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> int:
"""
get_attribute_as_uint is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uint64(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> int:
"""
get_attribute_as_uint64 is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uint64array(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.uint64]:
"""
get_attribute_as_uint64array is deprecated. Use og.Controller.get() instead.
"""
def get_attribute_as_uintarray(self, attribute: Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) -> numpy.ndarray[numpy.uint32]:
"""
get_attribute_as_uintarray is deprecated. Use og.Controller.get() instead.
"""
def get_bundle(self, path: str) -> IBundle2:
"""
Get the bundle object as read-write.
Args:
path (str): the path to the bundle
Returns:
omni.graph.core.IBundle2: The bundle object at the path, None if there isn't one
"""
def get_elapsed_time(self) -> float:
"""
Returns the time between last evaluation of the graph and "now"
Returns:
float: the elapsed time
"""
@staticmethod
@typing.overload
def get_elem_count(*args, **kwargs) -> typing.Any:
"""
get_elem_count is deprecated. Use og.Controller.get_array_size() instead.
get_elem_count is deprecated. Use og.Controller.get_array_size() instead.
"""
@typing.overload
def get_elem_count(self, arg0: Attribute) -> int: ...
def get_frame(self) -> float:
"""
Returns the global playback time in frames
Returns:
float: the global playback time in frames
"""
def get_graph(self) -> Graph:
"""
Gets the graph associated with this graph context
Returns:
omni.graph.core.Graph: The graph associated with this graph context.
"""
def get_graph_target(self, index: int = 18446744073709551614) -> str:
"""
Get the Prim path of the graph target.
The graph target is defined as the parent Prim of the compute graph, except during
instancing - where OmniGraph executes a graph once for each Prim. In the case
of instancing, the graph target will change at each execution to be the path of the instance.
If this is called outside of graph execution, the path of the graph Prim is returned, or an empty
token if the graph does not have a Prim associated with it.
Args:
index (int): The index of instance to fetch. By default, the graph context index is used.
Returns:
str: The prim path of the current graph target.
"""
@typing.overload
def get_input_bundle(self, path: str) -> IConstBundle2:
"""
Get the bundle object as read only.
Args:
path (str): the path to the bundle
Returns:
omni.graph.core.IBundle2: The bundle object at the path, None if there isn't one
Get a bundle object that is an input attribute.
Args:
node (omni.graph.core.Node): the node on which the bundle can be found
attribute_name (str): the name of the input attribute
instance (int): an instance index when getting value on an instantiated graph
Returns:
omni.graph.core.IConstBundle2: The bundle object at the path, None if there isn't one
"""
@typing.overload
def get_input_bundle(self, node: Node, attribute_name: str, instance: int = 18446744073709551614) -> IConstBundle2: ...
def get_input_target_bundles(self, node: Node, attribute_name: str, instance: int = 18446744073709551614) -> typing.List[IConstBundle2]:
"""
Get all input targets in the relationship with the given name on the specified compute node.
The targets are returned as bundle objects.
Args:
node (omni.graph.core.Node): the node on which the input targets can be found
attribute_name (str): the name of the relationship attribute
instance (int): an instance index when getting value on an instantiated graph
Returns:
list[omni.graph.core.IConstBundle2]: The list of input targets, as bundle objects.
"""
def get_is_playing(self) -> bool:
"""
Returns the state of global playback
Returns:
bool: True if playback has started, False is playback is stopped
"""
@typing.overload
def get_output_bundle(self, path: str) -> IBundle2:
"""
Get a bundle object that is an output attribute.
Args:
path (str): the path to the bundle
Returns:
omni.graph.core.IBundle2: The bundle object at the path, None if there isn't one
Get a bundle object that is an output attribute.
Args:
node (omni.graph.core.Node): the node on which the bundle can be found
attribute_name (str): the name of the output attribute
instance (int): an instance index when getting value on an instantiated graph
Returns:
omni.graph.core.IBundle2: The bundle object at the path, None if there isn't one
"""
@typing.overload
def get_output_bundle(self, node: Node, attribute_name: str, instance: int = 18446744073709551614) -> IBundle2: ...
def get_time(self) -> float:
"""
Returns the global playback time
Returns:
float: the global playback time in seconds
"""
def get_time_since_start(self) -> float:
"""
Returns the elapsed time since the app started
Returns:
float: the number of seconds since the app started in seconds
"""
def inspect(self, inspector: omni.inspect._omni_inspect.IInspector) -> bool:
"""
Runs the inspector on the graph context
Args:
inspector (omni.inspect.Inspector): The inspector to run
Returns:
bool: True if the inspector was successfully run on the context, False if it is not supported
"""
def is_valid(self) -> bool:
"""
Checks to see if this graph context object is valid
Returns:
bool: True if this object is valid
"""
def set_bool_attribute(self, arg0: bool, arg1: Attribute) -> None:
"""
set_bool_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_boolarray_attribute(self, arg0: typing.List[bool], arg1: Attribute) -> None:
"""
set_boolarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_double_attribute(self, arg0: float, arg1: Attribute) -> None:
"""
set_double_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_double_matrix_attribute(self, arg0: typing.List[float], arg1: Attribute) -> None:
"""
set_double_matrix_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_doublearray_attribute(self, arg0: typing.List[float], arg1: Attribute) -> None:
"""
set_doublearray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_float_attribute(self, arg0: float, arg1: Attribute) -> None:
"""
set_float_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_floatarray_attribute(self, arg0: typing.List[float], arg1: Attribute) -> None:
"""
set_floatarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_half_attribute(self, arg0: float, arg1: Attribute) -> None:
"""
set_half_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_halfarray_attribute(self, arg0: typing.List[float], arg1: Attribute) -> None:
"""
set_halfarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_int64_attribute(self, arg0: int, arg1: Attribute) -> None:
"""
set_int64_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_int64array_attribute(self, arg0: typing.List[int], arg1: Attribute) -> None:
"""
set_int64array_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_int_attribute(self, arg0: int, arg1: Attribute) -> None:
"""
set_int_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_intarray_attribute(self, arg0: typing.List[int], arg1: Attribute) -> None:
"""
set_intarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_nested_doublearray_attribute(self, arg0: typing.List[typing.List[float]], arg1: Attribute) -> None:
"""
set_nested_doublearray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_nested_floatarray_attribute(self, arg0: typing.List[typing.List[float]], arg1: Attribute) -> None:
"""
set_nested_floatarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_nested_halfarray_attribute(self, arg0: typing.List[typing.List[float]], arg1: Attribute) -> None:
"""
set_nested_halfarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_nested_intarray_attribute(self, arg0: typing.List[typing.List[int]], arg1: Attribute) -> None:
"""
set_nested_intarray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_string_attribute(self, arg0: str, arg1: Attribute) -> None:
"""
set_string_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uchar_attribute(self, arg0: int, arg1: Attribute) -> None:
"""
set_uchar_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uchararray_attribute(self, arg0: typing.List[int], arg1: Attribute) -> None:
"""
set_uchararray_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uint64_attribute(self, arg0: int, arg1: Attribute) -> None:
"""
set_uint64_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uint64array_attribute(self, arg0: typing.List[int], arg1: Attribute) -> None:
"""
set_uint64array_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uint_attribute(self, arg0: int, arg1: Attribute) -> None:
"""
set_uint_attribute is deprecated. Use og.Controller.set() instead.
"""
def set_uintarray_attribute(self, arg0: typing.List[int], arg1: Attribute) -> None:
"""
set_uintarray_attribute is deprecated. Use og.Controller.set() instead.
"""
@staticmethod
def write_bucket_to_backing(*args, **kwargs) -> typing.Any:
"""
Forces the given bucket to be written to the backing storage. Raises ValueError if the bucket could not be found.
Args:
bucket_id (int): The bucket id of the bucket to be written
"""
pass
class GraphEvaluationMode():
"""
How the graph evaluation is scheduled
Members:
GRAPH_EVALUATION_MODE_AUTOMATIC : Evaluation is scheduled based on graph type
GRAPH_EVALUATION_MODE_STANDALONE : Evaluation is scheduled as a single graph
GRAPH_EVALUATION_MODE_INSTANCED : Evaluation is scheduled by instances
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
GRAPH_EVALUATION_MODE_AUTOMATIC: omni.graph.core._omni_graph_core.GraphEvaluationMode # value = <GraphEvaluationMode.GRAPH_EVALUATION_MODE_AUTOMATIC: 0>
GRAPH_EVALUATION_MODE_INSTANCED: omni.graph.core._omni_graph_core.GraphEvaluationMode # value = <GraphEvaluationMode.GRAPH_EVALUATION_MODE_INSTANCED: 2>
GRAPH_EVALUATION_MODE_STANDALONE: omni.graph.core._omni_graph_core.GraphEvaluationMode # value = <GraphEvaluationMode.GRAPH_EVALUATION_MODE_STANDALONE: 1>
__members__: dict # value = {'GRAPH_EVALUATION_MODE_AUTOMATIC': <GraphEvaluationMode.GRAPH_EVALUATION_MODE_AUTOMATIC: 0>, 'GRAPH_EVALUATION_MODE_STANDALONE': <GraphEvaluationMode.GRAPH_EVALUATION_MODE_STANDALONE: 1>, 'GRAPH_EVALUATION_MODE_INSTANCED': <GraphEvaluationMode.GRAPH_EVALUATION_MODE_INSTANCED: 2>}
pass
class GraphEvent():
"""
Graph modification event.
Members:
CREATE_VARIABLE : Variable was created
REMOVE_VARIABLE : Variable was removed
VARIABLE_TYPE_CHANGE : Variable type was changed
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
CREATE_VARIABLE: omni.graph.core._omni_graph_core.GraphEvent # value = <GraphEvent.CREATE_VARIABLE: 0>
REMOVE_VARIABLE: omni.graph.core._omni_graph_core.GraphEvent # value = <GraphEvent.REMOVE_VARIABLE: 1>
VARIABLE_TYPE_CHANGE: omni.graph.core._omni_graph_core.GraphEvent # value = <GraphEvent.VARIABLE_TYPE_CHANGE: 5>
__members__: dict # value = {'CREATE_VARIABLE': <GraphEvent.CREATE_VARIABLE: 0>, 'REMOVE_VARIABLE': <GraphEvent.REMOVE_VARIABLE: 1>, 'VARIABLE_TYPE_CHANGE': <GraphEvent.VARIABLE_TYPE_CHANGE: 5>}
pass
class GraphPipelineStage():
"""
Pipeline stage in which the graph lives
Members:
GRAPH_PIPELINE_STAGE_SIMULATION : The regular evaluation stage
GRAPH_PIPELINE_STAGE_PRERENDER : The stage that evaluates just before rendering
GRAPH_PIPELINE_STAGE_POSTRENDER : The stage that evaluates just after rendering
GRAPH_PIPELINE_STAGE_ONDEMAND : The stage evaluating only when requested
GRAPH_PIPELINE_STAGE_UNKNOWN : The stage is not currently known
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
GRAPH_PIPELINE_STAGE_ONDEMAND: omni.graph.core._omni_graph_core.GraphPipelineStage # value = <GraphPipelineStage.GRAPH_PIPELINE_STAGE_ONDEMAND: 200>
GRAPH_PIPELINE_STAGE_POSTRENDER: omni.graph.core._omni_graph_core.GraphPipelineStage # value = <GraphPipelineStage.GRAPH_PIPELINE_STAGE_POSTRENDER: 30>
GRAPH_PIPELINE_STAGE_PRERENDER: omni.graph.core._omni_graph_core.GraphPipelineStage # value = <GraphPipelineStage.GRAPH_PIPELINE_STAGE_PRERENDER: 20>
GRAPH_PIPELINE_STAGE_SIMULATION: omni.graph.core._omni_graph_core.GraphPipelineStage # value = <GraphPipelineStage.GRAPH_PIPELINE_STAGE_SIMULATION: 10>
GRAPH_PIPELINE_STAGE_UNKNOWN: omni.graph.core._omni_graph_core.GraphPipelineStage # value = <GraphPipelineStage.GRAPH_PIPELINE_STAGE_UNKNOWN: 100>
__members__: dict # value = {'GRAPH_PIPELINE_STAGE_SIMULATION': <GraphPipelineStage.GRAPH_PIPELINE_STAGE_SIMULATION: 10>, 'GRAPH_PIPELINE_STAGE_PRERENDER': <GraphPipelineStage.GRAPH_PIPELINE_STAGE_PRERENDER: 20>, 'GRAPH_PIPELINE_STAGE_POSTRENDER': <GraphPipelineStage.GRAPH_PIPELINE_STAGE_POSTRENDER: 30>, 'GRAPH_PIPELINE_STAGE_ONDEMAND': <GraphPipelineStage.GRAPH_PIPELINE_STAGE_ONDEMAND: 200>, 'GRAPH_PIPELINE_STAGE_UNKNOWN': <GraphPipelineStage.GRAPH_PIPELINE_STAGE_UNKNOWN: 100>}
pass
class GraphRegistry():
"""
Manager of the node types registered to OmniGraph.
"""
def __init__(self) -> None: ...
def get_event_stream(self) -> carb.events._events.IEventStream:
"""
Get the event stream for the graph registry change notification.
The events that are raised are specified by GraphRegistryEvent. The payload for the
added and removed events is the name of the node type being added or removed, and uses
the key "node_type".
Returns:
carb.events.IEventStream: Event stream to monitor for graph registry changes
"""
def get_node_type_version(self, node_type_name: str) -> int:
"""
Finds the version number of the given node type.
Args:
node_type_name (str): Name of the node type to check
Returns:
int: Version number registered for the node type, None if it is not registered
"""
def inspect(self, inspector: omni.inspect._omni_inspect.IInspector) -> bool:
"""
Runs the inspector on the graph registry
Args:
inspector (omni.inspect.Inspector): The inspector to run
Returns:
bool: True if the inspector was successfully run on the graph registry, False if it is not supported
"""
pass
class GraphRegistryEvent():
"""
Graph Registry modification event.
Members:
NODE_TYPE_ADDED : Node type was registered
NODE_TYPE_REMOVED : Node type was deregistered
NODE_TYPE_NAMESPACE_CHANGED : Namespace of a node type changed
NODE_TYPE_CATEGORY_CHANGED : Category of a node type changed
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
NODE_TYPE_ADDED: omni.graph.core._omni_graph_core.GraphRegistryEvent # value = <GraphRegistryEvent.NODE_TYPE_ADDED: 0>
NODE_TYPE_CATEGORY_CHANGED: omni.graph.core._omni_graph_core.GraphRegistryEvent # value = <GraphRegistryEvent.NODE_TYPE_CATEGORY_CHANGED: 3>
NODE_TYPE_NAMESPACE_CHANGED: omni.graph.core._omni_graph_core.GraphRegistryEvent # value = <GraphRegistryEvent.NODE_TYPE_NAMESPACE_CHANGED: 2>
NODE_TYPE_REMOVED: omni.graph.core._omni_graph_core.GraphRegistryEvent # value = <GraphRegistryEvent.NODE_TYPE_REMOVED: 1>
__members__: dict # value = {'NODE_TYPE_ADDED': <GraphRegistryEvent.NODE_TYPE_ADDED: 0>, 'NODE_TYPE_REMOVED': <GraphRegistryEvent.NODE_TYPE_REMOVED: 1>, 'NODE_TYPE_NAMESPACE_CHANGED': <GraphRegistryEvent.NODE_TYPE_NAMESPACE_CHANGED: 2>, 'NODE_TYPE_CATEGORY_CHANGED': <GraphRegistryEvent.NODE_TYPE_CATEGORY_CHANGED: 3>}
pass
class IBundle2(_IBundle2, IConstBundle2, _IConstBundle2, omni.core._core.IObject):
"""
Provide read write access to recursive bundles.
"""
def __bool__(self) -> bool: ...
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
def add_attribute(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use create_attribute() instead.
"""
@staticmethod
def add_attributes(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use create_attributes() instead.
"""
def clear(self) -> None:
"""
DEPRECATED - use clear_contents() instead
"""
def clear_contents(self, bundle_metadata: bool = True, attributes: bool = True, child_bundles: bool = True) -> int:
"""
Removes all attributes and child bundles from this bundle, but keeps the bundle itself.
Args:
bundle_metadata (bool): Clears bundle metadata in this bundle.
attributes (bool): Clears attributes in this bundle.
child_bundles (bool): Clears child bundles in this bundle.
Returns:
omni.core.Result: Success if successfully cleared.
"""
@staticmethod
def copy_attribute(*args, **kwargs) -> typing.Any:
"""
Create new attribute by copying existing one, including its data.
Created attribute is owned by this bundle.
Args:
attribute (omni.graph.core.AttributeData): Attribute whose data type is to be copied.
overwrite (bool): Overwrite existing attribute in this bundle.
Returns:
omni.graph.core.AttributeData: Copied attribute.
Create new attribute by copying existing one, including its data.
Created attribute is owned by this bundle.
Args:
name (str): The new name for copied attribute.
attribute (omni.graph.core.AttributeData): Attribute whose data type is to be copied.
overwrite (bool): Overwrite existing attribute in this bundle.
Returns:
omni.graph.core.AttributeData: Copied attribute.
"""
@staticmethod
def copy_attributes(*args, **kwargs) -> typing.Any:
"""
Create new attributes by copying existing ones, including their data.
Names of new attributes are taken from source attributes.
Created attributes are owned by this bundle.
Args:
attributes (list[omni.graph.core.AttributeData]): Attributes whose data type is to be copied.
overwrite (bool): Overwrite existing attributes in this bundle.
Returns:
list[omni.graph.core.AttributeData]: A list of copied attributes.\
Create new attributes by copying existing ones, including their data, with possibility of giving them new names.
Created attributes are owned by this bundle.
Args:
names (list[str]): Names for the new attributes.
attributes (list[omni.graph.core.AttributeData]): Attributes whose data type is to be copied.
overwrite (bool): Overwrite existing attributes in this bundle.
Returns:
list[omni.graph.core.AttributeData]: A list of copied attributes.
"""
def copy_bundle(self, source_bundle: IConstBundle2, overwrite: bool = True) -> None:
"""
Copy bundle data and metadata from the source bundle to this bundle.
Args:
source_bundle (omni.graph.core.IConstBundle2): Bundle whose data is to be copied.
overwrite (bool): Overwrite existing content of the bundle.
"""
@typing.overload
def copy_child_bundle(self, bundle: IConstBundle2, name: typing.Optional[str] = None) -> IBundle2:
"""
Create new child bundle by copying existing one, with possibility of giving child a new name.
Created bundle is owned by this bundle.
Args:
bundle (omni.graph.core.IConstBundle2): Bundle whose data is to be copied.
name (str): Name of new child.
Returns:
omni.graph.core.IBundle2: Newly copied bundle.
Create new child bundle by copying existing one, with possibility of giving child a new name.
Created bundle is owned by this bundle.
Args:
name (str): Name of new child.
bundle (omni.graph.core.IConstBundle2): Bundle whose data is to be copied.
Returns:
omni.graph.core.IBundle2: Newly copied bundle.
"""
@typing.overload
def copy_child_bundle(self, name: str, bundle: IConstBundle2) -> IBundle2: ...
@typing.overload
def copy_child_bundles(self, bundles: typing.List[IConstBundle2], names: typing.Optional[typing.List[str]] = None) -> typing.List[IBundle2]:
"""
Create new child bundles by copying existing ones, with possibility of giving children new names.
Created bundles are owned by this bundle.
Args:
bundles (list[omni.graph.core.IConstBundle2]): Bundles whose data is to be copied.
names (list[str]): Names of new children.
Returns:
list[omni.graph.core.IBundle2]: Newly copied bundles.
Create new child bundles by copying existing ones, with possibility of giving children new names.
Created bundles are owned by this bundle.
Args:
names (list[str]): Names of new children.
bundles (list[omni.graph.core.IConstBundle2]): Bundles whose data is to be copied.
Returns:
list[omni.graph.core.IBundle2]: Newly copied bundles.
"""
@typing.overload
def copy_child_bundles(self, names: typing.List[str], bundles: typing.List[IConstBundle2]) -> typing.List[IBundle2]: ...
@staticmethod
def create_attribute(*args, **kwargs) -> typing.Any:
"""
Creates attribute based on provided name and type.
Created attribute is owned by this bundle.
Args:
name (str): Name of the attribute.
type (omni.graph.core.Type): Type of the attribute.
element_count (int): Number of elements in the array.
Returns:
omni.graph.core.AttributeData: Newly created attribute.
"""
@staticmethod
def create_attribute_like(*args, **kwargs) -> typing.Any:
"""
Use input attribute as pattern to create attribute in this bundle.
The name and type are taken from pattern attribute, data is not copied.
Created attribute is owned by this bundle.
Args:
pattern_attribute (omni.graph.core.AttributeData): Attribute whose name and type is to be used to create new attribute.
Returns:
omni.graph.core.AttributeData: Newly created attribute.
"""
@staticmethod
def create_attribute_metadata(*args, **kwargs) -> typing.Any:
"""
Create attribute metadata fields.
Args:
attribute (str): Name of the attribute.
field_names (list[str]): Names of new metadata field.
field_types (list[omni.graph.core.Type]): Types of new metadata field.
element_count (int): Number of elements in the arrray.
Returns:
list[omni.graph.core.AttributeData]: Newly created metadata fields.
Create attribute metadata field.
Args:
attribute (str): Name of the attribute.
field_name (str): Name of new metadata field.
field_type (omni.graph.core.Type): Type of new metadata field.
Returns:
omni.graph.core.AttributeData: Newly created metadata field.
"""
@staticmethod
def create_attributes(*args, **kwargs) -> typing.Any:
"""
Creates attributes based on provided names and types.
Created attributes are owned by this bundle.
Args:
names (list[str]): Names of the attributes.
types (list[omni.graph.core.Type]): Types of the attributes.
Returns:
list[omni.graph.core.AttributeData]: A list of created attributes.
"""
@staticmethod
def create_attributes_like(*args, **kwargs) -> typing.Any:
"""
Use input attributes as pattern to create attributes in this bundle.
Names and types for new attributes are taken from pattern attributes, data is not copied.
Created attributes are owned by this bundle.
Args:
pattern_attributes (list[omni.graph.core.AttributeData]): Attributes whose name and type is to be used to create new attributes.
Returns:
list[omni.graph.core.AttributeData]: A list of newly created attributes.
"""
@staticmethod
def create_bundle_metadata(*args, **kwargs) -> typing.Any:
"""
Creates bundle metadata fields based on provided names and types.
Created fields are owned by this bundle.
Args:
field_names (list[str]): Names of the fields.
field_types (list[omni.graph.core.Type]): Types of the fields.
element_count (int): Number of elements in the arrray.
Returns:
list[omni.graph.core.AttributeData]: A list of created fields.
Creates bundle metadata field based on provided name and type.
Created field are owned by this bundle.
Args:
field_name (str): Name of the field.
field_type (omni.graph.core.Type): Type of the field.
Returns:
omni.graph.core.AttributeData: Created field.
"""
def create_child_bundle(self, path: str) -> IBundle2:
"""
Creates immediate child bundle under specified path in this bundle.
Created bundle is owned by this bundle.
This method does not work recursively. Only immediate child can be created.
Args:
path (str): New child path in this bundle.
Returns:
omni.graph.core.IBundle2: Created child bundle.
"""
def create_child_bundles(self, paths: typing.List[str]) -> typing.List[IBundle2]:
"""
Creates immediate child bundles under specified paths in this bundle.
Created bundles are owned by this bundle.
This method does not work recursively. Only immediate children can be created.
Args:
paths (list[str]): New children paths in this bundle.
Returns:
list[omni.graph.core.IBundle2]: A list of created child bundles.
"""
@staticmethod
def get_attribute_by_name(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use get_attribute_by_name(name) instead
Searches for attribute in this bundle by using attribute name.
Args:
name (str): Attribute name to search for.
Returns:
omni.graph.core.AttributeData: An attribute. If attribute is not found then invalid attribute is returned.
"""
def get_attribute_data(self, write: bool = False) -> list:
"""
DEPRECATED - use get_attributes() instead
"""
def get_attribute_data_count(self) -> int:
"""
DEPRECATED - use get_attribute_count() instead
"""
@staticmethod
def get_attribute_metadata_by_name(*args, **kwargs) -> typing.Any:
"""
Search for metadata fields for the attribute by using field names.
Args:
attribute (str): Name of the attribute.
field_names (list[str]): Attribute metadata fields to be searched for.
Returns:
list[omni.graph.core.AttributeData]: Array of metadata fields in the attribute.
Search for metadata field for the attribute by using field name.
Args:
attribute (str): Name of the attribute.
field_name (str): Attribute metadata field to be searched for.
Returns:
omni.graph.core.AttributeData: Metadata fields in the attribute.
"""
def get_attribute_names_and_types(self) -> tuple:
"""
DEPRECATED - use get_attribute_names() or get_attribute_types() instead
"""
@staticmethod
def get_attributes(*args, **kwargs) -> typing.Any:
"""
Searches for attributes in this bundle by using attribute names.
Args:
names (list[str]): Attribute names to search for.
Returns:
list[omni.graph.core.AttributeData]: A list of found attributes.
"""
@staticmethod
def get_attributes_by_name(*args, **kwargs) -> typing.Any:
"""
Searches for attributes in this bundle by using attribute names.
Args:
names (list[str]): Attribute names to search for.
Returns:
list[omni.graph.core.AttributeData]: A list of found attributes.
"""
@staticmethod
def get_bundle_metadata_by_name(*args, **kwargs) -> typing.Any:
"""
Search for field handles in this bundle by using field names.
Args:
field_names (list[str]): Bundle metadata fields to be searched for.
Returns:
list[omni.graph.core.AttributeData]: Metadata fields in this bundle.
Search for field handle in this bundle by using field name.
Args:
field_name (str): Bundle metadata fields to be searched for.
Returns:
omni.graph.core.AttributeData: Metadata field in this bundle.
"""
def get_child_bundle(self, index: int) -> IBundle2:
"""
Get the child bundle by index.
Args:
index (int): Child bundle index in range [0, child_bundle_count).
Returns:
omni.graph.core.IBundle2: Child bundle under the index. If bundle index is out of range, then invalid bundle is returned.
"""
def get_child_bundle_by_name(self, name: str) -> IBundle2:
"""
Lookup for child under specified name.
Args:
path (str): Name to child bundle in this bundle.
Returns:
omni.graph.core.IBundle2: Child bundle in this bundle. If child does not exist under the path, then invalid bundle is returned.
"""
def get_child_bundles(self) -> typing.List[IBundle2]:
"""
Get all child bundle handles in this bundle.
Returns:
list[omni.graph.core.IBundle2]: A list of all child bundles in this bundle.
"""
def get_child_bundles_by_name(self, names: typing.List[str]) -> typing.List[IBundle2]:
"""
Lookup for children under specified names.
Args:
names (list[str]): Names of child bundles in this bundle.
Returns:
list[omni.graph.core.IBundle2]: A list of found child bundles in this bundle.
"""
def get_metadata_storage(self) -> IBundle2:
"""
DEPRECATED - DO NOT USE
"""
def get_parent_bundle(self) -> IBundle2:
"""
Get the parent of this bundle
Returns:
omni.graph.core.IBundle2: The parent of this bundle, or invalid bundle if there is no parent.
"""
def get_prim_path(self) -> str:
"""
DEPRECATED - use get_path() instead
"""
@staticmethod
def insert_attribute(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use copy_attribute() instead
"""
def insert_bundle(self, bundle_to_copy: IConstBundle2) -> None:
"""
DEPRECATED - use copy_bundle() instead.
"""
def is_read_only(self) -> bool:
"""
Returns if this interface is read-only.
"""
def is_valid(self) -> bool:
"""
DEPRECATED - use bool cast instead
"""
@staticmethod
def link_attribute(*args, **kwargs) -> typing.Any:
"""
Adds an attribute to this bundle as link with names taken from target attribute.
Added attribute is a link to other attribute that is part of another bundle.
The link is owned by this bundle, but target of the link is not.
Removing link from this bundle does not destroy the data link points to.
Args:
target_attribute (omni.graph.core.AttributeData): Attribute whose data is to be added.
Returns:
omni.graph.core.AttributeData: Attribute that is a link.
Adds an attribute to this bundle as link with custom name.
Added attribute is a link to other attribute that is part of another bundle.
The link is owned by this bundle, but target of the link is not.
Removing link from this bundle does not destroy the data link points to.
Args:
link_name (str): Name for new link.
target_attribute (omni.graph.core.AttributeData): Attribute whose data is to be added.
Returns:
omni.graph.core.AttributeData: Attribute that is a link.
"""
@staticmethod
def link_attributes(*args, **kwargs) -> typing.Any:
"""
Adds a set of attributes to this bundle as links with names taken from target attributes.
Added attributes are links to other attributes that are part of another bundle.
The links are owned by this bundle, but targets of the links are not.
Removing links from this bundle does not destroy the data links point to.
Args:
target_attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be added.
Returns:
list[omni.graph.core.AttributeData]: A list of attributes that are links.
Adds a set of attributes to this bundle as links with custom names.
Added attributes are links to other attributes that are part of another bundle.
The links are owned by this bundle, but targets of the links are not.
Removing links from this bundle does not destroy the data links point to.
Args:
link_names (list[str]):
target_attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be added.
Returns:
list[omni.graph.core.AttributeData]: A list of attributes that are links.
"""
@typing.overload
def link_child_bundle(self, name: str, bundle: IConstBundle2) -> IBundle2:
"""
Link a bundle as child in current bundle, under given name.
Args:
name (str): The name under which the child bundle should be linked
bundle (omni.graph.core.IConstBundle2): The bundle to link
Returns:
omni.graph.core.IBundle2: The linked bundle.
Link a bundle as child in current bundle.
Args:
bundle (omni.graph.core.IConstBundle2): The bundle to link
Returns:
omni.graph.core.IBundle2: The linked bundle.
"""
@typing.overload
def link_child_bundle(self, bundle: IConstBundle2) -> IBundle2: ...
@typing.overload
def link_child_bundles(self, names: typing.List[str], bundles: typing.List[IConstBundle2]) -> typing.List[IBundle2]:
"""
Link a set of bundles as child in current bundle, under given names.
Args:
names (list[str]): The names under which the child bundles should be linked
bundles (list[omni.graph.core.IConstBundle2]): The bundles to link
Returns:
list[omni.graph.core.IBundle2]: The list of created bundles.
Link a set of bundles as child in current bundle.
Args:
bundles (list[omni.graph.core.IConstBundle2]): The bundles to link
Returns:
list[omni.graph.core.IBundle2]: The list of created bundles.
"""
@typing.overload
def link_child_bundles(self, bundles: typing.List[IConstBundle2]) -> typing.List[IBundle2]: ...
def remove_all_attributes(self) -> int:
"""
Remove all attributes from this bundle.
Returns:
int: Number of attributes successfully removed.
"""
def remove_all_child_bundles(self) -> int:
"""
Remove all child bundles from this bundle.
Only empty bundles can be removed.
Returns:
int: Number of child bundles successfully removed.
"""
@typing.overload
def remove_attribute(self, name: str) -> None:
"""
DEPRECATED - use remove_attribute_by_name() instead.
Looks up the attribute and if it is part of this bundle then remove it.
Attribute handle that is not part of this bundle is ignored.
Args:
attribute (omni.graph.core.AttributeData): Attribute whose data is to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
@staticmethod
@typing.overload
def remove_attribute(*args, **kwargs) -> typing.Any: ...
@typing.overload
def remove_attribute_metadata(self, attribute: str, field_names: typing.List[str]) -> int:
"""
Remove attribute metadata fields.
Args:
attribute (str): Name of the attribute.
field_names (list[str]): Names of the fields to be removed.
Returns:
int: Number of fields successfully removed.
Remove attribute metadata field.
Args:
attribute (str): Name of the attribute.
field_name (str): Name of the field to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
@typing.overload
def remove_attribute_metadata(self, attribute: str, field_name: str) -> int: ...
@typing.overload
def remove_attributes(self, names: typing.List[str]) -> None:
"""
DEPRECATED - use remove_attributes_by_name() instead.
Looks up the attributes and if they are part of this bundle then remove them.
Attribute handles that are not part of this bundle are ignored.
Args:
attributes (list[omni.graph.core.AttributeData]): Attributes whose data is to be removed.
Returns:
int: number of removed attributes
"""
@staticmethod
@typing.overload
def remove_attributes(*args, **kwargs) -> typing.Any: ...
def remove_attributes_by_name(self, names: typing.List[str]) -> int:
"""
Looks up the attributes by names and remove their data and metadata.
Args:
names (list[str]): Names of the attributes whose data is to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
@typing.overload
def remove_bundle_metadata(self, field_names: typing.List[str]) -> int:
"""
Looks up bundle metadata fields and if they are part of this bundle metadata then remove them.
Fields that are not part of this bundle are ignored.
Args:
field_names (list[str]): Names of the fields whose data is to be removed.
Returns:
int: Number of fields successfully removed.
Looks up bundle metadata field and if it is part of this bundle metadata then remove it.
Field that is not part of this bundle is ignored.
Args:
field_name (str): Name of the field whose data is to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
@typing.overload
def remove_bundle_metadata(self, field_name: str) -> int: ...
def remove_child_bundle(self, bundle: IConstBundle2) -> int:
"""
Looks up the bundle and if it is child of the bundle then remove it.
Bundle handle that is not child of this bundle is ignored.
Only empty bundle can be removed.
Args:
bundle (omni.graph.core.IConstBundle2): bundle to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
def remove_child_bundles(self, bundles: typing.List[IConstBundle2]) -> int:
"""
Looks up the bundles and if they are children of the bundle then remove them.
Bundle handles that are not children of this bundle are ignored.
Only empty bundles can be removed.
Args:
bundles (list[omni.graph.core.IConstBundle2]): Bundles to be removed.
Returns:
int: Number of child bundles successfully removed.
"""
def remove_child_bundles_by_name(self, names: typing.List[str]) -> int:
"""
Looks up child bundles by name and remove their data and metadata.
Args:
names (list[str]): Names of the child bundles to be removed.
Returns:
omni.core.Result: Success if successfully removed.
"""
pass
class IBundleChanges(_IBundleChanges, omni.core._core.IObject):
"""
Interface for monitoring and handling changes in bundles and attributes.
The IBundleChanges_abi is an interface that provides methods for checking whether bundles and attributes
have been modified, and cleaning them if they have been modified. This is particularly useful in scenarios
where it's crucial to track changes and maintain the state of bundles and attributes.
This interface provides several methods for checking and cleaning modifications, each catering to different
use cases such as handling single bundles, multiple bundles, attributes, or specific attributes of a single bundle.
The methods of this interface return a BundleChangeType enumeration that indicates whether the checked entity
(bundle or attribute) has been modified.
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
@typing.overload
def activate_change_tracking(*args, **kwargs) -> typing.Any:
"""
@brief Activate tracking for specific bundle on its attributes and children.
@param handle to the specific bundles to enable change tracking.
@return An omni::core::Result indicating the success of the operation.
Activates the change tracking system for a bundle.
This method controls the change tracking system of a bundle. It's only applicable
for read-write bundles.
Args:
bundle: A bundle to activate change tracking system for.
"""
@typing.overload
def activate_change_tracking(self, bundle: IBundle2) -> None: ...
def clear_changes(self) -> int:
"""
Clears all recorded changes.
This method is used to clear or reset all the recorded changes of the bundles and attributes.
It can be used when the changes have been processed and need to be discarded.
An omni::core::Result indicating the success of the operation.
"""
@staticmethod
def create(*args, **kwargs) -> typing.Any: ...
@staticmethod
@typing.overload
def deactivate_change_tracking(*args, **kwargs) -> typing.Any:
"""
@brief Deactivate tracking for specific bundle on its attributes and children.
@param handle to the specific bundles to enable change tracking.
@return An omni::core::Result indicating the success of the operation.
Deactivates the change tracking system for a bundle.
This method controls the change tracking system of a bundle. It's only applicable
for read-write bundles.
Args:
bundle: A bundle to deactivate change tracking system for.
"""
@typing.overload
def deactivate_change_tracking(self, bundle: IBundle2) -> None: ...
@typing.overload
def get_change(self, bundle: IConstBundle2) -> BundleChangeType:
"""
Retrieves the change status of a list of bundles.
This method is used to check if any of the provided bundles or their contents have been modified.
Args:
bundles: A list of the bundles to check for modifications.
Returns:
list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each bundle.
Retrieves the change status of a specific attribute.
This method is used to check if a specific attribute has been modified.
Args:
attribute: The specific attribute to check for modifications.
Returns:
omni.graph.core.BundleChangeType: A BundleChangeType value indicating the type of change (if any) that has occurred to the attribute.
"""
@staticmethod
@typing.overload
def get_change(*args, **kwargs) -> typing.Any: ...
@typing.overload
def get_changes(self, bundles: typing.List[IConstBundle2]) -> typing.List[BundleChangeType]:
"""
Retrieves the change status of a list of bundles.
This method is used to check if any of the bundles in the provided list or their contents have been modified.
Args:
bundles: A list of the bundles to check for modifications.
Returns:
list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each bundle.
Retrieves the change status of a list of attributes.
This method is used to check if any of the attributes in the provided list have been modified.
Args:
attributes: A list of attributes to check for modifications.
Returns:
list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each attribute.
Retrieves the change status for a list of bundles and attributes.
This method is used to check if any of the bundles or attributes in the provided list have been modified.
If an entry in the list is neither a bundle nor an attribute, its change status will be marked as None.
Args:
entries: A list of bundles and attributes to check for modifications.
Returns:
list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each entry in the provided list.
"""
@staticmethod
@typing.overload
def get_changes(*args, **kwargs) -> typing.Any: ...
@typing.overload
def get_changes(self, entries: typing.Sequence) -> typing.List[BundleChangeType]: ...
pass
class IBundleFactory2(_IBundleFactory2, IBundleFactory, _IBundleFactory, omni.core._core.IObject):
"""
IBundleFactory version 2.
The version 2 allows to retrieve instances of IBundle instances from paths.
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
def get_bundle_from_path(*args, **kwargs) -> typing.Any:
"""
Get read write IBundle interface from path.
Args:
context (omni.graph.core.GraphContext): The context where bundles belong to.
path (str): Location of the bundle.
Returns:
omni.graph.core.IBundle2: Bundle instance.
"""
@staticmethod
def get_const_bundle_from_path(*args, **kwargs) -> typing.Any:
"""
Get read only IBundle interface from path.
Args:
context (omni.graph.core.GraphContext): The context where bundles belong to.
path (str): Location of the bundle.
Returns:
omni.graph.core.IConstBundle2: Bundle instance.
"""
pass
class IBundleFactory(_IBundleFactory, omni.core._core.IObject):
"""
Interface to create new bundles
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
def create(*args, **kwargs) -> typing.Any:
"""
Creates an interface object for bundle factories
Returns:
omni.graph.core.IBundleFactory2: Created instance of bundle factory.
"""
@staticmethod
def create_bundle(*args, **kwargs) -> typing.Any:
"""
Create bundle at given path.
Args:
context (omni.graph.core.GraphContext): The context where bundles are created.
path (str): Location for new bundle.
Returns:
omni.graph.core.IBundle2: Bundle instance.
"""
@staticmethod
def create_bundles(*args, **kwargs) -> typing.Any:
"""
Create bundles at given paths.
Args:
context (omni.graph.core.GraphContext): The context where bundles are created.
paths (list[str]): Locations for new bundles.
Returns:
list[omni.graph.core.IBundle2]: A list of bundle instances.
"""
@staticmethod
def get_bundle(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - no conversion is required
DEPRECATED - no conversion is required
"""
@staticmethod
def get_bundles(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - no conversion is required
DEPRECATED - no conversion is required
"""
pass
class IConstBundle2(_IConstBundle2, omni.core._core.IObject):
"""
Provide read only access to recursive bundles.
"""
def __bool__(self) -> bool:
"""
Returns:
bool: True if this bundle is valid, False otherwise.
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
def add_attribute(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use create_attribute() instead.
"""
@staticmethod
def add_attributes(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use create_attributes() instead.
"""
def clear(self) -> None:
"""
DEPRECATED - use clear_contents() instead
"""
@staticmethod
def get_attribute_by_name(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use get_attribute_by_name(name) instead
Searches for attribute in this bundle by using attribute name.
Args:
name (str): Attribute name to search for.
Returns:
omni.graph.core.AttributeData: An attribute. If attribute is not found then invalid attribute is returned.
"""
def get_attribute_count(self) -> int:
"""
Get the number of attributes in this bundle
Returns:
int: Number of attributes in this bundle.
"""
def get_attribute_data(self, write: bool = False) -> list:
"""
DEPRECATED - use get_attributes() instead
"""
def get_attribute_data_count(self) -> int:
"""
DEPRECATED - use get_attribute_count() instead
"""
@staticmethod
def get_attribute_metadata_by_name(*args, **kwargs) -> typing.Any:
"""
Search for metadata fields for the attribute by using field names.
Args:
attribute (str): Name of the attribute.
field_names (list[str]): Attribute metadata fields to be searched for.
Returns:
list[omni.graph.core.AttributeData]: Array of metadata fields in the attribute.
Search for metadata field for the attribute by using field name.
Args:
attribute (str): Name of the attribute.
field_name (str): Attribute metadata field to be searched for.
Returns:
omni.graph.core.AttributeData: Metadata fields in the attribute.
"""
def get_attribute_metadata_count(self, attribute: str) -> int:
"""
Gets the number of metadata fields in an attribute within the bundle
Args:
attribute (str): Name of the attribute to count metadata for.
Returns:
int: Number of metadata fields in the attribute.
"""
def get_attribute_metadata_names(self, attribute: str) -> typing.List[str]:
"""
Get names of all metadata fields in the attribute.
Args:
attribute (str): Name of the attribute.
Returns:
list[str]: Array of names in the attribute.
"""
@staticmethod
def get_attribute_metadata_types(*args, **kwargs) -> typing.Any:
"""
Get types of all metadata fields in the attribute.
Args:
attribute (string): Name of the attribute.
Returns:
list[omni.graph.core.Type]: Array of types in the attribute.
"""
def get_attribute_names(self) -> typing.List[str]:
"""
Get the names of all attributes in this bundle.
Returns:
list[str]: A list of the names.
"""
def get_attribute_names_and_types(self) -> tuple:
"""
DEPRECATED - use get_attribute_names() or get_attribute_types() instead
"""
@staticmethod
def get_attribute_types(*args, **kwargs) -> typing.Any:
"""
Get the types of all attributes in this bundle.
Returns:
list[omni.graph.core.Type]: A list of the types.
"""
@staticmethod
def get_attributes(*args, **kwargs) -> typing.Any:
"""
Get all attributes in this bundle.
Returns:
list[omni.graph.core.AttributeData]: A list of all attributes in this bundle.
"""
@staticmethod
def get_attributes_by_name(*args, **kwargs) -> typing.Any:
"""
Searches for attributes in this bundle by using attribute names.
Args:
names (list[str]): Attribute names to search for.
Returns:
list[omni.graph.core.AttributeData]: A list of found attributes.
"""
@staticmethod
def get_bundle_metadata_by_name(*args, **kwargs) -> typing.Any:
"""
Search for field handles in this bundle by using field names.
Args:
field_names (list[str]): Bundle metadata fields to be searched for.
Returns:
list[omni.graph.core.AttributeData]: Metadata fields in this bundle.
Search for field handle in this bundle by using field name.
Args:
field_name (str): Bundle metadata fields to be searched for.
Returns:
omni.graph.core.AttributeData: Metadata field in this bundle.
"""
def get_bundle_metadata_count(self) -> int:
"""
Get the number of metadata entries
Returns:
int: Number of metadata fields in this bundle.
"""
def get_bundle_metadata_names(self) -> typing.List[str]:
"""
Get the names of all metadata fields in this bundle.
Returns:
list[str]: Array of names in this bundle.
"""
@staticmethod
def get_bundle_metadata_types(*args, **kwargs) -> typing.Any:
"""
Get the types of all metadata fields in this bundle.
Returns:
list[omni.graph.core.Type]: Array of types in this bundle.
"""
def get_child_bundle(self, index: int) -> IConstBundle2:
"""
Get the child bundle by index.
Args:
index (int): Child bundle index in range [0, child_bundle_count).
Returns:
omni.graph.core.IConstBundle2: Child bundle under the index. If bundle index is out of range, then invalid bundle is returned.
"""
def get_child_bundle_by_name(self, path: str) -> IConstBundle2:
"""
Lookup for child under specified path.
Args:
path (str): Path to child bundle in this bundle.
Returns:
omni.graph.core.IConstBundle2: Child bundle in this bundle. If child does not exist under the path, then invalid bundle is returned.
"""
def get_child_bundle_count(self) -> int:
"""
Get the number of child bundles
Returns:
int: Number of child bundles in this bundle.
"""
def get_child_bundles(self) -> typing.List[IConstBundle2]:
"""
Get all child bundle handles in this bundle.
Returns:
list[omni.graph.core.IConstBundle2]: A list of all child bundles in this bundle.
"""
def get_child_bundles_by_name(self, names: typing.List[str]) -> typing.List[IConstBundle2]:
"""
Lookup for children under specified names.
Args:
names (list[str]): Names to child bundles in this bundle.
Returns:
list[omni.graph.core.IConstBundle2]: A list of found child bundles in this bundle.
"""
@staticmethod
def get_context(*args, **kwargs) -> typing.Any:
"""
Get the context used by this bundle
Returns:
omni.graph.core.GraphContext: The context of this bundle.
"""
def get_metadata_storage(self) -> IConstBundle2:
"""
Get access to metadata storage that contains all metadata information
Returns:
list[omni.graph.core.IBundle2]: List of bundles with the metadata information
"""
def get_name(self) -> str:
"""
Get the name of the bundle
Returns:
str: The name of this bundle.
"""
def get_parent_bundle(self) -> IConstBundle2:
"""
Get the parent bundle
Returns:
omni.graph.core.IConstBundle2: The parent of this bundle, or invalid bundle if there is no parent.
"""
def get_path(self) -> str:
"""
Get the path to this bundle
Returns:
str: The path to this bundle.
"""
def get_prim_path(self) -> str:
"""
DEPRECATED - use get_path() instead
"""
@staticmethod
def insert_attribute(*args, **kwargs) -> typing.Any:
"""
DEPRECATED - use copy_attribute() instead
"""
def insert_bundle(self, bundle_to_copy: IConstBundle2) -> None:
"""
DEPRECATED - use copy_bundle() instead.
"""
def is_read_only(self) -> bool:
"""
Returns if this interface is read-only.
"""
def is_valid(self) -> bool:
"""
DEPRECATED - use bool cast instead
"""
def remove_attribute(self, name: str) -> None:
"""
DEPRECATED - use remove_attribute_by_name() instead.
"""
def remove_attributes(self, names: typing.List[str]) -> None:
"""
DEPRECATED - use remove_attributes_by_name() instead.
"""
@property
def valid(self) -> bool:
"""
:type: bool
"""
pass
class INodeCategories(_INodeCategories, omni.core._core.IObject):
"""
Interface to the list of categories that a node type can belong to
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
def define_category(self, category_name: str, category_description: str) -> bool:
"""
Define a new category
@param[in] categoryName Name of the new category
@param[in] categoryDescription Description of the category
@return false if there was already a category with the given name
"""
@staticmethod
def get_all_categories() -> object:
"""
Get the list of available categories and their descriptions.
Returns:
dict[str,str]: Dictionary with categories as a name:description dictionary if it succeeded, else None
"""
@staticmethod
def get_node_categories(node_id: object) -> object:
"""
Return the list of categories that have been applied to the node.
Args:
node_id (str | Node): The node, or path to the node, whose categories are to be found
Returns:
list[str]: A list of category names applied to the node if it succeeded, else None
"""
@staticmethod
def get_node_type_categories(node_type_id: object) -> object:
"""
Return the list of categories that have been applied to the node type.
Args:
node_type_id (str | NodeType): The node type, or name of the node type, whose categories are to be found
Returns:
list[str]: A list of category names applied to the node type if it succeeded, else None
"""
def remove_category(self, category_name: str) -> bool:
"""
Remove an existing category, mainly to manage the ones created by a node type for itself
@param[in] categoryName Name of the category to remove
@return false if there was no category with the given name
"""
@property
def category_count(self) -> int:
"""
:type: int
"""
pass
class ISchedulingHints2(_ISchedulingHints2, ISchedulingHints, _ISchedulingHints, omni.core._core.IObject):
"""
Interface extension for ISchedulingHints that adds a new "pure" hint
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@typing.overload
def __init__(self, arg0: ISchedulingHints) -> None: ...
@property
def purity_status(self) -> ePurityStatus:
"""
:type: ePurityStatus
"""
@purity_status.setter
def purity_status(self, arg1: ePurityStatus) -> None:
pass
pass
class ISchedulingHints(_ISchedulingHints, omni.core._core.IObject):
"""
Interface to the list of scheduling hints that can be applied to a node type
"""
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
def get_data_access(self, data_type: eAccessLocation) -> eAccessType:
"""
Get the type of access the node has for a given data type
@param[in] dataType Type of data for which access type is being modified
@returns Value of the access type flag
"""
def inspect(self, inspector: omni.inspect._omni_inspect.IInspector) -> bool:
"""
Runs the inspector on the scheduling hints.
@param[in] inspector The inspector class
@return true if the inspection ran successfully, false if the inspection type is not supported
"""
def set_data_access(self, data_type: eAccessLocation, new_access_type: eAccessType) -> None:
"""
Set the flag describing how a node accesses particular data in its compute _abi (defaults to no access).
Setting any of these flags will, in most cases, automatically mark the node as "not threadsafe".
One current exception to this is allowing a node to be both threadsafe and a writer to USD, since
such behavior can be achieved if delayed writebacks (e.g. "registerForUSDWriteBack") are utilized
in the node's compute method.
@param[in] dataType Type of data for which access type is being modified
@param[in] newAccessType New value of the access type flag
"""
@property
def compute_rule(self) -> eComputeRule:
"""
:type: eComputeRule
"""
@compute_rule.setter
def compute_rule(self, arg1: eComputeRule) -> None:
pass
@property
def thread_safety(self) -> eThreadSafety:
"""
:type: eThreadSafety
"""
@thread_safety.setter
def thread_safety(self, arg1: eThreadSafety) -> None:
pass
pass
class IVariable(_IVariable, omni.core._core.IObject):
"""
Object that contains a value that is local to a graph, available from anywhere in the graph
"""
def __bool__(self) -> bool: ...
@typing.overload
def __init__(self, arg0: omni.core._core.IObject) -> None: ...
@typing.overload
def __init__(self) -> None: ...
@staticmethod
def get(*args, **kwargs) -> typing.Any:
"""
Get the value of a variable
Args:
graph_context (omni.graph.core.GraphContext): The GraphContext object to get the variable value from.
instance_path (str): Optional path to the prim instance to fetch the variable value for. By default this will
fetch the variable value from the graph prim.
Returns:
Any: Value of the variable
"""
@staticmethod
def get_array(*args, **kwargs) -> typing.Any:
"""
Get the value of an array variable
Args:
graph_context (omni.graph.core.GraphContext): The GraphContext object to get the variable value from.
get_for_write (bool): Should the data be retrieved for writing?
reserved_element_count (int): If the data is to be retrieved for writing, preallocate this many elements
instance_path (str): Optional path to the prim instance to fetch the variable value for. By default this will
fetch the variable value from the graph prim.
Returns:
Any: Value of the array variable
"""
@staticmethod
def set(*args, **kwargs) -> typing.Any:
"""
Sets the value of a variable
Args:
graph_context (omni.graph.core.GraphContext): The GraphContext object to store the variable value.
on_gpu (bool): Is the data to be set on the GPU?
instance_path (str): Optional path to the prim instance to set the variable value on. By default this will
set the variable value on the graph prim.
Returns:
bool: True if the value was successfully set
"""
@staticmethod
def set_type(*args, **kwargs) -> typing.Any:
"""
Changes the type of a variable. Changing the type of a variable may remove the variable's default value.
Args:
variable_type (omni.graph.core.Type): The type to switch the variable to.
Returns:
bool: True if the type was successfully changed.
"""
@property
def category(self) -> str:
"""
:type: str
"""
@category.setter
def category(self, arg1: str) -> None:
pass
@property
def display_name(self) -> str:
"""
:type: str
"""
@display_name.setter
def display_name(self, arg1: str) -> None:
pass
@property
def name(self) -> str:
"""
:type: str
"""
@property
def scope(self) -> eVariableScope:
"""
:type: eVariableScope
"""
@scope.setter
def scope(self, arg1: eVariableScope) -> None:
pass
@property
def source_path(self) -> str:
"""
:type: str
"""
@property
def tooltip(self) -> str:
"""
:type: str
"""
@tooltip.setter
def tooltip(self, arg1: str) -> None:
pass
@property
def type(self) -> omni::graph::core::Py_Type:
"""
Gets the data type of the variable.
Returns:
omni.graph.core.Type: The data type of the variable.
:type: omni::graph::core::Py_Type
"""
@property
def valid(self) -> bool:
"""
:type: bool
"""
pass
class MemoryType():
"""
Default memory location for an attribute or node's data
Members:
CPU : The memory is on the CPU by default
CUDA : The memory is on the GPU by default
ANY : The memory does not have any default device
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ANY: omni.graph.core._omni_graph_core.MemoryType # value = <MemoryType.ANY: 2>
CPU: omni.graph.core._omni_graph_core.MemoryType # value = <MemoryType.CPU: 0>
CUDA: omni.graph.core._omni_graph_core.MemoryType # value = <MemoryType.CUDA: 1>
__members__: dict # value = {'CPU': <MemoryType.CPU: 0>, 'CUDA': <MemoryType.CUDA: 1>, 'ANY': <MemoryType.ANY: 2>}
pass
class Node():
"""
An element of execution within a graph, containing attributes and connected to other nodes
"""
def __bool__(self) -> bool: ...
def __eq__(self, arg0: Node) -> bool: ...
def __hash__(self) -> int: ...
def __repr__(self) -> str: ...
def _do_not_use(self) -> bool:
"""
Temporary internal function - do not use
"""
def clear_old_compute_messages(self) -> int:
"""
Clears all compute messages logged for the node prior to its most recent evaluation.
Messages logged during the most recent evaluation remain untouched.
Normally this will be called during graph evaluation so it is of little use unless
you're writing your own evaluation manager.
Returns:
int: The number of messages that were deleted.
"""
@staticmethod
def create_attribute(*args, **kwargs) -> typing.Any:
"""
Creates an attribute with the specified name, type, and port type and returns success state.
Args:
attributeName (str): Name of the attribute.
attributeType (omni.graph.core.Type): Type of the attribute.
portType (omni.graph.core.AttributePortType): The port type of the attribute, defaults to
omni.graph.core.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT
value (Any): The initial value to set on the attribute, default is None
extendedType (omni.graph.core.ExtendedAttributeType): The extended type of the attribute, defaults to
omni.graph.core.ExtendedAttributeType.EXTENDED_ATTR_TYPE_REGULAR
unionTypes (str): Comma-separated list of union types if the extended type is
omni.graph.core.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION,
defaults to empty string for non-union types.
Returns:
bool: True if the creation was successful, else False
"""
def deregister_on_connected_callback(self, callback: int) -> None:
"""
De-registers the on_connected callback to be invoked when attributes connect.
Args:
callback (callable): The handle that was returned during the register_on_connected_callback call
"""
def deregister_on_disconnected_callback(self, callback: int) -> None:
"""
De-registers the on_disconnected callback to be invoked when attributes disconnect.
Args:
callback (callable): The handle that was returned during the register_on_disconnected_callback call
"""
def deregister_on_path_changed_callback(self, callback: int) -> None:
"""
Deregisters the on_path_changed callback to be invoked when anything changes in the stage. [DEPRECATED]
Args:
callback (callable): The handle that was returned during the register_on_path_changed_callback call
"""
def get_attribute(self, name: str) -> Attribute:
"""
Given the name of an attribute returns an attribute object to it.
Args:
name (str): The name of the attribute
Returns:
omni.graph.core.Attribute: Attribute with the given name, or None if it does not exist on the node
"""
def get_attribute_exists(self, name: str) -> bool:
"""
Given an attribute name, returns whether this attribute exists or not.
Args:
name (str): The name of the attribute
Returns:
bool: True if the attribute exists on this node, else False
"""
def get_attributes(self) -> typing.List[Attribute]:
"""
Returns the list of attributes on this node.
"""
@staticmethod
def get_backing_bucket_id(*args, **kwargs) -> typing.Any:
"""
Finds this node's bucket id within the backing store. The id is only valid until the next
modification of the backing store, so do not hold on to it.
Returns:
int: The bucket id, raises ValueError if the look up fails.
"""
@staticmethod
def get_compound_graph_instance(*args, **kwargs) -> typing.Any:
"""
Returns a handle to the associated sub-graph, if the given node is a compound node.
Returns:
omni.graph.core.Graph: The subgraph
"""
def get_compute_count(self) -> int:
"""
Returns the number of times this node's compute() has been called. The counter has a limited range and will
eventually roll over to 0, so a higher count cannot be assumed to represent a more recent compute than an
older one.
Returns:
int: Number of times this node's compute() has been called since the counter last rolled over to 0.
"""
@staticmethod
def get_compute_messages(*args, **kwargs) -> typing.Any:
"""
Returns a list of the compute messages currently logged for the node at a specific severity.
Args:
severity (omni.graph.core.Severity): Severity level of the message.
Returns:
list[str]: The list of messages, may be empty.
"""
def get_dynamic_downstream_control(self) -> bool:
"""
Check if the downstream nodes are influenced by this node
Returns:
bool: True if the current node can influence the execution of downstream nodes in dynamic scheduling
"""
def get_event_stream(self) -> carb.events._events.IEventStream:
"""
Get the event stream the node uses for notification of changes.
Returns:
carb.events.IEventStream: Event stream to monitor for node changes
"""
@staticmethod
def get_graph(*args, **kwargs) -> typing.Any:
"""
Get the graph to which this node belongs
Returns:
omni.graph.core.Graph: Graph associated with the current node. The returned graph will be invalid if the
node is not valid.
"""
def get_handle(self) -> int:
"""
Get an opaque handle to the node
Returns:
int: a unique handle to the node
"""
@staticmethod
def get_node_type(*args, **kwargs) -> typing.Any:
"""
Gets the node type of this node
Returns:
omni.graph.core.NodeType: The node type from which this node was created.
"""
def get_prim_path(self) -> str:
"""
Returns the path to the prim currently backing the node.
"""
def get_type_name(self) -> str:
"""
Get the node type name
Returns:
str: The type name of the node.
"""
@staticmethod
def get_wrapped_graph(*args, **kwargs) -> typing.Any:
"""
Get the graph wrapped by this node
Returns:
omni.graph.core.Graph: The graph wrapped by the current node, if any. The returned graph will be invalid
if the node does not wrap a graph or is invalid.
"""
def increment_compute_count(self) -> int:
"""
Increments the node's compute counter. This method is provided primarily for debugging and experimental uses
and should not normally be used by end-users.
Returns:
int: The new compute counter. This may be zero if the counter has just rolled over.
"""
def is_backed_by_usd(self) -> bool:
"""
Check if the node is back by USD or not
Returns:
bool: True if the current node is by an USD prim on the stage.
"""
def is_compound_node(self) -> bool:
"""
Returns whether this node is a compound node. A compound node is a node that has a node type that
is defined by an OmniGraph.
Returns:
bool: True if this node is a compound node, False otherwise.
"""
def is_disabled(self) -> bool:
"""
Check if the node is currently disabled
Returns:
bool: True if the node is disabled.
"""
def is_valid(self) -> bool:
"""
Check the validity of the node
Returns:
bool: True if the node is valid.
"""
@staticmethod
def log_compute_message(*args, **kwargs) -> typing.Any:
"""
Logs a compute message of a given severity for the node.
This method is intended to be used from within the compute() method of a
node to alert the user to any problems or issues with the node's most recent
evaluation. They are accumulated until the next successful evaluation
at which point they are cleared.
If duplicate messages are logged, with the same severity level, only one is
stored.
Args:
severity (omni.graph.core.Severity): Severity level of the message.
message (str): The message.
Returns:
bool: True if the message has already been logged, else False
"""
def node_id(self) -> int:
"""
Returns a unique identifier value for this node.
Returns:
int: Unique identifier value for the node - not persistent through file save and load
"""
def register_on_connected_callback(self, callback: object) -> int:
"""
Registers a callback to be invoked when the node has attributes connected. The callback takes 2 parameters:
the attributes from and attribute to of the connection.
Args:
callback (callable): The callback function
Returns:
int: A handle that could be used for deregistration.
"""
def register_on_disconnected_callback(self, callback: object) -> int:
"""
Registers a callback to be invoked when the node has attributes disconnected. The callback takes 2 parameters:
the attributes from and attribute to of the disconnection.
Args:
callback (callable): The callback function
Returns:
A handle identifying the callback that can be used for deregistration.
"""
def register_on_path_changed_callback(self, callback: object) -> int:
"""
Registers a callback to be invoked when a path changes in the stage. The callback takes 1 parameter:
a list of the paths that were changed. [DEPRECATED]
Args:
callback (callable): The callback function
Returns:
A handle identifying the callback that can be used for deregistration.
"""
def remove_attribute(self, attributeName: str) -> bool:
"""
Removes an attribute with the specified name and type and returns success state.
Args:
attributeName (str): Name of the attribute.
Returns:
bool: True if the removal was successful, False if the attribute was not found
"""
def request_compute(self) -> bool:
"""
Requests a compute of this node
Returns:
bool: True if the request was successful, False if there was an error
"""
def resolve_coupled_attributes(self, attributesArray: typing.List[Attribute]) -> bool:
"""
Resolves attribute types given a set of attributes which are fully type coupled.
For example if node 'Increment' has one input attribute 'a' and one output attribute 'b'
and the types of 'a' and 'b' should always match. If the input is resolved then this function will
resolve the output to the same type.
It will also take into consideration available conversions on the input size.
The type of the first (resolved) provided attribute will be used to resolve others or select appropriate conversions
Note that input attribute types are never inferred from output attribute types.
This function should only be called from the INodeType function 'on_connection_type_resolve'
Args:
attributesArray (list[omni.graph.core.Attribute]): Array of attributes to be resolved as a coupled group
Returns:
bool: True if successful, False otherwise, usually due to mismatched or missing resolved types
"""
@staticmethod
def resolve_partially_coupled_attributes(*args, **kwargs) -> typing.Any:
"""
Resolves attribute types given a set of attributes, that can have differing tuple counts and/or array depth,
and differing but convertible base data type.
The three input buffers are tied together, holding the attribute, the tuple
count, and the array depth of the types to be coupled.
This function will solve base type conversion by targeting the first provided type in the list,
for all other ones that require it.
For example if node 'makeTuple2' has two input attributes 'a' and 'b' and one output 'c' and we want to resolve
any float connection to the types 'a':float, 'b':float, 'c':float[2] (convertible base types and different tuple counts)
then the input buffers would contain:
attrsBuf = [a, b, c]
tuplesBuf = [1, 1, 2]
arrayDepthsBuf = [0, 0, 0]
rolesBuf = [AttributeRole::eNone, AttributeRole::eNone, AttributeRole::eNone]
This is worth noting that 'b' could be of any type convertible to float. But since the first provided
attribute is 'a', the type of 'a' will be used to propagate the type resolution.
Note that input attribute types are never inferred from output attribute types.
This function should only be called from the INodeType function 'on_connection_type_resolve'
Args:
attributesArray (list[omni.graph.core.Attribute]): Array of attributes to be resolved as a coupled group
tuplesArray (list[int]): Array of tuple count desired for each corresponding attribute. Any value
of None indicates the found tuple count is to be used when resolving.
arraySizesArray (list[int]): Array of array depth desired for each corresponding attribute. Any value
of None indicates the found array depth is to be used when resolving.
rolesArray (list[omni.graph.core.AttributeRole]): Array of role desired for each corresponding attribute. Any
value of AttributeRole::eUnknown/None indicates the found role is to be used when resolving.
Returns:
bool: True if successful, False otherwise, usually due to mismatched or missing resolved types
"""
def set_compute_incomplete(self) -> None:
"""
Informs the system that compute is incomplete for this frame. In lazy evaluation systems, this node will be
scheduled on the next frame since it still has more work to do.
"""
def set_disabled(self, disabled: bool) -> None:
"""
Sets whether the node is disabled or not.
Args:
disabled (bool): True for disabled, False for not.
"""
def set_dynamic_downstream_control(self, control: bool) -> None:
"""
Sets whether the current node can influence the execution of downstream nodes in dynamic scheduling
Args:
control (bool): True for being able to disable downstream nodes, False otherwise
"""
pass
class NodeEvent():
"""
Node modification event.
Members:
CREATE_ATTRIBUTE : Attribute was created
REMOVE_ATTRIBUTE : Attribute was removed
ATTRIBUTE_TYPE_RESOLVE : Extended attribute type was resolved
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ATTRIBUTE_TYPE_RESOLVE: omni.graph.core._omni_graph_core.NodeEvent # value = <NodeEvent.ATTRIBUTE_TYPE_RESOLVE: 2>
CREATE_ATTRIBUTE: omni.graph.core._omni_graph_core.NodeEvent # value = <NodeEvent.CREATE_ATTRIBUTE: 0>
REMOVE_ATTRIBUTE: omni.graph.core._omni_graph_core.NodeEvent # value = <NodeEvent.REMOVE_ATTRIBUTE: 1>
__members__: dict # value = {'CREATE_ATTRIBUTE': <NodeEvent.CREATE_ATTRIBUTE: 0>, 'REMOVE_ATTRIBUTE': <NodeEvent.REMOVE_ATTRIBUTE: 1>, 'ATTRIBUTE_TYPE_RESOLVE': <NodeEvent.ATTRIBUTE_TYPE_RESOLVE: 2>}
pass
class NodeType():
"""
Definition of a node's interface and structure
"""
def __bool__(self) -> bool:
"""
Returns whether the current node type is valid.
"""
def __eq__(self, arg0: NodeType) -> bool:
"""
Returns whether two node type objects refer to the same underlying node type implementation.
"""
def add_extended_input(self, name: str, type: str, is_required: bool, extended_type: ExtendedAttributeType) -> None:
"""
Adds an extended input type to this node type. Every node of this node type would then have this input.
Args:
name (str): The name of the input
type (str): Extra information for the type - for union types, this is a list of types of this union, comma separated
For example, "double,float"
is_required (bool): Whether the input is required or not
extended_type (omni.graph.core.ExtendedAttributeType): The kind of extended attribute this is
e.g. omni.graph.core.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION
"""
def add_extended_output(self, name: str, type: str, is_required: bool, extended_type: ExtendedAttributeType) -> None:
"""
Adds an extended output type to this node type. Every node of this node type would then have this output.
Args:
name (str): The name of the output
type (str): Extra information for the type - for union types, this is a list of types of this union, comma separated
For example, "double,float"
is_required (bool): Whether the output is required or not
extended_type (omni.graph.core.ExtendedAttributeType): The kind of extended attribute this is
e.g. omni.graph.core.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION
"""
def add_extended_state(self, name: str, type: str, is_required: bool, extended_type: ExtendedAttributeType) -> None:
"""
Adds an extended state type to this node type. Every node of this node type would then have this state.
Args:
name (str): The name of the state attribute
type (str): Extra information for the type - for union types, this is a list of types of this union, comma separated
For example, "double,float"
is_required (bool): Whether the state attribute is required or not
extended_type (omni.graph.core.ExtendedAttributeType): The kind of extended attribute this is
e.g. omni.graph.core.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION
"""
def add_input(self, name: str, type: str, is_required: bool, default_value: object = None) -> None:
"""
Adds an input to this node type. Every node of this node type would then have this input.
Args:
name (str): The name of the input
type (str): The type name of the input
is_required (bool): Whether the input is required or not
default_value (any): Default value for the attribute if it is not explicitly set (None means no default)
"""
def add_output(self, name: str, type: str, is_required: bool, default_value: object = None) -> None:
"""
Adds an output to this node type. Every node of this node type would then have this output.
Args:
name (str): The name of the output
type (str): The type name of the output
is_required (bool): Whether the output is required or not
default_value (any): Default value for the attribute if it is not explicitly set (None means no default)
"""
def add_state(self, name: str, type: str, is_required: bool, default_value: object = None) -> None:
"""
Adds an state to this node type. Every node of this node type would then have this state.
Args:
name (str): The name of the state
type (str): The type name of the state
is_required (bool): Whether the state is required or not
default_value (any): Default value for the attribute if it is not explicitly set (None means no default)
"""
def get_all_categories(self) -> list:
"""
Gets the node type's categories
Returns:
list[str]: A list of all categories associated with this node type
"""
def get_all_metadata(self) -> dict:
"""
Gets the node type's metadata
Returns:
dict[str,str]: A dictionary of name:value metadata on the node type
"""
def get_all_subnode_types(self) -> dict:
"""
Finds all subnode types of the current node type.
Returns:
dict[str, omni.graph.core.NodeType]: Dictionary of type_name:type_object for all subnode types of this one
"""
def get_metadata(self, key: str) -> str:
"""
Returns the metadata value for the given key.
Args:
key (str): The metadata keyword
Returns:
str | None: Metadata value for the given keyword, or None if it is not defined
"""
def get_metadata_count(self) -> int:
"""
Gets the number of metadata values set on the node type
Returns:
int: The number of metadata values currently defined on the node type.
"""
def get_node_type(self) -> str:
"""
Get this node type's name
Returns:
str: The name of this node type.
"""
def get_path(self) -> str:
"""
Gets the path to the node type definition
Returns:
str: The path to the node type prim. For compound node definitions, this is path on the stage to the
OmniGraphSchema.OmniGraphCompoundNodeType object that defines the compound.
For other node types, the path returned is unique, but does not represent a valid Prim on the stage.
"""
def get_scheduling_hints(self) -> ISchedulingHints:
"""
Gets the set of scheduling hints currently set on the node type.
Returns:
omni.graph.core.ISchedulingHints: The scheduling hints for this node type
"""
def has_state(self) -> bool:
"""
Checks to see if instantiations of the node type has internal state
Returns:
bool: True if nodes of this type will have internal state data, False if not.
"""
def inspect(self, inspector: omni.inspect._omni_inspect.IInspector) -> bool:
"""
Runs the inspector on the node type
Args:
inspector (omni.inspect.Inspector): The inspector to run
Returns:
bool: True if the inspector was successfully run on the node type, False if it is not supported
"""
def is_compound_node_type(self) -> bool:
"""
Checks to see if this node type defines a compound node type
Returns:
bool: True if this node type is a compound node type, meaning its implementation is defined by an OmniGraph
"""
def is_valid(self) -> bool:
"""
Checks to see if this object is valid
Returns:
bool: True if this node type object is valid.
"""
def set_has_state(self, has_state: bool) -> None:
"""
Sets the boolean indicating a node has state.
Args:
has_state (bool): Whether the node has state or not
"""
def set_metadata(self, key: str, value: str) -> bool:
"""
Sets the metadata value for the given key.
Args:
key (str): The metadata keyword
value (str): The value of the metadata
"""
def set_scheduling_hints(self, scheduling_hints: ISchedulingHints) -> None:
"""
Modify the scheduling hints defined on the node type.
Args:
scheduling_hints (omni.graph.core.ISchedulingHints): New set of scheduling hints for the node type
"""
__hash__ = None
pass
class OmniGraphBindingError(Exception, BaseException):
pass
class PtrToPtrKind():
"""
Memory type for the pointer to a GPU data array
Members:
NA : Memory is CPU or type is not an array
CPU : Pointers to GPU arrays live on the CPU
GPU : Pointers to GPU arrays live on the GPU
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
CPU: omni.graph.core._omni_graph_core.PtrToPtrKind # value = <PtrToPtrKind.CPU: 1>
GPU: omni.graph.core._omni_graph_core.PtrToPtrKind # value = <PtrToPtrKind.NA: 0>
NA: omni.graph.core._omni_graph_core.PtrToPtrKind # value = <PtrToPtrKind.NA: 0>
__members__: dict # value = {'NA': <PtrToPtrKind.NA: 0>, 'CPU': <PtrToPtrKind.CPU: 1>, 'GPU': <PtrToPtrKind.NA: 0>}
pass
class Severity():
"""
Severity level of the log message
Members:
INFO : Message is informational only
WARNING : Message is regarding a recoverable unexpected situation
ERROR : Message is regarding an unrecoverable unexpected situation
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
ERROR: omni.graph.core._omni_graph_core.Severity # value = <Severity.ERROR: 2>
INFO: omni.graph.core._omni_graph_core.Severity # value = <Severity.INFO: 0>
WARNING: omni.graph.core._omni_graph_core.Severity # value = <Severity.WARNING: 1>
__members__: dict # value = {'INFO': <Severity.INFO: 0>, 'WARNING': <Severity.WARNING: 1>, 'ERROR': <Severity.ERROR: 2>}
pass
class Type():
"""
Full definition of the data type owned by an attribute
"""
def __eq__(self, arg0: Type) -> bool: ...
def __getstate__(self) -> tuple: ...
def __hash__(self) -> int: ...
def __init__(self, base_type: BaseDataType, tuple_count: int = 1, array_depth: int = 0, role: AttributeRole = AttributeRole.NONE) -> None: ...
def __ne__(self, arg0: Type) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, arg0: tuple) -> None: ...
def __str__(self) -> str: ...
def get_base_type_name(self) -> str:
"""
Gets the name of this type's base data type
Returns:
str: Name of just the base data type of this type, e.g. "float"
"""
def get_ogn_type_name(self) -> str:
"""
Gets the OGN-style name of this type
Returns:
str: Name of this type in OGN format, which differs slightly from the USD format, e.g. "float[3]"
"""
def get_role_name(self) -> str:
"""
Gets the name of the role of this type
Returns:
str: Name of just the role of this type, e.g. "color"
"""
def get_type_name(self) -> str:
"""
Gets the name of this data type
Returns:
str: Name of this type, e.g. "float3"
"""
def is_compatible_raw_data(self, type_to_compare: Type) -> bool:
"""
Does a role-insensitive comparison with the given Type.
For example double[3] != pointd[3], but they are compatible and so this function would return True.
Args:
type_to_compare (omni.graph.core.Type): Type to compare for compatibility
Returns:
bool: True if the given type is compatible with this type
"""
def is_matrix_type(self) -> bool:
"""
Checks if the type one of the matrix types, whose tuples are interpreted as a square array
Returns:
bool: True if this type is one of the matrix types
"""
@property
def array_depth(self) -> int:
"""
(int) Zero for a single value, one for an array.
:type: int
"""
@array_depth.setter
def array_depth(self, arg1: int) -> None:
"""
(int) Zero for a single value, one for an array.
"""
@property
def base_type(self) -> BaseDataType:
"""
(omni.graph.core.BaseDataType) Base type of the attribute.
:type: BaseDataType
"""
@base_type.setter
def base_type(self, arg1: BaseDataType) -> None:
"""
(omni.graph.core.BaseDataType) Base type of the attribute.
"""
@property
def role(self) -> AttributeRole:
"""
(omni.graph.core.AttributeRole) The semantic role of the type.
:type: AttributeRole
"""
@role.setter
def role(self, arg1: AttributeRole) -> None:
"""
(omni.graph.core.AttributeRole) The semantic role of the type.
"""
@property
def tuple_count(self) -> int:
"""
(int) Number of components in each tuple. 1 for a single value (scalar), 3 for a point3d, etc.
:type: int
"""
@tuple_count.setter
def tuple_count(self, arg1: int) -> None:
"""
(int) Number of components in each tuple. 1 for a single value (scalar), 3 for a point3d, etc.
"""
pass
class _IBundle2(IConstBundle2, _IConstBundle2, omni.core._core.IObject):
pass
class _IBundleChanges(omni.core._core.IObject):
pass
class _IBundleFactory2(IBundleFactory, _IBundleFactory, omni.core._core.IObject):
pass
class _IBundleFactory(omni.core._core.IObject):
pass
class _IConstBundle2(omni.core._core.IObject):
pass
class _INodeCategories(omni.core._core.IObject):
pass
class _ISchedulingHints2(ISchedulingHints, _ISchedulingHints, omni.core._core.IObject):
pass
class _ISchedulingHints(omni.core._core.IObject):
pass
class _IVariable(omni.core._core.IObject):
pass
class eAccessLocation():
"""
What type of non-attribute data does this node access
Members:
E_USD : Accesses the USD stage data
E_GLOBAL : Accesses data that is not part of the node or node type
E_STATIC : Accesses data that is shared by every instance of a particular node type
E_TOPOLOGY : Accesses information on the topology of the graph to which the node belongs
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_GLOBAL: omni.graph.core._omni_graph_core.eAccessLocation # value = <eAccessLocation.E_GLOBAL: 1>
E_STATIC: omni.graph.core._omni_graph_core.eAccessLocation # value = <eAccessLocation.E_STATIC: 2>
E_TOPOLOGY: omni.graph.core._omni_graph_core.eAccessLocation # value = <eAccessLocation.E_TOPOLOGY: 3>
E_USD: omni.graph.core._omni_graph_core.eAccessLocation # value = <eAccessLocation.E_USD: 0>
__members__: dict # value = {'E_USD': <eAccessLocation.E_USD: 0>, 'E_GLOBAL': <eAccessLocation.E_GLOBAL: 1>, 'E_STATIC': <eAccessLocation.E_STATIC: 2>, 'E_TOPOLOGY': <eAccessLocation.E_TOPOLOGY: 3>}
pass
class eAccessType():
"""
How does the node access the data described by the enum eAccessLocation
Members:
E_NONE : There is no access to data of the associated type
E_READ : There is only read access to data of the associated type
E_WRITE : There is only write access to data of the associated type
E_READ_WRITE : There is both read and write access to data of the associated type
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_NONE: omni.graph.core._omni_graph_core.eAccessType # value = <eAccessType.E_NONE: 0>
E_READ: omni.graph.core._omni_graph_core.eAccessType # value = <eAccessType.E_READ: 1>
E_READ_WRITE: omni.graph.core._omni_graph_core.eAccessType # value = <eAccessType.E_READ_WRITE: 3>
E_WRITE: omni.graph.core._omni_graph_core.eAccessType # value = <eAccessType.E_WRITE: 2>
__members__: dict # value = {'E_NONE': <eAccessType.E_NONE: 0>, 'E_READ': <eAccessType.E_READ: 1>, 'E_WRITE': <eAccessType.E_WRITE: 2>, 'E_READ_WRITE': <eAccessType.E_READ_WRITE: 3>}
pass
class eComputeRule():
"""
How the node is allowed to be computed
Members:
E_DEFAULT : Nodes are computed according to the default evaluator rules
E_ON_REQUEST : The evaluator may skip computing this node until explicitly requested with INode::requestCompute
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_DEFAULT: omni.graph.core._omni_graph_core.eComputeRule # value = <eComputeRule.E_DEFAULT: 0>
E_ON_REQUEST: omni.graph.core._omni_graph_core.eComputeRule # value = <eComputeRule.E_ON_REQUEST: 1>
__members__: dict # value = {'E_DEFAULT': <eComputeRule.E_DEFAULT: 0>, 'E_ON_REQUEST': <eComputeRule.E_ON_REQUEST: 1>}
pass
class ePurityStatus():
"""
The purity of the node implementation. For some context, a "pure" node is
one whose initialize, compute, and release methods are entirely deterministic,
i.e. they will always produce the same output attribute values for a given set
of input attribute values, and do not access, rely on, or otherwise mutate data
external to the node's scope
Members:
E_IMPURE : Node is assumed to not be pure
E_PURE : Node can be considered pure if explicitly specified by the node author
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_IMPURE: omni.graph.core._omni_graph_core.ePurityStatus # value = <ePurityStatus.E_IMPURE: 0>
E_PURE: omni.graph.core._omni_graph_core.ePurityStatus # value = <ePurityStatus.E_PURE: 1>
__members__: dict # value = {'E_IMPURE': <ePurityStatus.E_IMPURE: 0>, 'E_PURE': <ePurityStatus.E_PURE: 1>}
pass
class eThreadSafety():
"""
How thread safe is the node during evaluation
Members:
E_SAFE : Nodes can be evaluated in multiple threads safely
E_UNSAFE : Nodes cannot be evaluated in multiple threads safely
E_UNKNOWN : The thread safety status of the node type is unknown
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_SAFE: omni.graph.core._omni_graph_core.eThreadSafety # value = <eThreadSafety.E_SAFE: 0>
E_UNKNOWN: omni.graph.core._omni_graph_core.eThreadSafety # value = <eThreadSafety.E_UNKNOWN: 2>
E_UNSAFE: omni.graph.core._omni_graph_core.eThreadSafety # value = <eThreadSafety.E_UNSAFE: 1>
__members__: dict # value = {'E_SAFE': <eThreadSafety.E_SAFE: 0>, 'E_UNSAFE': <eThreadSafety.E_UNSAFE: 1>, 'E_UNKNOWN': <eThreadSafety.E_UNKNOWN: 2>}
pass
class eVariableScope():
"""
Scope in which the variable has been made available
Members:
E_PRIVATE : Variable is accessible only to its graph
E_READ_ONLY : Variable can be read by other graphs
E_PUBLIC : Variable can be read/written by other graphs
"""
def __eq__(self, other: object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self, value: int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self, other: object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self, state: int) -> None: ...
@property
def name(self) -> str:
"""
:type: str
"""
@property
def value(self) -> int:
"""
:type: int
"""
E_PRIVATE: omni.graph.core._omni_graph_core.eVariableScope # value = <eVariableScope.E_PRIVATE: 0>
E_PUBLIC: omni.graph.core._omni_graph_core.eVariableScope # value = <eVariableScope.E_PUBLIC: 2>
E_READ_ONLY: omni.graph.core._omni_graph_core.eVariableScope # value = <eVariableScope.E_READ_ONLY: 1>
__members__: dict # value = {'E_PRIVATE': <eVariableScope.E_PRIVATE: 0>, 'E_READ_ONLY': <eVariableScope.E_READ_ONLY: 1>, 'E_PUBLIC': <eVariableScope.E_PUBLIC: 2>}
pass
def _commit_output_attributes_data(python_commit_db: dict) -> None:
"""
For internal use only. Batch commit of attribute values
Args:
python_commit_db : Dictionary of attributes as keys and data as values
"""
def _prefetch_input_attributes_data(python_prefetch_db: list) -> list:
"""
For internal use only.
Args:
python_prefetch_db : List of attributes
Returns:
list[Any]: Prefetched attribute values
"""
def acquire_interface(plugin_name: str = None, library_path: str = None) -> ComputeGraph:
pass
def attach(stage_id: int, mps: float) -> None:
"""
Attach the graph to a particular stage.
Args:
stage_id (int): The stage id of the stage to attach to
mps (float): the meters per second setting for the stage
"""
def deregister_node_type(name: str) -> bool:
"""
Deregisters a python subnode type with OmniGraph.
Args:
name (str): Name of the Python node type being deregistered
Returns:
bool: True if the deregistration was successful, else False
"""
def deregister_post_load_file_format_upgrade_callback(postload_handle: int) -> None:
"""
De-registers the postload callback to be invoked when the file format version changes.
Args:
postload_handle (int): The handle that was returned during the register_post_load_file_format_upgrade_callback call
"""
def deregister_pre_load_file_format_upgrade_callback(preload_handle: int) -> None:
"""
De-registers the preload callback to be invoked when the file format version changes.
Args:
preload_handle (int): The handle that was returned during the register_pre_load_file_format_upgrade_callback call
"""
def detach() -> None:
"""
Detaches the graph from the currently attached stage.
"""
def get_all_graphs() -> typing.List[Graph]:
"""
Get all of the top-level non-orchestration graphs
Returns:
list[omni.graph.core.Graph]: A list of the top level graphs (non-orchestration) in OmniGraph.
"""
def get_all_graphs_and_subgraphs() -> typing.List[Graph]:
"""
Get all of the non-orchestration graphs
Returns:
list[omni.graph.core.Graph]: A list of the (non-orchestration) in OmniGraph.
"""
def get_bundle_tree_factory_interface() -> IBundleFactory:
"""
Gets an object that can interface with an IBundleFactory
Returns:
omni.graph.core.IBundleFactory: Object that can interface with the bundle tree
"""
def get_compute_graph_contexts() -> typing.List[GraphContext]:
"""
Gets all of the current graph contexts
Returns:
list[omni.graph.core.GraphContext]: A list of all graph contexts in OmniGraph.
"""
def get_global_orchestration_graphs() -> typing.List[Graph]:
"""
Gets the global orchestration graphs
Returns:
list[omni.graph.core.Graph]: A list of the global orchestration graphs that house all other graphs.
"""
def get_global_orchestration_graphs_in_pipeline_stage(pipeline_stage: GraphPipelineStage) -> typing.List[Graph]:
"""
Returns a list of the global orchestration graphs that house all other graphs for a given pipeline stage.
Args:
pipeline_stage (omni.graph.core.GraphPipelineStage): The pipeline stage in question
Returns:
list[omni.graph.core.Graph]: A list of the global orchestration graphs in the given pipeline stage
"""
def get_graph_by_path(path: str) -> object:
"""
Finds the graph with the given path.
Args:
path (str): The path of the graph. For example "/World/PushGraph"
Returns:
omni.graph.core.Graph: The matching graph, or None if it was not found.
"""
def get_graphs_in_pipeline_stage(pipeline_stage: GraphPipelineStage) -> typing.List[Graph]:
"""
Returns a list of the non-orchestration graphs for a given pipeline stage (simulation, pre-render, post-render)
Args:
pipeline_stage (omni.graph.core.GraphPipelineStage): The pipeline stage in question
Returns:
list[omni.graph.core.Graph]: The list of graphs belonging to the pipeline stage
"""
def get_node_by_path(path: str) -> object:
"""
Get a node that lives at a given path
Args:
path (str): Path at which to find the node
Returns:
omni.graph.core.Node: The node corresponding to a node path in OmniGraph, None if no node was found at that path.
"""
def get_node_categories_interface() -> INodeCategories:
"""
Gets an object for accessing the node categories
Returns:
omni.graph.core.INodeCategories: Object that can interface with the category data
"""
def get_node_type(node_type_name: str) -> NodeType:
"""
Returns the registered node type object with the given name.
Args:
node_type_name (str): Name of the registered NodeType to find and return
Returns:
omni.graph.core.NodeType: NodeType object registered with the given name, None if it is not registered
"""
def get_registered_nodes() -> typing.List[str]:
"""
Get the currently registered node type names
Returns:
list[str]: The list of names of node types currently registered
"""
def is_global_graph_prim(prim_path: str) -> bool:
"""
Determines if the prim path passed in represents a prim that is backing a global graph
Args:
prim_path (str): The path to the prim in question
Returns:
bool: True if the prim path represents a prim that is backing a global graph, False otherwise
"""
def on_shutdown() -> None:
"""
For internal use only. Called to allow the Python API to clean up prior to the extension being unloaded.
"""
def register_node_type(name: object, version: int) -> None:
"""
Registers a new python subnode type with OmniGraph.
Args:
name (str): Name of the Python node type being registered
version (int): Version number of the Python node type being registered
"""
def register_post_load_file_format_upgrade_callback(callback: object) -> int:
"""
Registers a callback to be invoked when the file format version changes. Happens after the
file has already been parsed and stage attached to. The callback takes 3 parameters: the old file format version,
the new file format version, and the affected graph object.
Args:
callback (callable): The callback function
Returns:
int: A handle that could be used for deregistration. Note the calling module is responsible for deregistration
of the callback in all circumstances, including where the extension is hot-reloaded.
"""
def register_pre_load_file_format_upgrade_callback(callback: object) -> int:
"""
Registers a callback to be invoked when the file format version changes. Happens before the
file has already been parsed and stage attached to. The callback takes 3 parameters: the old file format version,
the new file format version, and a graph object (always invalid since the graph has not been created yet).
Args:
callback (callable): The callback function
Returns:
int: A handle that could be used for deregistration. Note the calling module is responsible for deregistration
of the callback in all circumstances, including where the extension is hot-reloaded.
"""
def register_python_node() -> None:
"""
Registers the unique Python node type with OmniGraph. This houses all of the Python node implementations as subtypes.
"""
def release_interface(arg0: ComputeGraph) -> None:
pass
def set_test_failure(has_failure: bool) -> None:
"""
Sets or clears a generic test failure.
Args:
has_failure (bool): If True then increment the test failure count, else clear it.
"""
def shutdown_compute_graph() -> None:
"""
Shuts down the compute graph. All data not backed by USD will be lost.
"""
def test_failure_count() -> int:
"""
Gets the number of active test failures
Returns:
int: The number of currently active test failures.
"""
def update(current_time: float, elapsed_time: float) -> None:
"""
Ticks the graph with the current time and elapsed time.
Args:
current_time (float): The current time
elapsed_time (float): The elapsed time since the last tick
"""
ACCORDING_TO_CONTEXT_GRAPH_INDEX = 18446744073709551614
APPLIED_SCHEMA: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.APPLIED_SCHEMA: 11>
ASSET: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.ASSET: 12>
AUTHORING_GRAPH_INDEX = 18446744073709551615
BOOL: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.BOOL: 1>
BUNDLE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.BUNDLE: 16>
COLOR: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.COLOR: 4>
CONNECTION: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.CONNECTION: 14>
DOUBLE: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.DOUBLE: 9>
ERROR: omni.graph.core._omni_graph_core.Severity # value = <Severity.ERROR: 2>
EXECUTION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.EXECUTION: 13>
FLOAT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.FLOAT: 8>
FRAME: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.FRAME: 8>
HALF: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.HALF: 7>
INFO: omni.graph.core._omni_graph_core.Severity # value = <Severity.INFO: 0>
INSTANCING_GRAPH_TARGET_PATH = '_OMNI_GRAPH_TARGET'
INT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.INT: 3>
INT64: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.INT64: 5>
MATRIX: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.MATRIX: 14>
NONE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.NONE: 0>
NORMAL: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.NORMAL: 2>
OBJECT_ID: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.OBJECT_ID: 15>
PATH: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.PATH: 17>
POSITION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.POSITION: 3>
PRIM: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.PRIM: 13>
PRIM_TYPE_NAME: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.PRIM_TYPE_NAME: 12>
QUATERNION: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.QUATERNION: 6>
RELATIONSHIP: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.RELATIONSHIP: 11>
TAG: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.TAG: 15>
TARGET: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TARGET: 20>
TEXCOORD: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TEXCOORD: 5>
TEXT: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TEXT: 10>
TIMECODE: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TIMECODE: 9>
TOKEN: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.TOKEN: 10>
TRANSFORM: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.TRANSFORM: 7>
UCHAR: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UCHAR: 2>
UINT: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UINT: 4>
UINT64: omni.graph.core._omni_graph_core.BaseDataType # value = <BaseDataType.UINT64: 6>
UNKNOWN: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.UNKNOWN: 21>
VECTOR: omni.graph.core._omni_graph_core.AttributeRole # value = <AttributeRole.VECTOR: 1>
WARNING: omni.graph.core._omni_graph_core.Severity # value = <Severity.WARNING: 1>
_internal = omni.graph.core._omni_graph_core._internal
_og_unstable = omni.graph.core._omni_graph_core._og_unstable
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/commands.py | import traceback
import omni.graph.tools as __ogt
from ._impl.commands import * # noqa: F401,PLW0401,PLW0614
_trace = "".join(traceback.format_stack())
__ogt.DeprecatedImport(f"Import 'omni.graph.core as og; help(og.cmds)' to access the OmniGraph commands\n{_trace}")
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/__init__.py | """
This file contains the interfaces that external Python scripts can use.
Import this file and use the APIs exposed below.
To get documentation on this module and methods import this file into a Python interpreter and run dir/help, like this:
.. code-block:: python
import omni.graph.core as og
help(og.get_graph_by_path)
"""
# fmt: off
# isort: off
import omni.core # noqa: F401 (Required for proper resolution of ONI wrappers)
# Get the bindings into the module
from . import _omni_graph_core # noqa: F401,PLW0406
from ._omni_graph_core import *
from ._impl.extension import _PublicExtension # noqa: F401
from ._impl.autonode.type_definitions import (
Color3d,
Color3f,
Color3h,
Color4d,
Color4f,
Color4h,
Double,
Double2,
Double3,
Double4,
Float,
Float2,
Float3,
Float4,
Half,
Half2,
Half3,
Half4,
Int,
Int2,
Int3,
Int4,
Matrix2d,
Matrix3d,
Matrix4d,
Normal3d,
Normal3f,
Normal3h,
Point3d,
Point3f,
Point3h,
Quatd,
Quatf,
Quath,
TexCoord2d,
TexCoord2f,
TexCoord2h,
TexCoord3d,
TexCoord3f,
TexCoord3h,
Timecode,
Token,
TypeRegistry,
UChar,
UInt,
Vector3d,
Vector3f,
Vector3h,
)
from ._impl.attribute_types import get_port_type_namespace
from ._impl.attribute_values import AttributeDataValueHelper
from ._impl.attribute_values import AttributeValueHelper
from ._impl.attribute_values import WrappedArrayType
from ._impl.bundles import Bundle
from ._impl.bundles import BundleContainer
from ._impl.bundles import BundleContents
from ._impl.bundles import BundleChanges
from ._impl.commands import cmds
from ._impl.controller import Controller
from ._impl.data_typing import data_shape_from_type
from ._impl.data_typing import DataWrapper
from ._impl.data_typing import Device
from ._impl.data_view import DataView
from ._impl.database import Database
from ._impl.database import DynamicAttributeAccess
from ._impl.database import DynamicAttributeInterface
from ._impl.database import PerNodeKeys
from ._impl.dtypes import Dtype
from ._impl.errors import OmniGraphError
from ._impl.errors import OmniGraphValueError
from ._impl.errors import ReadOnlyError
from ._impl.extension_information import ExtensionInformation
from ._impl.graph_controller import GraphController
from ._impl.inspection import OmniGraphInspector
from ._impl.node_controller import NodeController
from ._impl.object_lookup import ObjectLookup
from ._impl.runtime import RuntimeAttribute
from ._impl.settings import Settings
from ._impl.threadsafety_test_utils import ThreadsafetyTestUtils
from ._impl.traversal import traverse_downstream_graph
from ._impl.traversal import traverse_upstream_graph
from ._impl.type_resolution import resolve_base_coupled
from ._impl.type_resolution import resolve_fully_coupled
from ._impl.utils import attribute_value_as_usd
from ._impl.utils import get_graph_settings
from ._impl.utils import get_kit_version
from ._impl.utils import GraphSettings
from ._impl.utils import in_compute
from ._impl.utils import is_attribute_plain_data
from ._impl.utils import is_in_compute
from ._impl.utils import python_value_as_usd
from ._impl.utils import TypedValue
from . import autonode
from . import typing
from . import _unstable
# ==============================================================================================================
# These are symbols that should technically be prefaced with an underscore because they are used internally but
# not part of the public API but that would cause a lot of refactoring work so for now they are just added to the
# module contents but not the module exports.
# _ _ _____ _____ _____ ______ _ _
# | | | |_ _| __ \| __ \| ____| \ | |
# | |__| | | | | | | | | | | |__ | \| |
# | __ | | | | | | | | | | __| | . ` |
# | | | |_| |_| |__| | |__| | |____| |\ |
# |_| |_|_____|_____/|_____/|______|_| \_|
#
from ._impl.generate_ogn import generate_ogn_from_node
from ._impl.registration import PythonNodeRegistration
from ._impl.utils import load_example_file
from ._impl.utils import remove_attributes_if
from ._impl.utils import sync_to_usd
# ==============================================================================================================
# Soft-deprecated imports. Kept around for backward compatibility for one version.
# _____ ______ _____ _____ ______ _____ _______ ______ _____
# | __ \ | ____|| __ \ | __ \ | ____|/ ____| /\ |__ __|| ____|| __ \
# | | | || |__ | |__) || |__) || |__ | | / \ | | | |__ | | | |
# | | | || __| | ___/ | _ / | __| | | / /\ \ | | | __| | | | |
# | |__| || |____ | | | | \ \ | |____| |____ / ____ \ | | | |____ | |__| |
# |_____/ |______||_| |_| \_\|______|\_____|/_/ \_\|_| |______||_____/
#
from omni.graph.tools import RenamedClass as __RenamedClass # pylint: disable=wrong-import-order
from omni.graph.tools.ogn import MetadataKeys as __MetadataKeys # pylint: disable=wrong-import-order
MetadataKeys = __RenamedClass(__MetadataKeys, "MetadataKeys", "MetadataKeys has moved to omni.graph.tools.ogn")
# Ready for deletion, once omni.graph.window has removed its usage - OM-96121
def get_global_container_graphs() -> list[_omni_graph_core.Graph]:
import carb
carb.log_warn("get_global_container_graphs() has been deprecated - use get_global_orchestration_graphs() instead")
return _omni_graph_core.get_global_orchestration_graphs()
# ==============================================================================================================
# The bindings may have internal (single-underscore prefix) and external symbols. To be consistent with our export
# rules the internal symbols will be part of the module but not part of the published __all__ list, and the external
# symbols will be in both.
__bindings = []
for __bound_name in dir(_omni_graph_core):
# TODO: Right now the bindings and the core both define the same object type so they both can't be exported
# here so remove it from the bindings and it will be dealt with later.
if __bound_name in ["Bundle"]:
continue
if not __bound_name.startswith("__"):
if not __bound_name.startswith("_"):
__bindings.append(__bound_name)
globals()[__bound_name] = getattr(_omni_graph_core, __bound_name)
__all__ = __bindings + [
"attribute_value_as_usd",
"AttributeDataValueHelper",
"AttributeValueHelper",
"autonode",
"Bundle",
"BundleContainer",
"BundleContents",
"BundleChanges",
"cmds",
"Controller",
"data_shape_from_type",
"Database",
"DataView",
"DataWrapper",
"Device",
"Dtype",
"DynamicAttributeAccess",
"DynamicAttributeInterface",
"ExtensionInformation",
"get_graph_settings",
"get_kit_version",
"get_port_type_namespace",
"GraphController",
"GraphSettings",
"in_compute",
"is_attribute_plain_data",
"is_in_compute",
"MetadataKeys",
"NodeController",
"ObjectLookup",
"OmniGraphError",
"OmniGraphInspector",
"OmniGraphValueError",
"PerNodeKeys",
"python_value_as_usd",
"ReadOnlyError",
"resolve_base_coupled",
"resolve_fully_coupled",
"RuntimeAttribute",
"Settings",
"ThreadsafetyTestUtils",
"TypedValue",
"typing",
"WrappedArrayType",
"traverse_downstream_graph",
"traverse_upstream_graph",
"Color3d",
"Color3f",
"Color3h",
"Color4d",
"Color4f",
"Color4h",
"Double",
"Double2",
"Double3",
"Double4",
"Float",
"Float2",
"Float3",
"Float4",
"Half",
"Half2",
"Half3",
"Half4",
"Int",
"Int2",
"Int3",
"Int4",
"Matrix2d",
"Matrix3d",
"Matrix4d",
"Normal3d",
"Normal3f",
"Normal3h",
"Point3d",
"Point3f",
"Point3h",
"Quatd",
"Quatf",
"Quath",
"TexCoord2d",
"TexCoord2f",
"TexCoord2h",
"TexCoord3d",
"TexCoord3f",
"TexCoord3h",
"Timecode",
"Token",
"TypeRegistry",
"UChar",
"UInt",
"Vector3d",
"Vector3f",
"Vector3h",
]
_HIDDEN = [
"generate_ogn_from_node",
"get_global_container_graphs",
"PythonNodeRegistration",
"load_example_file",
"register_ogn_nodes",
"remove_attributes_if",
"sync_to_usd",
]
# isort: on
# fmt: on
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/setup.py | from setuptools import setup
from torch.utils.cpp_extension import BuildExtension, CUDAExtension
setup(
name="torch_wrap",
ext_modules=[CUDAExtension("torch_wrap", ["Py_WrapTensor.cpp"])],
cmdclass={"build_ext": BuildExtension},
)
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/autonode.py | """AutoNode - module for decorating code to populate it into OmniGraph nodes.
Allows generating nodes by decorating free functions, classes and modules by adding `@AutoFunc()` or `@AutoClass()` to
the declaration of the class.
Generating code relies on function signatures provided by python's type annotations, therefore the module only supports
native python types with `__annotations__`. CPython classes need need to be wrapped for now.
"""
from ._impl.autonode.autonode import (
AutoClass,
AutoFunc,
register_autonode_type_extension,
unregister_autonode_type_extension,
)
from ._impl.autonode.event import IEventStream
from ._impl.autonode.type_definitions import (
AutoNodeDefinitionGenerator,
AutoNodeDefinitionWrapper,
AutoNodeTypeConversion,
)
__all__ = [
"AutoClass",
"AutoFunc",
"AutoNodeDefinitionGenerator",
"AutoNodeDefinitionWrapper",
"AutoNodeTypeConversion",
"IEventStream",
"register_autonode_type_extension",
"unregister_autonode_type_extension",
]
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/omnigraph_utils.py | from omni.graph.tools import DeprecationError
raise DeprecationError("Import of omnigraph_utils no longer supported. Use 'import omni.graph.core as og' instead.")
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/_1_33.py | """Backward compatible module for omni.graph. version 1.33 and earlier.
This module contains everything that was formerly visible by default but will no longer be part of the Python API
for omni.graph. If there is something here you rely on contact the OmniGraph team and let them know.
Currently the module is in pre-deprecation, meaning you can still access everything here from the main module with
.. code-block:: python
import omni.graph. as og
og.pre_deprecated_but_still_visible()
Once the soft deprecation is enabled you will only be able to access the deprecated function with an explicit import:
.. code-block:: python
import omni.graph. as og
import omni.graph._1_33 as og1_33
if i_want_v1_33:
og1_33.soft_deprecated_but_still_accessible()
else:
og.current_function()
When hard deprecation is in place all functionality will be removed and import of this module will fail:
.. code-block:: python
import omni.graph._1_33 as ot1_33
# Raises DeprecationError
"""
from omni.graph.tools._impl.deprecate import (
DeprecatedClass,
DeprecatedImport,
DeprecateMessage,
RenamedClass,
deprecated_function,
)
from omni.graph.tools.ogn import MetadataKeys
# ==============================================================================================================
# Everything below here is deprecated, kept around for backward compatibility for one version.
# _____ ______ _____ _____ ______ _____ _______ ______ _____
# | __ \ | ____|| __ \ | __ \ | ____|/ ____| /\ |__ __|| ____|| __ \
# | | | || |__ | |__) || |__) || |__ | | / \ | | | |__ | | | |
# | | | || __| | ___/ | _ / | __| | | / /\ \ | | | __| | | | |
# | |__| || |____ | | | | \ \ | |____| |____ / ____ \ | | | |____ | |__| |
# |_____/ |______||_| |_| \_\|______|\_____|/_/ \_\|_| |______||_____/
#
from ._impl.attribute_types import extract_attribute_type_information, get_attribute_configuration
from ._impl.helpers import graph_iterator
from ._impl.object_lookup import ObjectLookup as _ObjectLookup
from ._impl.performance import OmniGraphPerformance
from ._impl.topology_commands import ConnectAttrsCommand as _ConnectAttrs
from ._impl.topology_commands import ConnectPrimCommand as _ConnectPrim
from ._impl.topology_commands import CreateAttrCommand as _CreateAttr
from ._impl.topology_commands import CreateGraphAsNodeCommand as _CreateGraphAsNode
from ._impl.topology_commands import CreateNodeCommand as _CreateNode
from ._impl.topology_commands import CreateSubgraphCommand as _CreateSubgraph
from ._impl.topology_commands import CreateVariableCommand as _CreateVariable
from ._impl.topology_commands import DeleteNodeCommand as _DeleteNode
from ._impl.topology_commands import DisconnectAllAttrsCommand as _DisconnectAllAttrs
from ._impl.topology_commands import DisconnectAttrsCommand as _DisconnectAttrs
from ._impl.topology_commands import DisconnectPrimCommand as _DisconnectPrim
from ._impl.topology_commands import RemoveAttrCommand as _RemoveAttr
from ._impl.topology_commands import RemoveVariableCommand as _RemoveVariable
from ._impl.utils import is_attribute_plain_data, temporary_setting
from ._impl.v1_5_0.context_helper import ContextHelper
from ._impl.v1_5_0.omnigraph_helper import (
BundledAttribute_t,
ConnectData_t,
ConnectDatas_t,
CreateNodeData_t,
CreateNodeDatas_t,
CreatePrimData_t,
CreatePrimDatas_t,
DeleteNodeData_t,
DeleteNodeDatas_t,
DisconnectData_t,
DisconnectDatas_t,
OmniGraphHelper,
SetValueData_t,
SetValueDatas_t,
)
from ._impl.v1_5_0.replaced_functions import attribute_type_from_ogn_type_name, attribute_type_from_usd_type_name
from ._impl.v1_5_0.update_file_format import can_set_use_schema_prims_setting, update_to_include_schema
from ._impl.v1_5_0.utils import (
ALLOW_IMPLICIT_GRAPH_SETTING,
ATTRIBUTE_TYPE_HINTS,
ATTRIBUTE_TYPE_TYPE_HINTS,
DISABLE_PRIM_NODES_SETTING,
ENABLE_LEGACY_PRIM_CONNECTIONS,
EXTENDED_ATTRIBUTE_TYPE_HINTS,
NODE_TYPE_HINTS,
USE_SCHEMA_PRIMS_SETTING,
)
from ._impl.value_commands import DisableGraphCommand as _DisableGraph
from ._impl.value_commands import DisableGraphUSDHandlerCommand as _DisableGraphUSDHandler
from ._impl.value_commands import DisableNodeCommand as _DisableNode
from ._impl.value_commands import EnableGraphCommand as _EnableGraph
from ._impl.value_commands import EnableGraphUSDHandlerCommand as _EnableGraphUSDHandler
from ._impl.value_commands import EnableNodeCommand as _EnableNode
from ._impl.value_commands import RenameNodeCommand as _RenameNode
from ._impl.value_commands import RenameSubgraphCommand as _RenameSubgraph
from ._impl.value_commands import SetAttrCommand as _SetAttr
from ._impl.value_commands import SetAttrDataCommand as _SetAttrData
from ._impl.value_commands import SetVariableTooltipCommand as _SetVariableTooltip
__all__ = [
"ALLOW_IMPLICIT_GRAPH_SETTING",
"attribute_type_from_ogn_type_name",
"attribute_type_from_usd_type_name",
"ATTRIBUTE_TYPE_HINTS",
"ATTRIBUTE_TYPE_TYPE_HINTS",
"BundledAttribute_t",
"can_set_use_schema_prims_setting",
"ConnectAttrsCommand",
"ConnectData_t",
"ConnectDatas_t",
"ConnectPrimCommand",
"ContextHelper",
"CreateAttrCommand",
"CreateGraphAsNodeCommand",
"CreateNodeCommand",
"CreateNodeData_t",
"CreateNodeDatas_t",
"CreatePrimData_t",
"CreatePrimDatas_t",
"CreateSubgraphCommand",
"CreateVariableCommand",
"DeleteNodeCommand",
"DeleteNodeData_t",
"DeleteNodeDatas_t",
"deprecated_function",
"DeprecatedClass",
"DeprecatedImport",
"DeprecateMessage",
"DISABLE_PRIM_NODES_SETTING",
"DisableGraphCommand",
"DisableGraphUSDHandlerCommand",
"DisableNodeCommand",
"DisconnectAllAttrsCommand",
"DisconnectAttrsCommand",
"DisconnectData_t",
"DisconnectDatas_t",
"DisconnectPrimCommand",
"ENABLE_LEGACY_PRIM_CONNECTIONS",
"EnableGraphCommand",
"EnableGraphUSDHandlerCommand",
"EnableNodeCommand",
"EXTENDED_ATTRIBUTE_TYPE_HINTS",
"extract_attribute_type_information",
"get_attribute_configuration",
"graph_iterator",
"is_attribute_plain_data",
"MetadataKeys",
"NODE_TYPE_HINTS",
"OmniGraphHelper",
"OmniGraphPerformance",
"OmniGraphTypes",
"RemoveAttrCommand",
"RemoveVariableCommand",
"RenamedClass",
"RenameNodeCommand",
"RenameSubgraphCommand",
"SetAttrCommand",
"SetAttrDataCommand",
"SetValueData_t",
"SetValueDatas_t",
"SetVariableTooltipCommand",
"temporary_setting",
"update_to_include_schema",
"USE_SCHEMA_PRIMS_SETTING",
]
ConnectAttrsCommand = RenamedClass(
_ConnectAttrs, "ConnectAttrsCommand", "import omni.graph.core as og; og.cmds.ConnectAttrs"
)
ConnectPrimCommand = RenamedClass(
_ConnectPrim, "ConnectPrimCommand", "import omni.graph.core as og; og.cmds.ConnectPrim"
)
CreateAttrCommand = RenamedClass(_CreateAttr, "CreateAttrCommand", "import omni.graph.core as og; og.cmdsCreateAttr")
CreateGraphAsNodeCommand = RenamedClass(
_CreateGraphAsNode, "CreateGraphAsNodeCommand", "import omni.graph.core as og; og.cmds.CreateGraphAsNode"
)
CreateNodeCommand = RenamedClass(_CreateNode, "CreateNodeCommand", "import omni.graph.core as og; og.cmds.CreateNode")
CreateSubgraphCommand = RenamedClass(
_CreateSubgraph, "CreateSubgraphCommand", "import omni.graph.core as og; og.cmds.CreateSubgraph"
)
CreateVariableCommand = RenamedClass(
_CreateVariable, "CreateVariableCommand", "import omni.graph.core as og; og.cmds.CreateVariable"
)
DeleteNodeCommand = RenamedClass(_DeleteNode, "DeleteNodeCommand", "import omni.graph.core as og; og.cmds.DeleteNode")
DisableGraphCommand = RenamedClass(
_DisableGraph, "DisableGraphCommand", "import omni.graph.core as og; og.cmds.DisableGraph"
)
DisableGraphUSDHandlerCommand = RenamedClass(
_DisableGraphUSDHandler,
"DisableGraphUSDHandlerCommand",
"import omni.graph.core as og; og.cmds.DisableGraphUSDHandler",
)
DisableNodeCommand = RenamedClass(
_DisableNode, "DisableNodeCommand", "import omni.graph.core as og; og.cmds.DisableNode"
)
DisconnectAllAttrsCommand = RenamedClass(
_DisconnectAllAttrs, "DisconnectAllAttrsCommand", "import omni.graph.core as og; og.cmds.DisconnectAllAttrs"
)
DisconnectAttrsCommand = RenamedClass(
_DisconnectAttrs, "DisconnectAttrsCommand", "import omni.graph.core as og; og.cmds.DisconnectAttrs"
)
DisconnectPrimCommand = RenamedClass(
_DisconnectPrim, "DisconnectPrimCommand", "import omni.graph.core as og; og.cmds.DisconnectPrim"
)
EnableGraphCommand = RenamedClass(
_EnableGraph, "EnableGraphCommand", "import omni.graph.core as og; og.cmds.EnableGraph"
)
EnableGraphUSDHandlerCommand = RenamedClass(
_EnableGraphUSDHandler,
"EnableGraphUSDHandlerCommand",
"import omni.graph.core as og; og.cmds.EnableGraphUSDHandler",
)
EnableNodeCommand = RenamedClass(_EnableNode, "EnableNodeCommand", "import omni.graph.core as og; og.cmds.EnableNode")
OmniGraphTypes = RenamedClass(_ObjectLookup, "OmniGraphTypes")
RemoveAttrCommand = RenamedClass(_RemoveAttr, "RemoveAttrCommand", "import omni.graph.core as og; og.cmds.RemoveAttr")
RemoveVariableCommand = RenamedClass(
_RemoveVariable, "RemoveVariableCommand", "import omni.graph.core as og; og.cmds.RemoveVariable"
)
RenameNodeCommand = RenamedClass(_RenameNode, "RenameNodeCommand", "import omni.graph.core as og; og.cmds.RenameNode")
RenameSubgraphCommand = RenamedClass(
_RenameSubgraph, "RenameSubgraphCommand", "import omni.graph.core as og; og.cmds.RenameSubgraph"
)
SetAttrCommand = RenamedClass(_SetAttr, "SetAttrCommand", "import omni.graph.core as og; og.cmds.SetAttr")
SetAttrDataCommand = RenamedClass(
_SetAttrData, "SetAttrDataCommand", "import omni.graph.core as og; og.cmds.SetAttrData"
)
SetVariableTooltipCommand = RenamedClass(
_SetVariableTooltip, "SetVariableTooltipCommand", "import omni.graph.core as og; og.cmds.SetVariableTooltip"
)
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/_unstable.py | # =============================================================================================================================
# This submodule is work-in-progress and subject to change without notice
# _ _ _____ ______ _______ __ ______ _ _ _____ ______ ___ _ _____ _____ _____ _ __
# | | | |/ ____| ____| /\|__ __| \ \ / / __ \| | | | __ \ / __ \ \ / / \ | | | __ \|_ _|/ ____| |/ /
# | | | | (___ | |__ / \ | | \ \_/ / | | | | | | |__) | | | | \ \ /\ / /| \| | | |__) | | | | (___ | ' /
# | | | |\___ \| __| / /\ \ | | \ /| | | | | | | _ / | | | |\ \/ \/ / | . ` | | _ / | | \___ \| <
# | |__| |____) | |____ / ____ \| | | | | |__| | |__| | | \ \ | |__| | \ /\ / | |\ | | | \ \ _| |_ ____) | . \
# \____/|_____/|______| /_/ \_\_| |_| \____/ \____/|_| \_\ \____/ \/ \/ |_| \_| |_| \_\_____|_____/|_|\_|
from . import _omni_graph_core as __cpp_bindings
from ._impl.unstable.commands import cmds # noqa: F401
from ._impl.unstable.subgraph_compound_commands import ( # noqa: F401
validate_attribute_for_promotion_from_compound_subgraph,
validate_nodes_for_compound_subgraph,
)
# Import the c++ bindings from the _unstable submodule.
__bindings = []
for __bound_name in dir(__cpp_bindings._og_unstable): # noqa PLW0212
if not __bound_name.startswith("__"):
if not __bound_name.startswith("_"):
__bindings.append(__bound_name)
globals()[__bound_name] = getattr(__cpp_bindings._og_unstable, __bound_name) # noqa PLW0212
__all__ = __bindings + [
"cmds",
"validate_attribute_for_promotion_from_compound_subgraph",
"validate_nodes_for_compound_subgraph",
]
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/typing.py | """OmniGraph submodule that handles all of the OmniGraph API typing information.
.. code-block:: python
import omni.graph.core.typing as ogty
def do_attribute_stuff(attribute: ogty.Attribute_t):
pass
"""
from ._impl.typing import (
Attribute_t,
Attributes_t,
AttributeSpec_t,
AttributeSpecs_t,
AttributesWithValues_t,
AttributeType_t,
AttributeTypeSpec_t,
AttributeWithValue_t,
ExtendedAttribute_t,
Graph_t,
Graphs_t,
GraphSpec_t,
GraphSpecs_t,
NewNode_t,
Node_t,
Nodes_t,
NodeSpec_t,
NodeSpecs_t,
NodeType_t,
Prim_t,
PrimAttrs_t,
Prims_t,
)
from ._impl.utils import AttributeValue_t, AttributeValues_t, ValueToSet_t
__all__ = [
"Attribute_t",
"Attributes_t",
"AttributeSpec_t",
"AttributeSpecs_t",
"AttributesWithValues_t",
"AttributeType_t",
"AttributeTypeSpec_t",
"AttributeValue_t",
"AttributeValues_t",
"AttributeWithValue_t",
"ExtendedAttribute_t",
"Graph_t",
"Graphs_t",
"GraphSpec_t",
"GraphSpecs_t",
"NewNode_t",
"Node_t",
"Nodes_t",
"NodeSpec_t",
"NodeSpecs_t",
"NodeType_t",
"Prim_t",
"PrimAttrs_t",
"Prims_t",
"ValueToSet_t",
]
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/bindings.py | """Temporary measure for backwards compatibility to import bindings from old module structure.
The generated PyBind libraries used to be in omni/graph/core/bindings/. They were moved to
omni/graph/core to correspond to the example extension structure for Python imports. All this
file does is make the old import "import omni.graph.core.bindings._omni_graph_core" work the
same as the new one "import omni.graph.core._omni_graph_core"
"""
import omni.graph.core._omni_graph_core as bindings
_omni_graph_core = bindings
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/_impl/inspection.py | """Helpers for running inspection on OmniGraph objects"""
import json
from contextlib import suppress
from typing import Dict, List, Optional, Union
import carb
import omni.graph.core as og
from .errors import OmniGraphError
# The types the inspector understands
_OmniGraphObjectTypes = Union[og.Graph, og.GraphContext, og.GraphRegistry, og.NodeType]
class OmniGraphInspector:
"""Provides simple interfaces for inspection of OmniGraph objects"""
def __init__(self):
"""Import the inspection interface, logging a warning if it doesn't exist.
This allows the functions to silently fail, while still providing an alert to the user as to why their
inspection operations might not work as expected.
"""
try:
import omni.inspect as oi
except ImportError as error:
carb.log_warn(f"Load the omni.inspect extension to use OmniGraphInspector ({error})")
oi = None
self.__oi = oi
# ----------------------------------------------------------------------
def available(self) -> bool:
"""Returns true if the inspection capabilities are available"""
return self.__oi is not None
# ----------------------------------------------------------------------
def memory_use(self, omnigraph_object: _OmniGraphObjectTypes) -> int:
"""Returns the number of bytes of memory used by the object, if it supports it
Args:
omnigraph_object: Object whose memory use is to be inspected
Raises:
OmniGraphError: If the object type doesn't support memory inspection
"""
if not self.__oi:
return 0
if type(omnigraph_object) not in [og.GraphContext, og.NodeType]:
raise OmniGraphError("Memory use can only be inspected on graph contexts and node types")
memory_inspector = self.__oi.IInspectMemoryUse()
omnigraph_object.inspect(memory_inspector)
return memory_inspector.total_used()
# ----------------------------------------------------------------------
def as_text(self, omnigraph_object: _OmniGraphObjectTypes, file_path: Optional[str] = None) -> str:
"""Returns the serialized data belonging to the context (for debugging)
Args:
omnigraph_object: Object whose memory use is to be inspected
file_path: If a string then dump the output to a file at that path, otherwise return a string with the dump
Returns:
If no file_path was specified then return the inspected data.
If a file_path was specified then return the path where the data was written (should be the same)
Raises:
OmniGraphError: If the object type doesn't support memory inspection
"""
if not self.__oi:
return ""
if not isinstance(omnigraph_object, og.GraphContext):
raise OmniGraphError("Serialization only works on graph contexts")
serializer = self.__oi.IInspectSerializer()
if file_path is None:
serializer.set_output_to_string()
else:
serializer.output_to_file_path = file_path
omnigraph_object.inspect(serializer)
return serializer.as_string() if file_path is None else serializer.get_output_location()
# ----------------------------------------------------------------------
def as_json(
self,
omnigraph_object: _OmniGraphObjectTypes,
file_path: Optional[str] = None,
flags: Optional[List[str]] = None,
) -> str:
"""Outputs the JSON format data belonging to the context (for debugging)
Args:
omnigraph_object: Object whose memory use is to be inspected
file_path: If a string then dump the output to a file at that path, otherwise return a string with the dump
flags: Set of enabled flags on the inspection object. Valid values are:
maps: Show all of the attribute type maps (lots of redundancy here, and independent of data present)
noDataDetails: Hide the minutiae of where each attribute's data is stored in FlatCache
Returns:
If no file_path was specified then return the inspected data.
If a file_path was specified then return the path where the data was written (should be the same)
Raises:
OmniGraphError: If the object type doesn't support memory inspection
"""
if not self.__oi:
return "{}"
if not type(omnigraph_object) in [og.GraphContext, og.Graph, og.NodeType, og.GraphRegistry]:
raise OmniGraphError(
"JSON serialization only works on graphs, graph contexts, node types, and the registry"
)
if flags is None:
flags = []
serializer = self.__oi.IInspectJsonSerializer()
for flag in flags:
serializer.set_flag(flag, True)
if file_path is None:
serializer.set_output_to_string()
else:
serializer.output_to_file_path = file_path
omnigraph_object.inspect(serializer)
if "help" in flags:
return serializer.help_information()
return serializer.as_string() if file_path is None else serializer.get_output_location()
# ----------------------------------------------------------------------
def attribute_locations(self, context: og.GraphContext) -> Dict[str, Dict[str, int]]:
"""Find all of the attribute data locations within FlatCache for the given context.
Args:
context: Graph context whose FlatCache data is to be inspected
Returns:
Dictionary with KEY = path, VALUE = { attribute name : attribute memory location }
"""
if not self.__oi:
return {}
serializer = self.__oi.IInspectJsonSerializer()
serializer.set_output_to_string()
context.inspect(serializer)
ignored_suffixes = ["_gpuElemCount", "_elemCount", "_cpuElemCount"]
try:
json_data = json.loads(serializer.as_string())["GraphContext"]["FlatCache"]["Bucket Contents"]
locations = {}
for bucket_id, bucket_info in json_data.items():
with suppress(KeyError):
paths = bucket_info["Path List"]
path_locations = [{} for _ in paths] if paths else [{}]
for storage_name, storage_info in bucket_info["Mirrored Arrays"].items():
abort = False
for suffix in ignored_suffixes:
if storage_name.endswith(suffix):
abort = True
if abort:
continue
# If the storage has no CPU location ignore it for now
with suppress(KeyError):
location = storage_info["CPU Data Location"]
data_size = storage_info["CPU Data Size"]
data_size = data_size / len(paths) if paths else data_size
if paths:
for i, _path in enumerate(paths):
path_locations[i][storage_name] = hex(int(location))
location += data_size
else:
path_locations[0][storage_name] = hex(int(location))
if paths:
for i, path in enumerate(paths):
locations[path] = path_locations[i]
else:
locations[f"NULL{bucket_id}"] = path_locations[0]
return locations
except Exception as error:
raise OmniGraphError("Could not get the FlatCache contents to analyze") from error
|
omniverse-code/kit/exts/omni.graph/omni/graph/core/_impl/attribute_types.py | """Support for nicer access to attribute types"""
from contextlib import suppress
import omni.graph.core as og
from .object_lookup import ObjectLookup
from .typing import AttributeWithValue_t
# Deprecated function support
from .v1_5_0.replaced_functions import BASE_DATA_TYPE_MAP # noqa
from .v1_5_0.replaced_functions import ROLE_MAP # noqa
from .v1_5_0.replaced_functions import attribute_type_from_ogn_type_name # noqa
from .v1_5_0.replaced_functions import attribute_type_from_usd_type_name # noqa
# Mapping of the port type onto the namespace that the port type will enforce on attributes with that type
PORT_TYPE_NAMESPACES = {
og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: "inputs",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: "outputs",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: "state",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: "unknown",
}
# Mapping of the port type onto the namespace that the port type will enforce on attributes with that type
PORT_TYPE_NAMESPACES = {
og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT: "inputs",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT: "outputs",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE: "state",
og.AttributePortType.ATTRIBUTE_PORT_TYPE_UNKNOWN: "unknown",
}
# ================================================================================
def get_port_type_namespace(port_type: og.AttributePortType) -> str:
"""Returns a string representing the namespace attributes of the named port type reside in"""
return PORT_TYPE_NAMESPACES[port_type]
# ----------------------------------------------------------------------
def get_attribute_configuration(attr: AttributeWithValue_t):
"""Get the array configuration information from the attribute.
Attributes can be simple, tuples, or arrays of either. The information on what this is will be
encoded in the attribute type name. This method decodes that type name to find out what type of
attribute data the attribute will use.
The method also gives the right answers for both Attribute and AttributeData with some suitable AttributeError
catches to special case on unimplemented methods.
Args:
attr: Attribute whose configuration is being determined
Returns:
Tuple of:
str: Name of the full/resolved data type used by the attribute (e.g. "float[3][]")
str: Name of the simple data type used by the attribute (e.g. "float")
bool: True if the data type is a tuple or array (e.g. "float3" or "float[]")
bool: True if the data type is a matrix and should be flattened (e.g. "matrixd[3]" or "framed[4][]")
Raises:
TypeError: If the attribute type is not yet supported
"""
# The actual data in extended types is the resolved type name; the attribute type is always token
ogn_type = attr.get_resolved_type() if isinstance(attr, og.Attribute) else attr.get_type()
type_name = ogn_type.get_ogn_type_name()
# The root name is important for lookup
root_type_name = ogn_type.get_base_type_name()
if ogn_type.base_type == og.BaseDataType.UNKNOWN and (
attr.get_extended_type()
in (og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY, og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION)
):
raise TypeError(f"Attribute '{attr.get_name()}' is not resolved, and so has no concrete type")
is_array_type = ogn_type.array_depth > 0 and ogn_type.role not in [og.AttributeRole.TEXT, og.AttributeRole.PATH]
is_matrix_type = (
type_name.startswith("matrix") or type_name.startswith("frame") or type_name.startswith("transform")
)
# Gather nodes automatically add one level of array to their attributes
is_gather_node = False
with suppress(AttributeError):
is_gather_node = attr.get_node().get_type_name() == "Gather"
if is_gather_node:
if is_array_type:
raise TypeError("Array types on Gather nodes are not yet supported in Python")
is_array_type = True
# Arrays of arrays are not yet supported in flatcache so they cannot be supported in Python
if ogn_type.array_depth > 1:
raise TypeError("Nested array types are not yet supported in Python")
return (type_name, root_type_name, is_array_type, is_matrix_type)
# ==============================================================================================================
def extract_attribute_type_information(attribute_object: AttributeWithValue_t) -> og.Type:
"""Decompose the type of an attribute into the parts relevant to getting and setting values.
The naming of the attribute get and set methods in the Python bindings are carefully constructed to correspond
to the ones returned here, to avoid construction of huge lookup tables. It makes the types instantly recognize
newly added support, and it makes them easier to expand, at the cost of being less explicit about the
correspondance between type and method.
Note:
If the attribute type is determined at runtime (e.g. Union or Any) then the resolved type is used.
When the type is not yet resolved the raw types of the attributes are returned (usually "token")
Args:
attribute_object: Attribute-like object that has an attribute type that can be decomposed
Returns:
og.Type with the type information of the attribute_object
Raises:
TypeError: If the attribute type or attribute type object is not supported
"""
# The actual data in extended types is the resolved type name; the attribute type is always token
type_name = None
with suppress(AttributeError):
if attribute_object.get_extended_type() in [
og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY,
og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION,
]:
type_name = attribute_object.get_resolved_type()
if type_name is None:
try:
type_name = attribute_object.get_type_name()
except AttributeError:
type_name = attribute_object.get_type()
# If a type was directly returned then it already has the information required
if isinstance(type_name, og.Type):
return type_name
return og.AttributeType.type_from_sdf_type_name(type_name)
# ==============================================================================================================
def get_attr_type(attr_info: AttributeWithValue_t):
"""
Get the type for the given attribute, taking in to account extended type
Args:
attr: Attribute whose type is to be determined
Returns:
The type of the attribute
"""
if isinstance(attr_info, og.AttributeData):
return attr_info.get_type()
attribute = ObjectLookup.attribute(attr_info)
if attribute is None:
raise og.OmniGraphError(f"Could not identify attribute from {attr_info} to get its type")
return attribute.get_resolved_type()
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.