Field3D
ProceduralField< Data_T > Class Template Reference

#include <ProceduralField.h>

Inheritance diagram for ProceduralField< Data_T >:
Field< Data_T > FieldRes FieldBase RefBase

List of all members.

Public Types

typedef ProceduralField< Data_T > class_type
typedef ProceduralFieldLookup
< Data_T > 
CubicInterp
typedef ProceduralFieldLookup
< Data_T > 
LinearInterp
typedef boost::intrusive_ptr
< ProceduralField
Ptr
- Public Types inherited from Field< Data_T >
typedef Data_T value_type
 Allows us to reference the template class.
typedef std::vector< PtrVec
 This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in.
- Public Types inherited from FieldRes
- Public Types inherited from FieldBase
- Public Types inherited from RefBase

Public Member Functions

virtual std::string className () const
 Returns the class name of the object. Used by the class pool and when writing the data to disk.
virtual Data_T lsSample (const V3d &lsP) const =0
Data_T typedFloatMetadata (const std::string &name, const Data_T &defaultVal) const
 Calls either sampleFloatMetadata() if the ProceduralField is scalar (half, float, or double), or sampleVecFloatMetadata() if the field is vector (V3h, V3f, V3d)
template<>
half typedFloatMetadata (const std::string &name, const half &defaultVal) const
template<>
float typedFloatMetadata (const std::string &name, const float &defaultVal) const
template<>
double typedFloatMetadata (const std::string &name, const double &defaultVal) const
template<>
V3h typedFloatMetadata (const std::string &name, const V3h &defaultVal) const
template<>
V3f typedFloatMetadata (const std::string &name, const V3f &defaultVal) const
template<>
V3d typedFloatMetadata (const std::string &name, const V3d &defaultVal) const
Data_T typedIntMetadata (const std::string &name, const Data_T &defaultVal) const
 Calls either sampleIntMetadata() if the ProceduralField is scalar (half, float, or double), or sampleVecIntMetadata() if the field is vector (V3h, V3f, V3d)
template<>
half typedIntMetadata (const std::string &name, const half &defaultVal) const
template<>
float typedIntMetadata (const std::string &name, const float &defaultVal) const
template<>
double typedIntMetadata (const std::string &name, const double &defaultVal) const
template<>
V3h typedIntMetadata (const std::string &name, const V3h &defaultVal) const
template<>
V3f typedIntMetadata (const std::string &name, const V3f &defaultVal) const
template<>
V3d typedIntMetadata (const std::string &name, const V3d &defaultVal) const
virtual Data_T value (int i, int j, int k) const =0
 Transforms the point from voxel space to subclass's space and calls the appropriate sample function.
virtual ~ProceduralField ()
 Destructor.
- Public Member Functions inherited from Field< Data_T >
const_iterator cbegin () const
 Const iterator to first element. "cbegin" matches the tr1 c++ standard.
const_iterator cbegin (const Box3i &subset) const
 Const iterator to first element of specific subset.
const_iterator cend () const
 Const iterator pointing one element past the last valid one.
const_iterator cend (const Box3i &subset) const
 Const iterator pointing one element past the last valid one (for a subset)
virtual std::string dataTypeString () const
virtual ~Field ()
 Dtor.
- Public Member Functions inherited from FieldRes
V3i const dataResolution () const
const Box3idataWindow () const
 Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass.
const Box3iextents () const
 Returns the extents of the data. This signifies the relevant area that the data exists over. However, the data window (below) may be smaller than the extents, in which case it is only safe to call value() for those coordinate inside the data window.
 FieldRes ()
 This constructor ensures that we have a valid mapping at all times.
 FieldRes (const FieldRes &src)
 Base class copy constructor.
bool isInBounds (int i, int j, int k) const
 Returns true is the indicies are in bounds of the data window.
FieldMapping::Ptr mapping ()
 Returns a pointer to the mapping.
const FieldMapping::Ptr mapping () const
 Returns a pointer to the mapping.
virtual long long int memSize () const
 Returns the memory usage (in bytes)
void setMapping (FieldMapping::Ptr mapping)
 Sets the field's mapping.
- Public Member Functions inherited from FieldBase
 FieldBase ()
 Constructor.
 FieldBase (const FieldBase &)
 Copy Constructor.
virtual ~FieldBase ()
 Destructor.
virtual Ptr clone () const =0
 Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
FieldMetadata< FieldBase > & metadata ()
 accessor to the m_metadata class
const FieldMetadata< FieldBase > & metadata () const
 Read only access to the m_metadata class.
virtual void metadataHasChanged (const std::string &)
 This function should implemented by concrete classes to get the callback when metadata changes.
void copyMetadata (const FieldBase &field)
 Copies the metadata from a second field.
- Public Member Functions inherited from RefBase
void ref () const
 Used by boost::intrusive_pointer.
size_t refcnt ()
 Used by boost::intrusive_pointer.
void unref () const
 Used by boost::intrusive_pointer.
 RefBase ()
 RefBase (const RefBase &)
 Copy constructor.
RefBaseoperator= (const RefBase &)
 Assignment operator.
virtual ~RefBase ()
 Destructor.
virtual bool checkRTTI (const char *typenameStr)=0
 This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();.
bool matchRTTI (const char *typenameStr)
 Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones.

Static Public Member Functions

static const char * classType ()
static
DEFINE_FIELD_RTTI_ABSTRACT_CLASS
const char * 
staticClassName ()

Private Types

typedef Field< Data_T > base
 Convenience typedef for referring to base class.

Static Private Attributes

static TemplatedFieldType
< ProceduralField< Data_T > > 
ms_classType

Additional Inherited Members

- Public Attributes inherited from Field< Data_T >
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
- Public Attributes inherited from FieldRes
- Public Attributes inherited from FieldBase
std::string attribute
 Optional name of the attribute the field represents.
std::string name
 Optional name of the field.

Detailed Description

template<class Data_T>
class ProceduralField< Data_T >

This class generalizes the Field concept to fields that don't necessarily contain voxel data. This is technically wrong (it's not true that a perlin noise volume IS-A Field) but it lends great flexibility to the Field concept.

So what happens when a ProceduralField is accessed using the Field interface? ProceduralField itself implements value() such that it automatically point-samples the field instead of accessing a particular voxel. This makes the ProceduralField seem as a regular Field to anyone using that interface.

The interesting part comes when we look at interpolation. Regular Field objects use Interpolator objects to produce values in-between voxels. For ProceduralField, we instead want to point-sample in space, but other than that the resultant value can be handled the same.

It is also fine to interpolate the ProceduralField outside its bounds - just as it is with regular Fields. The difference is that ProceduralFields still return valid values outside its bounds.

By using ProceduralField, we can support purely procedural and hybrid procedural/discrete volumes, but to the functions that use them, they all function the same.

Definition at line 120 of file ProceduralField.h.


Member Typedef Documentation

template<class Data_T>
typedef boost::intrusive_ptr<ProceduralField> ProceduralField< Data_T >::Ptr

Reimplemented from Field< Data_T >.

Definition at line 127 of file ProceduralField.h.

template<class Data_T>
typedef ProceduralFieldLookup<Data_T> ProceduralField< Data_T >::LinearInterp

Definition at line 129 of file ProceduralField.h.

template<class Data_T>
typedef ProceduralFieldLookup<Data_T> ProceduralField< Data_T >::CubicInterp

Definition at line 130 of file ProceduralField.h.

template<class Data_T>
typedef ProceduralField<Data_T> ProceduralField< Data_T >::class_type

Reimplemented from Field< Data_T >.

Definition at line 134 of file ProceduralField.h.

template<class Data_T>
typedef Field<Data_T> ProceduralField< Data_T >::base
private

Convenience typedef for referring to base class.

Reimplemented from Field< Data_T >.

Definition at line 189 of file ProceduralField.h.


Constructor & Destructor Documentation

template<class Data_T>
virtual ProceduralField< Data_T >::~ProceduralField ( )
inlinevirtual

Destructor.

Definition at line 150 of file ProceduralField.h.

{ /* Empty */ }

Member Function Documentation

template<class Data_T>
static DEFINE_FIELD_RTTI_ABSTRACT_CLASS const char* ProceduralField< Data_T >::staticClassName ( )
inlinestatic

Reimplemented from Field< Data_T >.

Definition at line 137 of file ProceduralField.h.

Referenced by ProceduralField< Data_T >::className().

{
return "ProceduralField";
}
template<class Data_T>
static const char* ProceduralField< Data_T >::classType ( )
inlinestatic

Reimplemented from Field< Data_T >.

Definition at line 142 of file ProceduralField.h.

References FieldBase::name.

template<class Data_T>
virtual Data_T ProceduralField< Data_T >::lsSample ( const V3d lsP) const
pure virtual
template<class Data_T>
virtual std::string ProceduralField< Data_T >::className ( ) const
inlinevirtual

Returns the class name of the object. Used by the class pool and when writing the data to disk.

Note:
This is different from classType for any templated class, as classType() will include the template parameter(s) but className remains just the name of the template itself.

Implements FieldBase.

Definition at line 159 of file ProceduralField.h.

References ProceduralField< Data_T >::staticClassName().

{ return staticClassName(); }
template<class Data_T>
virtual Data_T ProceduralField< Data_T >::value ( int  i,
int  j,
int  k 
) const
pure virtual

Transforms the point from voxel space to subclass's space and calls the appropriate sample function.

Implements Field< Data_T >.

template<class Data_T>
Data_T ProceduralField< Data_T >::typedIntMetadata ( const std::string &  name,
const Data_T &  defaultVal 
) const

Calls either sampleIntMetadata() if the ProceduralField is scalar (half, float, or double), or sampleVecIntMetadata() if the field is vector (V3h, V3f, V3d)

template<class Data_T>
Data_T ProceduralField< Data_T >::typedFloatMetadata ( const std::string &  name,
const Data_T &  defaultVal 
) const

Calls either sampleFloatMetadata() if the ProceduralField is scalar (half, float, or double), or sampleVecFloatMetadata() if the field is vector (V3h, V3f, V3d)

template<>
half ProceduralField< half >::typedIntMetadata ( const std::string &  name,
const half defaultVal 
) const
inline

Definition at line 216 of file ProceduralField.h.

{
return metadata().intMetadata(name, static_cast<int>(defaultVal));
}
template<>
float ProceduralField< float >::typedIntMetadata ( const std::string &  name,
const float &  defaultVal 
) const
inline

Definition at line 226 of file ProceduralField.h.

{
return metadata().intMetadata(name, static_cast<int>(defaultVal));
}
template<>
double ProceduralField< double >::typedIntMetadata ( const std::string &  name,
const double &  defaultVal 
) const
inline

Definition at line 236 of file ProceduralField.h.

{
return metadata().intMetadata(name, static_cast<int>(defaultVal));
}
template<>
V3h ProceduralField< V3h >::typedIntMetadata ( const std::string &  name,
const V3h defaultVal 
) const
inline

Definition at line 246 of file ProceduralField.h.

{
return V3h(metadata().vecIntMetadata(name, defaultVal));
}
template<>
V3f ProceduralField< V3f >::typedIntMetadata ( const std::string &  name,
const V3f defaultVal 
) const
inline

Definition at line 256 of file ProceduralField.h.

{
return V3f(metadata().vecIntMetadata(name, defaultVal));
}
template<>
V3d ProceduralField< V3d >::typedIntMetadata ( const std::string &  name,
const V3d defaultVal 
) const
inline

Definition at line 266 of file ProceduralField.h.

{
return V3d(metadata().vecIntMetadata(name, defaultVal));
}
template<>
half ProceduralField< half >::typedFloatMetadata ( const std::string &  name,
const half defaultVal 
) const
inline

Definition at line 276 of file ProceduralField.h.

{
return metadata().floatMetadata(name, static_cast<float>(defaultVal));
}
template<>
float ProceduralField< float >::typedFloatMetadata ( const std::string &  name,
const float &  defaultVal 
) const
inline

Definition at line 286 of file ProceduralField.h.

{
return metadata().floatMetadata(name, defaultVal);
}
template<>
double ProceduralField< double >::typedFloatMetadata ( const std::string &  name,
const double &  defaultVal 
) const
inline

Definition at line 296 of file ProceduralField.h.

{
return metadata().floatMetadata(name, static_cast<float>(defaultVal));
}
template<>
V3h ProceduralField< V3h >::typedFloatMetadata ( const std::string &  name,
const V3h defaultVal 
) const
inline

Definition at line 306 of file ProceduralField.h.

{
return V3h(metadata().vecFloatMetadata(name, defaultVal));
}
template<>
V3f ProceduralField< V3f >::typedFloatMetadata ( const std::string &  name,
const V3f defaultVal 
) const
inline

Definition at line 316 of file ProceduralField.h.

{
return V3f(metadata().vecFloatMetadata(name, defaultVal));
}
template<>
V3d ProceduralField< V3d >::typedFloatMetadata ( const std::string &  name,
const V3d defaultVal 
) const
inline

Definition at line 326 of file ProceduralField.h.

{
return V3d(metadata().vecFloatMetadata(name, defaultVal));
}

Member Data Documentation

template<class Data_T>
TemplatedFieldType<ProceduralField<Data_T> > ProceduralField< Data_T >::ms_classType
staticprivate

Reimplemented from Field< Data_T >.

Definition at line 185 of file ProceduralField.h.


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