Field.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2023, EPFL/Blue Brain Project
 * All rights reserved. Do not distribute without permission.
 * Responsible Author: Daniel Nachbaur <daniel.nachbaur@epfl.ch>
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <platform/core/common/Api.h>
#include <platform/core/common/CommonTypes.h>
#include <platform/core/common/PropertyObject.h>
 
SERIALIZATION_ACCESS(Field)
 
namespace core
{
class Field : public PropertyObject
{
public:
    PLATFORM_API Field(const FieldParameters& parameters, const Vector3ui& dimensions, const Vector3f& spacing,
                       const Vector3f& offset, const uint32_ts& indices, const floats& values,
                       const OctreeDataType dataType)
        : _parameters(parameters)
        , _dimensions(dimensions)
        , _spacing(spacing)
        , _offset(offset)
        , _octreeIndices(indices)
        , _octreeValues(values)
        , _octreeDataType(dataType)
    {
    }
 
    PLATFORM_API Boxd getBounds() const { return {_offset, _offset + Vector3f(_dimensions) * _spacing}; }
 
    PLATFORM_API Vector3i getDimensions() const { return _dimensions; }
 
    PLATFORM_API Vector3f getElementSpacing() const { return _spacing; }
 
    PLATFORM_API Vector3f getOffset() const { return _offset; }
 
    PLATFORM_API const uint32_ts& getOctreeIndices() const { return _octreeIndices; }
 
    PLATFORM_API const floats& getOctreeValues() const { return _octreeValues; }
 
    PLATFORM_API OctreeDataType getOctreeDataType() const { return _octreeDataType; }
 
protected:
    // Octree
    Vector3i _dimensions;
    Vector3f _spacing;
    Vector3f _offset;
    uint32_ts _octreeIndices;
    floats _octreeValues;
    OctreeDataType _octreeDataType;
    const FieldParameters& _parameters;
 
private:
    SERIALIZATION_FRIEND(Field);
};
} // namespace core