Field3D
|
#include <Field.h>
Classes | |
class | const_iterator |
Public Types | |
typedef Field< Data_T > | class_type |
typedef boost::intrusive_ptr < Field > | Ptr |
typedef Data_T | value_type |
Allows us to reference the template class. | |
typedef std::vector< Ptr > | Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. | |
![]() | |
![]() | |
![]() |
Public Member Functions | |
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 Data_T | value (int i, int j, int k) const =0 |
Read access to a voxel. The coordinates are in integer voxel space . | |
virtual | ~Field () |
Dtor. | |
![]() | |
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. | |
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. | |
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. | |
![]() | |
FieldBase () | |
Constructor. | |
FieldBase (const FieldBase &) | |
Copy Constructor. | |
virtual | ~FieldBase () |
Destructor. | |
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. | |
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. | |
![]() | |
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. | |
RefBase & | operator= (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 const char * | staticClassName () |
Public Attributes | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
![]() | |
std::string | attribute |
Optional name of the attribute the field represents. | |
std::string | name |
Optional name of the field. |
Private Types | |
typedef FieldRes | base |
Convenience typedef for referring to base class. |
Static Private Attributes | |
static TemplatedFieldType < Field< Data_T > > | ms_classType |
Additional Inherited Members | |
![]() | |
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. | |
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. | |
FieldMapping::Ptr | m_mapping |
Pointer to the field's mapping. |
This class provides read-only access to voxels. A read-only buffer can not be resized. Resizing is added by ResizableField. The object still has a size of course, but it can only be set by subclass-specific methods.
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, WritableField< Data_T >, SparseField< Data_T >, ProceduralField< Data_T >, MACField< Data_T >, DenseField< Data_T >, and EmptyField< Data_T >.
typedef Data_T Field< Data_T >::value_type |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in.
Reimplemented from FieldRes.
Reimplemented in SparseField< Data_T >, MACField< Data_T >, DenseField< Data_T >, and EmptyField< Data_T >.
typedef Field<Data_T> Field< Data_T >::class_type |
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, WritableField< Data_T >, SparseField< Data_T >, ProceduralField< Data_T >, DenseField< Data_T >, EmptyField< Data_T >, and MACField< Data_T >.
Convenience typedef for referring to base class.
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, WritableField< Data_T >, SparseField< Data_T >, MACField< Data_T >, ProceduralField< Data_T >, EmptyField< Data_T >, and DenseField< Data_T >.
|
inlinestatic |
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, WritableField< Data_T >, SparseField< Data_T >, ProceduralField< Data_T >, DenseField< Data_T >, and MACField< Data_T >.
Definition at line 397 of file Field.h.
|
inlinestatic |
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, WritableField< Data_T >, SparseField< Data_T >, ProceduralField< Data_T >, DenseField< Data_T >, EmptyField< Data_T >, and MACField< Data_T >.
Definition at line 402 of file Field.h.
References FieldBase::name.
Field< Data_T >::const_iterator Field< Data_T >::cbegin | ( | ) | const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard.
Reimplemented in SparseField< Data_T >, and DenseField< Data_T >.
Definition at line 471 of file Field.h.
References FieldRes::dataResolution().
Referenced by ResizableField< Data_T >::copyFrom(), and isIdentical().
Field< Data_T >::const_iterator Field< Data_T >::cbegin | ( | const Box3i & | subset | ) | const |
Const iterator to first element of specific subset.
Reimplemented in SparseField< Data_T >, and DenseField< Data_T >.
Field< Data_T >::const_iterator Field< Data_T >::cend | ( | ) | const |
Const iterator pointing one element past the last valid one.
Reimplemented in SparseField< Data_T >, and DenseField< Data_T >.
Definition at line 493 of file Field.h.
Referenced by isIdentical().
Field< Data_T >::const_iterator Field< Data_T >::cend | ( | const Box3i & | subset | ) | const |
Const iterator pointing one element past the last valid one (for a subset)
Reimplemented in SparseField< Data_T >, and DenseField< Data_T >.
|
pure virtual |
Read access to a voxel. The coordinates are in integer voxel space .
Implemented in SparseField< Data_T >, ProceduralField< Data_T >, MACField< Data_T >, DenseField< Data_T >, and EmptyField< Data_T >.
Referenced by LinearFieldInterp< Data_T >::sample(), and CubicFieldInterp< Data_T >::sample().
|
inlinevirtual |
Reimplemented from FieldRes.
Definition at line 441 of file Field.h.
References FieldBase::name.
Field< Data_T >::DEFINE_FIELD_RTTI_ABSTRACT_CLASS |
Reimplemented from FieldRes.
Reimplemented in ResizableField< Data_T >, and WritableField< Data_T >.
|
staticprivate |