\hypertarget{a10784}{}\section{V\+SI\+:\+:Element\+Input Class Reference}
\label{a10784}\index{V\+S\+I\+::\+Element\+Input@{V\+S\+I\+::\+Element\+Input}}


{\ttfamily \#include $<$Plugin-\/\+V\+S\+I/scene/element\+Input.\+hh$>$}

Inheritance diagram for V\+SI\+:\+:Element\+Input\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{a10784}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10784_a51db1edc867b3c5b409703438d899975}\label{a10784_a51db1edc867b3c5b409703438d899975}} 
\hyperlink{a10784_a51db1edc867b3c5b409703438d899975}{Element\+Input} (\hyperlink{a10740}{Input} $\ast$\+\_\+in, \hyperlink{a10804}{Scene\+Element} $\ast$\+\_\+parent)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a1340fe0a7bc2bd60b0ac2f7b044386b2}\label{a10784_a1340fe0a7bc2bd60b0ac2f7b044386b2}} 
\hyperlink{a10784_a1340fe0a7bc2bd60b0ac2f7b044386b2}{$\sim$\+Element\+Input} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a39f914fe8ef3d5535aff76685aaafa46}\label{a10784_a39f914fe8ef3d5535aff76685aaafa46}} 
\hyperlink{a10780_adfa3bd6d5dd67369dfd753172d35c3db}{Type} \hyperlink{a10784_a39f914fe8ef3d5535aff76685aaafa46}{type} () const
\begin{DoxyCompactList}\small\item\em \hyperlink{a10748}{Type} (=\hyperlink{a10740}{Input}) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a099ae269f5fc375757836afb37052db7}\label{a10784_a099ae269f5fc375757836afb37052db7}} 
void \hyperlink{a10784_a099ae269f5fc375757836afb37052db7}{set\+Valid} (bool \+\_\+value)
\begin{DoxyCompactList}\small\item\em Sets the valid flag (needed during code generation) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a3ec6743f9679bcf91e66afdf1fc177a5}\label{a10784_a3ec6743f9679bcf91e66afdf1fc177a5}} 
bool \hyperlink{a10784_a3ec6743f9679bcf91e66afdf1fc177a5}{valid} ()
\begin{DoxyCompactList}\small\item\em Returns state of valid flag (needed during code generation) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_af5c94739c47159608c3463da55fc8f7f}\label{a10784_af5c94739c47159608c3463da55fc8f7f}} 
void \hyperlink{a10784_af5c94739c47159608c3463da55fc8f7f}{set\+Value} (Q\+String \+\_\+value)
\begin{DoxyCompactList}\small\item\em Set to a user value. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a0f3f1d1b49eef3eb7adb37de0a249d6c}\label{a10784_a0f3f1d1b49eef3eb7adb37de0a249d6c}} 
Q\+String \hyperlink{a10784_a0f3f1d1b49eef3eb7adb37de0a249d6c}{value} () const
\begin{DoxyCompactList}\small\item\em Returns value set by user. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a88f22910153a5937eeeea9dd5b8293d2}\label{a10784_a88f22910153a5937eeeea9dd5b8293d2}} 
void \hyperlink{a10784_a88f22910153a5937eeeea9dd5b8293d2}{add\+Connection} (\hyperlink{a10764}{Connection} $\ast$\+\_\+conn)
\begin{DoxyCompactList}\small\item\em Add connection. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a524730e26df4bc743420533821f5ebdf}\label{a10784_a524730e26df4bc743420533821f5ebdf}} 
void \hyperlink{a10784_a524730e26df4bc743420533821f5ebdf}{remove\+Connection} (\hyperlink{a10764}{Connection} $\ast$\+\_\+conn)
\begin{DoxyCompactList}\small\item\em Remove connection. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_ab049106ee477a6de4478395caeeed76d}\label{a10784_ab049106ee477a6de4478395caeeed76d}} 
void \hyperlink{a10784_ab049106ee477a6de4478395caeeed76d}{set} (bool \+\_\+set)
\begin{DoxyCompactList}\small\item\em \char`\"{}\+Set\char`\"{} flag to mark input as set by user \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a4eb8b945008f49b4bf52cb821eea6331}\label{a10784_a4eb8b945008f49b4bf52cb821eea6331}} 
bool \hyperlink{a10784_a4eb8b945008f49b4bf52cb821eea6331}{is\+Set} ()
\begin{DoxyCompactList}\small\item\em Return \char`\"{}set\char`\"{} flag. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_ab698ac47e205fe2890a4031f55d53956}\label{a10784_ab698ac47e205fe2890a4031f55d53956}} 
void \hyperlink{a10784_ab698ac47e205fe2890a4031f55d53956}{set\+Force\+Ask} (bool \+\_\+set)
\begin{DoxyCompactList}\small\item\em \char`\"{}\+Force\+Ask\char`\"{} flag to mark an optional input for asking during script execution \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a5c50ff3a8ce10044052103e1aed0c0d8}\label{a10784_a5c50ff3a8ce10044052103e1aed0c0d8}} 
bool \hyperlink{a10784_a5c50ff3a8ce10044052103e1aed0c0d8}{is\+Force\+Ask\+Set} () const
\begin{DoxyCompactList}\small\item\em Return \char`\"{}\+Force\+Ask\char`\"{} flag. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a914cca6ba603cb3701036ae2f676fb89}\label{a10784_a914cca6ba603cb3701036ae2f676fb89}} 
unsigned int \hyperlink{a10784_a914cca6ba603cb3701036ae2f676fb89}{state} ()
\begin{DoxyCompactList}\small\item\em \hyperlink{a10740}{V\+S\+I\+::\+Input} state passthrough. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a0e0dc781b96bd45a8b491be0a8c33ad6}\label{a10784_a0e0dc781b96bd45a8b491be0a8c33ad6}} 
void \hyperlink{a10784_a0e0dc781b96bd45a8b491be0a8c33ad6}{save\+To\+Xml} (Q\+Dom\+Document \&\+\_\+doc, Q\+Dom\+Element \&\+\_\+root)
\begin{DoxyCompactList}\small\item\em Save to xml. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10784_a2aae24048dc1e74a529355ff021c95c0}\label{a10784_a2aae24048dc1e74a529355ff021c95c0}} 
void \hyperlink{a10784_a2aae24048dc1e74a529355ff021c95c0}{load\+From\+Xml} (Q\+Xml\+Query \&\+\_\+xml)
\begin{DoxyCompactList}\small\item\em Load from xml. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10784_a63f26217c95c507c28a652d6d776e7de}\label{a10784_a63f26217c95c507c28a652d6d776e7de}} 
\hyperlink{a10740}{Input} $\ast$ {\bfseries in\+\_\+}
\item 
\mbox{\Hypertarget{a10784_a54b579959efda6012524baecb240bba6}\label{a10784_a54b579959efda6012524baecb240bba6}} 
bool {\bfseries valid\+\_\+}
\item 
\mbox{\Hypertarget{a10784_adc6c887d657cd55a40136457c40211c3}\label{a10784_adc6c887d657cd55a40136457c40211c3}} 
bool {\bfseries is\+Set\+\_\+}
\item 
\mbox{\Hypertarget{a10784_a85411407e8c4d23aafa9f0a265da5953}\label{a10784_a85411407e8c4d23aafa9f0a265da5953}} 
Q\+String {\bfseries value\+\_\+}
\item 
\mbox{\Hypertarget{a10784_a78e2c107745b493a5753f725c6f281b0}\label{a10784_a78e2c107745b493a5753f725c6f281b0}} 
bool {\bfseries force\+Ask\+\_\+}
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{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 67 of file element\+Input.\+hh.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Plugin-\/\+V\+S\+I/scene/element\+Input.\+hh\item 
Plugin-\/\+V\+S\+I/scene/element\+Input.\+cc\end{DoxyCompactItemize}
