Isis 3 Programmer Reference
Public Types | Public Member Functions | Private Attributes | List of all members
Isis::ViewportBufferStretch Class Reference

#include <ViewportBufferStretch.h>

Inheritance diagram for Isis::ViewportBufferStretch:
Inheritance graph
Collaboration diagram for Isis::ViewportBufferStretch:
Collaboration graph

Public Types

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

Public Member Functions

 ViewportBufferStretch ()
 Constructor. More...
 
 ~ViewportBufferStretch ()
 Destructor. More...
 
virtual ViewportBufferAction::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...
 

Private Attributes

bool p_started
 True if this action has begun. More...
 

Detailed Description

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

Definition at line 22 of file ViewportBufferStretch.h.

Member Enumeration Documentation

◆ ActionType

enum Isis::ViewportBufferAction::ActionType
inherited

This uniquely identifies which child is instantiated.

Enumerator
none 

Parent was instantiated.

transform 

ViewportBufferTransform.

fill 

ViewportBufferFill.

stretch 

ViewportBufferStretch.

Definition at line 26 of file ViewportBufferAction.h.

Constructor & Destructor Documentation

◆ ViewportBufferStretch()

Isis::ViewportBufferStretch::ViewportBufferStretch ( )

Constructor.

Definition at line 16 of file ViewportBufferStretch.cpp.

◆ ~ViewportBufferStretch()

Isis::ViewportBufferStretch::~ViewportBufferStretch ( )

Destructor.

Definition at line 22 of file ViewportBufferStretch.cpp.

Member Function Documentation

◆ getActionType()

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

Returns the instantiated type.

Reimplemented from Isis::ViewportBufferAction.

Definition at line 27 of file ViewportBufferStretch.h.

References Isis::ViewportBufferAction::stretch.

◆ started() [1/2]

bool Isis::ViewportBufferAction::started ( )
inlineinherited

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

Definition at line 39 of file ViewportBufferAction.h.

References Isis::ViewportBufferAction::p_started.

Referenced by Isis::ViewportBuffer::DataReady(), Isis::ViewportBuffer::doQueuedActions(), Isis::ViewportBuffer::reinitialize(), Isis::ViewportBufferAction::started(), and Isis::ViewportBuffer::startFillAction().

◆ started() [2/2]

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

Sets started.

Parameters
startedTrue if starting

Definition at line 48 of file ViewportBufferAction.h.

References Isis::ViewportBufferAction::p_started, and Isis::ViewportBufferAction::started().

◆ stop()

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

Cancels the process, used if reinitialize requested for example.

Reimplemented in Isis::ViewportBufferFill.

Definition at line 53 of file ViewportBufferAction.h.

Member Data Documentation

◆ p_started

bool Isis::ViewportBufferAction::p_started
privateinherited

True if this action has begun.

Definition at line 73 of file ViewportBufferAction.h.

Referenced by Isis::ViewportBufferAction::started(), and Isis::ViewportBufferAction::ViewportBufferAction().

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