GRenderClick Class Reference

Special version of a GRenderRegion that renders into a mono bitmap. It is used for hit-detection only. It can also be asked if it is 'blank'. More...

#include <grndclik.h>

Inheritance diagram for GRenderClick:

List of all members.

Public Member Functions
	GRenderClick (DocRect ClipRegion, Matrix ConvertMatrix, FIXED16 ViewScale, UINT32 Depth, double dpi)
	Constructor. Most important job is to set the VeryMono flag. Do not call directly, use OSRenderBitmap::Create INT32 dpi changed to double dpi (12/12/95) to improve the range of values allowed at the < 1000dpi settings that we will be using.
	~GRenderClick ()
	Destructor. Simple cleanup, which involves deleting the RenderDC.
virtual void	DebugMe (INT32 Stretch)
	Dupms the current bitmap onto the current view window, so we can see what is going on. Do not call directly, use OSRenderBitmap::DebugMe.
virtual BOOL	ImmediateRender ()
	Used to Draw something immediately.
virtual BOOL	SetFirstBand ()
	Sets up for banded rendering. This class does not do banded rendering as yet. This just sets things up to indicate that everything will be done in one band.
virtual BOOL	GetNextBand ()
	Since this class does not do banded rendering, there are never any more bands.
Protected Member Functions
LPBITMAPINFO	GetLPBits (INT32 Width, INT32 Height, INT32 Depth, LPBYTE *)
	Allocates a bitmap from the CCMalloc heap.
void	FreeLPBits (LPBITMAPINFO, LPBYTE)
	Frees the memory allocated in GetLPBits.
virtual BitmapContents	GetContents (BOOL)
	To investigate whether anything has been rendered into a bitmap-based render region. Don't call directly, use OSRenderBitmap::GetContents.
BOOL	DisplayBits (LPBITMAPINFO lpDisplayBitmapInfo=NULL, LPBYTE lpDisplayBits=NULL)
	Supposed to dump bitmap on screen, but that makes no sense for this bitmap so it just does nothing and always returns TRUE.
virtual void	SetClean (BOOL bResetChangedBounds, BOOL FillWhite)
	Clears out the RR, both logically and (optionally) physically).
BOOL	AttachDevice (View *, wxDC *, Spread *SpreadToAttach=NULL, bool fOwned=false)
	Most work done in base class, except for the creation of a CCDC member.
BOOL	StartRender ()
	Most work done in base class, except for the calculation of the address & mask of the centre pixel.
Protected Attributes
LPBYTE	pMiddle
BYTE	MiddleMask
BOOL	ClearOnStart
Friends
class	OSRenderBitmap

---

Detailed Description

Special version of a GRenderRegion that renders into a mono bitmap. It is used for hit-detection only. It can also be asked if it is 'blank'.

Author:

Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com>

Date:

15/11/94

Definition at line 118 of file grndclik.h.

---

Constructor & Destructor Documentation

GRenderClick::GRenderClick (  DocRect  ClipRegion, Matrix  ConvertMatrix, FIXED16  ViewScale, UINT32  Depth, double  dpi )

Constructor. Most important job is to set the VeryMono flag. Do not call directly, use OSRenderBitmap::Create INT32 dpi changed to double dpi (12/12/95) to improve the range of values allowed at the < 1000dpi settings that we will be using. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Parameters: A  clip region, conversion matrix, scale and bitmap depth. [INPUTS] None  [OUTPUTS] Returns: None Definition at line 131 of file grndclik.cpp. : GRenderDIB(ClipRegion, ConvertMatrix, ViewScale, Depth, dpi) { pMiddle = NULL; // just in case used before set up RenderFlags.VeryMono = TRUE; // simple black&white rendering ClearOnStart = FALSE; }

GRenderClick::~GRenderClick (   )

Destructor. Simple cleanup, which involves deleting the RenderDC. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Definition at line 204 of file grndclik.cpp. { // Free up the bitmap here, as the call to FreeLPBits in the // GRenderDIB will not call the correct version (the virtual-ness will be // broken as it is called from a destructor if (pBitmapInfo!=NULL) { // FreeLPBits( lpBitmapInfo, lpBits ); FreeOffscreenState(); pBitmapInfo = NULL; pBits = NULL; } }

---

Member Function Documentation

BOOL GRenderClick::AttachDevice (  View *  pView, wxDC *  DCToAttach, Spread *  SpreadToAttach = NULL, bool  fOwned = false )  [protected, virtual]

Most work done in base class, except for the creation of a CCDC member. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Parameters: pView  is used for debug purposes only. DCToAttach is used as a [INPUTS] reference when making the bitmap. Returns: FALSE if failed (no mem for bitmap or CCDC), TRUE if OK Reimplemented from GRenderRegion. Reimplemented in GRenderClickColour, and GRenderClickColourNoPaper. Definition at line 619 of file grndclik.cpp. { // call base class first if (!GRenderDIB::AttachDevice(pView, DCToAttach, SpreadToAttach, fOwned)) return FALSE; // now replace the usual RenderDC with our new one. This makes the type of the CCDC // correct, so Quality rendering works correctly, for example. /* TRY { // IMPORTANT: we 'borrow' the HDC from DCToAttach. We must take care when // deleting this not to delete the HDCs (see the constructor). RenderDC = new CCDC( DCToAttach, RENDERTYPE_MONOBITMAP ); } CATCH (CMemoryException, e) { // Ooer - not enough memory TRACEALL( _T("No memory for CCDC in GRenderClick::AttachDevice") ); return FALSE; } END_CATCH */ RenderDC = new wxBufferedDC() ; m_fOwned = true; return TRUE; }

void GRenderClick::DebugMe (  INT32  Stretch  )  [virtual]

Dupms the current bitmap onto the current view window, so we can see what is going on. Do not call directly, use OSRenderBitmap::DebugMe. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: How  much you want the image stretched by [INPUTS] See also: OSRenderBitmap::DebugMe Reimplemented in GRenderClickColour. Definition at line 525 of file grndclik.cpp. { #if defined(_DEBUG) && 0 // GAT DWORD *rgb = (DWORD*)lpBitmapInfo->bmiColors; rgb[0] = RGB(0,0,0); rgb[1] = RGB(255,255,255); const INT32 w = WRect.width; const INT32 h = WRect.height; ::StretchDIBits( RenderDC->m_hDC, 0,0, w*Stretch, h*Stretch, 0,0,w,h, lpBits, lpBitmapInfo, DIB_RGB_COLORS, SRCCOPY ); #endif }

BOOL GRenderClick::DisplayBits (  LPBITMAPINFO  lpDisplayBitmapInfo = NULL, LPBYTE  lpDisplayBits = NULL )  [protected, virtual]

Supposed to dump bitmap on screen, but that makes no sense for this bitmap so it just does nothing and always returns TRUE. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Returns: TRUE always (cannot fail). Reimplemented from GRenderDIB. Definition at line 599 of file grndclik.cpp. { return TRUE; }

void GRenderClick::FreeLPBits (  LPBITMAPINFO  lpBMI, LPBYTE  lpB )  [protected, virtual]

Frees the memory allocated in GetLPBits. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 5/5/95 Reimplemented from GRenderDIB. Definition at line 906 of file grndclik.cpp. { // Free up the memory. Not from Limited Heap FreeDIB(lpBMI, lpB, NULL, FALSE); }

BitmapContents GRenderClick::GetContents (  BOOL  JustMiddle  )  [protected, virtual]

To investigate whether anything has been rendered into a bitmap-based render region. Don't call directly, use OSRenderBitmap::GetContents. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Parameters: If  justmiddle is TRUE, only checks on the centre pixel will be done (which [INPUTS] is faster). None  [OUTPUTS] Returns: BITMAPCONTENTS_CENTRE if centre pixel is set, _ANY if any pixel is set, _NONE if none and _ERROR if failed for some reason. See also: OSRenderBitmap::GetContents Reimplemented in GRenderClickColour. Definition at line 335 of file grndclik.cpp. { RECT UsedRect; if ( HaveRenderedSomething && (GetDrawContext()->GetChangedBBox( &UsedRect )) ) { if ( (UsedRect.right > UsedRect.left) || (UsedRect.top < UsedRect.bottom) ) { // something has been drawn - is it the middle? if ( (*pMiddle & MiddleMask) == 0) return BITMAPCONTENTS_CENTRE; // if only interested in centre pixel then we're out of here if (JustMiddle) return BITMAPCONTENTS_NONE; // not in the middle - if any byte is not 0xFF then something must have been // rendered LPDWORD Search = (LPDWORD)pBits; size_t Count = pBitmapInfo->bmiHeader.biSizeImage >> 2; while (Count--) { if (*Search != 0xFFFFFFFF) return BITMAPCONTENTS_ANY; Search++; } // else nothing rendered } } return BITMAPCONTENTS_NONE; }

LPBITMAPINFO GRenderClick::GetLPBits (  INT32  Width, INT32  Height, INT32  Depth, LPBYTE *  lplpBits )  [protected, virtual]

Allocates a bitmap from the CCMalloc heap. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 5/5/95 Parameters: Width,Height  - the width and height of the required bitmap [INPUTS] Depth - the bpp of the bitmap Returns: Pointer to a bitmap header block Reimplemented from GRenderDIB. Definition at line 883 of file grndclik.cpp. { // Get a DIB out of the CCMalloc heap LPBITMAPINFO bmInfo = NULL; bmInfo = AllocDIB( Width, Height, Depth, lplpBits, NULL, FALSE); // return it. return bmInfo; }

BOOL GRenderClick::GetNextBand (   )  [virtual]

Since this class does not do banded rendering, there are never any more bands. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 5/5/95 Returns: FALSE Reimplemented from GRenderDIB. Definition at line 862 of file grndclik.cpp. { // No banding return FALSE; }

BOOL GRenderClick::ImmediateRender (   )  [virtual]

Used to Draw something immediately. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 18/03/2004 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if current clip rect is within view (ie whether to render or not). Errors: - See also: - Reimplemented from RenderRegion. Definition at line 272 of file grndclik.cpp. { RenderFlags.bImmediateRender = TRUE; if (!StartRender()) return FALSE; // Set no funny attributes - let the hit test rendering do all that return TRUE; }

void GRenderClick::SetClean (  BOOL  bResetChangedBounds, BOOL  FillWhite )  [protected, virtual]

Clears out the RR, both logically and (optionally) physically). Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Parameters: FillWhite  TRUE for fill with white, FALSE to leave contents alone. [INPUTS] Reimplemented from GRenderRegion. Definition at line 296 of file grndclik.cpp. { // Do the normal cleaning process GRenderDIB::SetClean(bResetChangedBounds, FillWhite); // and if asked, mark the rr as needing clearing ClearOnStart = FillWhite; // Damn well clear it NOW! if (ClearOnStart) { // Set it to white if (pBits!=NULL) memset(pBits, 0xFF, pBitmapInfo->bmiHeader.biSizeImage); // Dont do it next time please ClearOnStart = FALSE; } }

BOOL GRenderClick::SetFirstBand (   )  [virtual]

Sets up for banded rendering. This class does not do banded rendering as yet. This just sets things up to indicate that everything will be done in one band. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 5/5/95 Returns: TRUE Reimplemented from GRenderDIB. Definition at line 840 of file grndclik.cpp. { // No Banding needed IsRegionBanded = FALSE; IsWaitingForRAM = FALSE; IsLastBand = TRUE; return TRUE; }

BOOL GRenderClick::StartRender (  void   )  [protected, virtual]

Most work done in base class, except for the calculation of the address & mask of the centre pixel. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Returns: TRUE if worked, FALSE if failed. Reimplemented from GRenderRegion. Reimplemented in GRenderClickColour. Definition at line 749 of file grndclik.cpp. { if (!GRenderDIB::StartRender()) return FALSE; // work out the address & mask of the centre pixel const INT32 w = WRect.width; const INT32 h = WRect.height; // address is pretty easy pMiddle = pBits + (h/2)*DIBUtil::ScanlineSize( w, 1 ); pMiddle += ((w/2)/8); // bit within byte is also reasonably straight-forward (and should be independent of // byte-sex) MiddleMask = (BYTE) ( (INT32)0x80 >> ((w/2)&7) ); // If we have been asked to clear out the contents of the bmp, then do it if (ClearOnStart) { // Set it to white if (pBits!=NULL) memset(pBits, 0xFF, pBitmapInfo->bmiHeader.biSizeImage); // Dont do it next time please ClearOnStart = FALSE; } return TRUE; }

---

Friends And Related Function Documentation

friend class OSRenderBitmap [friend]

Reimplemented in GRenderClickColour, and GRenderClickColourNoPaper. Definition at line 120 of file grndclik.h.

---

Member Data Documentation

BOOL GRenderClick::ClearOnStart [protected]

Definition at line 151 of file grndclik.h.

BYTE GRenderClick::MiddleMask [protected]

Definition at line 148 of file grndclik.h.

LPBYTE GRenderClick::pMiddle [protected]

Definition at line 147 of file grndclik.h.

---

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

• wxOil/grndclik.h (r1785/r751)
• wxOil/grndclik.cpp (r1785/r1282)

---