Isis 3.0
Home
Public Types | Public Member Functions | List of all members
Isis::ViewportBufferAction Class Reference

#include <ViewportBufferAction.h>

Inherited by Isis::ViewportBufferFill, Isis::ViewportBufferStretch, and Isis::ViewportBufferTransform.

Public Types

enum  ActionType { none, transform, fill, stretch }
 This uniquely identifies which child is instantiated. More...
 

Public Member Functions

 ViewportBufferAction ()
 Creates a new viewport buffer action. More...
 
virtual ~ViewportBufferAction ()
 Destructor. More...
 
virtual ActionType getActionType ()
 Returns the instantiated type. More...
 
bool started ()
 Returns true if this is an action that takes time and has begun. More...
 
void started (bool started)
 Sets started. More...
 
virtual void stop ()
 Cancels the process, used if reinitialize requested for example. More...
 

Detailed Description

Author
????-??-?? Unknown

Member Enumeration Documentation

enum Isis::ViewportBufferAction::ActionType

This uniquely identifies which child is instantiated.

Enumerator
none 

Parent was instantiated.

transform 

ViewportBufferTransform.

fill 

ViewportBufferFill.

stretch 

ViewportBufferStretch.

Constructor & Destructor Documentation

Isis::ViewportBufferAction::ViewportBufferAction ( )

Creates a new viewport buffer action.

Isis::ViewportBufferAction::~ViewportBufferAction ( )
virtual

Destructor.

Member Function Documentation

virtual ActionType Isis::ViewportBufferAction::getActionType ( )
inlinevirtual

Returns the instantiated type.

Reimplemented in Isis::ViewportBufferFill, Isis::ViewportBufferStretch, and Isis::ViewportBufferTransform.

References none.

Referenced by Isis::ViewportBuffer::DataReady(), and Isis::ViewportBuffer::totalUnfilledArea().

bool Isis::ViewportBufferAction::started ( )
inline

Returns true if this is an action that takes time and has begun.

Referenced by Isis::ViewportBuffer::DataReady(), and started().

void Isis::ViewportBufferAction::started ( bool  started)
inline

Sets started.

Parameters
startedTrue if starting

References started().

virtual void Isis::ViewportBufferAction::stop ( )
inlinevirtual

Cancels the process, used if reinitialize requested for example.

Reimplemented in Isis::ViewportBufferFill.

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