CShapeBox.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 CShapeBoxH
46 #define CShapeBoxH
47 //------------------------------------------------------------------------------
48 #include "world/CGenericObject.h"
49 #include "materials/CMaterial.h"
50 #include "materials/CTexture2d.h"
51 //------------------------------------------------------------------------------
52 
53 //------------------------------------------------------------------------------
54 namespace chai3d {
55 //------------------------------------------------------------------------------
56 
57 //==============================================================================
64 //==============================================================================
65 
66 //==============================================================================
77 //==============================================================================
78 class cShapeBox : public cGenericObject
79 {
80  //--------------------------------------------------------------------------
81  // CONSTRUCTOR & DESTRUCTOR:
82  //--------------------------------------------------------------------------
83 
84 public:
85 
87  cShapeBox(const double& a_sizeX,
88  const double& a_sizeY,
89  const double& a_sizeZ,
90  cMaterialPtr a_material = cMaterialPtr());
91 
93  virtual ~cShapeBox() {};
94 
95 
96  //--------------------------------------------------------------------------
97  // PUBLIC METHODS:
98  //--------------------------------------------------------------------------
99 
100 public:
101 
103  cShapeBox* copy(const bool a_duplicateMaterialData = false,
104  const bool a_duplicateTextureData = false,
105  const bool a_duplicateMeshData = false,
106  const bool a_buildCollisionDetector = true);
107 
109  void setSize(const double& a_sizeX,
110  const double& a_sizeY,
111  const double& a_sizeZ);
112 
114  inline double getSizeX() const { return (2.0 * m_hSizeX); }
115 
117  inline double getSizeY() const { return (2.0 * m_hSizeY); }
118 
120  inline double getSizeZ() const { return (2.0 * m_hSizeZ); }
121 
122 
123  //--------------------------------------------------------------------------
124  // PROTECTED VIRTUAL METHODS:
125  //--------------------------------------------------------------------------
126 
127 protected:
128 
130  virtual void render(cRenderOptions& a_options);
131 
133  virtual void updateBoundaryBox();
134 
136  virtual void scaleObject(const double& a_scaleFactor);
137 
139  virtual void computeLocalInteraction(const cVector3d& a_toolPos,
140  const cVector3d& a_toolVel,
141  const unsigned int a_IDN);
142 
144  virtual bool computeOtherCollisionDetection(cVector3d& a_segmentPointA,
145  cVector3d& a_segmentPointB,
146  cCollisionRecorder& a_recorder,
147  cCollisionSettings& a_settings);
148 
149 
150  //-----------------------------------------------------------------------
151  // PROTECTED METHODS:
152  //-----------------------------------------------------------------------
153 
154 protected:
155 
157  void copyShapeBoxProperties(cShapeBox* a_obj,
158  const bool a_duplicateMaterialData,
159  const bool a_duplicateTextureData,
160  const bool a_duplicateMeshData,
161  const bool a_buildCollisionDetector);
162 
163 
164  //--------------------------------------------------------------------------
165  // PROTECTED MEMBERS: (cShapeBox)
166  //--------------------------------------------------------------------------
167 
168  protected:
169 
171  double m_hSizeX;
172 
174  double m_hSizeY;
175 
177  double m_hSizeZ;
178 };
179 
180 //------------------------------------------------------------------------------
181 } // namespace chai3d
182 //------------------------------------------------------------------------------
183 
184 //------------------------------------------------------------------------------
185 #endif
186 //------------------------------------------------------------------------------
This class implements a 3D vector.
Definition: CVector3d.h:88
virtual void updateBoundaryBox()
This method updates the boundary box of this object.
Definition: CShapeBox.cpp:395
This structures provide a containers for storing rendering options that are passed through the sceneg...
Definition: CRenderOptions.h:82
virtual void computeLocalInteraction(const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int a_IDN)
This method updates the geometric relationship between the tool and the current object.
Definition: CShapeBox.cpp:295
double m_hSizeZ
half length of box along axis Z.
Definition: CShapeBox.h:177
double getSizeY() const
This method returns the box length along axis Y.
Definition: CShapeBox.h:117
double m_hSizeX
half length of box along axis Z.
Definition: CShapeBox.h:171
double getSizeZ() const
This method returns the box length along axis Z.
Definition: CShapeBox.h:120
std::shared_ptr< cMaterial > cMaterialPtr
Definition: CMaterial.h:67
double m_hSizeY
half length of box along axis Y.
Definition: CShapeBox.h:174
virtual bool computeOtherCollisionDetection(cVector3d &a_segmentPointA, cVector3d &a_segmentPointB, cCollisionRecorder &a_recorder, cCollisionSettings &a_settings)
This method computes collisions between a segment and this object.
Definition: CShapeBox.cpp:443
This class implements a base class for all 2D or 3D objects in CHAI3D.
Definition: CGenericObject.h:112
cShapeBox(const double &a_sizeX, const double &a_sizeY, const double &a_sizeZ, cMaterialPtr a_material=cMaterialPtr())
Constructor of cShapeBox.
Definition: CShapeBox.cpp:64
This class implements a collision detection recorder that stores all collision events that are report...
Definition: CCollisionBasics.h:185
This structure stores the collision settings that are passed to a collision detector when querying fo...
Definition: CCollisionBasics.h:242
virtual ~cShapeBox()
Destructor of cShapeBox.
Definition: CShapeBox.h:93
virtual void render(cRenderOptions &a_options)
This method renders this object graphically using OpenGL.
Definition: CShapeBox.cpp:187
void setSize(const double &a_sizeX, const double &a_sizeY, const double &a_sizeZ)
This method sets the dimensions of the box along each axis.
Definition: CShapeBox.cpp:165
Implements a base class for all objects.
double getSizeX() const
This method returns the box length along axis X.
Definition: CShapeBox.h:114
virtual void scaleObject(const double &a_scaleFactor)
This method scales the size of this object with given scale factor.
Definition: CShapeBox.cpp:410
Implements material properties.
Definition: CAudioBuffer.cpp:56
Implements 2D textures.
This class implements a 3D shape box.
Definition: CShapeBox.h:78
cShapeBox * copy(const bool a_duplicateMaterialData=false, const bool a_duplicateTextureData=false, const bool a_duplicateMeshData=false, const bool a_buildCollisionDetector=true)
This method creates a copy of itself.
Definition: CShapeBox.cpp:103
void copyShapeBoxProperties(cShapeBox *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: CShapeBox.cpp:136