|
Field3D
|
This subclass of Field does not store any data. More...
#include <EmptyField.h>
Public Types | |
| typedef EmptyField< Data_T > | class_type |
| typedef boost::intrusive_ptr< EmptyField > | Ptr |
| typedef std::vector< Ptr > | Vec |
Public Types inherited from ResizableField< Data_T > | |
| typedef ResizableField< Data_T > | class_type |
| typedef boost::intrusive_ptr< ResizableField > | Ptr |
Public Types inherited from WritableField< Data_T > | |
| typedef WritableField< Data_T > | class_type |
| typedef boost::intrusive_ptr< WritableField > | Ptr |
Public Types inherited from Field< Data_T > | |
| 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... | |
Public Types inherited from FieldRes | |
| typedef FieldRes | class_type |
| typedef boost::intrusive_ptr< FieldRes > | Ptr |
| typedef std::vector< Ptr > | Vec |
Public Types inherited from FieldBase | |
| typedef FieldBase | class_type |
| typedef boost::intrusive_ptr< FieldBase > | Ptr |
Public Types inherited from RefBase | |
| typedef boost::intrusive_ptr< RefBase > | Ptr |
| typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
Constructors & destructor | |
| EmptyField () | |
| Constructs an empty buffer. More... | |
| virtual void | clear (const Data_T &value) |
| Clears all the voxels in the storage. More... | |
| const Data_T & | constantvalue () const |
| Returns the constant value. More... | |
| void | setConstantvalue (const Data_T &val) |
| Sets the constant value. More... | |
From Field | |
| |
| virtual Data_T | value (int i, int j, int k) const |
| Read access to a voxel. The coordinates are in integer voxel space . More... | |
| virtual long long int | memSize () const |
| Returns the memory usage (in bytes) More... | |
From WritableField | |
| virtual Data_T & | lvalue (int i, int j, int k) |
| Write access to a voxel. The coordinates are global coordinates. More... | |
From FieldBase | |
| virtual FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION FieldBase::Ptr | clone () const |
| Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More... | |
Public Member Functions inherited from ResizableField< Data_T > | |
| void | copyFrom (typename Field< Data_T >::Ptr other) |
| Copies the data from another Field, also resizes. More... | |
| template<class Data_T2 > | |
| void | copyFrom (typename Field< Data_T2 >::Ptr other) |
| Copies the data from another Field of another template class, also resizes. More... | |
| void | matchDefinition (FieldRes::Ptr fieldToMatch) |
| Sets up this field so that resolution and mapping matches the other. More... | |
| void | setSize (const Box3i &extents) |
| Resizes the object. More... | |
| void | setSize (const Box3i &extents, const Box3i &dataWindow) |
| Resizes the object. More... | |
| void | setSize (const V3i &size) |
| Resizes the object. More... | |
| void | setSize (const V3i &size, int padding) |
| Resizes the object with padding. More... | |
Public Member Functions inherited from WritableField< Data_T > | |
| iterator | begin () |
| Iterator to first element. More... | |
| iterator | begin (const Box3i &subset) |
| Iterator to first element of specific subset. More... | |
| virtual void | clear (const Data_T &value) |
| Clears all the voxels in the storage. Should be re-implemented by subclasses that can provide a more efficient version. More... | |
| iterator | end () |
| Iterator pointing one element past the last valid one. More... | |
| iterator | end (const Box3i &subset) |
| Iterator pointing one element past the last valid one (for a subset) More... | |
| virtual Data_T & | lvalue (int i, int j, int k)=0 |
| Write access to a voxel. The coordinates are global coordinates. More... | |
Public Member Functions inherited from Field< Data_T > | |
| 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 Data_T | value (int i, int j, int k) const =0 |
| Read access to a voxel. The coordinates are in integer voxel space . More... | |
| virtual | ~Field () |
| Dtor. More... | |
Public Member Functions inherited from FieldRes | |
| V3i const | dataResolution () const |
| virtual std::string | dataTypeString () 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... | |
Public Member Functions inherited from FieldBase | |
| 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... | |
| FieldMetadata & | metadata () |
| accessor to the m_metadata class More... | |
| const FieldMetadata & | metadata () const |
| Read only access to the m_metadata class. More... | |
| void | copyMetadata (const FieldBase &field) |
| Copies the metadata from a second field. More... | |
Public Member Functions inherited from RefBase | |
| 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... | |
Public Member Functions inherited from MetadataCallback | |
| virtual void | metadataHasChanged (const std::string &) |
| Alerts the callback holder that the metadata has changed. More... | |
Static Public Member Functions | |
| static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from ResizableField< Data_T > | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from WritableField< Data_T > | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from Field< Data_T > | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from FieldRes | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from FieldBase | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from RefBase | |
| static const char * | staticClassType () |
Protected Attributes | |
| Data_T | m_constantData |
| Field constant value. More... | |
| Data_T | m_default |
| Field default value. More... | |
| Data_T | m_ignoredData |
| Dummy variable for assignment. More... | |
Protected Attributes inherited from FieldRes | |
| 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... | |
Private Types | |
| typedef ResizableField< Data_T > | base |
Additional Inherited Members | |
Public Attributes inherited from ResizableField< Data_T > | |
| DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
Public Attributes inherited from WritableField< Data_T > | |
| DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
Public Attributes inherited from Field< Data_T > | |
| DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
Public Attributes inherited from FieldRes | |
| DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
Public Attributes inherited from FieldBase | |
| std::string | attribute |
| Optional name of the attribute the field represents. More... | |
| std::string | name |
| Optional name of the field. More... | |
Protected Types inherited from ResizableField< Data_T > | |
| typedef WritableField< Data_T > | base |
Protected Types inherited from FieldRes | |
| typedef MatrixFieldMapping | default_mapping |
Protected Member Functions inherited from ResizableField< Data_T > | |
| virtual void | sizeChanged () |
| Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes. More... | |
Static Protected Attributes inherited from ResizableField< Data_T > | |
| static TemplatedFieldType< ResizableField< Data_T > > | ms_classType |
This subclass of Field does not store any data.
Its primary purpose is to be used as a proxy field. It can carry the same resolution, metadata and mapping as a regular field.
Usage is similar to a DenseField, except that it does not contain any data. It stores a default value that may be set and queried, so it can be treated as a constant field.
Definition at line 86 of file EmptyField.h.
| typedef boost::intrusive_ptr<EmptyField> EmptyField< Data_T >::Ptr |
Definition at line 93 of file EmptyField.h.
| typedef std::vector<Ptr> EmptyField< Data_T >::Vec |
Definition at line 94 of file EmptyField.h.
| typedef EmptyField<Data_T> EmptyField< Data_T >::class_type |
Definition at line 126 of file EmptyField.h.
|
private |
Definition at line 173 of file EmptyField.h.
| EmptyField< Data_T >::EmptyField |
Constructs an empty buffer.
Definition at line 182 of file EmptyField.h.
Referenced by EmptyField< Data_T >::clone().
|
virtual |
Clears all the voxels in the storage.
Reimplemented from WritableField< Data_T >.
Definition at line 191 of file EmptyField.h.
|
inline |
Returns the constant value.
Definition at line 256 of file EmptyField.h.
|
inline |
Sets the constant value.
Definition at line 248 of file EmptyField.h.
|
virtual |
Read access to a voxel. The coordinates are in integer voxel space .
Implements Field< Data_T >.
Definition at line 199 of file EmptyField.h.
References detail::max(), detail::min(), and UNUSED.
|
virtual |
Returns the memory usage (in bytes)
Reimplemented from FieldRes.
Definition at line 219 of file EmptyField.h.
|
inlinestatic |
Definition at line 129 of file EmptyField.h.
References EmptyField< Data_T >::staticClassType().
|
inlinestatic |
Definition at line 134 of file EmptyField.h.
Referenced by EmptyField< Data_T >::staticClassName().
|
virtual |
Write access to a voxel. The coordinates are global coordinates.
Implements WritableField< Data_T >.
Definition at line 228 of file EmptyField.h.
References detail::max(), detail::min(), and UNUSED.
|
inlinevirtual |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
Implements FieldBase.
Definition at line 153 of file EmptyField.h.
References EmptyField< Data_T >::EmptyField().
|
protected |
Field default value.
Definition at line 163 of file EmptyField.h.
|
protected |
Dummy variable for assignment.
Definition at line 165 of file EmptyField.h.
|
protected |
Field constant value.
Definition at line 167 of file EmptyField.h.