CARLA
Loading...
Searching...
No Matches
Public Member Functions | List of all members
carla::geom::Velocity Struct Reference

Linear velocity in metres per second. More...

#include <Velocity.h>

+ Inheritance diagram for carla::geom::Velocity:

Public Member Functions

FVector ToFVectorCmPerSecond () const
 Return this Velocity as an Unreal FVector in centimetres per second.
 
 Velocity ()=default
 
 Velocity (const FVector &v_cm_per_s)
 Build a Velocity (m/s) from an Unreal FVector expressed in centimetres per second.
 
constexpr Velocity (const Vector3D &v)
 
constexpr Velocity (float ix, float iy, float iz)
 
- Public Member Functions inherited from carla::geom::Vector3D
Vector3D Abs () const
 
float Length () const
 
float Length2D () const
 
Vector3D MakeUnitVector (const float epsilon=2.0f *std::numeric_limits< float >::epsilon()) const
 Return a unit-length copy of this vector.
 
template<typename MSGPACK_OBJECT >
void msgpack_object (MSGPACK_OBJECT *o, clmdep_msgpack::zone &sneaky_variable_that_shadows_z) const
 
template<typename Packer >
void msgpack_pack (Packer &pk) const
 
void msgpack_unpack (clmdep_msgpack::object const &o)
 
constexpr bool operator!= (const Vector3D &rhs) const
 
constexpr Vector3D & operator*= (float rhs)
 
constexpr Vector3D & operator+= (const Vector3D &rhs)
 
constexpr Vector3D & operator-= (const float f)
 
constexpr Vector3D & operator-= (const Vector3D &rhs)
 
constexpr Vector3D & operator/= (float rhs)
 
Vector3D & operator= (const FVector &rhs)=delete
 
constexpr bool operator== (const Vector3D &rhs) const
 
constexpr float SquaredLength () const
 
constexpr float SquaredLength2D () const
 
Vector3D ToCentimeters () const
 Return a Vector3D converted from meters to centimeters.
 
FVector ToFVector () const
 
Vector3D ToMeters () const
 Return a Vector3D converted from centimeters to meters.
 
 Vector3D ()=default
 
 Vector3D (const FVector &v)=delete
 These 2 methods are explicitly deleted to avoid creating them by other users, unlike locations, some vectors have units and some don't, by removing these methods we found several places were the conversion from cm to m was missing.
 
constexpr Vector3D (float ix, float iy, float iz)
 

Additional Inherited Members

- Public Attributes inherited from carla::geom::Vector3D
float x = 0.0f
 
float y = 0.0f
 
float z = 0.0f
 
- Static Public Attributes inherited from carla::geom::Vector3D
static constexpr auto Dim = 3
 

Detailed Description

Linear velocity in metres per second.

Inherits the storage and arithmetic of Vector3D while carrying unit semantics so consumers do not accidentally mix cm/s and m/s payloads at API boundaries.

Definition at line 17 of file Velocity.h.

Constructor & Destructor Documentation

◆ Velocity() [1/4]

carla::geom::Velocity::Velocity ( )
default

◆ Velocity() [2/4]

constexpr carla::geom::Velocity::Velocity ( float  ix,
float  iy,
float  iz 
)
inlineconstexpr

Definition at line 21 of file Velocity.h.

◆ Velocity() [3/4]

constexpr carla::geom::Velocity::Velocity ( const Vector3D &  v)
inlineexplicitconstexpr

Definition at line 25 of file Velocity.h.

◆ Velocity() [4/4]

carla::geom::Velocity::Velocity ( const FVector &  v_cm_per_s)
inlineexplicit

Build a Velocity (m/s) from an Unreal FVector expressed in centimetres per second.

Definition at line 33 of file Velocity.h.

Member Function Documentation

◆ ToFVectorCmPerSecond()

FVector carla::geom::Velocity::ToFVectorCmPerSecond ( ) const
inline

Return this Velocity as an Unreal FVector in centimetres per second.

Definition at line 42 of file Velocity.h.

References carla::geom::Vector3D::x, carla::geom::Vector3D::y, and carla::geom::Vector3D::z.


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