VSI::ElementInput Class Reference

#include <Plugin-VSI/scene/elementInput.hh>

Inheritance diagram for VSI::ElementInput:

Public Member Functions
	ElementInput (Input *_in, SceneElement *_parent)
	Constructor.
	~ElementInput ()
	Destructor.
Type	type () const override
	Type (=Input)
void	setValid (bool _value)
	Sets the valid flag (needed during code generation)
bool	valid ()
	Returns state of valid flag (needed during code generation)
void	setValue (const QString &_value)
	Set to a user value.
QString	value () const
	Returns value set by user.
void	addConnection (Connection *_conn) override
	Add connection.
void	removeConnection (Connection *_conn) override
	Remove connection.
void	set (bool _set)
	"Set" flag to mark input as set by user
bool	isSet ()
	Return "set" flag.
void	setForceAsk (bool _set)
	"ForceAsk" flag to mark an optional input for asking during script execution
bool	isForceAskSet () const
	Return "ForceAsk" flag.
unsigned int	state ()
	VSI::Input state passthrough.
void	saveToXml (QDomDocument &_doc, QDomElement &_root)
	Save to xml.
void	loadElementInputFromXml (QDomElement &_domElement)
	Load from xml.
Public Member Functions inherited from VSI::ElementInOut
	ElementInOut (InOut *_io, SceneElement *_parent)
	Constructor.
virtual	~ElementInOut ()
	Destructor.
ConnectionPoint *	connectionPointItem () const
	Connection point widget.
Text *	typeTextItem () const
	Type text widget.
Text *	descriptionTextItem () const
	Short description widget.
QList< Connection * >	connections () const
	Connections.
bool	validConnection (ElementInOut *_e)
	Can this input/output be connected to _e.
InOut *	inOut () const
	InOut context object.
SceneElement *	element ()
	Scene element.

Private Attributes
Input *	in_
bool	valid_
bool	isSet_
QString	value_
bool	forceAsk_

Additional Inherited Members
Public Types inherited from VSI::ElementInOut
enum	Type { TypeInput , TypeOutput }
	Type. More...

Detailed Description

Class for inputs of a scene element. It handles all the different ways of input (connection to an output, user configured during script creation, asking user during script execution, optional)

Definition at line 66 of file elementInput.hh.

Constructor & Destructor Documentation

ElementInput()

VSI::ElementInput::ElementInput	(	Input *	_in,
		SceneElement *	_parent
	)

Constructor.

Definition at line 67 of file elementInput.cc.

~ElementInput()

VSI::ElementInput::~ElementInput

(

)

Destructor.

Definition at line 107 of file elementInput.cc.

Member Function Documentation

addConnection()

void VSI::ElementInput::addConnection ( Connection *  _conn )

overridevirtual

Add connection.

Reimplemented from VSI::ElementInOut.

Definition at line 136 of file elementInput.cc.

isForceAskSet()

bool VSI::ElementInput::isForceAskSet ( ) const

inline

Return "ForceAsk" flag.

Definition at line 107 of file elementInput.hh.

isSet()

bool VSI::ElementInput::isSet

(

)

Return "set" flag.

Definition at line 199 of file elementInput.cc.

loadElementInputFromXml()

void VSI::ElementInput::loadElementInputFromXml

(

QDomElement &

_domElement

)

Load from xml.

Definition at line 255 of file elementInput.cc.

removeConnection()

void VSI::ElementInput::removeConnection ( Connection *  _conn )

overridevirtual

Remove connection.

Reimplemented from VSI::ElementInOut.

Definition at line 147 of file elementInput.cc.

saveToXml()

void VSI::ElementInput::saveToXml	(	QDomDocument &	_doc,
		QDomElement &	_root
	)

Save to xml.

Definition at line 210 of file elementInput.cc.

set()

void VSI::ElementInput::set

(

bool

_set

)

"Set" flag to mark input as set by user

Definition at line 172 of file elementInput.cc.

setForceAsk()

void VSI::ElementInput::setForceAsk ( bool  _set )

inline

"ForceAsk" flag to mark an optional input for asking during script execution

Definition at line 104 of file elementInput.hh.

setValid()

void VSI::ElementInput::setValid ( bool  _value )

inline

Sets the valid flag (needed during code generation)

Definition at line 80 of file elementInput.hh.

setValue()

void VSI::ElementInput::setValue

(

const QString &

_value

)

Set to a user value.

Definition at line 290 of file elementInput.cc.

state()

unsigned int VSI::ElementInput::state

(

)

VSI::Input state passthrough.

Definition at line 128 of file elementInput.cc.

type()

Type VSI::ElementInput::type ( ) const

inlineoverridevirtual

Type (=Input)

Implements VSI::ElementInOut.

Definition at line 77 of file elementInput.hh.

valid()

bool VSI::ElementInput::valid

(

)

Returns state of valid flag (needed during code generation)

Definition at line 114 of file elementInput.cc.

value()

QString VSI::ElementInput::value ( ) const

inline

Returns value set by user.

Definition at line 89 of file elementInput.hh.

Member Data Documentation

forceAsk_

bool VSI::ElementInput::forceAsk_

private

Definition at line 127 of file elementInput.hh.

in_

Input* VSI::ElementInput::in_

private

Definition at line 119 of file elementInput.hh.

isSet_

bool VSI::ElementInput::isSet_

private

Definition at line 124 of file elementInput.hh.

valid_

bool VSI::ElementInput::valid_

private

Definition at line 122 of file elementInput.hh.

value_

QString VSI::ElementInput::value_

private

Definition at line 125 of file elementInput.hh.

---

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

• Plugin-VSI/scene/elementInput.hh
• Plugin-VSI/scene/elementInput.cc