StepCore::Controller Class Reference

#include <tool.h>

Inheritance diagram for StepCore::Controller:

Public Member Functions
	Controller (Vector2d position=Vector2d::Zero(), Vector2d size=Vector2d(200, 60))
const QString &	decreaseShortcut () const
const QString &	increaseShortcut () const
double	increment () const
int	index () const
bool	isValid () const
const Vector2d &	limits () const
Object *	object () const
const Vector2d &	position () const
QString	property () const
const MetaProperty *	propertyPtr () const
void	setDecreaseShortcut (const QString &decreaseShortcut)
void	setIncreaseShortcut (const QString &increaseShortcut)
void	setIncrement (double increment)
void	setIndex (int index)
void	setLimits (const Vector2d &limits)
void	setObject (Object *object)
void	setPosition (const Vector2d &position)
void	setProperty (const QString &property)
void	setSize (const Vector2d &size)
void	setValue (double value)
void	setValue (double value, bool *ok)
const Vector2d &	size () const
QString	units () const
double	value () const
double	value (bool *ok) const
Public Member Functions inherited from StepCore::Item
	Item (const QString &name=QString())
	Item (const Item &item)
virtual	~Item ()
Color	color () const
void	deleteObjectErrors ()
ItemGroup *	group () const
ObjectErrors *	objectErrors ()
Item &	operator= (const Item &item)
void	setColor (Color color)
virtual void	setGroup (ItemGroup *group)
virtual void	setWorld (World *world)
ObjectErrors *	tryGetObjectErrors () const
World *	world () const
virtual void	worldItemRemoved (Item *item STEPCORE_UNUSED)
Public Member Functions inherited from StepCore::Object
	Object (const QString &name=QString())
virtual	~Object ()
const QString &	name () const
void	setName (const QString &name)
Public Member Functions inherited from StepCore::Tool
virtual	~Tool ()

Protected Attributes
QString	_decreaseShortcut
QString	_increaseShortcut
double	_increment
int	_index
Vector2d	_limits
Object *	_object
Vector2d	_position
QString	_property
Vector2d	_size
Protected Attributes inherited from StepCore::Object
QString	_name

Additional Inherited Members
Protected Member Functions inherited from StepCore::Item
virtual ObjectErrors *	createObjectErrors ()

Detailed Description

Controller item to control properties of other objects.

Actual displaying of the Controller and its user interaction should be implemented by application

Definition at line 357 of file tool.h.

Constructor & Destructor Documentation

StepCore::Controller::Controller ( Vector2d  position = Vector2d::Zero(), Vector2d  size = Vector2d(200,60)  )

explicit

Constructs Controller.

Definition at line 302 of file tool.cc.

Member Function Documentation

const QString& StepCore::Controller::decreaseShortcut ( ) const

inline

Get GUI increase shortcut.

Definition at line 396 of file tool.h.

const QString& StepCore::Controller::increaseShortcut ( ) const

inline

Get GUI decrease shortcut.

Definition at line 401 of file tool.h.

double StepCore::Controller::increment ( ) const

inline

Get increment step.

Definition at line 406 of file tool.h.

int StepCore::Controller::index ( ) const

inline

Get vector index of the controlled property.

Definition at line 386 of file tool.h.

bool StepCore::Controller::isValid

(

)

const

Returns true if controlled property is valid.

Definition at line 309 of file tool.cc.

const Vector2d& StepCore::Controller::limits ( ) const

inline

Get GUI slider limits.

Definition at line 391 of file tool.h.

Object* StepCore::Controller::object ( ) const

inline

Get pointer to the controlled object.

Definition at line 376 of file tool.h.

const Vector2d& StepCore::Controller::position ( ) const

inline

Get position of the Controller.

Definition at line 366 of file tool.h.

QString StepCore::Controller::property ( ) const

inline

Get name of the controlled property.

Definition at line 381 of file tool.h.

const MetaProperty* StepCore::Controller::propertyPtr ( ) const

inline

Get pointer to the controlled property.

Definition at line 414 of file tool.h.

void StepCore::Controller::setDecreaseShortcut ( const QString &  decreaseShortcut )

inline

Set GUI increase shortcut.

Definition at line 398 of file tool.h.

void StepCore::Controller::setIncreaseShortcut ( const QString &  increaseShortcut )

inline

Set GUI decrease shortcut.

Definition at line 403 of file tool.h.

void StepCore::Controller::setIncrement ( double  increment )

inline

Set increment step.

Definition at line 408 of file tool.h.

void StepCore::Controller::setIndex ( int  index )

inline

Set vector index of the controlled property.

Definition at line 388 of file tool.h.

void StepCore::Controller::setLimits ( const Vector2d &  limits )

inline

Set GUI slider limits.

Definition at line 393 of file tool.h.

void StepCore::Controller::setObject ( Object *  object )

inline

Set pointer to the controlled object.

Definition at line 378 of file tool.h.

void StepCore::Controller::setPosition ( const Vector2d &  position )

inline

Set position of the Controller.

Definition at line 368 of file tool.h.

void StepCore::Controller::setProperty ( const QString &  property )

inline

Set name of the controlled property.

Definition at line 383 of file tool.h.

void StepCore::Controller::setSize ( const Vector2d &  size )

inline

Set size of the Controller.

Definition at line 373 of file tool.h.

void StepCore::Controller::setValue ( double  value )

inline

Set value of the controlled property.

Definition at line 421 of file tool.h.

void StepCore::Controller::setValue	(	double	value,
		bool *	ok = 0
	)

Set value of the controlled property.

Parameters

value	New value for the property
ok	Will indicate success of operation (if not null)

Definition at line 334 of file tool.cc.

const Vector2d& StepCore::Controller::size ( ) const

inline

Get size of the Controller.

Definition at line 371 of file tool.h.

QString StepCore::Controller::units

(

)

const

Return units of measured property.

Definition at line 350 of file tool.cc.

double StepCore::Controller::value ( ) const

inline

Get value of the controlled property.

Definition at line 419 of file tool.h.

double StepCore::Controller::value

(

bool *

ok

)

const

Get value of the controlled property.

Parameters

ok	Will indicate success of operation (if not null)

Definition at line 317 of file tool.cc.

Member Data Documentation

QString StepCore::Controller::_decreaseShortcut

protected

Definition at line 446 of file tool.h.

QString StepCore::Controller::_increaseShortcut

protected

Definition at line 447 of file tool.h.

double StepCore::Controller::_increment

protected

Definition at line 449 of file tool.h.

int StepCore::Controller::_index

protected

Definition at line 443 of file tool.h.

Vector2d StepCore::Controller::_limits

protected

Definition at line 445 of file tool.h.

Object* StepCore::Controller::_object

protected

Definition at line 441 of file tool.h.

Vector2d StepCore::Controller::_position

protected

Definition at line 438 of file tool.h.

QString StepCore::Controller::_property

protected

Definition at line 442 of file tool.h.

Vector2d StepCore::Controller::_size

protected

Definition at line 439 of file tool.h.

---

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

• tool.h
• tool.cc