Archetype: The controls for the 3D eye in a spatial 3D view. More...

#include <rerun/blueprint/archetypes/eye_controls3d.hpp>

Public Member Functions
	EyeControls3D (EyeControls3D &&other)=default

	EyeControls3D (const EyeControls3D &other)=default

EyeControls3D &	operator= (const EyeControls3D &other)=default

EyeControls3D &	operator= (EyeControls3D &&other)=default

EyeControls3D	with_kind (const rerun::blueprint::components::Eye3DKind &_kind) &&
	The kind of the eye for the spatial 3D view.

EyeControls3D	with_position (const rerun::components::Position3D &_position) &&
	The cameras current position.

EyeControls3D	with_look_target (const rerun::components::Position3D &_look_target) &&
	The position the camera is currently looking at.

EyeControls3D	with_eye_up (const rerun::components::Vector3D &_eye_up) &&
	The up-axis of the eye itself, in world-space.

EyeControls3D	with_speed (const rerun::components::LinearSpeed &_speed) &&
	Translation speed of the eye in the view (when using WASDQE keys to move in the 3D scene).

EyeControls3D	with_tracking_entity (const rerun::components::EntityPath &_tracking_entity) &&
	Currently tracked entity.

EyeControls3D	with_spin_speed (const rerun::blueprint::components::AngularSpeed &_spin_speed) &&
	What speed, if any, the camera should spin around the eye-up axis.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static EyeControls3D	update_fields ()
	Update only some specific fields of a `EyeControls3D`.

static EyeControls3D	clear_fields ()
	Clear all the fields of a `EyeControls3D`.

Public Attributes
std::optional< ComponentBatch >	kind
	The kind of the eye for the spatial 3D view.

std::optional< ComponentBatch >	position
	The cameras current position.

std::optional< ComponentBatch >	look_target
	The position the camera is currently looking at.

std::optional< ComponentBatch >	eye_up
	The up-axis of the eye itself, in world-space.

std::optional< ComponentBatch >	speed
	Translation speed of the eye in the view (when using WASDQE keys to move in the 3D scene).

std::optional< ComponentBatch >	tracking_entity
	Currently tracked entity.

std::optional< ComponentBatch >	spin_speed
	What speed, if any, the camera should spin around the eye-up axis.

Static Public Attributes
static constexpr const char	ArchetypeName [] = "rerun.blueprint.archetypes.EyeControls3D"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_kind
	`ComponentDescriptor` for the `kind` field.

static constexpr auto	Descriptor_position
	`ComponentDescriptor` for the `position` field.

static constexpr auto	Descriptor_look_target
	`ComponentDescriptor` for the `look_target` field.

static constexpr auto	Descriptor_eye_up
	`ComponentDescriptor` for the `eye_up` field.

static constexpr auto	Descriptor_speed
	`ComponentDescriptor` for the `speed` field.

static constexpr auto	Descriptor_tracking_entity
	`ComponentDescriptor` for the `tracking_entity` field.

static constexpr auto	Descriptor_spin_speed
	`ComponentDescriptor` for the `spin_speed` field.

Detailed Description

Archetype: The controls for the 3D eye in a spatial 3D view.

This configures the camera through which the 3D scene is viewed.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

◆ with_kind()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_kind ( const rerun::blueprint::components::Eye3DKind & _kind ) &&

inline

The kind of the eye for the spatial 3D view.

This controls how the eye movement behaves when the user interact with the view. Defaults to orbital.

◆ with_look_target()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_look_target ( const rerun::components::Position3D & _look_target ) &&

inline

The position the camera is currently looking at.

If this is an orbital camera, this also is the center it orbits around.

By default this is the center of the scene bounds.

◆ with_eye_up()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_eye_up ( const rerun::components::Vector3D & _eye_up ) &&

inline

The up-axis of the eye itself, in world-space.

Initially, the up-axis of the eye will be the same as the up-axis of the scene (or +Z if the scene has no up axis defined).

◆ with_speed()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_speed ( const rerun::components::LinearSpeed & _speed ) &&

inline

Translation speed of the eye in the view (when using WASDQE keys to move in the 3D scene).

The default depends on the control kind. For orbit cameras it is derived from the distance to the orbit center. For first person cameras it is derived from the scene size.

◆ with_tracking_entity()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_tracking_entity ( const rerun::components::EntityPath & _tracking_entity ) &&

inline

Currently tracked entity.

If this is a camera, it takes over the camera pose, otherwise follows the entity.

◆ with_spin_speed()

EyeControls3D rerun::blueprint::archetypes::EyeControls3D::with_spin_speed ( const rerun::blueprint::components::AngularSpeed & _spin_speed ) &&

inline

What speed, if any, the camera should spin around the eye-up axis.

Defaults to zero, meaning no spinning.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::EyeControls3D::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::EyeControls3D::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ kind

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::kind

The kind of the eye for the spatial 3D view.

This controls how the eye movement behaves when the user interact with the view. Defaults to orbital.

◆ look_target

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::look_target

The position the camera is currently looking at.

If this is an orbital camera, this also is the center it orbits around.

By default this is the center of the scene bounds.

◆ eye_up

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::eye_up

The up-axis of the eye itself, in world-space.

Initially, the up-axis of the eye will be the same as the up-axis of the scene (or +Z if the scene has no up axis defined).

◆ speed

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::speed

Translation speed of the eye in the view (when using WASDQE keys to move in the 3D scene).

The default depends on the control kind. For orbit cameras it is derived from the distance to the orbit center. For first person cameras it is derived from the scene size.

◆ tracking_entity

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::tracking_entity

Currently tracked entity.

If this is a camera, it takes over the camera pose, otherwise follows the entity.

◆ spin_speed

std::optional<ComponentBatch> rerun::blueprint::archetypes::EyeControls3D::spin_speed

What speed, if any, the camera should spin around the eye-up axis.

Defaults to zero, meaning no spinning.

◆ Descriptor_kind

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_kind

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:kind",
            Loggable<rerun::blueprint::components::Eye3DKind>::ComponentType
        )

ComponentDescriptor for the kind field.

◆ Descriptor_position

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_position

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:position",
            Loggable<rerun::components::Position3D>::ComponentType
        )

ComponentDescriptor for the position field.

◆ Descriptor_look_target

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_look_target

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:look_target",
            Loggable<rerun::components::Position3D>::ComponentType
        )

ComponentDescriptor for the look_target field.

◆ Descriptor_eye_up

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_eye_up

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:eye_up",
            Loggable<rerun::components::Vector3D>::ComponentType
        )

ComponentDescriptor for the eye_up field.

◆ Descriptor_speed

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_speed

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:speed",
            Loggable<rerun::components::LinearSpeed>::ComponentType
        )

ComponentDescriptor for the speed field.

◆ Descriptor_tracking_entity

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_tracking_entity

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:tracking_entity",
            Loggable<rerun::components::EntityPath>::ComponentType
        )

ComponentDescriptor for the tracking_entity field.

◆ Descriptor_spin_speed

constexpr auto rerun::blueprint::archetypes::EyeControls3D::Descriptor_spin_speed

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "EyeControls3D:spin_speed",
            Loggable<rerun::blueprint::components::AngularSpeed>::ComponentType
        )

ComponentDescriptor for the spin_speed field.

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

rerun/blueprint/archetypes/eye_controls3d.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_kind()

◆ with_look_target()

◆ with_eye_up()

◆ with_speed()

◆ with_tracking_entity()

◆ with_spin_speed()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ kind

◆ look_target

◆ eye_up

◆ speed

◆ tracking_entity

◆ spin_speed

◆ Descriptor_kind

◆ Descriptor_position

◆ Descriptor_look_target

◆ Descriptor_eye_up

◆ Descriptor_speed

◆ Descriptor_tracking_entity

◆ Descriptor_spin_speed