Class IPositionComponent

Inheritance Relationships

Derived Types

Class Documentation

class IPositionComponent

Controls the 3D position of the component in world space.

Subclassed by csp::multiplayer::AudioSpaceComponent, csp::multiplayer::CinematicCameraSpaceComponent, csp::multiplayer::ConversationSpaceComponent, csp::multiplayer::ECommerceSpaceComponent, csp::multiplayer::HotspotSpaceComponent, csp::multiplayer::ITransformComponent, csp::multiplayer::LightSpaceComponent, csp::multiplayer::PortalSpaceComponent, csp::multiplayer::ReflectionSpaceComponent

Public Functions

virtual const csp::common::Vector3 &GetPosition() const = 0

Gets the position of the origin of this component in world space.

Note

The coordinate system used follows the glTF 2.0 specification, in meters.

  • Right handed coordinate system

  • +Y is UP

  • +X is left (facing forward)

  • +Z is forward

Returns

csp::common::Vector3 : The 3D position as a vector (left, up, forward) in meters.

virtual void SetPosition(const csp::common::Vector3 &InValue) = 0

Sets the position of the origin of this component in world space.

Note

The coordinate system used follows the glTF 2.0 specification, in meters.

  • Right handed coordinate system

  • +Y is UP

  • +X is left (facing forward)

  • +Z is forward

Parameters

InValuecsp::common::Vector3 : The new value expressed as a vector.

Protected Functions

virtual ~IPositionComponent() = default