#include <SDL2pp/Point.hh>

Inheritance diagram for SDL2pp::Point:

Public Member Functions
constexpr	Point ()
	Default constructor. More...

constexpr	Point (const SDL_Point &point)
	Construct a point from existing SDL_Point. More...

constexpr	Point (int x, int y)
	Construct the point from given coordinates. More...

	Point (const Point &) noexcept=default
	Copy constructor.

	Point (Point &&) noexcept=default
	Move constructor.

Point &	operator= (const Point &) noexcept=default
	Assignment operator. More...

Point &	operator= (Point &&) noexcept=default
	Move assignment operator. More...

constexpr int	GetX () const
	Get X coordinate of the point. More...

Point &	SetX (int nx)
	Set X coordinate of the point. More...

constexpr int	GetY () const
	Get Y coordinate of the point. More...

Point &	SetY (int ny)
	Set Y coordinate of the point. More...

constexpr Point	operator- () const
	Get point's memberwise negation. More...

constexpr Point	operator+ (const Point &other) const
	Get point's memberwise addition with another point. More...

constexpr Point	operator- (const Point &other) const
	Get point's memberwise subtraction with another point. More...

constexpr Point	operator/ (int value) const
	Get point's memberwise division by an integer. More...

constexpr Point	operator/ (const Point &other) const
	Get point's memberwise division by another point. More...

constexpr Point	operator% (int value) const
	Get point's memberwise remainder from division by an integer. More...

constexpr Point	operator% (const Point &other) const
	Get point's memberwise remainder from division by another point. More...

constexpr Point	operator* (int value) const
	Get point's memberwise multiplication by an integer. More...

constexpr Point	operator* (const Point &other) const
	Get point's memberwise multiplication by anoter point. More...

Point &	operator+= (const Point &other)
	Memberwise add another point. More...

Point &	operator-= (const Point &other)
	Memberwise subtract another point. More...

Point &	operator/= (int value)
	Memberwise divide by an integer. More...

Point &	operator/= (const Point &other)

Point &	operator%= (int value)
	Memberwise remainder from division by an integer. More...

Point &	operator%= (const Point &other)
	Memberwise remainder from division by another point. More...

Point &	operator*= (int value)
	Memberwise multiply by an integer. More...

Point &	operator*= (const Point &other)
	Memberwise multiply by another point. More...

Point	GetClamped (const Rect &rect) const
	Get a point with coordinates modified so it fits into a given rect. More...

Point &	Clamp (const Rect &rect)
	Clamp point coordinates to make it fit into a given rect. More...

Point	GetWrapped (const Rect &rect) const
	Get a point wrapped within a specified rect. More...

Point &	Wrap (const Rect &rect)
	Wrap point coordinates within a spedified rect. More...

Detailed Description

2D point

This class is public-derived from SDL_Point structure, may generally used as it if passed via pointer or reference. It also supports direct access to x and y members.

See also: http://wiki.libsdl.org/SDL_Point

Constructor & Destructor Documentation

◆ Point() [1/3]

constexpr SDL2pp::Point::Point ( )

inline

Default constructor.

Creates a Point(0, 0)

◆ Point() [2/3]

constexpr SDL2pp::Point::Point ( const SDL_Point & point )

inline

Construct a point from existing SDL_Point.

Parameters

[in] point Existing SDL_Point

◆ Point() [3/3]

constexpr SDL2pp::Point::Point	(	int	x,
		int	y
	)

inline

Construct the point from given coordinates.

Parameters

[in]	x	X coordinate
[in]	y	Y coordinate

Member Function Documentation

◆ Clamp()

Point & SDL2pp::Point::Clamp ( const Rect & rect )

Clamp point coordinates to make it fit into a given rect.

Parameters

[in] rect Rectangle to clamp with

Returns: Reference to self

◆ GetClamped()

Point SDL2pp::Point::GetClamped ( const Rect & rect ) const

Get a point with coordinates modified so it fits into a given rect.

Parameters

[in] rect Rectangle to clamp with

Returns: Clamped point

◆ GetWrapped()

Point SDL2pp::Point::GetWrapped ( const Rect & rect ) const

Get a point wrapped within a specified rect.

Parameters

[in] rect Rectangle to wrap with

Returns: Wrapped point

◆ GetX()

constexpr int SDL2pp::Point::GetX ( ) const

inline

Get X coordinate of the point.

Returns: X coordinate of the point

◆ GetY()

constexpr int SDL2pp::Point::GetY ( ) const

inline

Get Y coordinate of the point.

Returns: Y coordinate of the point

◆ operator%() [1/2]

constexpr Point SDL2pp::Point::operator% ( int value ) const

inline

Get point's memberwise remainder from division by an integer.

Parameters

[in] value Divisor

Returns: New Point representing memberwise remainder from division by an integer

◆ operator%() [2/2]

constexpr Point SDL2pp::Point::operator% ( const Point & other ) const

inline

Get point's memberwise remainder from division by another point.

Parameters

[in] other Divisor

Returns: New Point representing memberwise remainder from division by another point

◆ operator%=() [1/2]

Point& SDL2pp::Point::operator%= ( int value )

inline

Memberwise remainder from division by an integer.

Parameters

[in] value Divisor

Returns: Reference to self

◆ operator%=() [2/2]

Point& SDL2pp::Point::operator%= ( const Point & other )

inline

Memberwise remainder from division by another point.

Parameters

[in] other Divisor

Returns: Reference to self

◆ operator*() [1/2]

constexpr Point SDL2pp::Point::operator* ( int value ) const

inline

Get point's memberwise multiplication by an integer.

Parameters

[in] value Multiplier

Returns: New Point representing memberwise multiplication of point by an integer

◆ operator*() [2/2]

constexpr Point SDL2pp::Point::operator* ( const Point & other ) const

inline

Get point's memberwise multiplication by anoter point.

Parameters

[in] other Multiplier

Returns: New Point representing memberwise multiplication of point by another point

◆ operator*=() [1/2]

Point& SDL2pp::Point::operator*= ( int value )

inline

Memberwise multiply by an integer.

Parameters

[in] value Multiplier

Returns: Reference to self

◆ operator*=() [2/2]

Point& SDL2pp::Point::operator*= ( const Point & other )

inline

Memberwise multiply by another point.

Parameters

[in] other Multiplier

Returns: Reference to self

◆ operator+()

constexpr Point SDL2pp::Point::operator+ ( const Point & other ) const

inline

Get point's memberwise addition with another point.

Parameters

[in] other Point to add

Returns: New Point representing memberwise addition with another point

◆ operator+=()

Point& SDL2pp::Point::operator+= ( const Point & other )

inline

Memberwise add another point.

Parameters

[in] other Point to add to the current one

Returns: Reference to self

◆ operator-() [1/2]

constexpr Point SDL2pp::Point::operator- ( ) const

inline

Get point's memberwise negation.

Returns: New Point representing memberwise negation

◆ operator-() [2/2]

constexpr Point SDL2pp::Point::operator- ( const Point & other ) const

inline

Get point's memberwise subtraction with another point.

Parameters

[in] other Point to subtract

Returns: New Point representing memberwise subtraction of another point

◆ operator-=()

Point& SDL2pp::Point::operator-= ( const Point & other )

inline

Memberwise subtract another point.

Parameters

[in] other Point to subtract from the current one

Returns: Reference to self

◆ operator/() [1/2]

constexpr Point SDL2pp::Point::operator/ ( int value ) const

inline

Get point's memberwise division by an integer.

Parameters

[in] value Divisor

Returns: New Point representing memberwise division of point by an integer

◆ operator/() [2/2]

constexpr Point SDL2pp::Point::operator/ ( const Point & other ) const

inline

Get point's memberwise division by another point.

Parameters

[in] other Divisor

Returns: New Point representing memberwise division of point by another point

◆ operator/=() [1/2]

Point& SDL2pp::Point::operator/= ( int value )

inline

Memberwise divide by an integer.

Parameters

[in] value Divisor

Returns: Reference to self

◆ operator/=() [2/2]

Point& SDL2pp::Point::operator/= ( const Point & other )

inline

nbrief Memberwise divide by another point

Parameters

[in] other Divisor

Returns: Reference to self

◆ operator=() [1/2]

Point& SDL2pp::Point::operator= ( const Point & )

defaultnoexcept

Assignment operator.

Returns: Reference to self

◆ operator=() [2/2]

Point& SDL2pp::Point::operator= ( Point && )

defaultnoexcept

Move assignment operator.

Returns: Reference to self

◆ SetX()

Point& SDL2pp::Point::SetX ( int nx )

inline

Set X coordinate of the point.

Parameters

[in] nx New X coordinate value

Returns: Reference to self

◆ SetY()

Point& SDL2pp::Point::SetY ( int ny )

inline

Set Y coordinate of the point.

Parameters

[in] ny New Y coordinate value

Returns: Reference to self

◆ Wrap()

Point & SDL2pp::Point::Wrap ( const Rect & rect )

Wrap point coordinates within a spedified rect.

Parameters

[in] rect Rectangle to wrap with

Returns: Reference to self

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

SDL2pp/Point.hh
SDL2pp/Point.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Point() [1/3]

◆ Point() [2/3]

◆ Point() [3/3]

Member Function Documentation

◆ Clamp()

◆ GetClamped()

◆ GetWrapped()

◆ GetX()

◆ GetY()

◆ operator%() [1/2]

◆ operator%() [2/2]

◆ operator%=() [1/2]

◆ operator%=() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetX()

◆ SetY()

◆ Wrap()