1 //------------------------------------------------------------------------------ 2 // Copyright (c) 2001-2002, Haiku, Inc. 3 // 4 // Permission is hereby granted, free of charge, to any person obtaining a 5 // copy of this software and associated documentation files (the "Software"), 6 // to deal in the Software without restriction, including without limitation 7 // the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 // and/or sell copies of the Software, and to permit persons to whom the 9 // Software is furnished to do so, subject to the following conditions: 10 // 11 // The above copyright notice and this permission notice shall be included in 12 // all copies or substantial portions of the Software. 13 // 14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 // DEALINGS IN THE SOFTWARE. 21 // 22 // File Name: Layer.h 23 // Author: DarkWyrm <bpmagic@columbus.rr.com> 24 // Adi Oanca <adioanca@cotty.iren.com> 25 // Stephan Aßmus <superstippi@gmx.de> 26 // Description: Class used for rendering to the frame buffer. One layer per 27 // view on screen and also for window decorators 28 // 29 //------------------------------------------------------------------------------ 30 #ifndef _LAYER_H_ 31 #define _LAYER_H_ 32 33 #include <GraphicsDefs.h> 34 #include <List.h> 35 #include <Locker.h> 36 #include <OS.h> 37 #include <String.h> 38 #include <Rect.h> 39 #include <Region.h> 40 41 #include "RGBColor.h" 42 #include "ServerWindow.h" 43 44 //#define NEW_CLIPPING 1 45 46 enum { 47 B_LAYER_NONE = 1, 48 B_LAYER_MOVE = 2, 49 B_LAYER_SIMPLE_MOVE = 3, 50 B_LAYER_RESIZE = 4, 51 B_LAYER_MASK_RESIZE = 5, 52 }; 53 54 enum { 55 B_LAYER_ACTION_NONE = 0, 56 B_LAYER_ACTION_MOVE, 57 B_LAYER_ACTION_RESIZE 58 }; 59 60 enum { 61 B_LAYER_CHILDREN_DEPENDANT = 0x1000U, 62 }; 63 64 class ServerApp; 65 class RootLayer; 66 class DisplayDriver; 67 class LayerData; 68 class ServerBitmap; 69 70 class PointerEvent { 71 public: 72 int32 code; // B_MOUSE_UP, B_MOUSE_DOWN, B_MOUSE_MOVED, 73 // B_MOUSE_WHEEL_CHANGED 74 bigtime_t when; 75 BPoint where; 76 float wheel_delta_x; 77 float wheel_delta_y; 78 int32 modifiers; 79 int32 buttons; // B_PRIMARY_MOUSE_BUTTON, B_SECONDARY_MOUSE_BUTTON 80 // B_TERTIARY_MOUSE_BUTTON 81 int32 clicks; 82 }; 83 84 class Layer { 85 public: 86 Layer(BRect frame, const char* name, 87 int32 token, uint32 resize, 88 uint32 flags, DisplayDriver* driver); 89 virtual ~Layer(); 90 91 void AddChild(Layer* child, ServerWindow* serverWin); 92 void RemoveChild(Layer* child); 93 void RemoveSelf(); 94 bool HasChild(Layer* layer); 95 96 void SetRootLayer(RootLayer* rl) 97 { fRootLayer = rl; } 98 RootLayer* GetRootLayer() const 99 { return fRootLayer; } 100 101 uint32 CountChildren() const; 102 Layer* FindLayer(const int32 token); 103 Layer* LayerAt(const BPoint &pt, bool recursive = true); 104 105 virtual Layer* FirstChild() const; 106 virtual Layer* NextChild() const; 107 virtual Layer* PreviousChild() const; 108 virtual Layer* LastChild() const; 109 110 virtual void SetName(const char* name); 111 inline const char* Name() const 112 { return fName.String(); } 113 114 inline uint32 ResizeMode() const 115 { return fResizeMode; } 116 117 virtual void SetFlags(uint32 flags); 118 inline uint32 Flags() const 119 { return fFlags; } 120 121 #ifndef NEW_CLIPPING 122 virtual void RebuildFullRegion(); 123 void StartRebuildRegions(const BRegion& reg, 124 Layer* target, 125 uint32 action, 126 BPoint& pt); 127 128 void RebuildRegions(const BRegion& reg, 129 uint32 action, 130 BPoint pt, 131 BPoint ptOffset); 132 133 uint32 ResizeOthers(float x, float y, 134 BPoint coords[], 135 BPoint* ptOffset); 136 137 void EmptyGlobals(); 138 139 #endif 140 void Redraw(const BRegion& reg, 141 Layer* startFrom = NULL); 142 143 virtual void Draw(const BRect& r); 144 145 void Show(bool invalidate = true); 146 void Hide(bool invalidate = true); 147 bool IsHidden() const; 148 149 // graphic state 150 void PushState(); 151 void PopState(); 152 153 // coordinate system 154 BRect Bounds() const; 155 BRect Frame() const; 156 157 virtual void MoveBy(float x, float y); 158 virtual void ResizeBy(float x, float y); 159 virtual void ScrollBy(float x, float y); 160 161 virtual void MouseDown(const PointerEvent& evt); 162 virtual void MouseUp(const PointerEvent& evt); 163 virtual void MouseMoved(const PointerEvent& evt, uint32 transit); 164 virtual void WorkspaceActivated(int32 index, bool active); 165 virtual void WorkspacesChanged(uint32 oldWorkspaces, uint32 newWorkspaces); 166 167 BPoint BoundsOrigin() const; // BoundsFrameDiff()? 168 float Scale() const; 169 170 BPoint ConvertToParent(BPoint pt); 171 BRect ConvertToParent(BRect rect); 172 BRegion ConvertToParent(BRegion* reg); 173 174 BPoint ConvertFromParent(BPoint pt); 175 BRect ConvertFromParent(BRect rect); 176 BRegion ConvertFromParent(BRegion* reg); 177 178 BPoint ConvertToTop(BPoint pt); 179 BRect ConvertToTop(BRect rect); 180 BRegion ConvertToTop(BRegion* reg); 181 182 BPoint ConvertFromTop(BPoint pt); 183 BRect ConvertFromTop(BRect rect); 184 BRegion ConvertFromTop(BRegion *reg); 185 186 187 DisplayDriver* GetDisplayDriver() const 188 { return fDriver; } 189 190 ServerWindow* Window() const 191 { return fServerWin; } 192 193 ServerApp* App() const 194 { return fServerWin? fServerWin->App(): NULL; } 195 196 inline WinBorder* Owner() const 197 { return fOwner; } 198 199 virtual bool HasClient() 200 { return true; } 201 202 uint32 EventMask() const 203 { return fEventMask; } 204 205 uint32 EventOptions() const 206 { return fEventOptions; } 207 208 inline void QuietlySetEventMask(uint32 em) 209 { fEventMask = em; } 210 211 inline void QuietlySetEventOptions(uint32 eo) 212 { fEventOptions = eo; } 213 214 void PruneTree(); 215 216 // debugging 217 void PrintToStream(); 218 void PrintNode(); 219 void PrintTree(); 220 221 // server "private" - should not be used 222 void SetAsTopLayer(bool option) 223 { fIsTopLayer = option; } 224 225 inline bool IsTopLayer() const 226 { return fIsTopLayer; } 227 228 BRegion* ClippingRegion() const 229 { return fClipReg; } 230 231 // automatic background blanking by app_server 232 void SetViewColor(const RGBColor& color); 233 inline const RGBColor& ViewColor() const 234 { return fViewColor; } 235 236 void SetBackgroundBitmap(const ServerBitmap* bitmap); 237 inline const ServerBitmap* BackgroundBitmap() const 238 { return fBackgroundBitmap; } 239 240 // overlay support 241 // TODO: This can't be all, what about color key? 242 void SetOverlayBitmap(const ServerBitmap* bitmap); 243 inline const ServerBitmap* OverlayBitmap() const 244 { return fOverlayBitmap; } 245 246 void CopyBits(BRect& src, BRect& dst, 247 int32 xOffset, int32 yOffset); 248 #ifndef NEW_CLIPPING 249 inline const BRegion& VisibleRegion() const { return fVisible; } 250 inline const BRegion& FullVisible() const { return fFullVisible; } 251 252 #else 253 inline const BRegion& VisibleRegion() const { return fVisible2; } 254 inline const BRegion& FullVisible() const { return fFullVisible2; } 255 256 virtual void GetWantedRegion(BRegion& reg) const; 257 258 virtual void MovedByHook(float dx, float dy); 259 virtual void ResizedByHook(float dx, float dy, bool automatic); 260 virtual void ScrolledByHook(float dx, float dy); 261 262 void ConvertToParent2(BPoint* pt) const; 263 void ConvertToParent2(BRect* rect) const; 264 void ConvertToParent2(BRegion* reg) const; 265 void ConvertFromParent2(BPoint* pt) const; 266 void ConvertFromParent2(BRect* rect) const; 267 void ConvertFromParent2(BRegion* reg) const; 268 269 void ConvertToScreen2(BPoint* pt) const; 270 void ConvertToScreen2(BRect* rect) const; 271 void ConvertToScreen2(BRegion* reg) const; 272 void ConvertFromScreen2(BPoint* pt) const; 273 void ConvertFromScreen2(BRect* rect) const; 274 void ConvertFromScreen2(BRegion* reg) const; 275 bool IsVisuallyHidden() const; 276 private: 277 void do_Hide(); 278 void do_Show(); 279 void do_RebuildVisibleRegions(const BRegion &invalid, 280 const Layer *startFrom); 281 void do_MoveBy(float dx, float dy); 282 void do_ResizeBy(float dx, float dy); 283 void do_ScrollBy(float dx, float dy); 284 285 void do_Invalidate( const BRegion &invalid, 286 const Layer *startFrom = NULL); 287 288 void do_Redraw( const BRegion &invalid, 289 const Layer *startFrom = NULL); 290 291 void rebuild_visible_regions(const BRegion &invalid, 292 const BRegion &parentLocalVisible, 293 const Layer *startFrom); 294 295 virtual void _ReserveRegions(BRegion ®); 296 virtual void _GetWantedRegion(BRegion ®); 297 298 void clear_visible_regions(); 299 void resize_layer_frame_by(float x, float y); 300 void rezize_layer_redraw_more(BRegion ®, float dx, float dy); 301 void resize_layer_full_update_on_resize(BRegion ®, float dx, float dy); 302 303 #endif 304 private: 305 void do_CopyBits(BRect& src, BRect& dst, 306 int32 xOffset, int32 yOffset); 307 308 protected: 309 friend class RootLayer; 310 friend class WinBorder; 311 friend class ServerWindow; 312 // TODO: remove, is here for debugging purposes only 313 friend class OffscreenWinBorder; 314 315 #ifndef NEW_CLIPPING 316 void move_layer(float x, float y); 317 void resize_layer(float x, float y); 318 319 void FullInvalidate(const BRect& rect); 320 void FullInvalidate(const BRegion& region); 321 void Invalidate(const BRegion& region); 322 #endif 323 324 BRect fFrame; 325 // TODO: should be removed or reused in a similar fashion 326 // to hold the accumulated origins from the graphics state stack. 327 // The same needs to be done for "scale". (Keeping an accumulated 328 // value.) 329 // BPoint fBoundsLeftTop; 330 WinBorder* fOwner; 331 332 Layer* fParent; 333 Layer* fPreviousSibling; 334 Layer* fNextSibling; 335 Layer* fFirstChild; 336 Layer* fLastChild; 337 338 mutable Layer* fCurrent; 339 340 #ifndef NEW_CLIPPING 341 BRegion fVisible; 342 BRegion fFullVisible; 343 BRegion fFull; 344 int8 fFrameAction; 345 #else 346 private: 347 BRegion fVisible2; 348 BRegion fFullVisible2; 349 protected: 350 #endif 351 BRegion* fClipReg; 352 353 ServerWindow* fServerWin; 354 BString fName; 355 int32 fViewToken; 356 uint32 fFlags; 357 uint32 fResizeMode; 358 uint32 fEventMask; 359 uint32 fEventOptions; 360 bool fHidden; 361 bool fIsTopLayer; 362 uint16 fAdFlags; 363 364 DisplayDriver* fDriver; 365 LayerData* fLayerData; 366 367 RootLayer* fRootLayer; 368 369 private: 370 void RequestDraw(const BRegion& reg, 371 Layer* startFrom); 372 ServerWindow* SearchForServerWindow(); 373 374 void SendUpdateMsg(BRegion& reg); 375 void AddToViewsWithInvalidCoords() const; 376 void SendViewCoordUpdateMsg() const; 377 378 RGBColor fViewColor; 379 380 const ServerBitmap* fBackgroundBitmap; 381 const ServerBitmap* fOverlayBitmap; 382 383 }; 384 385 #endif // _LAYER_H_ 386