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 BMessage *msg); 162 virtual void MouseUp(const BMessage *msg); 163 virtual void MouseMoved(const BMessage *msg); 164 virtual void MouseWheelChanged(const BMessage *msg); 165 166 virtual void KeyDown(const BMessage *msg); 167 virtual void KeyUp(const BMessage *msg); 168 virtual void UnmappedKeyDown(const BMessage *msg); 169 virtual void UnmappedKeyUp(const BMessage *msg); 170 virtual void ModifiersChanged(const BMessage *msg); 171 172 virtual void WorkspaceActivated(int32 index, bool active); 173 virtual void WorkspacesChanged(uint32 oldWorkspaces, uint32 newWorkspaces); 174 175 BPoint BoundsOrigin() const; // BoundsFrameDiff()? 176 float Scale() const; 177 178 BPoint ConvertToParent(BPoint pt); 179 BRect ConvertToParent(BRect rect); 180 BRegion ConvertToParent(BRegion* reg); 181 182 BPoint ConvertFromParent(BPoint pt); 183 BRect ConvertFromParent(BRect rect); 184 BRegion ConvertFromParent(BRegion* reg); 185 186 BPoint ConvertToTop(BPoint pt); 187 BRect ConvertToTop(BRect rect); 188 BRegion ConvertToTop(BRegion* reg); 189 190 BPoint ConvertFromTop(BPoint pt); 191 BRect ConvertFromTop(BRect rect); 192 BRegion ConvertFromTop(BRegion *reg); 193 194 195 DisplayDriver* GetDisplayDriver() const 196 { return fDriver; } 197 198 ServerWindow* Window() const 199 { return fServerWin; } 200 201 ServerApp* App() const 202 { return fServerWin? fServerWin->App(): NULL; } 203 204 inline WinBorder* Owner() const 205 { return fOwner; } 206 207 virtual bool HasClient() 208 { return true; } 209 210 uint32 EventMask() const 211 { return fEventMask; } 212 213 uint32 EventOptions() const 214 { return fEventOptions; } 215 216 inline void QuietlySetEventMask(uint32 em) 217 { fEventMask = em; } 218 219 inline void QuietlySetEventOptions(uint32 eo) 220 { fEventOptions = eo; } 221 222 void PruneTree(); 223 224 // debugging 225 void PrintToStream(); 226 void PrintNode(); 227 void PrintTree(); 228 229 // server "private" - should not be used 230 void SetAsTopLayer(bool option) 231 { fIsTopLayer = option; } 232 233 inline bool IsTopLayer() const 234 { return fIsTopLayer; } 235 236 BRegion* ClippingRegion() const 237 { return fClipReg; } 238 239 // automatic background blanking by app_server 240 void SetViewColor(const RGBColor& color); 241 inline const RGBColor& ViewColor() const 242 { return fViewColor; } 243 244 void SetBackgroundBitmap(const ServerBitmap* bitmap); 245 inline const ServerBitmap* BackgroundBitmap() const 246 { return fBackgroundBitmap; } 247 248 // overlay support 249 // TODO: This can't be all, what about color key? 250 void SetOverlayBitmap(const ServerBitmap* bitmap); 251 inline const ServerBitmap* OverlayBitmap() const 252 { return fOverlayBitmap; } 253 254 void CopyBits(BRect& src, BRect& dst, 255 int32 xOffset, int32 yOffset); 256 #ifndef NEW_CLIPPING 257 inline const BRegion& VisibleRegion() const { return fVisible; } 258 inline const BRegion& FullVisible() const { return fFullVisible; } 259 260 #else 261 inline const BRegion& VisibleRegion() const { return fVisible2; } 262 inline const BRegion& FullVisible() const { return fFullVisible2; } 263 264 virtual void GetWantedRegion(BRegion& reg) const; 265 266 virtual void MovedByHook(float dx, float dy); 267 virtual void ResizedByHook(float dx, float dy, bool automatic); 268 virtual void ScrolledByHook(float dx, float dy); 269 270 void ConvertToParent2(BPoint* pt) const; 271 void ConvertToParent2(BRect* rect) const; 272 void ConvertToParent2(BRegion* reg) const; 273 void ConvertFromParent2(BPoint* pt) const; 274 void ConvertFromParent2(BRect* rect) const; 275 void ConvertFromParent2(BRegion* reg) const; 276 277 void ConvertToScreen2(BPoint* pt) const; 278 void ConvertToScreen2(BRect* rect) const; 279 void ConvertToScreen2(BRegion* reg) const; 280 void ConvertFromScreen2(BPoint* pt) const; 281 void ConvertFromScreen2(BRect* rect) const; 282 void ConvertFromScreen2(BRegion* reg) const; 283 bool IsVisuallyHidden() const; 284 private: 285 void do_Hide(); 286 void do_Show(); 287 void do_RebuildVisibleRegions(const BRegion &invalid, 288 const Layer *startFrom); 289 void do_MoveBy(float dx, float dy); 290 void do_ResizeBy(float dx, float dy); 291 void do_ScrollBy(float dx, float dy); 292 293 void do_Invalidate( const BRegion &invalid, 294 const Layer *startFrom = NULL); 295 296 void do_Redraw( const BRegion &invalid, 297 const Layer *startFrom = NULL); 298 299 void rebuild_visible_regions(const BRegion &invalid, 300 const BRegion &parentLocalVisible, 301 const Layer *startFrom); 302 303 virtual void _ReserveRegions(BRegion ®); 304 virtual void _GetWantedRegion(BRegion ®); 305 306 void clear_visible_regions(); 307 void resize_layer_frame_by(float x, float y); 308 void rezize_layer_redraw_more(BRegion ®, float dx, float dy); 309 void resize_layer_full_update_on_resize(BRegion ®, float dx, float dy); 310 311 #endif 312 private: 313 void do_CopyBits(BRect& src, BRect& dst, 314 int32 xOffset, int32 yOffset); 315 316 protected: 317 friend class RootLayer; 318 friend class WinBorder; 319 friend class ServerWindow; 320 // TODO: remove, is here for debugging purposes only 321 friend class OffscreenWinBorder; 322 323 #ifndef NEW_CLIPPING 324 void move_layer(float x, float y); 325 void resize_layer(float x, float y); 326 327 void FullInvalidate(const BRect& rect); 328 void FullInvalidate(const BRegion& region); 329 void Invalidate(const BRegion& region); 330 #endif 331 332 BRect fFrame; 333 // TODO: should be removed or reused in a similar fashion 334 // to hold the accumulated origins from the graphics state stack. 335 // The same needs to be done for "scale". (Keeping an accumulated 336 // value.) 337 // BPoint fBoundsLeftTop; 338 WinBorder* fOwner; 339 340 Layer* fParent; 341 Layer* fPreviousSibling; 342 Layer* fNextSibling; 343 Layer* fFirstChild; 344 Layer* fLastChild; 345 346 mutable Layer* fCurrent; 347 348 #ifndef NEW_CLIPPING 349 BRegion fVisible; 350 BRegion fFullVisible; 351 BRegion fFull; 352 int8 fFrameAction; 353 #else 354 private: 355 BRegion fVisible2; 356 BRegion fFullVisible2; 357 protected: 358 #endif 359 BRegion* fClipReg; 360 361 ServerWindow* fServerWin; 362 BString fName; 363 int32 fViewToken; 364 uint32 fFlags; 365 uint32 fResizeMode; 366 uint32 fEventMask; 367 uint32 fEventOptions; 368 bool fHidden; 369 bool fIsTopLayer; 370 uint16 fAdFlags; 371 372 DisplayDriver* fDriver; 373 LayerData* fLayerData; 374 375 RootLayer* fRootLayer; 376 377 private: 378 void RequestDraw(const BRegion& reg, 379 Layer* startFrom); 380 ServerWindow* SearchForServerWindow(); 381 382 status_t SendUpdateMsg(BRegion& reg); 383 void AddToViewsWithInvalidCoords() const; 384 void SendViewCoordUpdateMsg() const; 385 386 RGBColor fViewColor; 387 388 const ServerBitmap* fBackgroundBitmap; 389 const ServerBitmap* fOverlayBitmap; 390 391 }; 392 393 #endif // _LAYER_H_ 394