Information about an instancer instancing a picked object (or an instancer instancing such an instancer and so on). More...

#include <pickTask.h>

Public Attributes
SdfPath	instancerSceneIndexPath
	The path of the instancer in the scene index.

HdContainerDataSourceHandle	instancerPrimOrigin
	The prim origin data source of the instancer.

SdfPath	instanceSceneIndexPath
	For implicit instancing (native instancing in USD), the path of the picked instance in the scene index.

HdContainerDataSourceHandle	instancePrimOrigin
	The prim origin data source of the picked (implicit) instance.

int	instanceId
	Index of the picked instance.

Detailed Description

Information about an instancer instancing a picked object (or an instancer instancing such an instancer and so on).

Definition at line 128 of file pickTask.h.

Member Data Documentation

◆ instanceId

int instanceId

Index of the picked instance.

Definition at line 158 of file pickTask.h.

◆ instancePrimOrigin

HdContainerDataSourceHandle instancePrimOrigin

The prim origin data source of the picked (implicit) instance.

Note that typically, exactly one of instancePrimOrigin or instancerPrimOrigin will contain data depending on whether the instancing at the current level was implicit or not, respectively. This is because for implicit instancing, there is no authored instancer in the original scene (e.g., no USD instancer prim for USD native instancing).

For non-nested implicit instancing, the scenePath of the instancePrimOrigin will be an absolute path. For nested implicit instancing, the scenePath of the instancePrimOrigin is an absolute path for the outer instancer context and a relative path otherwise. The relative path corresponds to an instance within a prototype that was itself instanced. It is relative to the prototype's root.

Definition at line 156 of file pickTask.h.

◆ instancerPrimOrigin

HdContainerDataSourceHandle instancerPrimOrigin

The prim origin data source of the instancer.

Definition at line 133 of file pickTask.h.

◆ instancerSceneIndexPath

SdfPath instancerSceneIndexPath

The path of the instancer in the scene index.

Definition at line 131 of file pickTask.h.

◆ instanceSceneIndexPath

SdfPath instanceSceneIndexPath

For implicit instancing (native instancing in USD), the path of the picked instance in the scene index.

Definition at line 137 of file pickTask.h.

The documentation for this struct was generated from the following file:

pxr/imaging/hdx/pickTask.h