translation_rotation_scale3d.hpp

// DO NOT EDIT! This file was auto-generated by crates/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/re_types/definitions/rerun/datatypes/translation_rotation_scale3d.fbs".
 
#pragma once
 
#include "../compiler_utils.hpp"
#include "../result.hpp"
#include "rotation3d.hpp"
#include "scale3d.hpp"
#include "vec3d.hpp"
 
#include <cstdint>
#include <memory>
#include <optional>
 
namespace arrow {
    class Array;
    class DataType;
    class StructBuilder;
} // namespace arrow
 
namespace rerun::datatypes {
    /// **Datatype**: Representation of an affine transform via separate translation, rotation & scale.
    struct TranslationRotationScale3D {
        /// 3D translation vector, applied last.
        std::optional<rerun::datatypes::Vec3D> translation;
 
        /// 3D rotation, applied second.
        std::optional<rerun::datatypes::Rotation3D> rotation;
 
        /// 3D scale, applied first.
        std::optional<rerun::datatypes::Scale3D> scale;
 
        /// If true, this transform is from the parent space to the space where the transform was logged.
        ///
        /// If false (default), the transform maps from this space to its parent,
        /// i.e. the translation is the position in the parent space.
        bool from_parent;
 
      public:
        // Extensions to generated type defined in 'translation_rotation_scale3d_ext.cpp'
 
        /// Identity transformation.
        ///
        /// Applying this transform does not alter an entity's transformation.
        /// It has all optional fields set to `std::nullopt`.
        static const TranslationRotationScale3D IDENTITY;
 
        // Need to disable the maybe-uninitialized here because the compiler gets confused by the combination
        // of union-types datatypes inside of an optional component.
        //
        // See: https://github.com/rerun-io/rerun/issues/4027
        RERUN_DISABLE_MAYBE_UNINITIALIZED_PUSH
        TranslationRotationScale3D(const TranslationRotationScale3D& other)
            : translation(other.translation),
              rotation(other.rotation),
              scale(other.scale),
              from_parent(other.from_parent) {}
 
        RERUN_DISABLE_MAYBE_UNINITIALIZED_POP
 
        /// Creates a new 3D transform from translation/rotation/scale.
        ///
        /// \param translation_ \copydoc TranslationRotationScale3D::translation
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param scale_ \copydoc TranslationRotationScale3D::scale
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(
            const std::optional<Vec3D>& translation_, const std::optional<Rotation3D>& rotation_,
            const std::optional<Scale3D>& scale_, bool from_parent_ = false
        )
            : translation(translation_),
              rotation(rotation_),
              scale(scale_),
              from_parent(from_parent_) {}
 
        /// Creates a new 3D transform from translation/rotation/uniform-scale.
        ///
        /// \param translation_ \copydoc TranslationRotationScale3D::translation
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param uniform_scale Uniform scale factor that is applied to all axis equally.
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        ///
        /// _Implementation note:_ This explicit overload prevents interpretation of the float as
        /// bool, leading to a call to the wrong overload.
        TranslationRotationScale3D(
            const Vec3D& translation_, const Rotation3D& rotation_, float uniform_scale,
            bool from_parent_ = false
        )
            : translation(translation_),
              rotation(rotation_),
              scale(uniform_scale),
              from_parent(from_parent_) {}
 
        /// Creates a new rigid transform (translation & rotation only).
        ///
        /// \param translation_ \copydoc TranslationRotationScale3D::translation
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(
            const Vec3D& translation_, const Rotation3D& rotation_, bool from_parent_ = false
        )
            : translation(translation_),
              rotation(rotation_),
              scale(std::nullopt),
              from_parent(from_parent_) {}
 
        /// From translation & scale only.
        ///
        /// \param translation_ \copydoc TranslationRotationScale3D::translation
        /// \param scale_ \copydoc TranslationRotationScale3D::scale
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(
            const Vec3D& translation_, const Scale3D& scale_, bool from_parent_ = false
        )
            : translation(translation_),
              rotation(std::nullopt),
              scale(scale_),
              from_parent(from_parent_) {}
 
        /// From translation & uniform scale.
        ///
        /// \param translation_ \copydoc TranslationRotationScale3D::translation
        /// \param uniform_scale Uniform scale factor that is applied to all axis equally.
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        ///
        /// _Implementation note:_ This explicit overload prevents interpretation of the float as
        /// bool, leading to a call to the wrong overload.
        TranslationRotationScale3D(
            const Vec3D& translation_, float uniform_scale, bool from_parent_ = false
        )
            : translation(translation_),
              rotation(std::nullopt),
              scale(uniform_scale),
              from_parent(from_parent_) {}
 
        /// From rotation & scale only.
        ///
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param scale_ \copydoc TranslationRotationScale3D::scale
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(
            const Rotation3D& rotation_, const Scale3D& scale_, bool from_parent_ = false
        )
            : translation(std::nullopt),
              rotation(rotation_),
              scale(scale_),
              from_parent(from_parent_) {}
 
        /// From rotation & uniform scale.
        ///
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param uniform_scale Uniform scale factor that is applied to all axis equally.
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        ///
        /// _Implementation note:_ This explicit overload prevents interpretation of the float as
        /// bool, leading to a call to the wrong overload.
        TranslationRotationScale3D(
            const Rotation3D& rotation_, float uniform_scale, bool from_parent_ = false
        )
            : translation(std::nullopt),
              rotation(rotation_),
              scale(uniform_scale),
              from_parent(from_parent_) {}
 
        /// From translation only.
        ///
        /// \param translation_ 3D translation.
        /// \param from_parent_
        TranslationRotationScale3D(const Vec3D& translation_, bool from_parent_ = false)
            : translation(translation_),
              rotation(std::nullopt),
              scale(std::nullopt),
              from_parent(from_parent_) {}
 
        /// From rotation only.
        ///
        /// \param rotation_ \copydoc TranslationRotationScale3D::rotation
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(const Rotation3D& rotation_, bool from_parent_ = false)
            : translation(std::nullopt),
              rotation(rotation_),
              scale(std::nullopt),
              from_parent(from_parent_) {}
 
        /// From scale only.
        ///
        /// \param scale_ \copydoc TranslationRotationScale3D::scale
        /// \param from_parent_ \copydoc TranslationRotationScale3D::from_parent
        TranslationRotationScale3D(const Scale3D& scale_, bool from_parent_ = false)
            : translation(std::nullopt),
              rotation(std::nullopt),
              scale(scale_),
              from_parent(from_parent_) {}
 
      public:
        TranslationRotationScale3D() = default;
    };
} // namespace rerun::datatypes
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<datatypes::TranslationRotationScale3D> {
        static constexpr const char Name[] = "rerun.datatypes.TranslationRotationScale3D";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_datatype();
 
        /// Fills an arrow array builder with an array of this type.
        static rerun::Error fill_arrow_array_builder(
            arrow::StructBuilder* builder, const datatypes::TranslationRotationScale3D* elements,
            size_t num_elements
        );
 
        /// Serializes an array of `rerun::datatypes::TranslationRotationScale3D` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const datatypes::TranslationRotationScale3D* instances, size_t num_instances
        );
    };
} // namespace rerun