CVidCell Class¶

Overview
Quick Reference
Constructors
Operators
Methods

Overview¶

Note

The CVidCell class handles image sprite animations

The structure used for this class is CVidCell

Quick Reference¶

Quick Ref

void CVidCell::CVidCell(CResRef cNewResRef)

void CVidCell::CVidCell()

void CVidCell::~CVidCell()

void CVidCell::AddRangeAffect(unsigned short nAffectType, unsigned short nRangeId, unsigned long rgbAffectColor, unsigned char pulsePeriod)

void CVidCell::AddResPaletteAffect(unsigned short nAffectType, unsigned long rgbAffectColor, unsigned char pulsePeriod)

void CVidCell::Blt8To32(unsigned long* surface, int surfacePitch, CPoint& destOffset, CRect& destClip, unsigned long dwFlags, CPoint& sourceOffset, bool isAlphaMap)

void CVidCell::DeleteRangeAffects(unsigned short nRangeId)

void CVidCell::DeleteResPaletteAffect()

virtual int CVidCell::FrameAdvance()

int CVidCell::FrameSet(unsigned short nFrame)

int CVidCell::FXRender3d(int nRefPtX, int nRefPtY, CRect& rFXRect, CRect& rClip, unsigned long dwFlags, int bAlphaValues)

int CVidCell::FXRender3d(int nRefPtX, int nRefPtY, CRect& rFXRect, unsigned long dwFlags, int nTransVal, int bAlphaValues)

int CVidCell::GetCurrentCenterPoint(CPoint& ptReference)

int CVidCell::GetCurrentFrameSize(CSize& frameSize)

virtual int CVidCell::GetFrame()

int CVidCell::GetFrameSize(short nSequence, short nFrame, CSize& frameSize)

unsigned short CVidCell::GetNumberSequences()

unsigned char CVidCell::GetSequenceLength(unsigned short nSequence)

int CVidCell::IsEndOfSequence()

int CVidCell::IsEndOfTwitchSequence()

void CVidCell::RealizePalette(unsigned long dwFlags)

virtual int CVidCell::Render(int x, int y, CRect& rClipping, CVidPoly* pClipPoly, int nPolys, unsigned long dwFlags, int nTransVal)

virtual int CVidCell::Render(unsigned long* pSurface, long lPitch, int nRefPtX, int nRefPtY, CRect& rClip, unsigned long dwFlags, CPoint& ptSource)

int CVidCell::Render3d(int x, int y, CRect& rClipping, CRect& rScale, CVidPoly* pClipPoly, int nPolys, unsigned long dwFlags, int nTransVal)

int CVidCell::Render3d(int nRefPtX, int nRefPtY, CRect& rClip, unsigned long dwFlags)

int CVidCell::Render3d(int x, int y, CRect& rClipping, CVidPoly* pClipPoly, int nPolys, unsigned long dwFlags, int nTransVal)

int CVidCell::RenderPVR(int x, int y, CRect& rClip, unsigned long dwFlags, int nTransVal)

virtual void __cdecl CVidCell::RenderTexture(int x, int y, CRect& rFxRect, CSize dataPitch, CRect& rClip, CRect& rScale, unsigned long dwFlags)

virtual void __cdecl CVidCell::RenderTexture(int x, int y, CRect& rFxRect, CSize dataPitch, CRect& rClip, unsigned long dwFlags)

int CVidCell::SequenceSet(unsigned short nSequence)

void CVidCell::SetPalette(CVidPalette& cPalette)

void CVidCell::SetPalette(RGBQUAD* pRgbQuad, int nPaletteEntries, unsigned short nType)

virtual void CVidCell::StoreBackground(int srcx, int srcy, CRect& srcClip, CRect& rStorage, unsigned char bNumbered)

void CVidCell::SuppressTint(short nRange)

void CVidCell::UnsuppressTint(short nRange)

CVidCell& CVidCell::operator=(CVidCell& __that)

Constructors¶

Name	Description
CVidCell::CVidCell	Constructs a `CVidCell` object
CVidCell::CVidCell	Destroys a `CVidCell` object

CVidCell::CVidCell¶

Constructs a CVidCell object

void CVidCell::CVidCell(CResRef cNewResRef);

Parameters

CResRef cNewResRef -

Remarks

Constructs a CVidCell object

CVidCell::CVidCell¶

Constructs a CVidCell object

void CVidCell::CVidCell();

Remarks

Constructs a CVidCell object

CVidCell::~CVidCell¶

Destroys the CVidCell object

virtual void CVidCell::~CVidCell();

Remarks

Destroys the CVidCell object

Methods¶

CVidCell::AddRangeAffect¶

void CVidCell::AddRangeAffect(
   unsigned short nAffectType,
   unsigned short nRangeId,
   unsigned long rgbAffectColor,
   unsigned char pulsePeriod);

Parameters

unsigned short nAffectType -
unsigned short nRangeId -
unsigned long rgbAffectColor -
unsigned char pulsePeriod -

Remarks

CVidCell::AddResPaletteAffect¶

void CVidCell::AddResPaletteAffect(
   unsigned short nAffectType,
   unsigned long rgbAffectColor,
   unsigned char pulsePeriod);

Parameters

unsigned short nAffectType -
unsigned long rgbAffectColor -
unsigned char pulsePeriod -

Remarks

CVidCell::Blt8To32¶

void CVidCell::Blt8To32(
   unsigned long* surface,
   int surfacePitch,
   CPoint& destOffset,
   CRect& destClip,
   unsigned long dwFlags,
   CPoint& sourceOffset,
   bool isAlphaMap);

Parameters

unsigned long* surface -
int surfacePitch -
CPoint& destOffset -
CRect& destClip -
unsigned long dwFlags -
CPoint& sourceOffset -
bool isAlphaMap -

Remarks

CVidCell::DeleteRangeAffects¶

void CVidCell::DeleteRangeAffects(unsigned short nRangeId);

Parameters

unsigned short nRangeId -

Remarks

CVidCell::DeleteResPaletteAffect¶

void CVidCell::DeleteResPaletteAffect();

Remarks

CVidCell::FrameAdvance¶

virtual int CVidCell::FrameAdvance();

Return Value

Returns int

Remarks

CVidCell::FrameSet¶

int CVidCell::FrameSet(unsigned short nFrame);

Parameters

unsigned short nFrame -

Return Value

Returns int

Remarks

CVidCell::FXRender3d¶

int CVidCell::FXRender3d(
   int nRefPtX,
   int nRefPtY,
   CRect& rFXRect,
   CRect& rClip,
   unsigned long dwFlags,
   int bAlphaValues);

Parameters

int nRefPtX -
int nRefPtY -
CRect& rFXRect -
CRect& rClip -
unsigned long dwFlags -
int bAlphaValues -

Return Value

Returns int

Remarks

CVidCell::FXRender3d¶

int CVidCell::FXRender3d(
   int nRefPtX,
   int nRefPtY,
   CRect& rFXRect,
   unsigned long dwFlags,
   int nTransVal,
   int bAlphaValues);

Parameters

int nRefPtX -
int nRefPtY -
CRect& rFXRect -
unsigned long dwFlags -
int nTransVal -
int bAlphaValues -

Return Value

Returns int

Remarks

CVidCell::GetCurrentCenterPoint¶

int CVidCell::GetCurrentCenterPoint(CPoint& ptReference);

Parameters

CPoint& ptReference -

Return Value

Returns int

Remarks

CVidCell::GetCurrentFrameSize¶

int CVidCell::GetCurrentFrameSize(CSize& frameSize);

Parameters

CSize& frameSize -

Return Value

Returns int

Remarks

CVidCell::GetFrame¶

virtual int CVidCell::GetFrame();

Return Value

Returns int

Remarks

CVidCell::GetFrameSize¶

int CVidCell::GetFrameSize(
   short nSequence,
   short nFrame,
   CSize& frameSize);

Parameters

short nSequence -
short nFrame -
CSize& frameSize -

Return Value

Returns int

Remarks

CVidCell::GetNumberSequences¶

unsigned short CVidCell::GetNumberSequences();

Return Value

Returns unsigned short

Remarks

CVidCell::GetSequenceLength¶

unsigned char CVidCell::GetSequenceLength(unsigned short nSequence);

Parameters

unsigned short nSequence -

Return Value

Returns unsigned char

Remarks

CVidCell::IsEndOfSequence¶

int CVidCell::IsEndOfSequence();

Return Value

Returns int

Remarks

CVidCell::IsEndOfTwitchSequence¶

int CVidCell::IsEndOfTwitchSequence();

Return Value

Returns int

Remarks

CVidCell::RealizePalette¶

void CVidCell::RealizePalette(unsigned long dwFlags);

Parameters

unsigned long dwFlags -

Remarks

CVidCell::Render¶

virtual int CVidCell::Render(
   int x,
   int y,
   CRect& rClipping,
   CVidPoly* pClipPoly,
   int nPolys,
   unsigned long dwFlags,
   int nTransVal);

Parameters

int x -
int y -
CRect& rClipping -
CVidPoly* pClipPoly -
int nPolys -
unsigned long dwFlags -
int nTransVal -

Return Value

Returns int

Remarks

CVidCell::Render¶

virtual int CVidCell::Render(
   unsigned long* pSurface,
   long lPitch,
   int nRefPtX,
   int nRefPtY,
   CRect& rClip,
   unsigned long dwFlags,
   CPoint& ptSource);

Parameters

unsigned long* pSurface -
long lPitch -
int nRefPtX -
int nRefPtY -
CRect& rClip -
unsigned long dwFlags -
CPoint& ptSource -

Return Value

Returns int

Remarks

CVidCell::Render3d¶

int CVidCell::Render3d(
   int x,
   int y,
   CRect& rClipping,
   CRect& rScale,
   CVidPoly* pClipPoly,
   int nPolys,
   unsigned long dwFlags,
   int nTransVal);

Parameters

int x -
int y -
CRect& rClipping -
CRect& rScale -
CVidPoly* pClipPoly -
int nPolys -
unsigned long dwFlags -
int nTransVal -

Return Value

Returns int

Remarks

CVidCell::Render3d¶

int CVidCell::Render3d(
   int nRefPtX,
   int nRefPtY,
   CRect& rClip,
   unsigned long dwFlags);

Parameters

int nRefPtX -
int nRefPtY -
CRect& rClip -
unsigned long dwFlags -

Return Value

Returns int

Remarks

CVidCell::Render3d¶

int CVidCell::Render3d(
   int x,
   int y,
   CRect& rClipping,
   CVidPoly* pClipPoly,
   int nPolys,
   unsigned long dwFlags,
   int nTransVal);

Parameters

int x -
int y -
CRect& rClipping -
CVidPoly* pClipPoly -
int nPolys -
unsigned long dwFlags -
int nTransVal -

Return Value

Returns int

Remarks

CVidCell::RenderPVR¶

int CVidCell::RenderPVR(
   int x,
   int y,
   CRect& rClip,
   unsigned long dwFlags,
   int nTransVal);

Parameters

int x -
int y -
CRect& rClip -
unsigned long dwFlags -
int nTransVal -

Return Value

Returns int

Remarks

CVidCell::RenderTexture¶

virtual void __cdecl CVidCell::RenderTexture(
   int x,
   int y,
   CRect& rFxRect,
   CSize dataPitch,
   CRect& rClip,
   CRect& rScale,
   unsigned long dwFlags);

Parameters

int x -
int y -
CRect& rFxRect -
CSize dataPitch -
CRect& rClip -
CRect& rScale -
unsigned long dwFlags -

Remarks

CVidCell::RenderTexture¶

virtual void __cdecl CVidCell::RenderTexture(
   int x,
   int y,
   CRect& rFxRect,
   CSize dataPitch,
   CRect& rClip,
   unsigned long dwFlags);

Parameters

int x -
int y -
CRect& rFxRect -
CSize dataPitch -
CRect& rClip -
unsigned long dwFlags -

Remarks

CVidCell::SequenceSet¶

int CVidCell::SequenceSet(unsigned short nSequence);

Parameters

unsigned short nSequence -

Return Value

Returns int

Remarks

CVidCell::SetPalette¶

void CVidCell::SetPalette(CVidPalette& cPalette);

Parameters

CVidPalette& cPalette -

Remarks

CVidCell::SetPalette¶

void CVidCell::SetPalette(
   RGBQUAD* pRgbQuad,
   int nPaletteEntries,
   unsigned short nType);

Parameters

RGBQUAD* pRgbQuad -
int nPaletteEntries -
unsigned short nType -

Remarks

CVidCell::StoreBackground¶

virtual void CVidCell::StoreBackground(
   int srcx,
   int srcy,
   CRect& srcClip,
   CRect& rStorage,
   unsigned char bNumbered);

Parameters

int srcx -
int srcy -
CRect& srcClip -
CRect& rStorage -
unsigned char bNumbered -

Return Value

Returns

Remarks

CVidCell::SuppressTint¶

void CVidCell::SuppressTint(short nRange);

Parameters

short nRange -

Remarks

CVidCell::UnsuppressTint¶

void CVidCell::UnsuppressTint(short nRange);

Parameters

short nRange -

Remarks

Operators¶

Name	Description
CVidCell::operator=

CVidCell::operator=¶

CVidCell& CVidCell::operator=(CVidCell& __that);

Parameters

CVidCell& __that -

Return Value

Returns CVidCell&

Remarks