1 //******************************************************************************
2 ///
3 /// @file core/shape/sphere.h
4 ///
5 /// Declarations related to the sphere geometric primitive.
6 ///
7 /// @copyright
8 /// @parblock
9 ///
10 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.8.
11 /// Copyright 1991-2017 Persistence of Vision Raytracer Pty. Ltd.
12 ///
13 /// POV-Ray is free software: you can redistribute it and/or modify
14 /// it under the terms of the GNU Affero General Public License as
15 /// published by the Free Software Foundation, either version 3 of the
16 /// License, or (at your option) any later version.
17 ///
18 /// POV-Ray is distributed in the hope that it will be useful,
19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 /// GNU Affero General Public License for more details.
22 ///
23 /// You should have received a copy of the GNU Affero General Public License
24 /// along with this program.  If not, see <http://www.gnu.org/licenses/>.
25 ///
26 /// ----------------------------------------------------------------------------
27 ///
28 /// POV-Ray is based on the popular DKB raytracer version 2.12.
29 /// DKBTrace was originally written by David K. Buck.
30 /// DKBTrace Ver 2.0-2.12 were written by David K. Buck & Aaron A. Collins.
31 ///
32 /// @endparblock
33 ///
34 //******************************************************************************
35 
36 #ifndef POVRAY_CORE_SPHERE_H
37 #define POVRAY_CORE_SPHERE_H
38 
39 // Module config header file must be the first file included within POV-Ray unit header files
40 #include "core/configcore.h"
41 
42 #include "core/scene/object.h"
43 
44 namespace pov
45 {
46 
47 //##############################################################################
48 ///
49 /// @addtogroup PovCoreShape
50 ///
51 /// @{
52 
53 //******************************************************************************
54 ///
55 /// @name Object Types
56 ///
57 /// @{
58 
59 #define SPHERE_OBJECT (BASIC_OBJECT)
60 
61 /// @}
62 ///
63 //******************************************************************************
64 
65 class Sphere : public ObjectBase
66 {
67     public:
68         Vector3d Center;
69         DBL Radius;
70 
71         Sphere();
72         virtual ~Sphere();
73 
74         virtual ObjectPtr Copy();
75 
76         virtual bool All_Intersections(const Ray&, IStack&, TraceThreadData *);
77         virtual bool Inside(const Vector3d&, TraceThreadData *) const;
78         virtual void Normal(Vector3d&, Intersection *, TraceThreadData *) const;
79         virtual void UVCoord(Vector2d&, const Intersection *, TraceThreadData *) const;
80         virtual void Translate(const Vector3d&, const TRANSFORM *);
81         virtual void Rotate(const Vector3d&, const TRANSFORM *);
82         virtual void Scale(const Vector3d&, const TRANSFORM *);
83         virtual void Transform(const TRANSFORM *);
84         virtual void Compute_BBox();
85         virtual bool Intersect_BBox(BBoxDirection, const BBoxVector3d&, const BBoxVector3d&, BBoxScalar) const;
86 
87         static bool Intersect(const BasicRay& ray, const Vector3d& Center, DBL Radius2, DBL *Depth1, DBL  *Depth2);
88 
89     private:
90 
91         /// Ellipsoid mode flag.
92         ///
93         /// A value of `false` indicates that the primitive is in _spherical_ mode, while a value of `true` indicates
94         /// _ellipsoidal_ mode.
95         ///
96         /// **Spherical mode** uses the @ref Center and @ref Radius members to track all transformations to the
97         /// primitive, while the @ref Trans member only tracks rotations and is used exclusively for UV mapping.
98         /// If a transformation cannot be tracked in this manner, the primitive is switched to _ellipsoidal mode_.
99         ///
100         /// **Ellipsoidal mode** uses the @ref Trans member to track center, radius and all transformations, while the
101         /// @ref Center is pegged to the coordinate origin and the @radius to unity.
102         ///
103         bool Do_Ellipsoid;
104 };
105 
106 /// @}
107 ///
108 //##############################################################################
109 
110 }
111 
112 #endif // POVRAY_CORE_SPHERE_H
113