instigate::geometry::concept::line::interface< T > Struct Template Reference

Interface for the concept Line Concept. More...

#include <concept_line.hpp>

Inheritance diagram for instigate::geometry::concept::line::interface< T >:

List of all members.

Associated types
typedef T::point_type	point_type
	Type of the point.
typedef T::coordinate_type	coordinate_type
	Coordinate type.
static void	set_source_x (T &p, const coordinate_type &v)
	Sets the source x coordinate of line with given value.
static void	set_source_y (T &p, const coordinate_type &v)
	Sets the source y coordinate of line with given value.
static void	set_target_x (T &p, const coordinate_type &v)
	Sets the target @ x coordinate of the line with given value.
static void	set_target_y (T &p, const coordinate_type &v)
	Sets the target @ y coordinate of the line with given value.
static const coordinate_type	get_source_x (const T &p)
	Gets the source @ x coordinate of the line.
static const coordinate_type	get_source_y (const T &p)
	Gets the source @ y coordinate of the line.
static const coordinate_type	get_target_x (const T &p)
	Gets the target x coordinate of the line.
static const coordinate_type	get_target_y (const T &p)
	Gets the target y coordinate of the line.

---

Detailed Description

template<typename T>
struct instigate::geometry::concept::line::interface< T >

Interface for the concept Line Concept.

This is a "non-intrusive" interface for the line. Any type, that conceptually can be treated as a line can become a model of this concept, if this interface is provided for it by specializing this template structure with that type and providing definitions for associated types and basic operations.

---

Member Typedef Documentation

template<typename T>

typedef T::point_type instigate::geometry::concept::line::interface< T >::point_type

Type of the point.

The type should be the point concept model.

---

Member Function Documentation

template<typename T>

static const coordinate_type instigate::geometry::concept::line::interface< T >::get_source_x

(

const T &

p

)

[inline, static]

Gets the source @ x coordinate of the line.

Parameters:

[in]

p

is line, which source x coordinate to be get

Returns:

the source x coordinate of the line

Complexity:

O(1).

template<typename T>

static const coordinate_type instigate::geometry::concept::line::interface< T >::get_source_y

(

const T &

p

)

[inline, static]

Gets the source @ y coordinate of the line.

Parameters:

[in]

p

is line, which source y coordinate to be get

Returns:

the source y coordinate of the line

Complexity:

O(1).

template<typename T>

static const coordinate_type instigate::geometry::concept::line::interface< T >::get_target_x

(

const T &

p

)

[inline, static]

Gets the target x coordinate of the line.

Parameters:

[in]

p

is line, which target x coordinate to be get

Returns:

the target x coordinate of the line

Complexity:

O(1).

template<typename T>

static const coordinate_type instigate::geometry::concept::line::interface< T >::get_target_y

(

const T &

p

)

[inline, static]

Gets the target y coordinate of the line.

Parameters:

[in]

p

is line, which target y coordinate to be get

Returns:

the target y coordinate of the line

Complexity:

O(1).

template<typename T>

static void instigate::geometry::concept::line::interface< T >::set_source_x	(	T &	p,
		const coordinate_type &	v
	)			[inline, static]

Sets the source x coordinate of line with given value.

Parameters:

[out]	p	is the line, which source x coordinate to be set
[in]	v	is the value to be set

Complexity:

O(1).

template<typename T>

static void instigate::geometry::concept::line::interface< T >::set_source_y	(	T &	p,
		const coordinate_type &	v
	)			[inline, static]

Sets the source y coordinate of line with given value.

Parameters:

[out]	p	is the line, which source y coordinate to be set
[in]	v	is the value to be set

Complexity:

O(1).

template<typename T>

static void instigate::geometry::concept::line::interface< T >::set_target_x	(	T &	p,
		const coordinate_type &	v
	)			[inline, static]

Sets the target @ x coordinate of the line with given value.

Parameters:

[out]	p	is the line, which target @ x coordinate to be set
[in]	v	is the value to be set

Complexity:

O(1).

template<typename T>

static void instigate::geometry::concept::line::interface< T >::set_target_y	(	T &	p,
		const coordinate_type &	v
	)			[inline, static]

Sets the target @ y coordinate of the line with given value.

Parameters:

[out]	p	is the line, which target @ y coordinate to be set
[in]	v	is the value to be set

Complexity:

O(1).

---

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

• src/geometry/concept_line.hpp