#include <PXL_DeepSampleList.h>

Inheritance diagram for PXL_DeepSampleList:

Classes
class	Sum
	Class to help with weighted sums of pixels. More...

Public Types
enum	SampleFlag { VOLUME_SAMPLE = 0x01, MATTE_SURFACE = 0x02 }

Public Member Functions
	PXL_DeepSampleList (const PXL_DeepChannelListPtr &channels, int nsamples, bool precomposited)

	PXL_DeepSampleList (const PXL_DeepSampleList &src)

	~PXL_DeepSampleList ()

PXL_DeepSampleList &	operator= (const PXL_DeepSampleList &src)=delete

PXL_DeepSampleListPtr	splitSegments (const PXL_DeepSampleList &l) const

void	clear ()

int	sampleCapacity () const
	Return the maximum number of samples. More...

bool	preComposited () const

void	setSampleCount (int nsamples)

void	setPreComposited (bool c)
	Set the pre-composited state. More...

const PXL_DeepChannelListPtr &	channels () const
	Accessors. More...

float	zfront (int sample) const
	Return z-back for given sample. More...

const float *	zfront (float *storage, int start=0, int end=-1) const

float	zback (int sample) const
	Return z-back for a given sample. More...

const float *	zback (float *storage, int start=0, int end=-1) const

float	zmid (int sample) const
	Return the z midpoint for a given sample. More...

uint8	flags (int sample) const
	Return flags for a given sample (see SampleFlag enum) More...

bool	isVolume (int sample) const
	Check to see whether a sample is a volume. More...

bool	isMatte (int sample) const
	Check to see whether a sample is a matte sample. More...

const uint8 *	flags (uint8 *storage, int start=0, int end=-1) const

uint64	coverage (int sample) const
	Return the sub-sample pixel location for a given sample. More...

const uint64 *	coverage (uint64 *storage, int start=0, int end=-1) const

const float *	channelData (int channel, int sample, float *storage) const

const float *	channelData (int channel, float *storage, int start=0, int end=-1) const

bool	save (UT_JSONWriter &j, const PXL_DeepChannelListPtr &channels) const
	Encode the sample list into a JSON stream. More...

void	dump (const PXL_DeepChannelListPtr &channels, const char *msg="", int start=0, int end=-1) const
	Dump sample list for debugging. More...

void	dump (const char *msg="", int start=0, int end=-1) const
	Dump sample list (without channel data) for debugging. More...

const float *	fillZfront (float *storage, int start, int end) const

const float *	fillZback (float *storage, int start, int end) const

const uint8 *	fillSampleFlags (uint8 *storage, int start, int end) const

const uint64 *	fillCoverage (uint64 *storage, int start, int end) const

const float *	fillChannel (int ch, float *storage, int start, int end) const

uint8 *	flagBuffer ()

uint64 *	coverageBuffer ()
	Get write-able array of coverage. More...

float *	channelBuffer (int i)
	Get write-able array of data for a given channel. More...

const uint8 *	flagBuffer () const

const uint64 *	coverageBuffer () const
	Get read-only array of coverages. More...

const float *	channelBuffer (int i) const
	Get read-only array of data for a given channel. More...

int	findFullOpacity (int of_channel, float opacity_thresh=1.0) const

void	trimLength (int nrecords)
	Trim the list to the number of records specified. More...

void	copySample (int didx, const PXL_DeepSampleList &s, int sidx, float scale=1)

void	extractSegment (int didx, const PXL_DeepSampleList &s, int sidx, float zf, float zb, float scale=1)
	Split the source sample into the destination index at the given z value. More...

void	setConditional (int didx, const PXL_DeepSampleList &s, int sidx)

void	addSample (int didx, const PXL_DeepSampleList &s, int sidx, float scale=1)

void	zeroData ()
	Initialize all records to zero. More...

void	zeroData (int sample)
	Clear a single sample. More...

void	composite (int of_channel, bool force=false)
	Perform compositing on the sample array using the given opacity channel. More...

void	uncomposite (int of_channel, bool force=false)
	Perform uncompositing of sampels using the opacity channel. More...


int	sampleCount () const

int	size () const


float *	zfrontBuffer ()

float *	zbackBuffer ()


const float *	zfrontBuffer () const

const float *	zbackBuffer () const


void	copyZfront (const PXL_DeepSampleList &s)

void	copyZback (const PXL_DeepSampleList &s)

void	copyZ (const PXL_DeepSampleList &s)

void	copyFlags (const PXL_DeepSampleList &s)

void	copySampleId (const PXL_DeepSampleList &s)

void	copyChannel (int ch, const PXL_DeepSampleList &s)

void	copyAllChannels (const PXL_DeepSampleList &s)

Public Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepSampleList >
SYS_FORCE_INLINE	UT_IntrusiveRefCounter () noexcept
	Default constructor: Sets counter to 0. More...

SYS_FORCE_INLINE	UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
	Copy constructor: Sets counter to 0. More...

UT_IntrusiveRefCounter &	operator= (const UT_IntrusiveRefCounter &) noexcept
	Assignment operator: Does not modify counter. More...

SYS_FORCE_INLINE uint32	use_count () const noexcept
	Return current counter. More...

SYS_FORCE_INLINE bool	conditionalAddRef () noexcept

Static Public Member Functions
static PXL_DeepSampleListPtr	combine (const PXL_DeepSampleListPtr &a, const PXL_DeepSampleListPtr &b)

static bool	save (UT_JSONWriter &j, const PXL_DeepSampleListPtr &list, const PXL_DeepChannelListPtr &channels)
	Save, handling null pointers properly. More...

static PXL_DeepSampleListPtr	load (UT_JSONParser &j, const PXL_DeepChannelListPtr &c)

Additional Inherited Members
Protected Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepSampleList >
SYS_FORCE_INLINE	~UT_IntrusiveRefCounter ()
	Destructor: Only derived classes can destruct this. More...

Detailed Description

Class to represent a list of deep pixel samples.

The class stores multiple samples for multiple image channels. The image channels Each pixel list has:

int sampleCount
The number of samples in the list Each sample has:
float z:
Z-Depth of the sample
uint8 flags:
Flags associated with the sample
uint64 coverage:
The sample coverage mask
float *channel_data:
Image channel values

The coverage mask will either be 0 (indicating full coverage) or a bit-mask representing the coverage. If there are more than 64 samples, the sample id's rotate (i.e. mask |= 1 << (sample_id % 64)).

Definition at line 41 of file PXL_DeepSampleList.h.

Member Enumeration Documentation

enum PXL_DeepSampleList::SampleFlag

Enumerator
VOLUME_SAMPLE
MATTE_SURFACE

Definition at line 68 of file PXL_DeepSampleList.h.

Constructor & Destructor Documentation

PXL_DeepSampleList::PXL_DeepSampleList	(	const PXL_DeepChannelListPtr &	channels,
		int	nsamples,
		bool	precomposited
	)

PXL_DeepSampleList::PXL_DeepSampleList ( const PXL_DeepSampleList & src )

PXL_DeepSampleList::~PXL_DeepSampleList ( )

Member Function Documentation

void PXL_DeepSampleList::addSample	(	int	didx,
		const PXL_DeepSampleList &	s,
		int	sidx,
		float	scale = `1`
	)

Add the source sample to this sample (with an optional scale). This only adjusts non-ordinal channels.

float* PXL_DeepSampleList::channelBuffer ( int i )

inline

Get write-able array of data for a given channel.

Definition at line 233 of file PXL_DeepSampleList.h.

const float* PXL_DeepSampleList::channelBuffer ( int i ) const

inline

Get read-only array of data for a given channel.

Definition at line 245 of file PXL_DeepSampleList.h.

const float* PXL_DeepSampleList::channelData	(	int	channel,
		int	sample,
		float *	storage
	)		const

inline

Return the channel data for a given sample. The storage array must contain at least channelSize(channel) floats.

Definition at line 159 of file PXL_DeepSampleList.h.

const float* PXL_DeepSampleList::channelData	(	int	channel,
		float *	storage,
		int	start = `0`,
		int	end = `-1`
	)		const

inline

Return all the data for a given channel. The storage array must be at least sampleCount()*channelSize(channel) floats.

Definition at line 163 of file PXL_DeepSampleList.h.

const PXL_DeepChannelListPtr& PXL_DeepSampleList::channels ( ) const

inline

Accessors.

Definition at line 95 of file PXL_DeepSampleList.h.

void PXL_DeepSampleList::clear ( )

Clear buffers etc. This keeps a reference to the channels and the precompositing state.

static PXL_DeepSampleListPtr PXL_DeepSampleList::combine	(	const PXL_DeepSampleListPtr &	a,
		const PXL_DeepSampleListPtr &	b
	)

static

Merge two lists sorted into a single list. If the definition of the pixel lists (i.e. the channels) don't match, then the method will return a. The method properly handles nullptr values.

void PXL_DeepSampleList::composite	(	int	of_channel,
		bool	force = `false`
	)

Perform compositing on the sample array using the given opacity channel.

void PXL_DeepSampleList::copyAllChannels ( const PXL_DeepSampleList & s )