Field3D
|
#include <ProceduralField.h>
Public Types | |
typedef ProceduralField< Data_T > | class_type |
typedef ProceduralFieldLookup< Data_T > | CubicInterp |
typedef ProceduralFieldLookup< Data_T > | LinearInterp |
typedef boost::intrusive_ptr< ProceduralField > | Ptr |
![]() | |
typedef Field< Data_T > | class_type |
typedef boost::intrusive_ptr< Field > | Ptr |
typedef Data_T | value_type |
Allows us to reference the template class. More... | |
typedef std::vector< Ptr > | Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. More... | |
![]() | |
typedef FieldRes | class_type |
typedef boost::intrusive_ptr< FieldRes > | Ptr |
typedef std::vector< Ptr > | Vec |
![]() | |
typedef FieldBase | class_type |
typedef boost::intrusive_ptr< FieldBase > | Ptr |
![]() | |
typedef boost::intrusive_ptr< RefBase > | Ptr |
typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
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) More... | |
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) More... | |
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 FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION 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. More... | |
virtual | ~ProceduralField () |
Destructor. More... | |
![]() | |
const_iterator | cbegin () const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard. More... | |
const_iterator | cbegin (const Box3i &subset) const |
Const iterator to first element of specific subset. More... | |
const_iterator | cend () const |
Const iterator pointing one element past the last valid one. More... | |
const_iterator | cend (const Box3i &subset) const |
Const iterator pointing one element past the last valid one (for a subset) More... | |
virtual std::string | dataTypeString () const |
virtual | ~Field () |
Dtor. More... | |
![]() | |
V3i const | dataResolution () const |
const Box3i & | dataWindow () const |
Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass. More... | |
const Box3i & | extents () 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. More... | |
FieldRes () | |
This constructor ensures that we have a valid mapping at all times. More... | |
FieldRes (const FieldRes &src) | |
Base class copy constructor. More... | |
bool | isInBounds (int i, int j, int k) const |
Returns true is the indicies are in bounds of the data window. More... | |
FieldMapping::Ptr | mapping () |
Returns a pointer to the mapping. More... | |
const FieldMapping::Ptr | mapping () const |
Returns a pointer to the mapping. More... | |
virtual void | mappingChanged () |
Tells the subclass that the mapping changed. More... | |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) More... | |
void | setMapping (FieldMapping::Ptr mapping) |
Sets the field's mapping. More... | |
virtual size_t | voxelCount () const |
Counts the number of voxels. For most fields, this is just the volume of the data window, but sparse data structures can override this to return a better value. More... | |
![]() | |
FieldBase () | |
Constructor. More... | |
FieldBase (const FieldBase &) | |
Copy Constructor. More... | |
virtual | ~FieldBase () |
Destructor. More... | |
virtual std::string | className () const =0 |
Returns the class name of the object. Used by the class pool and when writing the data to disk. More... | |
virtual std::string | classType () const =0 |
Returns the full class type string. More... | |
virtual Ptr | clone () const =0 |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More... | |
FieldMetadata< FieldBase > & | metadata () |
accessor to the m_metadata class More... | |
const FieldMetadata< FieldBase > & | metadata () const |
Read only access to the m_metadata class. More... | |
virtual void | metadataHasChanged (const std::string &) |
This function should implemented by concrete classes to get the callback when metadata changes. More... | |
void | copyMetadata (const FieldBase &field) |
Copies the metadata from a second field. More... | |
![]() | |
void | ref () const |
Used by boost::intrusive_pointer. More... | |
size_t | refcnt () |
Used by boost::intrusive_pointer. More... | |
void | unref () const |
Used by boost::intrusive_pointer. More... | |
WeakPtr | weakPtr () const |
RefBase () | |
RefBase (const RefBase &) | |
Copy constructor. More... | |
RefBase & | operator= (const RefBase &) |
Assignment operator. More... | |
virtual | ~RefBase () |
Destructor. More... | |
virtual bool | checkRTTI (const char *typenameStr)=0 |
This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. More... | |
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. More... | |
Static Public Member Functions | |
static DEFINE_FIELD_RTTI_ABSTRACT_CLASS const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassType () |
Private Types | |
typedef Field< Data_T > | base |
Static Private Attributes | |
static TemplatedFieldType< ProceduralField< Data_T > > | ms_classType |
Additional Inherited Members | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
std::string | attribute |
Optional name of the attribute the field represents. More... | |
std::string | name |
Optional name of the field. More... | |
![]() | |
typedef MatrixFieldMapping | default_mapping |
![]() | |
Box3i | m_dataWindow |
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval. More... | |
Box3i | m_extents |
Defines the extents of the the storage. This may be larger or smaller than the data window, and in the case where it is larger, care must be taken not to access voxels outside the data window. This should be treated as a closed (i.e. inclusive) interval. More... | |
FieldMapping::Ptr | m_mapping |
Pointer to the field's mapping. More... | |
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.
typedef boost::intrusive_ptr<ProceduralField> ProceduralField< Data_T >::Ptr |
Definition at line 127 of file ProceduralField.h.
typedef ProceduralFieldLookup<Data_T> ProceduralField< Data_T >::LinearInterp |
Definition at line 129 of file ProceduralField.h.
typedef ProceduralFieldLookup<Data_T> ProceduralField< Data_T >::CubicInterp |
Definition at line 130 of file ProceduralField.h.
typedef ProceduralField<Data_T> ProceduralField< Data_T >::class_type |
Definition at line 134 of file ProceduralField.h.
|
private |
Definition at line 188 of file ProceduralField.h.
|
inlinevirtual |
Destructor.
Definition at line 150 of file ProceduralField.h.
References FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION, ProceduralField< Data_T >::lsSample(), FieldBase::name, ProceduralField< Data_T >::typedFloatMetadata(), ProceduralField< Data_T >::typedIntMetadata(), and ProceduralField< Data_T >::value().
|
inlinestatic |
Definition at line 137 of file ProceduralField.h.
|
inlinestatic |
Definition at line 142 of file ProceduralField.h.
References FieldBase::name.
|
pure virtual |
|
pure virtual |
Transforms the point from voxel space to subclass's space and calls the appropriate sample function.
Implements Field< Data_T >.
Referenced by ProceduralField< Data_T >::~ProceduralField().
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)
Referenced by ProceduralField< Data_T >::~ProceduralField().
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)
Referenced by ProceduralField< Data_T >::~ProceduralField().
|
inline |
Definition at line 215 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::intMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 225 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::intMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 235 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::intMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 245 of file ProceduralField.h.
References FieldBase::metadata().
|
inline |
Definition at line 255 of file ProceduralField.h.
References FieldBase::metadata().
|
inline |
Definition at line 265 of file ProceduralField.h.
References half, and FieldBase::metadata().
|
inline |
Definition at line 275 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::floatMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 285 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::floatMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 295 of file ProceduralField.h.
References FieldMetadata< CallBack_T >::floatMetadata(), and FieldBase::metadata().
|
inline |
Definition at line 305 of file ProceduralField.h.
References FieldBase::metadata().
|
inline |
Definition at line 315 of file ProceduralField.h.
References FieldBase::metadata().
|
inline |
Definition at line 325 of file ProceduralField.h.
References FIELD3D_NAMESPACE_HEADER_CLOSE, and FieldBase::metadata().
|
staticprivate |
Definition at line 184 of file ProceduralField.h.