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-2013 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 <float.h>
32 #include "OgreVector3.h"
34 #include "OgreRay.h"
35 
36 namespace Ogre {
37 namespace Volume {
38 
42  {
43  protected:
44 
54  virtual Vector3 getIntersectionStart(const Ray &ray, Real maxDistance) const;
55 
65  virtual Vector3 getIntersectionEnd(const Ray &ray, Real maxDistance) const;
66 
67  public:
68 
70  static const uint32 VOLUME_CHUNK_ID;
71 
74 
76  static const size_t SERIALIZATION_CHUNK_SIZE;
77 
80  virtual ~Source(void);
81 
88  virtual Vector4 getValueAndGradient(const Vector3 &position) const = 0;
89 
96  virtual Real getValue(const Vector3 &position) const = 0;
97 
116  void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, const String &file);
117 
130  void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, Real maxClampedAbsoluteDensity, const String &file);
131 
147  bool getFirstRayIntersection(const Ray &ray, Vector3 &result, Real scale = (Real)1.0, size_t maxIterations = 5000, Real maxDistance = (Real)10000.0) const;
148 
154  };
155 
156 }
157 }
158 
159 #endif
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::Volume::Source::serialize
void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, Real maxClampedAbsoluteDensity, const String &file)
Same as the other serialize function but with a user definable maximum absolute density value.
OgreRay.h
Ogre::Volume::Source::getIntersectionStart
virtual Vector3 getIntersectionStart(const Ray &ray, Real maxDistance) const
Gets the start vector of an intersection.
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::Volume::Source::serialize
void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, const String &file)
Serializes a volume source to a discrete grid file with deflated compression.
Ogre::Volume::Source::getFirstRayIntersection
bool getFirstRayIntersection(const Ray &ray, Vector3 &result, Real scale=(Real) 1.0, size_t maxIterations=5000, Real maxDistance=(Real) 10000.0) const
Gets the first intersection of a ray with the volume.
Ogre::Volume::Source::getVolumeSpaceToWorldSpaceFactor
Real getVolumeSpaceToWorldSpaceFactor(void) const
Gets a factor to come from volume coordinate to world coordinate.
Ogre::Volume::Source::SERIALIZATION_CHUNK_SIZE
static const size_t SERIALIZATION_CHUNK_SIZE
The amount of items being written as one chunk during serialization.
Definition: OgreVolumeSource.h:76
Ogre::Volume::Source::VOLUME_CHUNK_VERSION
static const uint16 VOLUME_CHUNK_VERSION
The version of volume files.
Definition: OgreVolumeSource.h:73
Ogre::Volume::Source::getValueAndGradient
virtual Vector4 getValueAndGradient(const Vector3 &position) const =0
Gets the density value and gradient at a specific position.
Ogre::Volume::Source::~Source
virtual ~Source(void)
Destructor.
_OgreVolumeExport
#define _OgreVolumeExport
Definition: OgreVolumePrerequisites.h:43
Ogre::Volume::Source::getValue
virtual Real getValue(const Vector3 &position) const =0
Gets the density value at a specific position.
Ogre::Vector4
4-dimensional homogeneous vector.
Definition: OgreVector4.h:46
Ogre::Volume::Source::VOLUME_CHUNK_ID
static const uint32 VOLUME_CHUNK_ID
The id of volume files.
Definition: OgreVolumeSource.h:70
Ogre::Volume::Source::getIntersectionEnd
virtual Vector3 getIntersectionEnd(const Ray &ray, Real maxDistance) const
Gets the end vector of an intersection.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
OgreVolumePrerequisites.h
Ogre::Ray
Representation of a ray in space, i.e.
Definition: OgreRay.h:47
OgreVector3.h
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:52
Ogre::Volume::Source
Abstract class defining the density function.
Definition: OgreVolumeSource.h:42

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.