VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties
makVrf::DtOffsetLocationEntryWidget Class Reference

A collection of 3 range widgets for x, y and z offsets (in meters). More...

Inheritance diagram for makVrf::DtOffsetLocationEntryWidget:
Inheritance graph
[legend]

Public Member Functions

 DtOffsetLocationEntryWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0, const CreationFlags &cflags=NormalMode)
virtual ~DtOffsetLocationEntryWidget ()
virtual void setLabel (const std::string &)
 Display label. This will set the label for x, y and z values. Separate labels by semi-colon.
virtual double x () const
 Returns the offset value for x.
virtual double y () const
 Returns the offset value for y.
virtual double z () const
 Returns the offset value for z.
virtual void setX (double)
 Sets the x value.
virtual void setY (double)
 Sets the y value.
virtual void setZ (double)
 Sets the z value.
virtual DtReaderWritercreateBoundVariable (const std::string &variableName)
 Creates the reader/writer variable that will be used as part of the task statement (DtRwOffsetVector)
virtual void setupFromBoundVariable (const DtReaderWriter *variableName)
 Sets up the widget from the given reader/writer variables (DtRwOffsetVector)
virtual
DtTaskSetVariableWidgetExtensionInterface
parameterContents (QWidget *parent, const Qt::WindowFlags &flags=0) const
 Return extension that allows entry of default and range values in meters.
virtual void setTopLabelIsCheckable (bool b)
 Sets whether or not the top label is checkable.
virtual void setXLabel (const QString &)
virtual QString xLabel () const
virtual void setYLabel (const QString &)
virtual QString yLabel () const
virtual void setZLabel (const QString &)
virtual QString zLabel () const
virtual void setRange (double bottom, double top)
virtual void setDefaultValue (const std::string &)
 Default value to set in control. Separate by semi-colon to set values for x, y and z.
virtual void setVariableData (const QString &)
 Variable data that can be used by this control to initialize values (i.e.
- Public Member Functions inherited from makVrf::DtTaskSetVariableWidget
 DtTaskSetVariableWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0, const CreationFlags &cflags=NormalMode)
virtual ~DtTaskSetVariableWidget ()
virtual void setToolTip (const QString &)
 Sets the tool tip.
virtual void setLabel (const QString &)
 QString version for property.
virtual void setVariableData (const std::string &)
 Calls QString version.
virtual QString variableData () const
virtual QString label () const
virtual void setupFrom (const std::vector< makVrv::DtSimEntry * > &data)
 Sets up widget with currently selected item. No-op.
virtual void setIsInternal (bool)
 Whether or not value is internal. Internal values will not be shown to the user on the scripted task dialog.
virtual bool isInternal () const
virtual void setTopLineVisible (bool)
 Hides top line.
virtual bool topLineVisible () const
virtual void createTopLine ()
 Creates top line.
virtual void setIndent (int)
 Sets the indent level for the contents of this widget, except for the title line.
virtual int indent () const
virtual bool isValid () const
 Indicates the current selection is valid.
virtual void setTopLabelChecked (bool)
 Sets the top label to be checked/unchecked and calls topLabelChecked if the check box is visible.
virtual bool topLabelChecked () const
virtual void setRange (const DtRange &)
virtual void setRangeTop (double)
virtual void setRangeTop (int)
virtual double rangeTop () const
virtual void setRangeBottom (double)
virtual void setRangeBottom (int)
virtual double rangeBottom () const
virtual const DtRangegetRange () const
virtual bool topLabelIsCheckable () const
virtual void getDefaultSpecificTitles (QString &defaultTitle, QString &specificTitle) const
virtual void setDefaultSpecificTitles (const QString &defaultTitle, const QString &specificTitle)
virtual void setupDefaultSpecificFromVariableData (const DtString &var)
 Format is allowdefault=[defaultTitle],[specificTitle].
virtual std::string scriptedTaskVariableName () const
 In most cases this is the objectName of the object, however, in some cases (as in radio button) this could be a name that is shared amongst like objects, so, that is returned instead.
- Public Member Functions inherited from makVrf::DtTaskSetVariableWidgetInterface
 DtTaskSetVariableWidgetInterface ()
virtual ~DtTaskSetVariableWidgetInterface ()
virtual void widgetInitializedForDialog (DtScriptedTaskDialog *)
 Called when the widget is initialized from a scripted task dialog. Default implementation is to do nothing.
virtual bool guiElementOnly () const
 Returns true if this is a GUI element only. Default is false.

Static Public Member Functions

static makVrv::DtUnicode codeVariableType ()
static std::string designerGroup ()
static std::string headerFile ()
static std::string variableName ()
- Static Public Member Functions inherited from makVrf::DtTaskSetVariableWidget
static bool includeInQtDesigner ()
- Static Public Member Functions inherited from makVrf::DtTaskSetVariableWidgetInterface
static bool canBeUsedAsWidget ()
 Whether or not this shows up as a usable variable widget.
static void initializeForQtDesignerExtension (makVrv::DtDe &de, QDesignerFormEditorInterface *core)
 Implement at class level to perform Qt Designer custom widget initialization. Please refer to Qt documentation for designer modifications.

Public Attributes

QGridLayout * myGridLayout
QWidget * myCanvas
DtRangeEntryWidgetmyX
DtRangeEntryWidgetmyY
DtRangeEntryWidgetmyZ
- Public Attributes inherited from makVrf::DtTaskSetVariableWidget
boost::signal< void(bool)> signal_topLevelCheckStateChanged
int myIndent
QVBoxLayout * myVariableWidgetLayout
QHBoxLayout * mySpacedLayout
QVBoxLayout * myVariableContentLayout
 When creating subclasses of this item, use the variable content layout to add your content.
QWidget * myTopLine
QLabelmyTopLabel
QWidget * myChoiceCanvas
QRadioButton * myUseDefault
QRadioButton * myUseSpecific
QSpacerItem * myTopSeparator
QHBoxLayout * myTopLineLayout
QSpacerItem * mySpacerItem

Protected Member Functions

virtual void topLabelCheckStateChanged ()
virtual void adjustLabelSizes ()
virtual std::string variableDataFromUiDesigner (const QDomElement &element, const DtScriptedTaskVariableLayoutConverter &converter) const
 Given the Ui designer properties create a string that will represent the variable data for those properties.

Properties

QString xLabel
QString yLabel
QString zLabel
- Properties inherited from makVrf::DtTaskSetVariableWidget
QString label
bool isInternal
int indent
QString variableData

Additional Inherited Members

- Public Types inherited from makVrf::DtTaskSetVariableWidgetInterface
enum  CreationFlags { NormalMode = 0x00000000, QtDesignerMode = 0x00000001 }
- Signals inherited from makVrf::DtTaskSetVariableWidget
void validityUpdated ()
 Signal which can be emitted to indicate the validity of the current widget selection has changed.
- Protected Slots inherited from makVrf::DtTaskSetVariableWidget
- Protected Attributes inherited from makVrf::DtTaskSetVariableWidget
makVrv::DtDemyDe
makVrv::DtSignalConnectionManager myConnections
bool myTopLabelIsCheckable
DtRange myRange
bool myIsInternal
CreationFlags myCreationFlags
QString myVariableData

Detailed Description

A collection of 3 range widgets for x, y and z offsets (in meters).

It is up to the user of this widget to determine what x, y and z actually mean. Different than a location entry widget as this will not be effected by coordinate system selection

Constructor & Destructor Documentation

makVrf::DtOffsetLocationEntryWidget::DtOffsetLocationEntryWidget ( makVrv::DtDe de,
QWidget *  parent,
const Qt::WindowFlags &  flags = 0,
const CreationFlags cflags = NormalMode 
)
virtual makVrf::DtOffsetLocationEntryWidget::~DtOffsetLocationEntryWidget ( )
virtual

Member Function Documentation

virtual void makVrf::DtOffsetLocationEntryWidget::setLabel ( const std::string &  )
virtual

Display label. This will set the label for x, y and z values. Separate labels by semi-colon.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtOffsetLocationEntryWidget::setXLabel ( const QString &  )
virtual

Label setting. If any labels are empty then label will be hidden

virtual QString makVrf::DtOffsetLocationEntryWidget::xLabel ( ) const
virtual
virtual void makVrf::DtOffsetLocationEntryWidget::setYLabel ( const QString &  )
virtual
virtual QString makVrf::DtOffsetLocationEntryWidget::yLabel ( ) const
virtual
virtual void makVrf::DtOffsetLocationEntryWidget::setZLabel ( const QString &  )
virtual
virtual QString makVrf::DtOffsetLocationEntryWidget::zLabel ( ) const
virtual
virtual void makVrf::DtOffsetLocationEntryWidget::setRange ( double  bottom,
double  top 
)
virtual

These methods must be implemented in order to be considered a DtTaskSetVariable that can be used as part of a scripted task. Same range is set for x, y and z

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtOffsetLocationEntryWidget::setDefaultValue ( const std::string &  )
virtual

Default value to set in control. Separate by semi-colon to set values for x, y and z.

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual void makVrf::DtOffsetLocationEntryWidget::setVariableData ( const QString &  )
virtual

Variable data that can be used by this control to initialize values (i.e.

filtered list box, combo box). Items should be separated by a semi-colon. Unused for this class

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual double makVrf::DtOffsetLocationEntryWidget::x ( ) const
virtual

Returns the offset value for x.

virtual double makVrf::DtOffsetLocationEntryWidget::y ( ) const
virtual

Returns the offset value for y.

virtual double makVrf::DtOffsetLocationEntryWidget::z ( ) const
virtual

Returns the offset value for z.

virtual void makVrf::DtOffsetLocationEntryWidget::setX ( double  )
virtual

Sets the x value.

virtual void makVrf::DtOffsetLocationEntryWidget::setY ( double  )
virtual

Sets the y value.

virtual void makVrf::DtOffsetLocationEntryWidget::setZ ( double  )
virtual

Sets the z value.

virtual DtReaderWriter* makVrf::DtOffsetLocationEntryWidget::createBoundVariable ( const std::string &  variableName)
virtual

Creates the reader/writer variable that will be used as part of the task statement (DtRwOffsetVector)

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual void makVrf::DtOffsetLocationEntryWidget::setupFromBoundVariable ( const DtReaderWriter variableName)
virtual

Sets up the widget from the given reader/writer variables (DtRwOffsetVector)

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual DtTaskSetVariableWidgetExtensionInterface* makVrf::DtOffsetLocationEntryWidget::parameterContents ( QWidget *  parent,
const Qt::WindowFlags &  flags = 0 
) const
virtual

Return extension that allows entry of default and range values in meters.

Will also change according to coordinate settings

Reimplemented from makVrf::DtTaskSetVariableWidgetInterface.

static makVrv::DtUnicode makVrf::DtOffsetLocationEntryWidget::codeVariableType ( )
inlinestatic
static std::string makVrf::DtOffsetLocationEntryWidget::designerGroup ( )
inlinestatic
static std::string makVrf::DtOffsetLocationEntryWidget::headerFile ( )
inlinestatic
static std::string makVrf::DtOffsetLocationEntryWidget::variableName ( )
inlinestatic
virtual void makVrf::DtOffsetLocationEntryWidget::setTopLabelIsCheckable ( bool  )
virtual

Sets whether or not the top label is checkable.

If it is will hide the top label label and show the check box. If the check box is shown calls topLabelChecked

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtOffsetLocationEntryWidget::topLabelCheckStateChanged ( )
protectedvirtual

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtOffsetLocationEntryWidget::adjustLabelSizes ( )
protectedvirtual
virtual std::string makVrf::DtOffsetLocationEntryWidget::variableDataFromUiDesigner ( const QDomElement &  ,
const DtScriptedTaskVariableLayoutConverter  
) const
protectedvirtual

Given the Ui designer properties create a string that will represent the variable data for those properties.

Reimplemented from makVrf::DtTaskSetVariableWidget.

Member Data Documentation

QGridLayout* makVrf::DtOffsetLocationEntryWidget::myGridLayout
QWidget* makVrf::DtOffsetLocationEntryWidget::myCanvas
DtRangeEntryWidget* makVrf::DtOffsetLocationEntryWidget::myX
DtRangeEntryWidget* makVrf::DtOffsetLocationEntryWidget::myY
DtRangeEntryWidget* makVrf::DtOffsetLocationEntryWidget::myZ

Property Documentation

QString makVrf::DtOffsetLocationEntryWidget::xLabel
readwrite
QString makVrf::DtOffsetLocationEntryWidget::yLabel
readwrite
QString makVrf::DtOffsetLocationEntryWidget::zLabel
readwrite

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)