Field3D
|
#include <Field.h>
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. | |
![]() | |
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 | |
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) | |
const_iterator (const const_iterator &i) | |
const_iterator (const Field< Data_T > &field, const Box3i &window, const V3i ¤tPos) | |
virtual std::string | dataTypeString () const |
template<class Iter_T> | |
bool | operator!= (const Iter_T &rhs) const |
Data_T | operator* () const |
const const_iterator & | operator++ () |
template<class Iter_T> | |
bool | operator== (const Iter_T &rhs) 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 void | mappingChanged () |
Tells the subclass that the mapping changed. | |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) | |
void | setMapping (FieldMapping::Ptr mapping) |
Sets the field's mapping. | |
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. | |
![]() | |
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 std::string | classType () const =0 |
Returns the full class type string. | |
virtual Ptr | clone () const =0 |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
FieldMetadata & | metadata () |
accessor to the m_metadata class | |
const FieldMetadata & | metadata () const |
Read only access to the m_metadata class. | |
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. | |
WeakPtr | weakPtr () const |
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. | |
![]() | |
virtual void | metadataHasChanged (const std::string &) |
Alerts the callback holder that the metadata has changed. | |
Static Public Member Functions | |
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 () |
Public Attributes | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
int | x |
Current position. | |
int | y |
int | z |
![]() | |
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. | |
Private Attributes | |
const Field< Data_T > & | m_field |
Reference to field being iterated over. | |
Box3i | m_window |
Window to traverse. | |
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. | |
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.
|
inline |
Definition at line 506 of file Field.h.
References const_iterator(), m_field, m_window, x, y, and z.
Referenced by const_iterator(), and operator++().
|
inline |
|
inline |
|
inline |
|
inline |
|
inlinestatic |
|
inlinestatic |
Field< Data_T >::const_iterator Field< Data_T >::cbegin | ( | ) | const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard.
Definition at line 433 of file Field.h.
Field< Data_T >::const_iterator Field< Data_T >::cbegin | ( | const Box3i & | subset | ) | const |
Field< Data_T >::const_iterator Field< Data_T >::cend | ( | ) | const |
Const iterator pointing one element past the last valid one.
Field< Data_T >::const_iterator Field< Data_T >::cend | ( | const Box3i & | subset | ) | const |
|
pure virtual |
Read access to a voxel. The coordinates are in integer voxel space .
|
inlinevirtual |
int Field< Data_T >::const_iterator::x |
Current position.
Definition at line 552 of file Field.h.
Referenced by const_iterator(), const_iterator(), operator!=(), operator*(), operator++(), and operator==().
int Field< Data_T >::const_iterator::y |
Definition at line 552 of file Field.h.
Referenced by const_iterator(), const_iterator(), operator!=(), operator*(), operator++(), and operator==().
int Field< Data_T >::const_iterator::z |
Definition at line 552 of file Field.h.
Referenced by const_iterator(), const_iterator(), operator!=(), operator*(), operator++(), and operator==().
Window to traverse.
Definition at line 559 of file Field.h.
Referenced by const_iterator(), const_iterator(), and operator++().
Reference to field being iterated over.
Definition at line 561 of file Field.h.
Referenced by const_iterator(), const_iterator(), and operator*().
|
staticprivate |