esp::metadata::attributes::SemanticVolumeAttributes class

This class describes the attributes describing some Semantic Volume. Currently only used for region annotations.

Base classes

class AbstractAttributes
Base class for all implemented attributes. Inherits from esp::core::managedContainers::AbstractFileBasedManagedObject so the attributes can be managed by a esp::core::managedContainers::ManagedContainer.

Constructors, destructors, conversion operators

SemanticVolumeAttributes(const std::string& handle) explicit

Public functions

auto getLabel() const -> std::string
Get the label assigned to this semantic volume.
void setLabel(const std::string& _label)
Set the label assigned to this semantic volume.
auto getFloorHeight() const -> double
Get the height of the floor upon which the flat poly loop's points lie.
void setFloorHeight(double _floor_height)
Set the height of the floor upon which the flat poly loop's points lie.
auto getExtrusionHeight() const -> double
Get the height of the extrusion above the plane of the poly loop.
void setExtrusionHeight(double _extrusion_height)
Set the height of the extrusion above the plane of the poly loop. lie.
auto getMinBounds() const -> Magnum::Vector3
Get the minimum bounds point for the region annotation.
void setMinBounds(const Magnum::Vector3& _min_bounds)
Set the minimum bounds point for the region annotation.
auto getMaxBounds() const -> Magnum::Vector3
Get the maximum bounds point for the region annotation.
void setMaxBounds(const Magnum::Vector3& _max_bounds)
Set the maximum bounds point for the region annotation.
auto getPolyLoop() const -> const std::vector<Magnum::Vector3>&
retrieve a const reference to the vector holding the poly loop points.
void setPolyLoop(std::vector<Magnum::Vector3> _polyLoop)
Set the vector holding the poly loop points.
void writeValuesToJson(io::JsonGenericValue& jsonObj, io::JsonAllocator& allocator) const override
Populate a JSON object with all the first-level values held in this SemanticVolumeAttributes. Default is overridden to handle special cases for SemanticVolumeAttributes.

Protected functions

auto getObjectInfoHeaderInternal() const -> std::string override
Retrieve a comma-separated string holding the header values for the info returned for this managed object, type-specific.
auto getObjectInfoInternal() const -> std::string override
Retrieve a comma-separated informational string about the contents of this managed object.

Protected variables

std::vector<Magnum::Vector3> polyLoop_
Vector of points making up the poly loop that describes the extrusion base.