gepetto::viewer::EnumProperty Class Reference

#include <gepetto/viewer/node-property.h>

Inheritance diagram for gepetto::viewer::EnumProperty:

Collaboration diagram for gepetto::viewer::EnumProperty:

Public Types
typedef shared_ptr< EnumProperty >	Ptr_t
typedef boost::function< T(void)>	Getter_t
typedef boost::function< void(const T &)>	Setter_t
Public Types inherited from gepetto::viewer::PropertyTpl< T, Range >
typedef boost::function< void(const T &)>	Setter_t
typedef boost::function< T(void)>	Getter_t
typedef shared_ptr< PropertyTpl >	Ptr_t

Public Member Functions
virtual std::string	type ()
const MetaEnum *	metaEnum () const
	EnumProperty (const std::string &name, const MetaEnum *type, const Getter_t &g, const Setter_t &s)
bool	set (const int &value)
	Set the enum property. More...
bool	set (const std::string &value)
	Set the enum property from a string. More...
bool	get (int &v)
	Get the enum property as an integer. More...
bool	get (std::string &v)
	Get the enum property as a string. More...
Public Member Functions inherited from gepetto::viewer::PropertyTpl< T, Range >
	PropertyTpl (const std::string &name, const Getter_t &g, const Setter_t &s)
virtual	~PropertyTpl ()
virtual bool	set (const T &value)
virtual bool	get (T &value)
bool	hasReadAccess () const
bool	hasWriteAccess () const
const Getter_t &	getter () const
void	getter (const Getter_t &g)
const Setter_t &	setter () const
void	setter (const Setter_t &s)
Public Member Functions inherited from gepetto::viewer::Property
virtual bool	set (void)
virtual bool	set (const bool &v)
virtual bool	set (const float &v)
virtual bool	set (const unsigned long &v)
virtual bool	set (const osgVector2 &v)
virtual bool	set (const osgVector3 &v)
virtual bool	set (const osgVector4 &v)
virtual bool	set (const Configuration &v)
virtual bool	get (void)
virtual bool	get (bool &v)
virtual bool	get (float &v)
virtual bool	get (unsigned long &v)
virtual bool	get (osgVector2 &v)
virtual bool	get (osgVector3 &v)
virtual bool	get (osgVector4 &v)
virtual bool	get (Configuration &v)
const std::string &	name () const
Public Member Functions inherited from gepetto::viewer::Range< Scalar >
	Range ()
bool	hasMin ()
bool	hasMax ()
bool	hasRange ()
void	setRange (const Scalar &minimum, const Scalar &maximum)
void	setRange (const Scalar &minimum, const Scalar &maximum, const Scalar &_step)

Static Public Member Functions
static Ptr_t	create (const std::string &name, const MetaEnum *type, const Getter_t &g, const Setter_t &s)
Static Public Member Functions inherited from gepetto::viewer::PropertyTpl< T, Range >
static Ptr_t	create (const std::string &name, const Getter_t &g, const Setter_t &s)
static Ptr_t	create (const std::string &name, const Getter_t &g)
static Ptr_t	create (const std::string &name, const Setter_t &s)
template<typename Obj >
static Getter_t	getterFromMemberFunction (Obj *obj, const T &(Obj::*mem_func)() const)
template<typename Obj >
static Getter_t	getterFromMemberFunction (Obj *obj, T(Obj::*mem_func)() const)
template<typename Obj >
static Setter_t	setterFromMemberFunction (Obj *obj, void(Obj::*mem_func)(const T &))
template<typename Obj >
static Setter_t	setterFromMemberFunction (Obj *obj, void(Obj::*mem_func)(T))
template<typename Obj , typename RetType >
static Ptr_t	create (const std::string &name, Obj *obj, RetType(Obj::*mem_get)() const, void(Obj::*mem_set)(const T &))
template<typename Obj , typename RetType >
static Ptr_t	create (const std::string &name, Obj *obj, RetType(Obj::*mem_get)() const, void(Obj::*mem_set)(T))
template<typename Obj , typename RetType >
static Ptr_t	createRO (const std::string &name, Obj *obj, RetType(Obj::*mem_get)() const)
template<typename Obj >
static Ptr_t	createWO (const std::string &name, Obj *obj, void(Obj::*mem_set)(const T &))
template<typename Obj , typename RetType >
static Ptr_t	createWO (const std::string &name, Obj *obj, void(Obj::*mem_set)(T))

Additional Inherited Members
Public Attributes inherited from gepetto::viewer::Range< Scalar >
Scalar	min
Scalar	max
Scalar	step
bool	adaptiveDecimal
Protected Member Functions inherited from gepetto::viewer::Property
	Property (const std::string &name)
virtual	~Property ()
template<typename T >
void	invalidType (T) const
void	invalidGet () const
void	invalidSet () const
Protected Attributes inherited from gepetto::viewer::Property
const std::string	name_

Member Typedef Documentation

Getter_t

typedef boost::function< T (void)> gepetto::viewer::PropertyTpl< T, Range >::Getter_t

Ptr_t

typedef shared_ptr<EnumProperty> gepetto::viewer::EnumProperty::Ptr_t

Setter_t

typedef boost::function<void(const T&)> gepetto::viewer::PropertyTpl< T, Range >::Setter_t

Constructor & Destructor Documentation

EnumProperty()

gepetto::viewer::EnumProperty::EnumProperty ( const std::string &  name, const MetaEnum *  type, const Getter_t &  g, const Setter_t &  s  )

inline

Member Function Documentation

create()

static Ptr_t gepetto::viewer::EnumProperty::create ( const std::string &  name, const MetaEnum *  type, const Getter_t &  g, const Setter_t &  s  )

inlinestatic

get() [1/2]

bool gepetto::viewer::EnumProperty::get ( int &  v )

inlinevirtual

Get the enum property as an integer.

Reimplemented from gepetto::viewer::Property.

References gepetto::viewer::Property::get().

get() [2/2]

bool gepetto::viewer::EnumProperty::get ( std::string &  v )

virtual

Get the enum property as a string.

Reimplemented from gepetto::viewer::Property.

metaEnum()

const MetaEnum* gepetto::viewer::EnumProperty::metaEnum ( ) const

inline

set() [1/2]

bool gepetto::viewer::EnumProperty::set ( const int &  value )

virtual

Set the enum property.

It also checks that value is a valid enum.

Reimplemented from gepetto::viewer::Property.

set() [2/2]

bool gepetto::viewer::EnumProperty::set ( const std::string &  value )

virtual

Set the enum property from a string.

It also checks that value is a valid enum.

Reimplemented from gepetto::viewer::Property.

type()

virtual std::string gepetto::viewer::EnumProperty::type ( )

inlinevirtual

Reimplemented from gepetto::viewer::PropertyTpl< T, Range >.