CBitmap.h
Go to the documentation of this file.
1 //==============================================================================
2 /*
3  Software License Agreement (BSD License)
4  Copyright (c) 2003-2016, CHAI3D.
5  (www.chai3d.org)
6 
7  All rights reserved.
8 
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions
11  are met:
12 
13  * Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 
16  * Redistributions in binary form must reproduce the above
17  copyright notice, this list of conditions and the following
18  disclaimer in the documentation and/or other materials provided
19  with the distribution.
20 
21  * Neither the name of CHAI3D nor the names of its contributors may
22  be used to endorse or promote products derived from this software
23  without specific prior written permission.
24 
25  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  POSSIBILITY OF SUCH DAMAGE.
37 
38  \author <http://www.chai3d.org>
39  \author Francois Conti
40  \version 3.2.0 $Rev: 1869 $
41 */
42 //==============================================================================
43 
44 //------------------------------------------------------------------------------
45 #ifndef CBitmapH
46 #define CBitmapH
47 //------------------------------------------------------------------------------
48 #include "widgets/CPanel.h"
49 //------------------------------------------------------------------------------
50 
51 //------------------------------------------------------------------------------
52 namespace chai3d {
53 //------------------------------------------------------------------------------
54 
55 //==============================================================================
62 //==============================================================================
63 
64 //==============================================================================
76 //==============================================================================
77 class cBitmap : public cPanel
78 {
79  //--------------------------------------------------------------------------
80  // CONSTRUCTOR & DESTRUCTOR:
81  //--------------------------------------------------------------------------
82 
83 public:
84 
86  cBitmap();
87 
89  virtual ~cBitmap();
90 
91 
92  //-----------------------------------------------------------------------
93  // PUBLIC METHODS:
94  //--------------------------------------------------------------------------
95 
96 public:
97 
99  virtual cBitmap* copy(const bool a_duplicateMaterialData = false,
100  const bool a_duplicateTextureData = false,
101  const bool a_duplicateMeshData = false,
102  const bool a_buildCollisionDetector = false);
103 
105  bool loadFromFile(std::string a_filename);
106 
108  bool loadFromImage(cImagePtr a_image);
109 
111  void setZoom(const float a_zoomWidth,
112  const float a_zoomHeight);
113 
115  double getZoomHeight() const { return (m_zoomHeight); }
116 
118  double getZoomWidth() const { return (m_zoomWidth); }
119 
121  virtual void updateBitmapMesh();
122 
123 
124  //--------------------------------------------------------------------------
125  // PROTECTED MEMBERS:
126  //--------------------------------------------------------------------------
127 
128 protected:
129 
131  double m_zoomWidth;
132 
134  double m_zoomHeight;
135 
136 
137  //--------------------------------------------------------------------------
138  // PROTECTED METHODS:
139  //--------------------------------------------------------------------------
140 
141 protected:
142 
144  void copyBitmapProperties(cBitmap* a_obj,
145  const bool a_duplicateMaterialData,
146  const bool a_duplicateTextureData,
147  const bool a_duplicateMeshData,
148  const bool a_buildCollisionDetector);
149 };
150 
151 //------------------------------------------------------------------------------
152 } // namespace chai3d
153 //------------------------------------------------------------------------------
154 
155 //------------------------------------------------------------------------------
156 #endif
157 //------------------------------------------------------------------------------
Implements a panel widget.
This class implements a 2D panel widget.
Definition: CPanel.h:80
double m_zoomWidth
Horizontal zoom factor.
Definition: CBitmap.h:131
void setZoom(const float a_zoomWidth, const float a_zoomHeight)
This method sets the horizontal and vertical zoom factors.
Definition: CBitmap.cpp:91
bool loadFromImage(cImagePtr a_image)
This method loads a bitmap image from an image structure.
Definition: CBitmap.cpp:183
This class implements a 2D bitmap widget.
Definition: CBitmap.h:77
bool loadFromFile(std::string a_filename)
This method loads a bitmap image from a file.
Definition: CBitmap.cpp:133
double getZoomWidth() const
This method returns the zoom factor along the vertical axis.
Definition: CBitmap.h:118
virtual void updateBitmapMesh()
This method updates the mesh model of this bitmap.
Definition: CBitmap.cpp:108
void copyBitmapProperties(cBitmap *a_obj, const bool a_duplicateMaterialData, const bool a_duplicateTextureData, const bool a_duplicateMeshData, const bool a_buildCollisionDetector)
This method copies all properties of this object to another.
Definition: CBitmap.cpp:265
cBitmap()
Constructor of cBitmap.
Definition: CBitmap.cpp:59
std::shared_ptr< cImage > cImagePtr
Definition: CImage.h:63
double m_zoomHeight
Vertical zoom factor.
Definition: CBitmap.h:134
virtual ~cBitmap()
Destructor of cBitmap.
Definition: CBitmap.cpp:78
virtual cBitmap * copy(const bool a_duplicateMaterialData=false, const bool a_duplicateTextureData=false, const bool a_duplicateMeshData=false, const bool a_buildCollisionDetector=false)
This method creates a copy of itself.
Definition: CBitmap.cpp:234
Definition: CAudioBuffer.cpp:56
double getZoomHeight() const
This method returns the zoom factor along the horizontal axis.
Definition: CBitmap.h:115