OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreVolumeSource.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __Ogre_Volume_Source_H__
29 #define __Ogre_Volume_Source_H__
30 
31 #include "OgreVector3.h"
33 
34 namespace Ogre {
35 namespace Volume {
36 
40  {
41  protected:
42 
52  virtual Vector3 getIntersectionStart(const Ray &ray, Real maxDistance) const;
53 
63  virtual Vector3 getIntersectionEnd(const Ray &ray, Real maxDistance) const;
64 
65  public:
66 
68  static const uint32 VOLUME_CHUNK_ID;
69 
72 
74  static const size_t SERIALIZATION_CHUNK_SIZE;
75 
78  virtual ~Source(void);
79 
86  virtual Vector4 getValueAndGradient(const Vector3 &position) const = 0;
87 
94  virtual Real getValue(const Vector3 &position) const = 0;
95 
114  void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, const String &file);
115 
128  void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, Real maxClampedAbsoluteDensity, const String &file);
129 
145  bool getFirstRayIntersection(const Ray &ray, Vector3 &result, Real scale = (Real)1.0, size_t maxIterations = 5000, Real maxDistance = (Real)10000.0) const;
146 
151  Real getVolumeSpaceToWorldSpaceFactor(void) const;
152  };
153 
154 }
155 }
156 
157 #endif
Representation of a ray in space, i.e.
Definition: OgreRay.h:45
float Real
Software floating point type.
unsigned int uint32
Definition: OgrePlatform.h:420
Abstract class defining the density function.
static const uint16 VOLUME_CHUNK_VERSION
The version of volume files.
static const size_t SERIALIZATION_CHUNK_SIZE
The amount of items being written as one chunk during serialization.
Standard 3-dimensional vector.
Definition: OgreVector3.h:50
static const uint32 VOLUME_CHUNK_ID
The id of volume files.
_StringBase String
Definition: OgreCommon.h:53
#define _OgreVolumeExport
unsigned short uint16
Definition: OgrePlatform.h:421
4-dimensional homogeneous vector.
Definition: OgreVector4.h:45