HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PXL_DeepSampleFilter Class Referenceabstract

#include <PXL_DeepSampleFilter.h>

+ Inheritance diagram for PXL_DeepSampleFilter:

Public Member Functions

 PXL_DeepSampleFilter ()
 
virtual ~PXL_DeepSampleFilter ()
 
virtual int filteredTupleSize (const char *name, int src_size) const
 
const PXL_DeepChannelListPtrupdateChannels (const PXL_DeepChannelListPtr &ch)
 
virtual PXL_DeepSampleListPtr filter (const PXL_DeepSampleListPtr &l) const =0
 Modify the incoming sample list to create a new sample list. More...
 
const PXL_DeepChannelListPtrchannels () const
 Return the channel list after the filter has run. More...
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepSampleFilter >
SYS_FORCE_INLINE UT_IntrusiveRefCounter ()
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &)
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &)
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const
 Return current counter. More...
 

Static Public Member Functions

static PXL_DeepSampleFilterPtr nullFilter ()
 
static PXL_DeepSampleFilterPtr monochrome (const UT_StringHolder &opac=UT_StringRef("Of"))
 
static PXL_DeepSampleFilterPtr precomposite (const UT_StringHolder &opac=UT_StringRef("Of"))
 
static PXL_DeepSampleFilterPtr uncomposite (const UT_StringHolder &opac=UT_StringRef("Of"))
 

Protected Member Functions

virtual void doUpdateChannels (const PXL_DeepChannelListPtr &ch)=0
 
void setChannels (const PXL_DeepChannelListPtr &c)
 
- Protected Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepSampleFilter >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Protected Attributes

PXL_DeepChannelListPtr myChannels
 

Detailed Description

This sample filter creates a new PXL_DeepsampleList from a source deep sample list.

Multiple filters can be chained together and applied after the

Definition at line 23 of file PXL_DeepSampleFilter.h.

Constructor & Destructor Documentation

PXL_DeepSampleFilter::PXL_DeepSampleFilter ( )
virtual PXL_DeepSampleFilter::~PXL_DeepSampleFilter ( )
virtual

Member Function Documentation

const PXL_DeepChannelListPtr& PXL_DeepSampleFilter::channels ( ) const
inline

Return the channel list after the filter has run.

Definition at line 50 of file PXL_DeepSampleFilter.h.

virtual void PXL_DeepSampleFilter::doUpdateChannels ( const PXL_DeepChannelListPtr ch)
protectedpure virtual
virtual PXL_DeepSampleListPtr PXL_DeepSampleFilter::filter ( const PXL_DeepSampleListPtr l) const
pure virtual

Modify the incoming sample list to create a new sample list.

virtual int PXL_DeepSampleFilter::filteredTupleSize ( const char *  name,
int  src_size 
) const
virtual

Return the tuple size of the filtered result. This may be called before the channel list is defined. It should return 0 if the channel will be filtered out of the resulting samples.

By default, the tuple size will remain unchanged.

static PXL_DeepSampleFilterPtr PXL_DeepSampleFilter::monochrome ( const UT_StringHolder opac = UT_StringRef("Of"))
static
static PXL_DeepSampleFilterPtr PXL_DeepSampleFilter::nullFilter ( )
static
static PXL_DeepSampleFilterPtr PXL_DeepSampleFilter::precomposite ( const UT_StringHolder opac = UT_StringRef("Of"))
static
void PXL_DeepSampleFilter::setChannels ( const PXL_DeepChannelListPtr c)
inlineprotected

Definition at line 70 of file PXL_DeepSampleFilter.h.

static PXL_DeepSampleFilterPtr PXL_DeepSampleFilter::uncomposite ( const UT_StringHolder opac = UT_StringRef("Of"))
static
const PXL_DeepChannelListPtr& PXL_DeepSampleFilter::updateChannels ( const PXL_DeepChannelListPtr ch)
inline

Update the channel list. This should call the protected setChannels(). It returns the channel list output by this filter.

Definition at line 39 of file PXL_DeepSampleFilter.h.

Member Data Documentation

PXL_DeepChannelListPtr PXL_DeepSampleFilter::myChannels
protected

Definition at line 74 of file PXL_DeepSampleFilter.h.


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