FrameLabelObject Class Reference

This class provides access to the display properties for a FrameLabelObject. More...

#include <FrameLabelObject.h>

Inheritance diagram for FrameLabelObject:

Inheritance graph

List of all members.

Public Member Functions

virtual void setAnimations (const std::vector< Animation * > &animations)=0
virtual const std::vector
< Animation * > & 		getAnimations () const =0
virtual void insertAnimation (Animation *pAnimation)=0
virtual void eraseAnimation (Animation *pAnimation)=0
virtual void setAutoMode (bool autoMode)=0
virtual bool getAutoMode () const =0

Static Public Member Functions

static bool getSettingDisplayMinimumFrame ()
static bool hasSettingDisplayMinimumFrame ()
static void setSettingDisplayMinimumFrame (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayMinimumFrameKey ()

Protected Member Functions

virtual ~FrameLabelObject ()

Detailed Description

This class provides access to the display properties for a FrameLabelObject.

Possible GraphicObjectTypes: GraphicObjectType::FRAME_LABEL_OBJECT.

FrameLabelObjects have two modes of operation: Automatic and Manual.

Automatic Mode is the default mode for a FrameLabelObject which has been added to a view by the user. When the FrameLabelObject is operating in Automatic Mode it maintains a list of Animation objects which is comprised of:

The FrameLabelObject will automatically update its list of Animation objects when:

Manual Mode is the default mode for a FrameLabelObject which has been created programmatically. When the FrameLabelObject is operating in Manual Mode it will only update its list of Animation objects when an Animation in the list is deleted.

This subclass of Subject will notify upon the following conditions:

Definition at line 48 of file FrameLabelObject.h.

Constructor & Destructor Documentation

virtual FrameLabelObject::~FrameLabelObject (  )  [protected, virtual]

This should be destroyed by calling GraphicLayer::removeObject.

Definition at line 165 of file FrameLabelObject.h.

Member Function Documentation

static bool FrameLabelObject::getSettingDisplayMinimumFrame (  )  [static]

When multiple Animation objects are present, this setting determines how text is displayed.

If this setting is true, then the time (or frame number) of the least recent (oldest) Animation is displayed. Otherwise, the time (or frame number) of the most recent (newest) Animation is displayed. Returns the current value for this setting. If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 67 of file FrameLabelObject.h.

static bool FrameLabelObject::hasSettingDisplayMinimumFrame (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 74 of file FrameLabelObject.h.

static void FrameLabelObject::setSettingDisplayMinimumFrame ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 90 of file FrameLabelObject.h.

static std::string FrameLabelObject::getSettingDisplayMinimumFrameKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 98 of file FrameLabelObject.h.

virtual void FrameLabelObject::setAnimations ( const std::vector< Animation * > &  animations  )  [pure virtual]

Sets the Animation objects for the object to monitor.

If the object is in Automatic Mode, this method does nothing.

Parameters:
animations Animation objects to monitor.
See also:
setAutoMode(), getAutoMode()

virtual const std::vector<Animation*>& FrameLabelObject::getAnimations (  )  const [pure virtual]

Gets the Animation objects being monitored by the object.

Returns:
Animation objects being monitored.

virtual void FrameLabelObject::insertAnimation ( Animation *  pAnimation  )  [pure virtual]

Inserts an Animation into the vector of Animation objects being monitored.

If the object is in Automatic Mode, this method does nothing.

Parameters:
pAnimation A pointer to an Animation to insert into the vector.
See also:
setAutoMode(), getAutoMode()

virtual void FrameLabelObject::eraseAnimation ( Animation *  pAnimation  )  [pure virtual]

Erases an Animation from the vector of Animation objects being monitored.

If the object is in Automatic Mode, this method does nothing.

Parameters:
pAnimation A pointer to an Animation to erase from the vector.
See also:
setAutoMode(), getAutoMode()

virtual void FrameLabelObject::setAutoMode ( bool  autoMode  )  [pure virtual]

Sets the current mode.

If autoMode matches the current mode, this method does nothing.

Parameters:
autoMode A value of true will clear all current Animation objects and operate in Automatic Mode. A value of false will clear all current Animation objects and operate in Manual Mode.
See also:
getAutoMode()

virtual bool FrameLabelObject::getAutoMode (  )  const [pure virtual]

Gets the current mode.

Returns:
True if the object is operating in Automatic Mode, false otherwise.
See also:
setAutoMode()

Software Development Kit - Opticks 4.9.0 Build 16218