Symbian sdk帮助-类CBitmapFrameData 译文作者: GEF

译文版本:1.0 译文时间:2005-10-23

--------------------------------------------------------------------------------

位置: bmpancli.h

Class CBitmapFrameData

class CBitmapFrameData : public CBase;

描述

为一帧动画封装所需的内容。

每个动画帧都包括了一个在某时间段指定位置的位图。你可以选择性的引入蒙板来隐藏部分位图或者使部分位图透明化，使背景可见。

在一个完整的动画中往往需要定义多个帧，定义好所需的帧之后使用CBitmapAnimClientData来构造之。

派生自

CBase – 所有类的基类
CBitmapFrameData -为一帧动画封装所需的内容
成员

CBitmapFrameData中定义:
Bitmap(), BitmapsOwnedExternally(), IntervalInMilliSeconds(), Mask(), NewL(), NewL(), NewL(), Position(), SetBitmap(), SetBitmapsOwnedExternally(), SetInterval(), SetMask(), SetPosition(), ~CBitmapFrameData()

继承自 CBase:
operator new()

--------------------------------------------------------------------------------

构造子与析构子

--------------------------------------------------------------------------------

~CBitmapFrameData()

IMPORT_C ~CBitmapFrameData();

描述

析构子。

除非“外部归属”标志被设定，否则该析构函数将删除位图以及蒙板对象。

返回值
--------------------------------------------------------------------------------

NewL()

static IMPORT_C CBitmapFrameData *NewL();

描述

创建一个新的空帧对象。

返回值

CBitmapFrameData *
新建CBitmapFrameData对象

--------------------------------------------------------------------------------

NewL()

static IMPORT_C CBitmapFrameData *NewL(CFbsBitmap *aBitmap, CFbsBitmap *aMask=NULL);

描述

创建一个新的带有指定位图或者蒙板的帧对象。

该对象拥有指定位图及蒙板的所有权。

参数

CFbsBitmap *aBitmap
指向新帧中使用的位图的指针。

CFbsBitmap *aMask
如果置为non-NULL,指向新帧中的蒙板。

返回值

CBitmapFrameData *
新建CBitmapFrameData对象

--------------------------------------------------------------------------------

NewL()

static IMPORT_C CBitmapFrameData *NewL(CFbsBitmap *aBitmap, CFbsBitmap *aMask, TInt aIntervalInMilliSeconds, TPoint aPosition);

描述

创建一个新的帧对象。

拥有指定位图和蒙板（如果指定）的所有权，其帧长度和位置也同时被设置。

参数

CFbsBitmap *aBitmap
指向位图的指针。

CFbsBitmap *aMask
如果置为non-NULL,指向帧中的蒙板。

TInt aIntervalInMilliSeconds
使用毫秒表示的帧长度。

TPoint aPosition
相对于动画窗口的帧位置。

返回值

CBitmapFrameData *
新建CBitmapFrameData对象

--------------------------------------------------------------------------------

成员函数

--------------------------------------------------------------------------------

SetBitmap()

IMPORT_C void SetBitmap(CFbsBitmap *aBitmap);

描述

设置帧位图。

除非“外部归属”（SetBitmapsOwnedExternally()）的标志被设定，否则将删除存在的帧位图并接管新位图的所有权。

参数

CFbsBitmap *aBitmap
帧位图

返回值

void

--------------------------------------------------------------------------------

SetMask()

IMPORT_C void SetMask(CFbsBitmap *aMask);

描述

设置帧蒙板。

除非“外部归属”（SetBitmapsOwnedExternally()）的标志被设定，否则将删除存在的蒙板位图并接管新位图的所有权。

参数

CFbsBitmap *aMask
帧中使用的蒙板

返回值

void

--------------------------------------------------------------------------------

SetPosition()

IMPORT_C void SetPosition(TPoint aPosition);

描述

设置相对于动画窗口的帧位置。

参数

TPoint aPosition
相对于动画窗口的帧位置。

返回值

void

--------------------------------------------------------------------------------

SetInterval()

IMPORT_C void SetInterval(TInt aIntervalInMilliSeconds);

描述

设置毫秒为单位的帧长度。

可使用CBitmapAnimClientData::SetFrameInterval()来为一个完整的动画设置时间长度。为独立帧设置的时间长度将覆盖动画级的时间长度设定。

参数

TInt aIntervalInMilliSeconds
显示帧的毫秒数。

返回值

void

--------------------------------------------------------------------------------

SetBitmapsOwnedExternally()

IMPORT_C void SetBitmapsOwnedExternally(TBool aOwnedExternally);

描述

设置位图和蒙板是否归属于该帧。

参数

TBool aOwnedExternally
若为EFalse,则位图和蒙板将归属于帧；反之若为ETrue,则位图和蒙板将不归属于帧。

返回值

void

--------------------------------------------------------------------------------

Bitmap()

IMPORT_C CFbsBitmap *Bitmap() const;

描述

取得帧位图。

该函数不影响位图归属。

返回值

CFbsBitmap *
帧位图

--------------------------------------------------------------------------------

Mask()

IMPORT_C CFbsBitmap *Mask() const;

描述

取得帧蒙板。

该函数不影响位图归属。

返回值

CFbsBitmap *
帧蒙板

--------------------------------------------------------------------------------

IntervalInMilliSeconds()

IMPORT_C TInt IntervalInMilliSeconds() const;

描述

取得毫秒级的帧长度。

返回值

TInt
显示动画帧所需的毫秒数。

--------------------------------------------------------------------------------

Position()

IMPORT_C TPoint Position() const;

描述

取得相对于动画窗口的帧位置。

返回值

TPoint
相对于动画窗口的帧位置。

--------------------------------------------------------------------------------

BitmapsOwnedExternally()

IMPORT_C TBool BitmapsOwnedExternally() const;

描述

测试该帧是否拥有位图和蒙板。

返回值

TBool
如果拥有位图和蒙板则值为ETrue，反之值为EFalse.