GRenderClickColour Class Reference

Special version of a GRenderClick that renders into a colour bitmap. It is used for colour picker hit-detection/pixel colour detection only. More...

#include <grndclik.h>

Inheritance diagram for GRenderClickColour:

List of all members.

Public Member Functions
	GRenderClickColour (DocRect ClipRegion, Matrix ConvertMatrix, FIXED16 ViewScale, UINT32 Depth, double dpi)
	Constructor. Most important jobs are to set the VeryMono flag to FALSE, and to set m_DoCompression = TRUE to ensure correct handling of transparencies.
	~GRenderClickColour ()
	Destructor. Simple cleanup, which involves calling our base classes.
virtual void	DebugMe (INT32 Stretch)
	Dumps the current bitmap onto the current view window, so we can see what is going on. Do not call directly, use OSRenderBitmap::DebugMe.
Pixel32bpp	GetCentrePixel32BPP ()
	This sexy little function is what makes my custom colour picker control read the TRUE 32-bit document colour.
Pixel32bpp	GetAveragePixel32BPP ()
	To find the colour under the pointer, taking the differences of pixels around the centre pixel into account.
Protected Member Functions
virtual BitmapContents	GetContents (BOOL JustMiddle)
	To investigate whether anything has been rendered into a bitmap-based render region. Don't call directly, use OSRenderBitmap::GetContents.
Private Member Functions
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.
Friends
class	OSRenderBitmap

---

Detailed Description

Special version of a GRenderClick that renders into a colour bitmap. It is used for colour picker hit-detection/pixel colour detection only.

Author:

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

Date:

27/10/99

Definition at line 165 of file grndclik.h.

---

Constructor & Destructor Documentation

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

Constructor. Most important jobs are to set the VeryMono flag to FALSE, and to set m_DoCompression = TRUE to ensure correct handling of transparencies. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/99 Parameters: A  clip region, conversion matrix, scale and bitmap depth. [INPUTS] None  [OUTPUTS] Returns: None Do not call directly, use OSRenderBitmap::Create Definition at line 157 of file grndclik.cpp. : GRenderClick(ClipRegion, ConvertMatrix, ViewScale, Depth, dpi) { RenderFlags.VeryMono = FALSE; // simple black&white rendering NOT !!!!! RenderFlags.HitDetect = FALSE; m_DoCompression = TRUE; }

GRenderClickColour::~GRenderClickColour (   )

Destructor. Simple cleanup, which involves calling our base classes. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/99 Definition at line 230 of file grndclik.cpp. : ~GRenderClick() { }

---

Member Function Documentation

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

Most work done in base class, except for the creation of a CCDC member. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/99 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 GRenderClick. Reimplemented in GRenderClickColourNoPaper. Definition at line 664 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_COLOURBITMAP ); } CATCH (CMemoryException, e) { // Ooer - not enough memory TRACEALL( _T("No memory for CCDC in GRenderClickColour::AttachDevice") ); return FALSE; } END_CATCH */ RenderDC = new wxBufferedDC() ; m_fOwned = true; return TRUE; }

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

Dumps the current bitmap onto the current view window, so we can see what is going on. Do not call directly, use OSRenderBitmap::DebugMe. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/99 Parameters: How  much you want the image stretched by [INPUTS] See also: OSRenderBitmap::DebugMe Reimplemented from GRenderClick. Definition at line 560 of file grndclik.cpp. { #if defined(_DEBUG) && 0 // GAT const INT32 w = WRect.right - WRect.left; const INT32 h = WRect.bottom - WRect.top; INT32 Offset = (Stretch/100) * w * (Stretch%100); Stretch = Stretch%100; // DIBUtil::InvertAlpha(lpBitmapInfo, lpBits); DWORD oldComp = lpBitmapInfo->bmiHeader.biCompression; lpBitmapInfo->bmiHeader.biCompression = BI_RGB; INT32 ret = ::StretchDIBits( RenderDC->m_hDC, 0,0, w*Stretch, h*Stretch, 0,0,w,h, lpBits, lpBitmapInfo, DIB_RGB_COLORS, SRCCOPY ); lpBitmapInfo->bmiHeader.biCompression = oldComp; // DIBUtil::InvertAlpha(lpBitmapInfo, lpBits); #endif }

Pixel32bpp GRenderClickColour::GetAveragePixel32BPP (   )

To find the colour under the pointer, taking the differences of pixels around the centre pixel into account. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 14/10/2004 Parameters: -  [INPUTS] Pix  - 32bpp value of average colour in GRenderClickColour bitmap [OUTPUTS] Returns: - See also: OSRenderBitmap::GetContents Definition at line 478 of file grndclik.cpp. { Pixel32bpp Pix; INT32 Blue = pMiddle [0]; // Give centre pixel more weight by initialising average INT32 Green = pMiddle [1]; INT32 Red = pMiddle [2]; INT32 Alpha = pMiddle [3]; // not in the middle - if any byte is not 0xFF then something must have been // rendered LPBYTE pSearch = pBits; UINT32 Count = pBitmapInfo->bmiHeader.biSizeImage >> 2; UINT32 size = Count+1; while (Count--) { Blue += pSearch[0]; Green += pSearch[1]; Red += pSearch[2]; Alpha += pSearch[3]; pSearch += 4; } //TRACEUSER( "Phil", _T("AvgPix1 B=%d G=%d R=%d A=%d\n"), Blue, Green, Red, Alpha); Pix.Blue = Blue/size; Pix.Green = Green/size; Pix.Red = Red/size; Pix.Alpha = Alpha/size; //TRACEUSER( "Phil", _T("AvgPix2 B=%d G=%d R=%d A=%d\n"), Pix.Blue, Pix.Green, Pix.Red, Pix.Alpha); return Pix; }

Pixel32bpp GRenderClickColour::GetCentrePixel32BPP (   )

This sexy little function is what makes my custom colour picker control read the TRUE 32-bit document colour. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/99 Parameters: Pix  --- reference to variable that colour information will be returned in. [INPUTS] This is created internally by the custom colour picker control. Pix  (via reference) [OUTPUTS] See also: NodeRenderableInk::FindSimpleAtPointForColourPicker ccolpick.cpp Definition at line 447 of file grndclik.cpp. { Pixel32bpp Pix; Pix.Alpha = 0; // Generally there is no alpha channel, so set it to a default // grab the centre pixels TRUE 32-bit value .... Pix.Blue = pMiddle [0]; // pointer to byte of centre pixel Pix.Green = pMiddle [1]; Pix.Red = pMiddle [2]; Pix.Alpha = pMiddle [3]; return Pix; }

BitmapContents GRenderClickColour::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> (Phil 16/03/2004) 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 from GRenderClick. Definition at line 391 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? BYTE middleT = pMiddle[3]; // Read transp channel if (middleT < GRenderRegion::ClickTranspLimit) 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 LPBYTE pSearch = pBits; size_t Count = pBitmapInfo->bmiHeader.biSizeImage >> 2; while (Count--) { if (pSearch[3] < GRenderRegion::ClickTranspLimit) return BITMAPCONTENTS_ANY; pSearch += 4; } // else nothing rendered } } return BITMAPCONTENTS_NONE; }

BOOL GRenderClickColour::StartRender (  void   )  [private, virtual]

Most work done in base class, except for the calculation of the address & mask of the centre pixel. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 15/11/94 Returns: TRUE if worked, FALSE if failed. Reimplemented from GRenderClick. Definition at line 792 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; UINT32 scanlineSize = DIBUtil::ScanlineSize( w, 32 ); // address is pretty easy GRenderClick::pMiddle = pBits + (h/2)*scanlineSize; GRenderClick::pMiddle += (w/2) * 32/8; // Bytes per pixel // The following is immaterial in 32BPP bitmaps... // 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 from GRenderClick. Reimplemented in GRenderClickColourNoPaper. Definition at line 167 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)

---