Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

FlashBitmapRecord Class Reference

Maintains a record of the bitmaps used for fills. More...

#include <swfbitmp.h>

Inheritance diagram for FlashBitmapRecord:

CCObject SimpleCCObject List of all members.

Public Member Functions

 FlashBitmapRecord (void)
 Creates a FlashBitmapRecord list node, and initialises all member variables.
 ~FlashBitmapRecord (void)
 Destroys this instance of FlashBitmapRecord.
FlashBitmapRecord * AddElement (void)
 Adds an element to the tail of the list.
void DeleteNextElement (void)
 Deletes the next item in the list.
void DeleteLastElement (void)
 Deletes the previous item in the list.
OILBitmap * GetBitmap (void)
 Gets the value of mpBitmap.
WORD GetBitmapID (void)
 Gets the value of mBitmapID.
DocColour GetContoneStart (void)
 Gets the value of mStartColour.
DocColour GetContoneEnd (void)
 Gets the value of mEndColour.
BOOL GetIsContone (void)
 Gets the value of mIsContone.
UINT32 GetTransparency (void)
 Gets the value of mTransparency.
FlashBitmapRecord * GetNext (void)
 Gets mpNext.
FlashBitmapRecord * GetLast (void)
 Gets mpLast.
void SetBitmap (OILBitmap *pBitmap)
 Sets the value of mpBitmap.
void SetBitmapID (WORD BitmapID)
 Sets the value of mBitmapID.
void SetContoneColours (const DocColour &Start, const DocColour &End)
void SetIsContone (BOOL State)
 Sets the value of mIsContone.
void SetTransparency (UINT32 Transparency)
 Sets the value of mTransparency.
void SetNext (FlashBitmapRecord *pNext)
 Sets the value of mpNext.
void SetLast (FlashBitmapRecord *pLast)
 Sets the value of mpLast.

Private Attributes

OILBitmap * mpBitmap
WORD mBitmapID
DocColour mStartColour
DocColour mEndColour
BOOL mIsContone
UINT32 mTransparency
FlashBitmapRecord * mpNext
FlashBitmapRecord * mpLast

Detailed Description

Maintains a record of the bitmaps used for fills.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/10/99

Definition at line 113 of file swfbitmp.h.

Constructor & Destructor Documentation

FlashBitmapRecord::FlashBitmapRecord (  void   ) 
 

Creates a FlashBitmapRecord list node, and initialises all member variables.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 115 of file swfbitmp.cpp.

00116 {
00117     // Pointers should always be initialised to NULL when created.
00118     mpNext          = NULL;     // No subsequent nodes.
00119     mpLast          = NULL;     // No previous nodes.
00120     mpBitmap        = NULL;     // No bitmap attached.
00121 
00122     mIsContone      = FALSE;
00123     mBitmapID       = 0;
00124 
00125     mTransparency   = 255;      // The bitmap is (initially) transparent.
00126 }

FlashBitmapRecord::~FlashBitmapRecord (  void   ) 
 

Destroys this instance of FlashBitmapRecord.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 140 of file swfbitmp.cpp.

00141 {
00142     // Clean up any stray values.
00143     mpNext      = NULL;
00144     mpLast      = NULL;
00145     mpBitmap    = NULL;
00146 }

Member Function Documentation

FlashBitmapRecord * FlashBitmapRecord::AddElement (  void   ) 
 

Adds an element to the tail of the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
pTail - The pointer to the new node.

Definition at line 160 of file swfbitmp.cpp.

00161 {
00162     FlashBitmapRecord *pTail = new FlashBitmapRecord;
00163     
00164     // Set the appropriate pointers.
00165     pTail->SetLast ( this );        // Ensure that a reference exists to this object...
00166     pTail->SetNext ( mpNext );      // Avoids any problems if mpLast isn't NULL.
00167     mpNext = pTail;                 // ... and a reference exists to the new one.
00168 
00169     return pTail;
00170 }

void FlashBitmapRecord::DeleteLastElement (  void   ) 
 

Deletes the previous item in the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 184 of file swfbitmp.cpp.

00185 {
00186     FlashBitmapRecord *pToDelete = mpLast;
00187     
00188     // Reset mpLast to be mpLast->GetLast (), so that the list isn't broken.
00189     if ( mpLast != NULL )
00190         mpLast = mpLast->GetLast ();
00191 
00192     delete pToDelete;
00193 }

void FlashBitmapRecord::DeleteNextElement (  void   ) 
 

Deletes the next item in the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 207 of file swfbitmp.cpp.

00208 {
00209     FlashBitmapRecord *pToDelete = mpNext;
00210     
00211     // Reset mpNext to be mpNext->GetNext (), so that the list isn't broken.
00212     if ( mpNext != NULL )
00213         mpNext = mpNext->GetNext ();
00214 
00215     delete pToDelete;
00216 }

OILBitmap * FlashBitmapRecord::GetBitmap (  void   ) 
 

Gets the value of mpBitmap.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
mpBitmap - A pointer to a kernel bitmap.

Definition at line 230 of file swfbitmp.cpp.

00231 {
00232     return mpBitmap;
00233 }

WORD FlashBitmapRecord::GetBitmapID (  void   ) 
 

Gets the value of mBitmapID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
mBitmapID - The internal ID number used by the Flash file.

Definition at line 247 of file swfbitmp.cpp.

00248 {
00249     return mBitmapID;
00250 }

DocColour FlashBitmapRecord::GetContoneEnd (  void   ) 
 

Gets the value of mEndColour.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
2/12/99
Parameters:
- [INPUTS]
Returns:
mEndColour - The end colour for a contone operation.

Definition at line 281 of file swfbitmp.cpp.

00282 {
00283     return mEndColour;
00284 }

DocColour FlashBitmapRecord::GetContoneStart (  void   ) 
 

Gets the value of mStartColour.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
2/12/99
Parameters:
- [INPUTS]
Returns:
mStartColour - The start colour for a contone operation.

Definition at line 264 of file swfbitmp.cpp.

00265 {
00266     return mStartColour;
00267 }

BOOL FlashBitmapRecord::GetIsContone (  void   ) 
 

Gets the value of mIsContone.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
2/12/99
Parameters:
- [INPUTS]
Returns:
mIsContone - Is the bitmap contoned.

Definition at line 298 of file swfbitmp.cpp.

00299 {
00300     return mIsContone;
00301 }

FlashBitmapRecord * FlashBitmapRecord::GetLast (  void   ) 
 

Gets mpLast.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
*mpLast - A pointer to the previous node in the linked list.

Definition at line 332 of file swfbitmp.cpp.

00333 {
00334     return mpLast;
00335 }

FlashBitmapRecord * FlashBitmapRecord::GetNext (  void   ) 
 

Gets mpNext.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
*mpNext - A pointer to the next node in the linked list.

Definition at line 349 of file swfbitmp.cpp.

00350 {
00351     return mpNext;
00352 }

UINT32 FlashBitmapRecord::GetTransparency (  void   ) 
 

Gets the value of mTransparency.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/11/00
Parameters:
- [INPUTS]
Returns:
mTransparency - The transparency channel of the bitmap.

Definition at line 315 of file swfbitmp.cpp.

00316 {
00317     return mTransparency;
00318 }

void FlashBitmapRecord::SetBitmap (  OILBitmap *  pBitmap  ) 
 

Sets the value of mpBitmap.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
pBitmap - A pointer to a kernel bitmap. [INPUTS]
Returns:
-

Definition at line 366 of file swfbitmp.cpp.

00367 {
00368     mpBitmap = pBitmap;
00369 }

void FlashBitmapRecord::SetBitmapID (  WORD  BitmapID  ) 
 

Sets the value of mBitmapID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
BitmapID - The ID value for this bitmap. [INPUTS]
Returns:
-

Definition at line 438 of file swfbitmp.cpp.

00439 {
00440     mBitmapID = BitmapID;
00441 }

void FlashBitmapRecord::SetContoneColours (  const DocColour &  Start,
const DocColour &  End
) 
 

Definition at line 384 of file swfbitmp.cpp.

00386 {
00387     // Set the values for the start and end colours.
00388     mStartColour    = Start;
00389     mEndColour      = End;
00390 }

void FlashBitmapRecord::SetIsContone (  BOOL  IsContone  ) 
 

Sets the value of mIsContone.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
1/12/99
Parameters:
IsContone - Is the bitmap to be rendered as a contone bitmap. [INPUTS]
Returns:
-

Definition at line 404 of file swfbitmp.cpp.

00405 {
00406     mIsContone = IsContone;
00407 }

void FlashBitmapRecord::SetLast (  FlashBitmapRecord *  pLast  ) 
 

Sets the value of mpLast.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
pLast - A pointer to the previous FlashBitmapRecord in the linked list. [INPUTS]
Returns:
-

Definition at line 455 of file swfbitmp.cpp.

00456 {
00457     mpLast = pLast;
00458 }

void FlashBitmapRecord::SetNext (  FlashBitmapRecord *  pNext  ) 
 

Sets the value of mpNext.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
pNext - A pointer to the next FlashBitmapRecord in the linked list. [INPUTS]
Returns:
-

Definition at line 472 of file swfbitmp.cpp.

00473 {
00474     mpNext = pNext;
00475 }

void FlashBitmapRecord::SetTransparency (  UINT32  Transparency  ) 
 

Sets the value of mTransparency.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/11/00
Parameters:
Transparency - The transparency of the bitmap. [INPUTS]
Returns:
-

Definition at line 421 of file swfbitmp.cpp.

00422 {
00423     mTransparency = Transparency;
00424 }

Member Data Documentation

WORD FlashBitmapRecord::mBitmapID [private]
 

Definition at line 147 of file swfbitmp.h.

DocColour FlashBitmapRecord::mEndColour [private]
 

Definition at line 149 of file swfbitmp.h.

BOOL FlashBitmapRecord::mIsContone [private]
 

Definition at line 150 of file swfbitmp.h.

OILBitmap* FlashBitmapRecord::mpBitmap [private]
 

Definition at line 146 of file swfbitmp.h.

FlashBitmapRecord* FlashBitmapRecord::mpLast [private]
 

Definition at line 153 of file swfbitmp.h.

FlashBitmapRecord* FlashBitmapRecord::mpNext [private]
 

Definition at line 152 of file swfbitmp.h.

DocColour FlashBitmapRecord::mStartColour [private]
 

Definition at line 148 of file swfbitmp.h.

UINT32 FlashBitmapRecord::mTransparency [private]
 

Definition at line 151 of file swfbitmp.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:54:21 2007 for Camelot by  doxygen 1.4.4