rcsc::ViewWidth Class Reference

view width data class More...

#include <view_mode.h>

Public Types
enum	Type { NARROW = 60 , NORMAL = 120 , WIDE = 180 , ILLEGAL = 0 }
	types of view width

Public Member Functions
	ViewWidth ()
	init by NORMAL
	ViewWidth (const ViewWidth::Type t)
	construct with 't'. NO explicit More...
ViewWidth &	operator= (const ViewWidth::Type t)
	substituion operator by type Id More...
	operator ViewWidth::Type () const
	type operator More...
ViewWidth::Type	type () const
	get type Id More...
bool	operator== (const ViewWidth &w) const
	compare operator. More...
bool	operator== (const ViewWidth::Type t) const
	compare operator. More...
bool	operator!= (const ViewWidth &w) const
	compare operator. More...
bool	operator!= (const ViewWidth::Type t) const
	compare operator. More...
const ViewWidth &	operator++ ()
	increase view width type More...
const ViewWidth	operator++ (int)
	increase view width type More...
const ViewWidth &	operator-- ()
	decrease view width type More...
const ViewWidth	operator-- (int)
	increase view width type More...
double	width () const
	get degree value depending on the current type and server param More...
std::string	str () const
	get width type name More...

Static Public Member Functions
static double	width (const ViewWidth::Type type)
	get degree value depending on the current type and server param More...
static ViewWidth::Type	parse (const char *msg)
	static method. get the type described by string More...

Detailed Description

view width data class

Constructor & Destructor Documentation

ViewWidth()

rcsc::ViewWidth::ViewWidth ( const ViewWidth::Type  t )

inline

construct with 't'. NO explicit

Parameters

t

type Id

Member Function Documentation

operator ViewWidth::Type()

rcsc::ViewWidth::operator ViewWidth::Type ( ) const

inline

type operator

Returns

type Id

operator!=() [1/2]

bool rcsc::ViewWidth::operator!= ( const ViewWidth &  w ) const

inline

compare operator.

Parameters

w	value to be compared

Returns

compared result

This operator should declare and defined at the global scope...

operator!=() [2/2]

bool rcsc::ViewWidth::operator!= ( const ViewWidth::Type  t ) const

inline

compare operator.

Parameters

t	type Id to be compared

Returns

compared result

operator++() [1/2]

const ViewWidth & rcsc::ViewWidth::operator++

(

)

increase view width type

Returns

const reference to this object

operator++() [2/2]

const ViewWidth rcsc::ViewWidth::operator++

(

int

)

increase view width type

Returns

old value

operator--() [1/2]

const ViewWidth & rcsc::ViewWidth::operator--

(

)

decrease view width type

Returns

const reference to this object

operator--() [2/2]

const ViewWidth rcsc::ViewWidth::operator--

(

int

)

increase view width type

Returns

old value

operator=()

ViewWidth & rcsc::ViewWidth::operator= ( const ViewWidth::Type  t )

inline

substituion operator by type Id

Parameters

t

type Id

Returns

reference to itself

operator==() [1/2]

bool rcsc::ViewWidth::operator== ( const ViewWidth &  w ) const

inline

compare operator.

Parameters

w	value to be compared

Returns

compared result

This operator should declare and defined at the global scope...

operator==() [2/2]

bool rcsc::ViewWidth::operator== ( const ViewWidth::Type  t ) const

inline

compare operator.

Parameters

t	type Id to be compared

Returns

compared result

parse()

static ViewWidth::Type rcsc::ViewWidth::parse ( const char *  msg )

static

static method. get the type described by string

Parameters

msg	string to be analyzed

Returns

type Id

str()

std::string rcsc::ViewWidth::str

(

)

const

get width type name

Returns

the name string of width type

type()

ViewWidth::Type rcsc::ViewWidth::type ( ) const

inline

get type Id

Returns

type Id

width() [1/2]

double rcsc::ViewWidth::width ( ) const

inline

get degree value depending on the current type and server param

Returns

degree value

width() [2/2]

static double rcsc::ViewWidth::width ( const ViewWidth::Type  type )

static

get degree value depending on the current type and server param

Parameters

type	view width type

Returns

degree value

---

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

• /home/kali/rc/tools/include/rcsc/player/view_mode.h