#include <coordSysPrimSceneIndex.h>

Inheritance diagram for HdsiCoordSysPrimSceneIndex:

Classes
struct	_Binding

Public Member Functions
HDSI_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override

HDSI_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override

Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector < HdSceneIndexBaseRefPtr >	GetInputScenes () const final

Public Member Functions inherited from HdSceneIndexBase
HD_API	HdSceneIndexBase ()

HD_API	~HdSceneIndexBase () override

HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)

HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)

HdDataSourceBaseHandle	GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const

HD_API void	SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)

HD_API std::string	GetDisplayName () const

HD_API void	SetDisplayName (const std::string &n)

HD_API void	AddTag (const TfToken &tag)

HD_API void	RemoveTag (const TfToken &tag)

HD_API bool	HasTag (const TfToken &tag) const

HD_API TfTokenVector	GetTags () const

Public Member Functions inherited from TfRefBase
	TfRefBase ()

	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object. More...

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object. More...

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase ()

	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions
static HdsiCoordSysPrimSceneIndexRefPtr	New (HdSceneIndexBaseRefPtr const &inputScene)

Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Protected Types
using	_Bindings = std::vector< _Binding >

using	_PrimToBindings = std::map< SdfPath, _Bindings >

Protected Member Functions
HDSI_API	HdsiCoordSysPrimSceneIndex (HdSceneIndexBaseRefPtr const &inputScene)

void	_PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override

void	_PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override

void	_PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override

void	_AddBindingsForPrim (const SdfPath &primPath, SdfPathSet *addedCoordSysPrims=nullptr)

void	_RemoveBindings (const _Bindings &bindings, SdfPathSet *removedCoordSysPrims)

void	_RemoveBindingsForPrim (const SdfPath &primPath, SdfPathSet *removedCoordSysPrims)

void	_RemoveBindingsForSubtree (const SdfPath &primPath, SdfPathSet *removedCoordSysPrims)

HdContainerDataSourceHandle	_GetCoordSysPrimSource (const SdfPath &primPath) const

Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API	HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)

virtual HD_API void	_PrimsRenamed (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RenamedPrimEntries &entries)

const HdSceneIndexBaseRefPtr &	_GetInputSceneIndex () const

Protected Member Functions inherited from HdSceneIndexBase
HD_API void	_SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)

HD_API void	_SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)

HD_API void	_SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)

HD_API void	_SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)

HD_API bool	_IsObserved () const

virtual HD_API void	_SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)

Protected Member Functions inherited from TfRefBase
virtual TF_API	~TfRefBase ()

Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()

TfRefPtr< Tf_Remnant >	_Register () const

template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const

bool	_HasRemnant () const

Additional Inherited Members
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Detailed Description

If prim P has a coord sys binding FOO to another prim Q, the scene index will add a coord sys prim Q.__coordSys:FOO under Q. It will rewrite the coord sys binding on P to point to Q.__coordSys:FOO and use Q's xform data source for Q.__coordSys:FOO.

Motivation: USD allows for a coord sys binding to target any xformable prim. Some render delegates, however, only allow a coord sys binding to point to a prim of type coord sys. This scene index is creating prim's of that type for such render delegates.

For compatibility with the UsdImagingDelegate which is already adding a coord sys prim under Q itself using a property path, we ignore coord sys bindings to paths which are not prim paths.

An example:

Input to scene index:

/MyXform dataSource: xform: [ some xform ] /MyPrim dataSource: coordSysBinding: FOO: /MyXform

Will be transformed to:

/MyXform dataSource: xform: [ some xform ] /MyXform.__coordSys:FOO dataSource: coordSys: name: FOO xform: [ as above ] /MyPrim dataSource: coordSysBinding: FOO: /MyXform.__coordSys:FOO

Definition at line 62 of file coordSysPrimSceneIndex.h.

Member Typedef Documentation

using HdsiCoordSysPrimSceneIndex::_Bindings = std::vector<_Binding>

protected

Definition at line 105 of file coordSysPrimSceneIndex.h.

using HdsiCoordSysPrimSceneIndex::_PrimToBindings = std::map<SdfPath, _Bindings>

protected

Definition at line 106 of file coordSysPrimSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdsiCoordSysPrimSceneIndex::HdsiCoordSysPrimSceneIndex ( HdSceneIndexBaseRefPtr const & inputScene )

protected

Member Function Documentation

void HdsiCoordSysPrimSceneIndex::_AddBindingsForPrim	(	const SdfPath &	primPath,
		SdfPathSet *	addedCoordSysPrims = `nullptr`
	)

protected

HdContainerDataSourceHandle HdsiCoordSysPrimSceneIndex::_GetCoordSysPrimSource ( const SdfPath & primPath ) const

protected

void HdsiCoordSysPrimSceneIndex::_PrimsAdded	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::AddedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiCoordSysPrimSceneIndex::_PrimsDirtied	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::DirtiedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiCoordSysPrimSceneIndex::_PrimsRemoved	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::RemovedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiCoordSysPrimSceneIndex::_RemoveBindings	(	const _Bindings &	bindings,
		SdfPathSet *	removedCoordSysPrims
	)

protected

void HdsiCoordSysPrimSceneIndex::_RemoveBindingsForPrim	(	const SdfPath &	primPath,
		SdfPathSet *	removedCoordSysPrims
	)

protected

void HdsiCoordSysPrimSceneIndex::_RemoveBindingsForSubtree	(	const SdfPath &	primPath,
		SdfPathSet *	removedCoordSysPrims
	)

protected

HDSI_API SdfPathVector HdsiCoordSysPrimSceneIndex::GetChildPrimPaths ( const SdfPath & primPath ) const

overridevirtual

Returns the paths of all scene index prims located immediately below primPath. This function can be used to traverse the scene by recursing from SdfPath::AbsoluteRootPath(); such a traversal is expected to give the same set of prims as the flattening of the scene index's PrimsAdded and PrimsRemoved messages. This function is expected to be threadsafe.

Implements HdSceneIndexBase.

HDSI_API HdSceneIndexPrim HdsiCoordSysPrimSceneIndex::GetPrim ( const SdfPath & primPath ) const

overridevirtual

Returns a pair of (prim type, datasource) for the object at primPath. If no such object exists, the type will be the empty token and the datasource will be null. This function is expected to be threadsafe.

Implements HdSceneIndexBase.

static HdsiCoordSysPrimSceneIndexRefPtr HdsiCoordSysPrimSceneIndex::New ( HdSceneIndexBaseRefPtr const & inputScene )

inlinestatic

Creates a new coord sys prim scene index.

Definition at line 68 of file coordSysPrimSceneIndex.h.

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

pxr/imaging/hdsi/coordSysPrimSceneIndex.h

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation