Overview | All Modules | Tutorial | User's Guide | Programming Guide
Previous

COVISE Online Documentation

Next

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vrui::coSlopePoti Class Reference

A special rotary knob to adjust slope values. More...

#include <coValuePoti.h>

Inheritance diagram for vrui::coSlopePoti:
vrui::coValuePoti vrui::coAction vrui::coUIElement vrui::vruiCollabInterface vrui::coUpdateable

Public Member Functions

 coSlopePoti (const std::string &buttonText, coValuePotiActor *actor, const std::string &backgroundTexture, vruiCOIM *cInterfaceManager=0, const std::string &interfaceName="")
 Constructor. More...
 
virtual void setValue (float)
 Set slope poti value. More...
 
virtual bool update ()
 Update method, called every overall frame. More...
 
virtual void remoteOngoing (const char *message)
 Inform collaborators about value changes. More...
 
virtual void setABS (bool on)
 Define if poti should only represent positive values. More...
 
virtual bool getABS () const
 Get state of positive values display. More...
 
virtual float getValue () const
 Get current poti value. More...
 
virtual const char * getClassName () const
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
 
float convertSlopeToLinear (float) const
 Converts a slope value to a linear value. More...
 
float convertLinearToSlope (float) const
 Converts a linear value to a slope value. More...
 
- Public Member Functions inherited from vrui::coValuePoti
 coValuePoti (const std::string &buttonText, coValuePotiActor *actor, const std::string &backgroundTexture, vruiCOIM *cInterfaceManager=0, const std::string &interfaceName="")
 Constructor. More...
 
virtual ~coValuePoti ()
 Destructor. More...
 
virtual float getWidth () const
 Returns element width. More...
 
virtual float getHeight () const
 Returns element height. More...
 
virtual float getXpos () const
 Returns element x position. More...
 
virtual float getYpos () const
 Returns element y position. More...
 
virtual bool update ()
 Update poti value depending on user input. More...
 
virtual void setValue (float value)
 Set poti value. More...
 
virtual void setMin (float min)
 Set minimum poti value. More...
 
virtual void setMax (float max)
 Set maximum poti value. More...
 
virtual float getValue () const
 Get poti value. More...
 
virtual int hit (vruiHit *hit)
 This method is called on intersections of the input device with the poti . More...
 
virtual void miss ()
 Called when input device leaves the element. More...
 
void joystickUp ()
 
void joystickDown ()
 
void setPos (float x, float y, float z=0.0f)
 Set poti location. More...
 
void setSize (float size)
 Set poti size. More...
 
void setSize (float width, float height, float depth)
 Set different sizes for each dimension (see setSize) More...
 
void setInteger (bool on)
 Set number type for poti value. More...
 
void setIncrement (float increment)
 Set increment for discreet poti. More...
 
void setLogarithmic (bool on)
 
void setState (float min, float max, float value, bool isInt, float inc=0.0f)
 Set maximum poti value. More...
 
virtual float getMin () const
 
virtual float getMax () const
 
virtual bool isInteger () const
 
virtual bool isDiscrete () const
 
virtual float getIncrement () const
 
virtual bool isLogarithmic () const
 
virtual float getXSize () const
 
virtual float getYSize () const
 
virtual float getZSize () const
 
virtual void setLabelVisible (bool)
 Set the poti label visibility. More...
 
virtual bool isLabelVisible ()
 This method checks if the label is visible. More...
 
const std::string & getBackgroundTexture () const
 
const std::string & getButtonText () const
 
float discreteValue (float value) const
 
virtual const char * getClassName () const
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
 
- Public Member Functions inherited from vrui::coAction
 coAction ()
 Constructor. More...
 
virtual ~coAction ()
 Destructor. More...
 
virtual int hit (vruiHit *hit)=0
 hit is called whenever the node, or any node underneath the node with this action is intersected return ACTION_CALL_ON_MISS if you want miss to be called otherwise return ACTION_DONE More...
 
virtual void miss ()
 miss is called once after a hit, if the node is not intersected anymore More...
 
void setFrame (unsigned int frame)
 INTERNAL set the framecounter (used to produce the miss call) More...
 
unsigned int getFrame () const
 INTERNAL get the framecounter (used to produce the miss call) More...
 
void setNode (vruiNode *)
 INTERNAL set the node this action belongs to. More...
 
void addChild (coAction *)
 INTERNAL add a child action. More...
 
virtual int hitAll (vruiHit *hit)
 INTERNAL same as miss/hit, but do it for all children as well. More...
 
virtual void missAll ()
 INTERNAL same as miss/hit, but do it for all children as well. More...
 
- Public Member Functions inherited from vrui::coUIElement
 coUIElement ()
 
virtual ~coUIElement ()
 Destructor. More...
 
virtual void createGeometry ()
 
virtual void setParent (coUIContainer *)
 Set parent container. More...
 
virtual coUIContainergetParent ()
 Get parent container. More...
 
virtual void setEnabled (bool enabled)
 Set activation state. More...
 
virtual void setHighlighted (bool highlighted)
 Set highlight state. More...
 
virtual void setVisible (bool visible)
 Set element visibility. More...
 
virtual bool isEnabled () const
 Get activation state. More...
 
virtual bool isHighlighted () const
 Get highlight state. More...
 
virtual bool isVisible () const
 Get visibility state. More...
 
virtual float getWidth () const =0
 Returns element width. More...
 
virtual float getHeight () const =0
 Returns element height. More...
 
virtual float getDepth () const
 Get z axis object size. More...
 
virtual float getXpos () const =0
 Returns element x position. More...
 
virtual float getYpos () const =0
 Returns element y position. More...
 
virtual float getZpos () const
 Get z position. More...
 
virtual void childResized (bool shrink=true)
 This method is called by children whenever they change their size Implementations of this method should call the childResized() of their parent container. More...
 
virtual void resizeToParent (float, float, float, bool shrink=true)
 This method is called by containers after they resized to allow children to adjust their geometry to the new parents' size Children must not call childResized() of their parent here, as this could lead to an infinite loop. More...
 
virtual void shrinkToMin ()
 Set element location in space. More...
 
virtual void setPos (float, float, float)=0
 
virtual void setSize (float, float, float)
 Set UI element size. More...
 
virtual void setSize (float)
 Set UI element size, use equal values for all dimensions. More...
 
virtual float getResizePref ()
 
virtual void setUserData (coUIUserData *)
 Set the current userdata object. More...
 
virtual coUIUserDatagetUserData () const
 Returns the current userdata object. More...
 
virtual vruiTransformNodegetDCS ()
 
virtual vruiUIElementProvidergetUIElementProvider () const
 
virtual void setAttachment (int)
 sets the attachment border More...
 
virtual int getAttachment () const
 returns the attachment border More...
 
void setUniqueName (const char *)
 
const char * getUniqueName () const
 
virtual const char * getClassName () const
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
 
- Public Member Functions inherited from vrui::vruiCollabInterface
 vruiCollabInterface (vruiCOIM *manager, const std::string &interfaceName, int iType=NONE)
 Constructor. More...
 
virtual ~vruiCollabInterface ()
 Destructor, removes references to this interface from its coim. More...
 
int getType () const
 get the interface type More...
 
vruiCOIMgetManager ()
 
virtual void parseMessage (int type, unsigned int len, const char *message)
 this method is called when a message from a remote UI arrives More...
 
- Public Member Functions inherited from vrui::coUpdateable
 coUpdateable ()
 Constructor. More...
 
virtual ~coUpdateable ()
 you should adds this object to the update manager in your constructor More...
 
virtual bool update ()=0
 this method is called once per frame as long as it returns true. More...
 

Protected Member Functions

void setLinearValue (float value)
 Set linear slope poti value. More...
 
- Protected Member Functions inherited from vrui::coValuePoti
virtual void remoteLock (const char *message)
 Disable poti. More...
 
virtual void remoteOngoing (const char *message)
 Inform collaborators about value changes. More...
 
virtual void releaseRemoteLock (const char *message)
 Re-enable poti. More...
 
virtual void setEnabled (bool on)
 Set activation state. More...
 
virtual void setText (const std::string &buttonText)
 Set button text. More...
 
void displayValue (float value)
 Set the poti value to actually display. More...
 
- Protected Member Functions inherited from vrui::coUIElement
virtual void resizeGeometry ()
 
virtual const vruiMatrixgetTransformMatrix ()
 
- Protected Member Functions inherited from vrui::vruiCollabInterface
void setType (int interfaceType)
 set the type of the this interface More...
 
void sendLockMessage (const char *message)
 lock the interaction with remote interfaces More...
 
void sendOngoingMessage (const char *message)
 send interactions to remote interfaces More...
 
void sendReleaseMessage (const char *message)
 unlock the interaction with remote interfaces More...
 
virtual void remoteLock (const char *message)
 this method is called whenever a remote interaction is started. More...
 
virtual void remoteOngoing (const char *message)
 this method is called whenever a remote interaction is going on. More...
 
virtual void releaseRemoteLock (const char *message)
 this method is called whenever a remote interaction is finished. More...
 

Protected Attributes

bool positive
 true=positive values only, false=negative values are allowed More...
 
- Protected Attributes inherited from vrui::coValuePoti
float myX
 poti x location More...
 
float myY
 poti y location More...
 
float minValue
 poti minimum value More...
 
float maxValue
 poti maximum value More...
 
float value
 current value represented by this poti More...
 
coCombinedButtonInteractioninteractionA
 interaction for first button More...
 
coCombinedButtonInteractioninteractionB
 interaction for second button (fine Tune) More...
 
coCombinedButtonInteractioninteractionW
 wheel interaction More...
 
bool unregister
 true if the interaction should be unregistered More...
 
float lastRoll
 previous mouse orientation More...
 
std::string buttonText
 value display text More...
 
std::string baseButtonText
 
std::string backgroundTexture
 
coValuePotiActormyActor
 action listener More...
 
bool integer
 true if adjustable value is an integer More...
 
float increment
 step size this poti, 0.0 if continuous More...
 
bool discrete
 
bool logarithmic = false
 true if scale is logarithmic More...
 
bool labelVisible
 true if label is visible More...
 
- Protected Attributes inherited from vrui::coAction
std::string actionName
 name of this action this can be used to distinguish betwenn different types of actions like touch and intersection actions More...
 
- Protected Attributes inherited from vrui::coUIElement
float xScaleFactor
 UI element x axis scale factor. More...
 
float yScaleFactor
 UI element y axis scale factor. More...
 
float zScaleFactor
 UI element z axis scale factor. More...
 
bool enabled
 true if UI element is enabled, false if UI element cannot be used More...
 
bool highlighted
 true if highlighted More...
 
bool visible
 true if UI element is visible, false if not visible but still present in scene tree More...
 
vruiUIElementProvideruiElementProvider
 
- Protected Attributes inherited from vrui::vruiCollabInterface
int remoteContext
 a remote context (if this UI element is used in several contexts) More...
 

Additional Inherited Members

- Public Types inherited from vrui::coValuePoti
enum  { MAX_SLOPE = 1000 }
 
- Public Types inherited from vrui::coAction
enum  Result { ACTION_DONE = 0x00 , ACTION_CALL_ON_MISS = 0x01 , ACTION_UNDEF = 0x02 }
 
- Public Types inherited from vrui::coUIElement
enum  Material {
  RED = 0 , GREEN , BLUE , YELLOW ,
  GREY , WHITE , BLACK , DARK_YELLOW ,
  WHITE_NL , ITEM_BACKGROUND_NORMAL , ITEM_BACKGROUND_HIGHLIGHTED , ITEM_BACKGROUND_DISABLED ,
  HANDLE_BACKGROUND_NORMAL , HANDLE_BACKGROUND_HIGHLIGHTED , HANDLE_BACKGROUND_DISABLED , BACKGROUND ,
  NUM_MATERIALS
}
 Color definitions, to be used whenever a material is needed. More...
 
enum  {
  LEFT = 0 , TOP , RIGHT , BOTTOM ,
  REPLACE
}
 attachment order is counterclockwise like this and describes the side/border which the item is attached to! More...
 
- Public Types inherited from vrui::vruiCollabInterface
enum  {
  NONE = 10 , VALUEPOTI = 11 , HSVWHEEL = 12 , PUSHBUTTON = 13 ,
  TOGGLEBUTTON = 14 , FunctionEditor = 15 , PinEditor = 16
}
 
- Static Public Member Functions inherited from vrui::coUIElement
static vruiMatrixgetMatrixFromPositionHprScale (float x, float y, float z, float h, float p, float r, float scale)
 Constructor. More...
 
- Public Attributes inherited from vrui::coUIElement
enum vrui::coUIElement:: { ... }  Attachments
 attachment order is counterclockwise like this and describes the side/border which the item is attached to! More...
 

Detailed Description

A special rotary knob to adjust slope values.

The angle of the rotary knob represents the selected slope value.

See also
coValuePoti

Constructor & Destructor Documentation

◆ coSlopePoti()

vrui::coSlopePoti::coSlopePoti ( const std::string &  buttonText,
coValuePotiActor actor,
const std::string &  backgroundTexture,
vruiCOIM cInterfaceManager = 0,
const std::string &  interfaceName = "" 
)

Constructor.

Parameters
buttonTextbutton text
actoraction listener for poti value changes
backgroundTexturebackground texture file name
cInterfaceManagercollaborative interface manager (optional)
interfaceNameunique ID string for collaboration (optional)

Member Function Documentation

◆ convertLinearToSlope()

float vrui::coSlopePoti::convertLinearToSlope ( float  linear) const

Converts a linear value to a slope value.

Parameters
linearvalue [0..1]
Returns
corresponding slope value [-MAX_SLOPE..MAX_SLOPE]

◆ convertSlopeToLinear()

float vrui::coSlopePoti::convertSlopeToLinear ( float  slope) const

Converts a slope value to a linear value.

The linear value can be converted to the current rotational angle by multiplying it with 2 Pi.

Parameters
slopeslope value to convert [-MAX_SLOPE..MAX_SLOPE]
Returns
corresponding linear value [0..1]

◆ getABS()

bool vrui::coSlopePoti::getABS ( ) const
virtual

Get state of positive values display.

Returns
true if positive values only

◆ getClassName()

const char * vrui::coSlopePoti::getClassName ( ) const
virtual

get the Element's classname

Reimplemented from vrui::coValuePoti.

◆ getValue()

float vrui::coSlopePoti::getValue ( ) const
virtual

Get current poti value.

Returns
current poti value

Reimplemented from vrui::coValuePoti.

◆ isOfClassName()

bool vrui::coSlopePoti::isOfClassName ( const char *  classname) const
virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coValuePoti.

◆ remoteOngoing()

void vrui::coSlopePoti::remoteOngoing ( const char *  message)
virtual

Inform collaborators about value changes.

Parameters
messagemessage string passed to collaborators

Reimplemented from vrui::coValuePoti.

◆ setABS()

void vrui::coSlopePoti::setABS ( bool  newState)
virtual

Define if poti should only represent positive values.

Parameters
newStatetrue = positive values only

◆ setLinearValue()

void vrui::coSlopePoti::setLinearValue ( float  linear)
protected

Set linear slope poti value.

Parameters
linlinear value [0..1]

◆ setValue()

void vrui::coSlopePoti::setValue ( float  val)
virtual

Set slope poti value.

Parameters
valnew value [-MAX_SLOPE..MAX_SLOPE]

Reimplemented from vrui::coValuePoti.

◆ update()

bool vrui::coSlopePoti::update ( )
virtual

Update method, called every overall frame.

Reimplemented from vrui::coValuePoti.

Member Data Documentation

◆ positive

bool vrui::coSlopePoti::positive
protected

true=positive values only, false=negative values are allowed


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

Authors: Martin Aumüller, Ruth Lang, Daniela Rainer, Jürgen Schulze-Döbold, Andreas Werner, Peter Wolf, Uwe Wössner
Copyright © 1993-2009 HLRS, 2004-2009 RRZK, 2005-2009 Visenso
COVISE Version 6.5 Academic