Apollo  6.0
Open source self driving car software
Public Member Functions | List of all members
apollo::planning::STPoint Class Reference

#include <st_point.h>

Inheritance diagram for apollo::planning::STPoint:
Inheritance graph
Collaboration diagram for apollo::planning::STPoint:
Collaboration graph

Public Member Functions

 STPoint ()=default
 
 STPoint (const double s, const double t)
 
 STPoint (const common::math::Vec2d &vec2d_point)
 
double x () const =delete
 
double y () const =delete
 
double s () const
 
double t () const
 
void set_s (const double s)
 
void set_t (const double t)
 
std::string DebugString () const
 
- Public Member Functions inherited from apollo::common::math::Vec2d
constexpr Vec2d (const double x, const double y) noexcept
 Constructor which takes x- and y-coordinates. More...
 
constexpr Vec2d () noexcept
 Constructor returning the zero vector. More...
 
double x () const
 Getter for x component. More...
 
double y () const
 Getter for y component. More...
 
void set_x (const double x)
 Setter for x component. More...
 
void set_y (const double y)
 Setter for y component. More...
 
double Length () const
 Gets the length of the vector. More...
 
double LengthSquare () const
 Gets the squared length of the vector. More...
 
double Angle () const
 Gets the angle between the vector and the positive x semi-axis. More...
 
void Normalize ()
 Returns the unit vector that is co-linear with this vector. More...
 
double DistanceTo (const Vec2d &other) const
 Returns the distance to the given vector. More...
 
double DistanceSquareTo (const Vec2d &other) const
 Returns the squared distance to the given vector. More...
 
double CrossProd (const Vec2d &other) const
 Returns the "cross" product between these two Vec2d (non-standard). More...
 
double InnerProd (const Vec2d &other) const
 Returns the inner product between these two Vec2d. More...
 
Vec2d rotate (const double angle) const
 rotate the vector by angle. More...
 
void SelfRotate (const double angle)
 rotate the vector itself by angle. More...
 
Vec2d operator+ (const Vec2d &other) const
 Sums two Vec2d. More...
 
Vec2d operator- (const Vec2d &other) const
 Subtracts two Vec2d. More...
 
Vec2d operator* (const double ratio) const
 Multiplies Vec2d by a scalar. More...
 
Vec2d operator/ (const double ratio) const
 Divides Vec2d by a scalar. More...
 
Vec2doperator+= (const Vec2d &other)
 Sums another Vec2d to the current one. More...
 
Vec2doperator-= (const Vec2d &other)
 Subtracts another Vec2d to the current one. More...
 
Vec2doperator*= (const double ratio)
 Multiplies this Vec2d by a scalar. More...
 
Vec2doperator/= (const double ratio)
 Divides this Vec2d by a scalar. More...
 
bool operator== (const Vec2d &other) const
 Compares two Vec2d. More...
 
std::string DebugString () const
 Returns a human-readable string representing this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from apollo::common::math::Vec2d
static Vec2d CreateUnitVec2d (const double angle)
 Creates a unit-vector with a given angle to the positive x semi-axis. More...
 
- Protected Attributes inherited from apollo::common::math::Vec2d
double x_ = 0.0
 
double y_ = 0.0
 

Constructor & Destructor Documentation

◆ STPoint() [1/3]

apollo::planning::STPoint::STPoint ( )
default

◆ STPoint() [2/3]

apollo::planning::STPoint::STPoint ( const double  s,
const double  t 
)

◆ STPoint() [3/3]

apollo::planning::STPoint::STPoint ( const common::math::Vec2d vec2d_point)
explicit

Member Function Documentation

◆ DebugString()

std::string apollo::planning::STPoint::DebugString ( ) const

◆ s()

double apollo::planning::STPoint::s ( ) const

◆ set_s()

void apollo::planning::STPoint::set_s ( const double  s)

◆ set_t()

void apollo::planning::STPoint::set_t ( const double  t)

◆ t()

double apollo::planning::STPoint::t ( ) const

◆ x()

double apollo::planning::STPoint::x ( ) const
delete

◆ y()

double apollo::planning::STPoint::y ( ) const
delete

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