Include dependency graph for engine.h:

This graph shows which files directly or indirectly include this file:

Classes
class	UsdImagingGLEngine
	The UsdImagingGLEngine is the main entry point API for rendering USD scenes. More...

struct	UsdImagingGLEngine::Parameters
	Parameters to construct UsdImagingGLEngine. More...

struct	UsdImagingGLEngine::IntersectionResult
	Pick result. More...

struct	UsdImagingGLEngine::PickParams
	Pick params. More...

Typedefs
using	UsdStageWeakPtr = TfWeakPtr<class UsdStage>

using	_AppSceneIndicesSharedPtr = std::shared_ptr<struct _AppSceneIndices>

Functions
	TF_DECLARE_WEAK_AND_REF_PTRS (GlfSimpleLightingContext)

	TF_DECLARE_REF_PTRS (UsdImagingSceneIndex)

	TF_DECLARE_REF_PTRS (UsdImagingRootOverridesSceneIndex)

	TF_DECLARE_REF_PTRS (HdCachingSceneIndex)

	TF_DECLARE_REF_PTRS (HdsiLegacyDisplayStyleOverrideSceneIndex)

	TF_DECLARE_REF_PTRS (HdsiPrimTypeAndPathPruningSceneIndex)

	TF_DECLARE_REF_PTRS (HdsiSceneGlobalsSceneIndex)

	TF_DECLARE_REF_PTRS (HdSceneIndexBase)

	TF_DECLARE_REF_PTRS (HdMergingSceneIndex)

	TF_DECLARE_REF_PTRS (HdxTaskControllerSceneIndex)

	TF_DECLARE_REF_PTRS (UsdExecImagingStageSceneIndexInterface)

Class Documentation

◆ UsdImagingGLEngine::Parameters

struct UsdImagingGLEngine::Parameters

Parameters to construct UsdImagingGLEngine.

Definition at line 88 of file engine.h.

Class Members
bool	allowAsynchronousSceneProcessing = false	`allowAsynchronousSceneProcessing` indicates to constructed hydra scene indices that asynchronous processing is allowow. Applications should perodically call PollForAsynchronousUpdates on the engine.
bool	displayUnloadedPrimsWithBounds = false	`displayUnloadedPrimsWithBounds` draws bounding boxes for unloaded prims if they have extents/extentsHint authored.
HdDriver	driver	An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if your application creates multiple UsdImagingGLEngine's that wish to use the same HdDriver / Hgi.
bool	enableUsdDrawModes = true	`enableUsdDrawModes` enables the UsdGeomModelAPI draw mode feature.
SdfPathVector	excludedPaths
bool	gpuEnabled = true	The `gpuEnabled` argument determines if this instance will allow Hydra to use the GPU to produce images.
SdfPathVector	invisedPaths
TfToken	rendererPluginId	The `rendererPluginId` argument indicates the renderer plugin that Hydra should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of `gpuEnabled`.
SdfPath	rootPath = SdfPath::AbsoluteRootPath()
SdfPath	sceneDelegateID = SdfPath::AbsoluteRootPath()

◆ UsdImagingGLEngine::IntersectionResult

struct UsdImagingGLEngine::IntersectionResult

Pick result.

This includes the necessary information to identify the picked instance.

That is, if the picked prim is instanced by a point instancer, the instancer path and the instance corresponding to the picked instance are reported in the instancer context. If a picked prim is USD native instance, the USD proxy path is used instead for the hitPrimPath. Note that nested scenarios are supported. If a point instancer itself is a native instance, its USD proxy path is reported in the instancer context.

Definition at line 324 of file engine.h.

Class Members
int	hitInstanceIndex	Deprecated instancerContext has more complete information.
SdfPath	hitInstancerPath	Deprecated instancerContext has more complete information.
GfVec3d	hitNormal	Normal at intersection point in world space.
GfVec3d	hitPoint	Intersection point in world space (that is, given projectionMatrix and viewMatrix are factored out of the result when picking is using, for example, the depth buffer).
SdfPath	hitPrimPath	Path to picked gprim on the USD stage. This is a USD proxy path.
HdInstancerContext	instancerContext	Paths to nested point instancers and instance indices identifying the picked instance. This is in order from the outer most to the inner most point instancer. The paths are USD proxy paths to the relevant point instancers on the USD stage. Hydra instancers created to realize USD native instancing are not included.

◆ UsdImagingGLEngine::PickParams

struct UsdImagingGLEngine::PickParams

Pick params.

Definition at line 350 of file engine.h.

Class Members

TfToken

resolveMode

Resolve mode.

If resolve mode is set to resolveDeep, picking uses Deep Selection to gather all paths within the given frustum even if obscured by other visible objects. If resolve mode is set to resolveNearestToCenter, picking renders to a customized depth buffer to find all approximate points of intersection. This is less accurate than implicit methods or rendering with GL_SELECT, but leverages any data already cached in the renderer.

The tokens are defined in HdxPickResolveMode in hdx/pickTask.h.

Typedef Documentation

◆ _AppSceneIndicesSharedPtr

using _AppSceneIndicesSharedPtr = std::shared_ptr<struct _AppSceneIndices>

Definition at line 77 of file engine.h.

◆ UsdStageWeakPtr

using UsdStageWeakPtr = TfWeakPtr<class UsdStage>

Definition at line 73 of file engine.h.

Classes

Typedefs