opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Friends | List of all members
osc::Rect Class Referencefinal

#include <rect.h>

Public Member Functions

 Rect ()=default
 
Vector2 origin () const
 
Vector2 dimensions () const
 
float width () const
 
float height () const
 
Vector2 half_extents () const
 
float area () const
 
float left () const
 
float right () const
 
float ypd_top () const
 
float ypd_bottom () const
 
float ypu_top () const
 
float ypu_bottom () const
 
RectCorners corners () const
 
Vector2 min_corner () const
 
Vector2 max_corner () const
 
Vector2 ypd_top_left () const
 
Vector2 ypd_top_right () const
 
Vector2 ypd_bottom_left () const
 
Vector2 ypd_bottom_right () const
 
Vector2 ypu_top_left () const
 
Vector2 ypu_top_right () const
 
Vector2 ypu_bottom_left () const
 
Vector2 ypu_bottom_right () const
 
Rect with_flipped_y (float distance_between_x_axes) const
 
Rect with_dimensions (const Vector2 &new_dimensions) const
 
Rect with_dimensions_scaled_by (const Vector2 &scale_factors) const
 
Rect with_origin_and_dimensions_scaled_by (float scale_factor) const
 

Static Public Member Functions

static constexpr Rect from_point (const Vector2 &point)
 
static constexpr Rect from_origin_and_dimensions (const Vector2 &origin, const Vector2 &dimensions)
 
static Rect from_corners (const Vector2 &p1, const Vector2 &p2)
 

Friends

bool operator== (const Rect &, const Rect &)=default
 

Constructor & Destructor Documentation

◆ Rect()

osc::Rect::Rect ( )
default

Member Function Documentation

◆ area()

float osc::Rect::area ( ) const
inline

◆ corners()

RectCorners osc::Rect::corners ( ) const
inline

◆ dimensions()

Vector2 osc::Rect::dimensions ( ) const
inline

◆ from_corners()

static Rect osc::Rect::from_corners ( const Vector2 p1,
const Vector2 p2 
)
inlinestatic

◆ from_origin_and_dimensions()

static constexpr Rect osc::Rect::from_origin_and_dimensions ( const Vector2 origin,
const Vector2 dimensions 
)
inlinestaticconstexpr

◆ from_point()

static constexpr Rect osc::Rect::from_point ( const Vector2 point)
inlinestaticconstexpr

◆ half_extents()

Vector2 osc::Rect::half_extents ( ) const
inline

◆ height()

float osc::Rect::height ( ) const
inline

◆ left()

float osc::Rect::left ( ) const
inline

◆ max_corner()

Vector2 osc::Rect::max_corner ( ) const
inline

◆ min_corner()

Vector2 osc::Rect::min_corner ( ) const
inline

◆ origin()

Vector2 osc::Rect::origin ( ) const
inline

◆ right()

float osc::Rect::right ( ) const
inline

◆ width()

float osc::Rect::width ( ) const
inline

◆ with_dimensions()

Rect osc::Rect::with_dimensions ( const Vector2 new_dimensions) const
inline

◆ with_dimensions_scaled_by()

Rect osc::Rect::with_dimensions_scaled_by ( const Vector2 scale_factors) const
inline

◆ with_flipped_y()

Rect osc::Rect::with_flipped_y ( float  distance_between_x_axes) const
inline

◆ with_origin_and_dimensions_scaled_by()

Rect osc::Rect::with_origin_and_dimensions_scaled_by ( float  scale_factor) const
inline

◆ ypd_bottom()

float osc::Rect::ypd_bottom ( ) const
inline

◆ ypd_bottom_left()

Vector2 osc::Rect::ypd_bottom_left ( ) const
inline

◆ ypd_bottom_right()

Vector2 osc::Rect::ypd_bottom_right ( ) const
inline

◆ ypd_top()

float osc::Rect::ypd_top ( ) const
inline

◆ ypd_top_left()

Vector2 osc::Rect::ypd_top_left ( ) const
inline

◆ ypd_top_right()

Vector2 osc::Rect::ypd_top_right ( ) const
inline

◆ ypu_bottom()

float osc::Rect::ypu_bottom ( ) const
inline

◆ ypu_bottom_left()

Vector2 osc::Rect::ypu_bottom_left ( ) const
inline

◆ ypu_bottom_right()

Vector2 osc::Rect::ypu_bottom_right ( ) const
inline

◆ ypu_top()

float osc::Rect::ypu_top ( ) const
inline

◆ ypu_top_left()

Vector2 osc::Rect::ypu_top_left ( ) const
inline

◆ ypu_top_right()

Vector2 osc::Rect::ypu_top_right ( ) const
inline

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const Rect ,
const Rect  
)
friend

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