rerun::archetypes::ViewCoordinates Struct Reference

Archetype: How we interpret the coordinate system of an entity/space. More...

#include <rerun/archetypes/view_coordinates.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
constexpr	ViewCoordinates (uint8_t axis0, uint8_t axis1, uint8_t axis2)
	Construct Vec3D from x/y/z values.
	ViewCoordinates (ViewCoordinates &&other)=default
	ViewCoordinates (rerun::components::ViewCoordinates _xyz)

Public Attributes
rerun::components::ViewCoordinates	xyz
	The directions of the [x, y, z] axes.

Static Public Attributes
static constexpr const char	IndicatorComponentName []
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	ULF
	X=Up, Y=Left, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	UFL
	X=Up, Y=Forward, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LUF
	X=Left, Y=Up, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LFU
	X=Left, Y=Forward, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FUL
	X=Forward, Y=Up, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FLU
	X=Forward, Y=Left, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	ULB
	X=Up, Y=Left, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	UBL
	X=Up, Y=Back, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LUB
	X=Left, Y=Up, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LBU
	X=Left, Y=Back, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BUL
	X=Back, Y=Up, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BLU
	X=Back, Y=Left, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	URF
	X=Up, Y=Right, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	UFR
	X=Up, Y=Forward, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RUF
	X=Right, Y=Up, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RFU
	X=Right, Y=Forward, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FUR
	X=Forward, Y=Up, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FRU
	X=Forward, Y=Right, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	URB
	X=Up, Y=Right, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	UBR
	X=Up, Y=Back, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RUB
	X=Right, Y=Up, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RBU
	X=Right, Y=Back, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BUR
	X=Back, Y=Up, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BRU
	X=Back, Y=Right, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DLF
	X=Down, Y=Left, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DFL
	X=Down, Y=Forward, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LDF
	X=Left, Y=Down, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LFD
	X=Left, Y=Forward, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FDL
	X=Forward, Y=Down, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FLD
	X=Forward, Y=Left, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DLB
	X=Down, Y=Left, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DBL
	X=Down, Y=Back, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LDB
	X=Left, Y=Down, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LBD
	X=Left, Y=Back, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BDL
	X=Back, Y=Down, Z=Left.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BLD
	X=Back, Y=Left, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DRF
	X=Down, Y=Right, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DFR
	X=Down, Y=Forward, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RDF
	X=Right, Y=Down, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RFD
	X=Right, Y=Forward, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FDR
	X=Forward, Y=Down, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	FRD
	X=Forward, Y=Right, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DRB
	X=Down, Y=Right, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	DBR
	X=Down, Y=Back, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RDB
	X=Right, Y=Down, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RBD
	X=Right, Y=Back, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BDR
	X=Back, Y=Down, Z=Right.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	BRD
	X=Back, Y=Right, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_X_UP
	X=Up, Y=Right, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_X_DOWN
	X=Down, Y=Right, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_Y_UP
	X=Right, Y=Up, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_Y_DOWN
	X=Right, Y=Down, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_Z_UP
	X=Right, Y=Forward, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	RIGHT_HAND_Z_DOWN
	X=Right, Y=Back, Z=Down.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_X_UP
	X=Up, Y=Right, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_X_DOWN
	X=Down, Y=Right, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_Y_UP
	X=Right, Y=Up, Z=Forward.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_Y_DOWN
	X=Right, Y=Down, Z=Back.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_Z_UP
	X=Right, Y=Back, Z=Up.
static RERUN_SDK_EXPORT const rerun::archetypes::ViewCoordinates	LEFT_HAND_Z_DOWN
	X=Right, Y=Forward, Z=Down.

Detailed Description

Archetype: How we interpret the coordinate system of an entity/space.

For instance: What is "up"? What does the Z axis mean? Is this right-handed or left-handed?

The three coordinates are always ordered as [x, y, z].

For example [Right, Down, Forward] means that the X axis points to the right, the Y axis points down, and the Z axis points forward.

Make sure that this archetype is logged at or above the origin entity path of your 3D views.

Example

View coordinates for adjusting the eye camera

#include <rerun.hpp>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_view_coordinates");
    rec.spawn().exit_on_failure();
 
    rec.log_static("world", rerun::ViewCoordinates::RIGHT_HAND_Z_UP); // Set an up-axis
    rec.log(
        "world/xyz",
        rerun::Arrows3D::from_vectors({{1.0, 0.0, 0.0}, {0.0, 1.0, 0.0}, {0.0, 0.0, 1.0}}
        ).with_colors({{255, 0, 0}, {0, 255, 0}, {0, 0, 255}})
    );
}

Member Data Documentation

IndicatorComponentName

constexpr const char rerun::archetypes::ViewCoordinates::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.ViewCoordinatesIndicator"

---

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

• rerun/archetypes/view_coordinates.hpp