00001 // $Id: offattr.h 1282 2006-06-09 09:46:49Z alex $ 00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE 00003 ================================XARAHEADERSTART=========================== 00004 00005 Xara LX, a vector drawing and manipulation program. 00006 Copyright (C) 1993-2006 Xara Group Ltd. 00007 Copyright on certain contributions may be held in joint with their 00008 respective authors. See AUTHORS file for details. 00009 00010 LICENSE TO USE AND MODIFY SOFTWARE 00011 ---------------------------------- 00012 00013 This file is part of Xara LX. 00014 00015 Xara LX is free software; you can redistribute it and/or modify it 00016 under the terms of the GNU General Public License version 2 as published 00017 by the Free Software Foundation. 00018 00019 Xara LX and its component source files are distributed in the hope 00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the 00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 00022 See the GNU General Public License for more details. 00023 00024 You should have received a copy of the GNU General Public License along 00025 with Xara LX (see the file GPL in the root directory of the 00026 distribution); if not, write to the Free Software Foundation, Inc., 51 00027 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00028 00029 00030 ADDITIONAL RIGHTS 00031 ----------------- 00032 00033 Conditional upon your continuing compliance with the GNU General Public 00034 License described above, Xara Group Ltd grants to you certain additional 00035 rights. 00036 00037 The additional rights are to use, modify, and distribute the software 00038 together with the wxWidgets library, the wxXtra library, and the "CDraw" 00039 library and any other such library that any version of Xara LX relased 00040 by Xara Group Ltd requires in order to compile and execute, including 00041 the static linking of that library to XaraLX. In the case of the 00042 "CDraw" library, you may satisfy obligation under the GNU General Public 00043 License to provide source code by providing a binary copy of the library 00044 concerned and a copy of the license accompanying it. 00045 00046 Nothing in this section restricts any of the rights you have under 00047 the GNU General Public License. 00048 00049 00050 SCOPE OF LICENSE 00051 ---------------- 00052 00053 This license applies to this program (XaraLX) and its constituent source 00054 files only, and does not necessarily apply to other Xara products which may 00055 in part share the same code base, and are subject to their own licensing 00056 terms. 00057 00058 This license does not apply to files in the wxXtra directory, which 00059 are built into a separate library, and are subject to the wxWindows 00060 license contained within that directory in the file "WXXTRA-LICENSE". 00061 00062 This license does not apply to the binary libraries (if any) within 00063 the "libs" directory, which are subject to a separate license contained 00064 within that directory in the file "LIBS-LICENSE". 00065 00066 00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS 00068 ---------------------------------------------- 00069 00070 Subject to the terms of the GNU Public License (see above), you are 00071 free to do whatever you like with your modifications. However, you may 00072 (at your option) wish contribute them to Xara's source tree. You can 00073 find details of how to do this at: 00074 http://www.xaraxtreme.org/developers/ 00075 00076 Prior to contributing your modifications, you will need to complete our 00077 contributor agreement. This can be found at: 00078 http://www.xaraxtreme.org/developers/contribute/ 00079 00080 Please note that Xara will not accept modifications which modify any of 00081 the text between the start and end of this header (marked 00082 XARAHEADERSTART and XARAHEADEREND). 00083 00084 00085 MARKS 00086 ----- 00087 00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara 00089 designs are registered or unregistered trademarks, design-marks, and/or 00090 service marks of Xara Group Ltd. All rights in these marks are reserved. 00091 00092 00093 Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK. 00094 http://www.xara.com/ 00095 00096 =================================XARAHEADEREND============================ 00097 */ 00098 00099 #ifndef INC_OFFSCREENATTR 00100 #define INC_OFFSCREENATTR 00101 00102 // structs, typedefs, defines 00103 00104 // class definitions 00105 // 1 - call classes member functions, 00106 // 2 - use the class type for one of the members (not required if have pointer to class ??) 00107 // 3 - to derive a superclass?? 00108 //#include "attrval.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00109 #include "gla.h" 00110 00112 // class predeclarations 00114 class KernelBitmap; 00115 class GRenderRegion; 00116 00118 // debugging 00120 // Create a bitmap copy of the feathered object for comparison with the bitmap generated 00121 // via the offscreen rendering system (ie m_pOffscreenBitmapInfo/Bits inside GoingOutOfScope) 00122 // NB Set _DEBUG_OFFSCREEN_PIXEL_WIDTH, leave _DEBUG_OFFSCREEN_MP_WIDTH as is 00123 // ( See notes in fthrattr.cpp for useage guidelines ) 00124 //#define _DEBUG_OFFSCREEN_PIXEL_WIDTH 44 00125 //#define _DEBUG_OFFSCREEN_MP_WIDTH _DEBUG_OFFSCREEN_PIXEL_WIDTH * 750 00126 00128 // 00129 // Helper functions 00130 // 00132 // Conversion between millipoints and pixels at current view scale 00133 FIXED16 GetCurrentViewScale(); 00134 MILLIPOINT ConvertMeasurementToMillipointsAtCurrentViewScale(INT32 Width, UnitType type); 00135 UINT32 ConvertMillipointsToPixelsAtCurrentViewScale(MILLIPOINT mp); 00136 INT32 PixelsPerMeterAtCurrentViewScale(); 00137 00139 // 00140 // AttributeValue classes 00141 // 00143 00144 /******************************************************************************************** 00145 > class OffscreenAttrValue : public GeometryLinkedAttrValue 00146 Author: Ilan_Copelyn (Xara Group Ltd) <camelotdev@xara.com> 00147 Created: 2/06/2000 00148 Purpose: Provides a superclass from which you can derive attributes which require 00149 the nodes which they affect to be rendered offscreen. 00150 SeeAlso: 00151 Notes: This attribute is not meant to be instantated directly! 00152 It has no AttrIndex and is not added to the default attribute table 00153 when the attribute manager initialises itself 00154 ********************************************************************************************/ 00155 00156 class OffscreenAttrValue : public GeometryLinkedAttrValue 00157 { 00158 CC_DECLARE_DYNAMIC( OffscreenAttrValue ) 00159 00160 protected: 00161 OffscreenAttrValue(); // not meant to be instantiated directly 00162 public: 00163 ~OffscreenAttrValue(); 00164 00165 public: 00166 // Standard functions required by Attribute framework 00167 virtual BOOL IsDifferent(AttributeValue*); 00168 00169 // Karim 17/08/2000 00170 // This override is required so that the m_fForceTransparency flag is copied around. 00171 virtual void SimpleCopy(AttributeValue *pOther) 00172 { 00173 GeometryLinkedAttrValue::SimpleCopy(pOther); 00174 m_fForceTransparency = ((OffscreenAttrValue*)pOther)->m_fForceTransparency; 00175 } 00176 00177 // Generic attr rendering functions (rely on GRenderRegion offscreen rendering system to do the work) 00178 virtual void Restore(RenderRegion *, BOOL); 00179 virtual void Render(RenderRegion *, BOOL Temp = FALSE); 00180 00181 // Query function for GRenderRegion 00182 // virtual BOOL OffscreenBmpRectMayExceedViewableRect() { return FALSE; } // not used at the moment. might by required though 00183 virtual DocRect GetOffscreenBoundingRect(); 00184 virtual void SetOffscreenBoundingRect(const DocRect drOffBB) { m_OffBB = drOffBB; } 00185 00186 // Allow derived classes to overide integral parts of the offscreen bmp setup process 00187 virtual BOOL DoesOffscreenBmpRequireTransp(GRenderRegion* pGRR = NULL); 00188 BOOL TestNodeForTransparency(Node* pNode = NULL); 00189 virtual void GetMinimumOffscreenBmpDimensions(UINT32* RequiredWidth, UINT32* RequiredHeight) { *RequiredWidth=0;*RequiredHeight=0; } 00190 virtual BOOL DoesOffscreenBMPCaptureBackground() {return FALSE;} 00191 00192 // Karim 17/08/2000 - force this attr to always use a transparency-capable offscreen bmp. 00193 void SetAlwaysUseTransparency() { m_fForceTransparency = TRUE; } 00194 // Karim 17/08/2000 00195 // let this attr choose whether or not to use a transparency-capable offscreen bitmap. 00196 void UnsetAlwaysUseTransparency() { m_fForceTransparency = FALSE; } 00197 00198 // Overide this to use the offscreen bitmap 00199 virtual void OffscreenRenderingCompleted(RenderRegion *pRender, LPBITMAPINFO lpBitmapInfo, LPBYTE lpBits, DocRect BitmapRect) = 0; 00200 00201 //------------------------------------------------------------------------------------------------------------- 00202 // Debugging your offscreen attribute 00203 // 00204 #ifdef _DEBUG_OFFSCREEN_PIXEL_WIDTH 00205 protected: 00206 // Debugging function. Creates bitmap of a node using new GRenderBitmap RR. 00207 // Useful for comparing to offscreen bitmap. 00208 KernelBitmap* CreateIntermediateBitmap( GRenderRegion* GRR, Node* pNode, double ScreenResMultiplier, 00209 UINT32 bpp, BOOL UseInternalFmt ); 00210 BOOL RenderDebuggingBitmaps(GRenderRegion* GRR, Node* pNode, double ScreenResMultiplier, 00211 UINT32 bpp, BOOL UseInternalFmt ); 00212 #endif 00213 00214 protected: 00215 //------------------------------------------------------------------------------------------------------------- 00216 // Member Variables 00217 // 00218 00219 // Offscreen rendering attributes: 00220 DocRect m_OffBB; 00221 00222 // Karim 16/08/2000 00223 // a record of whether or not our linked node requires transparency. 00224 BOOL m_fForceTransparency; 00225 // DocRect m_ViewBB; 00226 00227 #ifdef _DEBUG_OFFSCREEN_PIXEL_WIDTH 00228 // Debugging members 00229 KernelBitmap* md_NodeBmp; 00230 KernelBitmap* md_SlicedBmp; 00231 #endif 00232 00233 00234 //------------------------------------------------------------------------------------------------------------- 00235 00236 #ifdef DEBUGOFFSCREENATTRS 00237 private: 00238 // Debug render-twice flag. See OffscreenAttrValue::Render() for more info. 00239 BOOL m_fHasBeenRendered; 00240 #endif 00241 }; 00242 00243 00244 #endif //INC_OFFSCREENATTR