Developer Documentation
Public Member Functions | Private Attributes | Friends | List of all members
VSI::Element Class Reference

#include <Plugin-VSI/parser/element.hh>

Public Member Functions

 Element (Context *_context, const QString &_name)
 Constructor. More...
 
 ~Element ()
 Destructor. More...
 
Context * context () const
 Context of element. More...
 
QString name () const
 Element name. More...
 
const QString & category () const
 Element category. More...
 
const QString & shortDescription () const
 Short description. More...
 
const QString & longDescription () const
 Long description. More...
 
const QVector< Input * > & inputs () const
 Inputs. More...
 
const QVector< Output * > & outputs () const
 Outputs. More...
 
const QVector< Function * > & functions () const
 Functions. More...
 
Input * dataIn ()
 Scenegraph input. More...
 
Output * dataOut ()
 Scenegraph output. More...
 
unsigned int flags () const
 Flags. More...
 
QString precode () const
 Precode segment. More...
 
QString code () const
 Code segment. More...
 
unsigned int getNewId ()
 Returns an unused id number. More...
 
void setMinId (unsigned int _id)
 sets the minimum for an unused id More...
 

Private Attributes

Context * context_
 
QString name_
 
QString category_
 
QString shortDesc_
 
QString longDesc_
 
QString precode_
 
QString code_
 
QVector< Input * > inputs_
 
QVector< Output * > outputs_
 
QVector< Function * > functions_
 
Input * dataIn_
 
Output * dataOut_
 
unsigned int flags_
 
unsigned int id_
 

Friends

class Context
 

Detailed Description

Class that represents an element of the visual scripting interface.

Definition at line 68 of file element.hh.

Constructor & Destructor Documentation

◆ Element()

VSI::Element::Element ( Context *  _context,
const QString &  _name 
)

Constructor.

Definition at line 59 of file element.cc.

◆ ~Element()

VSI::Element::~Element ( )

Destructor.

Definition at line 74 of file element.cc.

Member Function Documentation

◆ category()

const QString & VSI::Element::category ( ) const
inline

Element category.

Definition at line 85 of file element.hh.

◆ code()

QString VSI::Element::code ( ) const
inline

Code segment.

Definition at line 115 of file element.hh.

◆ context()

Context * VSI::Element::context ( ) const
inline

Context of element.

Definition at line 79 of file element.hh.

◆ dataIn()

Input * VSI::Element::dataIn ( )
inline

Scenegraph input.

Definition at line 103 of file element.hh.

◆ dataOut()

Output * VSI::Element::dataOut ( )
inline

Scenegraph output.

Definition at line 106 of file element.hh.

◆ flags()

unsigned int VSI::Element::flags ( ) const
inline

Flags.

Definition at line 109 of file element.hh.

◆ functions()

const QVector< Function * > & VSI::Element::functions ( ) const
inline

Functions.

Definition at line 100 of file element.hh.

◆ getNewId()

unsigned int VSI::Element::getNewId ( )

Returns an unused id number.

Definition at line 92 of file element.cc.

◆ inputs()

const QVector< Input * > & VSI::Element::inputs ( ) const
inline

Inputs.

Definition at line 94 of file element.hh.

◆ longDescription()

const QString & VSI::Element::longDescription ( ) const
inline

Long description.

Definition at line 91 of file element.hh.

◆ name()

QString VSI::Element::name ( void  ) const
inline

Element name.

Definition at line 82 of file element.hh.

◆ outputs()

const QVector< Output * > & VSI::Element::outputs ( ) const
inline

Outputs.

Definition at line 97 of file element.hh.

◆ precode()

QString VSI::Element::precode ( ) const
inline

Precode segment.

Definition at line 112 of file element.hh.

◆ setMinId()

void VSI::Element::setMinId ( unsigned int  _id)

sets the minimum for an unused id

Definition at line 100 of file element.cc.

◆ shortDescription()

const QString & VSI::Element::shortDescription ( ) const
inline

Short description.

Definition at line 88 of file element.hh.

Friends And Related Function Documentation

◆ Context

friend class Context
friend

Definition at line 123 of file element.hh.

Member Data Documentation

◆ category_

QString VSI::Element::category_
private

Definition at line 129 of file element.hh.

◆ code_

QString VSI::Element::code_
private

Definition at line 134 of file element.hh.

◆ context_

Context* VSI::Element::context_
private

Definition at line 126 of file element.hh.

◆ dataIn_

Input* VSI::Element::dataIn_
private

Definition at line 140 of file element.hh.

◆ dataOut_

Output* VSI::Element::dataOut_
private

Definition at line 141 of file element.hh.

◆ flags_

unsigned int VSI::Element::flags_
private

Definition at line 143 of file element.hh.

◆ functions_

QVector<Function*> VSI::Element::functions_
private

Definition at line 138 of file element.hh.

◆ id_

unsigned int VSI::Element::id_
private

Definition at line 145 of file element.hh.

◆ inputs_

QVector<Input*> VSI::Element::inputs_
private

Definition at line 136 of file element.hh.

◆ longDesc_

QString VSI::Element::longDesc_
private

Definition at line 131 of file element.hh.

◆ name_

QString VSI::Element::name_
private

Definition at line 128 of file element.hh.

◆ outputs_

QVector<Output*> VSI::Element::outputs_
private

Definition at line 137 of file element.hh.

◆ precode_

QString VSI::Element::precode_
private

Definition at line 133 of file element.hh.

◆ shortDesc_

QString VSI::Element::shortDesc_
private

Definition at line 130 of file element.hh.

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