UsdImagingDataSourcePointInstancerMask Class Reference

A data source representing a point instancer's instance mask. More...

Inheritance diagram for UsdImagingDataSourcePointInstancerMask:

Public Member Functions
	HD_DECLARE_DATASOURCE (UsdImagingDataSourcePointInstancerMask)
VtValue	GetValue (HdSampledDataSource::Time shutterOffset) override
	Returns the value of this data source at frame-relative time shutterOffset. More...
VtBoolArray	GetTypedValue (HdSampledDataSource::Time shutterOffset) override
	Returns the value of this data source at frame-relative time shutterOffset, as type T. More...
bool	GetContributingSampleTimesForInterval (HdSampledDataSource::Time startTime, HdSampledDataSource::Time endTime, std::vector< HdSampledDataSource::Time > *outSampleTimes) override
	Given a shutter window of interest (startTime and endTime relative to the current frame), return a list of sample times for the caller to query with GetValue such that the caller can reconstruct the signal over the shutter window. More...
Public Member Functions inherited from HdTypedSampledDataSource< T >
	HD_DECLARE_DATASOURCE_ABSTRACT (HdTypedSampledDataSource< T >)
Public Member Functions inherited from HdSampledDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdSampledDataSource)

Additional Inherited Members
Public Types inherited from HdTypedSampledDataSource< T >
using	Type = T
Public Types inherited from HdSampledDataSource
using	Time = float

Detailed Description

A data source representing a point instancer's instance mask.

It stores, per instance, whether an instance is deactivated. If it has zero length, all instances are active.

Definition at line 44 of file dataSourcePointInstancer.h.

Member Function Documentation

GetContributingSampleTimesForInterval()

bool GetContributingSampleTimesForInterval ( HdSampledDataSource::Time  startTime, HdSampledDataSource::Time  endTime, std::vector< HdSampledDataSource::Time > *  outSampleTimes  )

overridevirtual

Given a shutter window of interest (startTime and endTime relative to the current frame), return a list of sample times for the caller to query with GetValue such that the caller can reconstruct the signal over the shutter window.

For a sample-based attribute, this might be a list of times when samples are defined. For a procedural scene, this might be a generated distribution. Note that the returned samples don't need to be within startTime and endTime; if a boundary sample is outside of the window, implementers can return it, and callers should expect it and interpolate to startTime or endTime accordingly. If this call returns true, the caller is expected to pass the list of outSampleTimes to GetValue. If this call returns false, this value is uniform across the shutter window and the caller should call GetValue(0) to get that uniform value.

Implements HdSampledDataSource.

GetTypedValue()

VtBoolArray GetTypedValue ( HdSampledDataSource::Time  shutterOffset )

overridevirtual

Returns the value of this data source at frame-relative time shutterOffset, as type T.

Implements HdTypedSampledDataSource< T >.

GetValue()

VtValue GetValue ( HdSampledDataSource::Time  shutterOffset )

overridevirtual

Returns the value of this data source at frame-relative time shutterOffset.

The caller does not track the frame; the scene index producing this datasource is responsible for that, if applicable. Note that, although this call returns a VtValue for each shutter offset, the type of the held value is expected to be the same across all shutter offsets. This call is expected to be threadsafe.

Implements HdSampledDataSource.

---

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

• pxr/usdImaging/usdImaging/dataSourcePointInstancer.h