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

#include <ViewportBufferTransform.h>

Inheritance diagram for Isis::ViewportBufferTransform:
Inheritance graph
Collaboration diagram for Isis::ViewportBufferTransform:
Collaboration graph

Public Types

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

Public Member Functions

 ViewportBufferTransform ()
 Constructor.
 
virtual ActionType getActionType ()
 Returns the instance type.
 
void setTranslation (int x, int y)
 Sets the translation amount in x and y.
 
int getXTranslation ()
 Gets the amount the buffer should be translated in X.
 
int getYTranslation ()
 Gets the amount the buffer should be translated in Y.
 
void setResize (int width, int height)
 Sets the size the buffer should be resized to.
 
const int & getBufferWidth ()
 Returns the new buffer width.
 
const int & getBufferHeight ()
 Returns the new buffer height.
 
bool resizeFirst ()
 Returns true if the resize should happen before the translation.
 
void resizeFirst (bool resizeFirst)
 Sets whether the resize should happen before the translation.
 
bool started ()
 Returns true if this is an action that takes time and has begun.
 
void started (bool started)
 Sets started.
 
virtual void stop ()
 Cancels the process, used if reinitialize requested for example.
 

Private Attributes

int p_xTranslation
 How far to translate in X.
 
int p_yTranslation
 How far to translate in Y.
 
int p_newBufferWidth
 New width.
 
int p_newBufferHeight
 New height.
 
bool p_resizeFirst
 Do the resize before the translation?
 
bool p_started
 True if this action has begun.
 

Detailed Description

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

Definition at line 21 of file ViewportBufferTransform.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

◆ ViewportBufferTransform()

Isis::ViewportBufferTransform::ViewportBufferTransform ( )

Constructor.

Definition at line 18 of file ViewportBufferTransform.cpp.

References p_newBufferHeight, p_newBufferWidth, p_resizeFirst, p_xTranslation, and p_yTranslation.

Member Function Documentation

◆ getActionType()

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

Returns the instance type.

Reimplemented from Isis::ViewportBufferAction.

Definition at line 26 of file ViewportBufferTransform.h.

References Isis::ViewportBufferAction::transform.

◆ getBufferHeight()

const int & Isis::ViewportBufferTransform::getBufferHeight ( )
inline

Returns the new buffer height.

Returns
const int&

Definition at line 67 of file ViewportBufferTransform.h.

References p_newBufferHeight.

Referenced by Isis::ViewportBuffer::actionsPreserveData(), and Isis::ViewportBuffer::reinitializeActionExists().

◆ getBufferWidth()

const int & Isis::ViewportBufferTransform::getBufferWidth ( )
inline

Returns the new buffer width.

Returns
const int&

Definition at line 58 of file ViewportBufferTransform.h.

References p_newBufferWidth.

Referenced by Isis::ViewportBuffer::actionsPreserveData(), and Isis::ViewportBuffer::reinitializeActionExists().

◆ getXTranslation()

int Isis::ViewportBufferTransform::getXTranslation ( )
inline

Gets the amount the buffer should be translated in X.

Returns
int

Definition at line 37 of file ViewportBufferTransform.h.

References p_xTranslation.

Referenced by Isis::ViewportBuffer::actionsPreserveData().

◆ getYTranslation()

int Isis::ViewportBufferTransform::getYTranslation ( )
inline

Gets the amount the buffer should be translated in Y.

Returns
int

Definition at line 47 of file ViewportBufferTransform.h.

References p_yTranslation.

Referenced by Isis::ViewportBuffer::actionsPreserveData().

◆ resizeFirst() [1/2]

bool Isis::ViewportBufferTransform::resizeFirst ( )
inline

Returns true if the resize should happen before the translation.

Returns
bool

Definition at line 77 of file ViewportBufferTransform.h.

References p_resizeFirst.

Referenced by Isis::ViewportBuffer::actionsPreserveData(), Isis::ViewportBuffer::pan(), Isis::ViewportBuffer::resizedViewport(), and resizeFirst().

◆ resizeFirst() [2/2]

void Isis::ViewportBufferTransform::resizeFirst ( bool resizeFirst)
inline

Sets whether the resize should happen before the translation.

Parameters
resizeFirst

Definition at line 86 of file ViewportBufferTransform.h.

References p_resizeFirst, and resizeFirst().

◆ setResize()

void Isis::ViewportBufferTransform::setResize ( int width,
int height )

Sets the size the buffer should be resized to.

Parameters
width
height

Definition at line 44 of file ViewportBufferTransform.cpp.

References p_newBufferHeight, and p_newBufferWidth.

Referenced by Isis::ViewportBuffer::pan(), Isis::ViewportBuffer::reinitialize(), and Isis::ViewportBuffer::resizedViewport().

◆ setTranslation()

void Isis::ViewportBufferTransform::setTranslation ( int x,
int y )

Sets the translation amount in x and y.

Parameters
x
y

Definition at line 32 of file ViewportBufferTransform.cpp.

References p_xTranslation, and p_yTranslation.

Referenced by Isis::ViewportBuffer::pan(), and Isis::ViewportBuffer::resizedViewport().

◆ 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::ViewportBufferAction::started().

◆ 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_newBufferHeight

int Isis::ViewportBufferTransform::p_newBufferHeight
private

New height.

Definition at line 95 of file ViewportBufferTransform.h.

Referenced by getBufferHeight(), setResize(), and ViewportBufferTransform().

◆ p_newBufferWidth

int Isis::ViewportBufferTransform::p_newBufferWidth
private

New width.

Definition at line 94 of file ViewportBufferTransform.h.

Referenced by getBufferWidth(), setResize(), and ViewportBufferTransform().

◆ p_resizeFirst

bool Isis::ViewportBufferTransform::p_resizeFirst
private

Do the resize before the translation?

Definition at line 96 of file ViewportBufferTransform.h.

Referenced by resizeFirst(), resizeFirst(), and ViewportBufferTransform().

◆ 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(), Isis::ViewportBufferAction::started(), and Isis::ViewportBufferAction::ViewportBufferAction().

◆ p_xTranslation

int Isis::ViewportBufferTransform::p_xTranslation
private

How far to translate in X.

Definition at line 92 of file ViewportBufferTransform.h.

Referenced by getXTranslation(), setTranslation(), and ViewportBufferTransform().

◆ p_yTranslation

int Isis::ViewportBufferTransform::p_yTranslation
private

How far to translate in Y.

Definition at line 93 of file ViewportBufferTransform.h.

Referenced by getYTranslation(), setTranslation(), and ViewportBufferTransform().

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