Panda3D
pgScrollFrame.h
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file pgScrollFrame.h
10  * @author drose
11  * @date 2005-08-17
12  */
13 
14 #ifndef PGSCROLLFRAME_H
15 #define PGSCROLLFRAME_H
16 
17 #include "pandabase.h"
18 
19 #include "pgVirtualFrame.h"
20 #include "pgSliderBarNotify.h"
21 #include "pgSliderBar.h"
22 
23 #ifdef PHAVE_ATOMIC
24 #include <atomic>
25 #endif
26 
27 /**
28  * This is a special kind of frame that pretends to be much larger than it
29  * actually is. You can scroll through the frame, as if you're looking
30  * through a window at the larger frame beneath. All children of this frame
31  * node are scrolled and clipped as if they were children of the larger,
32  * virtual frame.
33  *
34  * This is implemented as a specialization of PGVirtualFrame, which handles
35  * the meat of the virtual canvas. This class adds automatic support for
36  * scroll bars, and restricts the virtual transform to translate only (no
37  * scale or rotate).
38  */
39 class EXPCL_PANDA_PGUI PGScrollFrame : public PGVirtualFrame, public PGSliderBarNotify {
40 PUBLISHED:
41  explicit PGScrollFrame(const std::string &name = "");
42  virtual ~PGScrollFrame();
43 
44 protected:
45  PGScrollFrame(const PGScrollFrame &copy);
46 
47 public:
48  virtual PandaNode *make_copy() const;
49  virtual bool cull_callback(CullTraverser *trav, CullTraverserData &data);
50  virtual void xform(const LMatrix4 &mat);
51 
52 PUBLISHED:
53  void setup(PN_stdfloat width, PN_stdfloat height,
54  PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top,
55  PN_stdfloat slider_width, PN_stdfloat bevel);
56 
57  INLINE void set_virtual_frame(PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top);
58  INLINE void set_virtual_frame(const LVecBase4 &virtual_frame);
59  INLINE const LVecBase4 &get_virtual_frame() const;
60  INLINE bool has_virtual_frame() const;
61  INLINE void clear_virtual_frame();
62 
63  INLINE void set_manage_pieces(bool manage_pieces);
64  INLINE bool get_manage_pieces() const;
65 
66  INLINE void set_auto_hide(bool auto_hide);
67  INLINE bool get_auto_hide() const;
68 
69  INLINE void set_horizontal_slider(PGSliderBar *horizontal_slider);
70  INLINE void clear_horizontal_slider();
71  INLINE PGSliderBar *get_horizontal_slider() const;
72 
73  INLINE void set_vertical_slider(PGSliderBar *vertical_slider);
74  INLINE void clear_vertical_slider();
75  INLINE PGSliderBar *get_vertical_slider() const;
76 
77  void remanage();
78  INLINE void recompute();
79 
80 protected:
81  virtual void frame_changed();
82 
83  virtual void item_transform_changed(PGItem *item);
84  virtual void item_frame_changed(PGItem *item);
85  virtual void item_draw_mask_changed(PGItem *item);
86  virtual void slider_bar_adjust(PGSliderBar *slider_bar);
87 
88 private:
89  void recompute_clip();
90 
91  void recompute_canvas();
92  PN_stdfloat interpolate_canvas(PN_stdfloat clip_min, PN_stdfloat clip_max,
93  PN_stdfloat canvas_min, PN_stdfloat canvas_max,
94  PGSliderBar *slider_bar);
95 
96 private:
97  bool _needs_remanage;
98  bool _needs_recompute_clip;
99  std::atomic_flag _canvas_computed;
100 
101  bool _has_virtual_frame;
102  LVecBase4 _virtual_frame;
103 
104  bool _manage_pieces;
105  bool _auto_hide;
106 
107  PT(PGSliderBar) _horizontal_slider;
108  PT(PGSliderBar) _vertical_slider;
109 
110 public:
111  static TypeHandle get_class_type() {
112  return _type_handle;
113  }
114  static void init_type() {
115  PGVirtualFrame::init_type();
116  register_type(_type_handle, "PGScrollFrame",
117  PGVirtualFrame::get_class_type());
118  }
119  virtual TypeHandle get_type() const {
120  return get_class_type();
121  }
122  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
123 
124 private:
125  static TypeHandle _type_handle;
126 };
127 
128 #include "pgScrollFrame.I"
129 
130 #endif
pgVirtualFrame.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PGVirtualFrame::setup
void setup(PN_stdfloat width, PN_stdfloat height)
Creates a PGVirtualFrame with the indicated dimensions.
Definition: pgVirtualFrame.cxx:115
PGItem
This is the base class for all the various kinds of gui widget objects.
Definition: pgItem.h:53
pandabase.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
register_type
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(),...
Definition: register_type.I:22
CullTraverser
This object performs a depth-first traversal of the scene graph, with optional view-frustum culling,...
Definition: cullTraverser.h:45
PGSliderBar
This is a particular kind of PGItem that draws a little bar with a slider that moves from left to rig...
Definition: pgSliderBar.h:31
pgSliderBarNotify.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
TypeHandle
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
pgSliderBar.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PGSliderBarNotify
Objects that inherit from this class can receive notify messages when a slider bar moves or otherwise...
Definition: pgSliderBarNotify.h:26
CullTraverserData
This collects together the pieces of data that are accumulated for each node while walking the scene ...
Definition: cullTraverserData.h:40
PGScrollFrame
This is a special kind of frame that pretends to be much larger than it actually is.
Definition: pgScrollFrame.h:39
PGVirtualFrame
This represents a frame that is rendered as a window onto another (possibly much larger) canvas.
Definition: pgVirtualFrame.h:43
pgScrollFrame.I
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PandaNode
A basic node of the scene graph or data graph.
Definition: pandaNode.h:64