Blue Brain BioExplorer
core::BrickedVolume Class Referenceabstract

A volume type where the voxels are copied for each added brick. More...

#include <BrickedVolume.h>

Inheritance diagram for core::BrickedVolume:
Collaboration diagram for core::BrickedVolume:

Public Member Functions

virtual PLATFORM_API void setBrick (const void *data, const Vector3ui &position, const Vector3ui &size)=0
 Sets a brick of data in the volume. More...
 
- Public Member Functions inherited from core::Volume
PLATFORM_API Volume (const Vector3ui &dimensions, const Vector3f &spacing, const DataType type)
 Constructs a Volume object. More...
 
virtual PLATFORM_API void setDataRange (const Vector2f &range)=0
 
PLATFORM_API Vector2f getDataRange () const
 
virtual PLATFORM_API void commit ()=0
 Commits changes to the volume. More...
 
PLATFORM_API size_t getSizeInBytes () const
 Gets the size of the volume in bytes. More...
 
PLATFORM_API Boxd getBounds () const
 Gets the bounding box of the volume. More...
 
PLATFORM_API Vector3f getDimensions () const
 Get the Dimensions object. More...
 
PLATFORM_API Vector3f getElementSpacing () const
 Get the Element Spacing object. More...
 
PLATFORM_API Vector3f getOffset () const
 Get the Offset object. More...
 
PLATFORM_API Vector2f getValueRange () const
 Get the Value Range object. More...
 
- Public Member Functions inherited from core::BaseObject
 BaseObject ()=default
 
virtual ~BaseObject ()=default
 
 BaseObject (const BaseObject &)
 
BaseObjectoperator= (const BaseObject &rhs)
 
bool isModified () const
 
void resetModified ()
 
void markModified (const bool triggerCallback=true)
 
void onModified (const ModifiedCallback &callback)
 
void clearModifiedCallback ()
 

Protected Member Functions

 BrickedVolume (const Vector3ui &dimensions, const Vector3f &spacing, const DataType type)
 Constructs a new BrickedVolume object. More...
 
- Protected Member Functions inherited from core::BaseObject
template<typename T >
void _updateValue (T &member, const T &newValue, const bool triggerCallback=true)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)
 

Additional Inherited Members

- Public Types inherited from core::BaseObject
using ModifiedCallback = std::function< void(const BaseObject &)>
 
- Protected Attributes inherited from core::Volume
std::atomic_size_t _sizeInBytes {0}
 
const Vector3ui _dimensions
 
const Vector3f _spacing
 
Vector3f _offset
 
const DataType _dataType
 
Vector2f _valueRange {-1e6f, 1e6f}
 

Detailed Description

A volume type where the voxels are copied for each added brick.

Definition at line 34 of file BrickedVolume.h.

Constructor & Destructor Documentation

◆ BrickedVolume()

core::BrickedVolume::BrickedVolume ( const Vector3ui dimensions,
const Vector3f spacing,
const DataType  type 
)
inlineprotected

Constructs a new BrickedVolume object.

Parameters
dimensionsThe dimensions of the volume as a Vector3ui object.
spacingThe spacing between voxels as a Vector3f object.
typeThe data type of the volume.

Definition at line 52 of file BrickedVolume.h.

Member Function Documentation

◆ setBrick()

virtual PLATFORM_API void core::BrickedVolume::setBrick ( const void *  data,
const Vector3ui position,
const Vector3ui size 
)
pure virtual

Sets a brick of data in the volume.

Parameters
dataThe data to be set as a void pointer.
positionThe position of the brick as a Vector3ui object.
sizeThe size of the brick as a Vector3ui object.

Implemented in core::engine::ospray::OSPRayBrickedVolume.


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