rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Types | Public Member Functions
IlvSimpleBitmapTransition Class Reference

Bitmap transition class. More...

#include <ilviews/bitmaps/transition.h>

Inheritance diagram for IlvSimpleBitmapTransition:
IlvBitmapTransition

Public Types

enum  Transition { ,
  WipeLeft, WipeRight, WipeDown, WipeUp ,
  BoxIn, BoxOut, SplitHorizontalIn, SplitHorizontalOut,
  SplitVerticalIn, SplitVerticalOut , SnailIn , BandVerticalIn,
  BandHorizontalIn
}
 This enumeration defines the various transitions that IlvSimpleBitmapTransition objects can deal with. More...
 

Public Member Functions

 IlvSimpleBitmapTransition (Transition type)
 Constructor. More...
 
virtual void computeTransitionBitmapData (IlDouble oldRate, IlDouble newRate, const IlvRGBBitmapData &src, const IlvRGBBitmapData &dst, IlvRGBBitmapData &bitmap, IlvRegion &region) const
 Computes a transition image between the specified bitmap data objects. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvBitmapTransition
static void Draw (IlvPort &dst, const IlvPoint &at, const IlvBitmapData &src, const IlvRegion &region)
 Draws the specified region of the bitmap data object into the specified port. More...
 

Detailed Description

Bitmap transition class.

Library: display

This class handles bitmap transitions using simple geometric algorithms.

See Also
IlvAlphaBitmapTransition, IlvDissolveBitmapTransition

Member Enumeration Documentation

This enumeration defines the various transitions that IlvSimpleBitmapTransition objects can deal with.

Enumerator
WipeLeft 

Wipes the source image from the right to the left, revealing the destination image.

WipeRight 

Wipes the source image from the left to the right, revealing the destination image.

WipeDown 

Wipes the source image from the top to the bottom, revealing the destination image.

WipeUp 

Wipes the source image from the bottom to the top, revealing the destination image.

BoxIn 

Wipes the source image by describing a box from the borders of the image to the center, revealing the destination image.

BoxOut 

Wipes the source image by describing a box from the center of the image to the borders, revealing the destination image.

SplitHorizontalIn 

Wipes the source image both from the left to the center and from the right to the center, revealing the destination image.

SplitHorizontalOut 

Wipes the source image both from the center to the left and from the center to the right, revealing the destination image.

SplitVerticalIn 

Wipes the source image both from the top to the center and from the bottom to the center, revealing the destination image.

SplitVerticalOut 

Wipes the source image both from the center to the top and from the center to the bottom, revealing the destination image.

SnailIn 

Wipes the source image by using a 'snail', revealing the destination image.

BandVerticalIn 

Wipes the source image by using vertical lines, revealing the destination image.

BandHorizontalIn 

Wipes the source image by using horizontal lines, revealing the destination image.

Constructor & Destructor Documentation

IlvSimpleBitmapTransition::IlvSimpleBitmapTransition ( Transition  type)

Constructor.

Initializes a new instance of the IlvSimpleBitmapTransition class.

Parameters
typeThe type of transition.

Member Function Documentation

virtual void IlvSimpleBitmapTransition::computeTransitionBitmapData ( IlDouble  oldRate,
IlDouble  newRate,
const IlvRGBBitmapData src,
const IlvRGBBitmapData dst,
IlvRGBBitmapData current,
IlvRegion region 
) const
virtual

Computes a transition image between the specified bitmap data objects.

This method is pure and must be defined in subclasses. It computes a transition image given a source bitmap data object, a destination bitmap data object, and a percentage of completion of the transition. src and dst must have the same size and color depth.
When calling this method, current must contain the transition image corresponding to the oldRate percentage of completion. After returning, current contains the transition image corresponding to the newRate percentage of completion.

Parameters
oldRateThe previous percentage of completion of the transition. Valid values are double values in the interval 0-100.
newRateThe new percentage of completion of the transition. Valid values are double values in the interval 0-100.
srcThe source bitmap data.
dstThe destination bitmap data.
currentThe current bitmap data.
regionThe region of the current bitmap that has changed between the transition from oldRate to newRate.

Implements IlvBitmapTransition.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.