OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
osgTerrain::Locator Class Reference
Inheritance diagram for osgTerrain::Locator:
Inheritance graph
[legend]

List of all members.

Public Types

enum  CoordinateSystemType { GEOCENTRIC, GEOGRAPHIC, PROJECTED }
 CoordinateSystemType provides the classification of the type coordinate system represented. More...
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Locator ()
 Locator (const Locator &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Object (osgTerrain, Locator)
void setCoordinateSystemType (CoordinateSystemType type)
 Set the CoordinatesSyetemType.
CoordinateSystemType getCoordinateSystemType () const
 Get the CoordinatesSyetemType.
void setFormat (const std::string &format)
 Set the coordinate system format string.
const std::string & getFormat () const
 Get the coordinate system format string.
void setCoordinateSystem (const std::string &cs)
 Set the CoordinateSystem reference string, should be stored in a form consistent with the Format.
const std::string & getCoordinateSystem () const
 Get the CoordinateSystem reference string.
void setEllipsoidModel (osg::EllipsoidModel *ellipsode)
 Set EllipsoidModel to describe the model used to map lat, long and height into geocentric XYZ and back.
osg::EllipsoidModelgetEllipsoidModel ()
 Get the EllipsoidModel.
const osg::EllipsoidModelgetEllipsoidModel () const
 Get the const EllipsoidModel.
void setTransform (const osg::Matrixd &transform)
 Set the transformation from local coordinates to model coordinates.
const osg::MatrixdgetTransform () const
 Set the transformation from local coordinates to model coordinates.
void setTransformAsExtents (double minX, double minY, double maxX, double maxY)
 Set the extents of the local coords.
virtual bool orientationOpenGL () const
virtual bool convertLocalToModel (const osg::Vec3d &local, osg::Vec3d &world) const
virtual bool convertModelToLocal (const osg::Vec3d &world, osg::Vec3d &local) const
bool computeLocalBounds (Locator &source, osg::Vec3d &bottomLeft, osg::Vec3d &topRight) const
void setDefinedInFile (bool flag)
bool getDefinedInFile () const
void setTransformScaledByResolution (bool scaledByResolution)
bool getTransformScaledByResolution () const
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
 return the name of the object's library.
virtual const char * className () const =0
 return the name of the object's class type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static bool convertLocalCoordBetween (const Locator &source, const osg::Vec3d &sourceNDC, const Locator &destination, osg::Vec3d &destinationNDC)

Protected Member Functions

virtual ~Locator ()
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

CoordinateSystemType _coordinateSystemType
std::string _format
std::string _cs
osg::ref_ptr< osg::EllipsoidModel_ellipsoidModel
osg::Matrixd _transform
osg::Matrixd _inverse
bool _definedInFile
bool _transformScaledByResolution
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Member Enumeration Documentation

CoordinateSystemType provides the classification of the type coordinate system represented.

Enumerator:
GEOCENTRIC 

GEOCENTRIC coordinate systems are ones mapped to the around the ellipsoid, i.e.

whole earth.

GEOGRAPHIC 

GEOGRAPHIC coordinate systems are ones mapped to latitude and longitude.

PROJECTED 

PROJECTED coordinate systems are ones projected to a local projected coordinate system i.e.

UTMs.


Constructor & Destructor Documentation

osgTerrain::Locator::Locator ( )
osgTerrain::Locator::Locator ( const Locator ,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgTerrain::Locator::~Locator ( )
protectedvirtual

Member Function Documentation

bool osgTerrain::Locator::computeLocalBounds ( Locator source,
osg::Vec3d bottomLeft,
osg::Vec3d topRight 
) const
static bool osgTerrain::Locator::convertLocalCoordBetween ( const Locator source,
const osg::Vec3d sourceNDC,
const Locator destination,
osg::Vec3d destinationNDC 
)
inlinestatic
virtual bool osgTerrain::Locator::convertLocalToModel ( const osg::Vec3d local,
osg::Vec3d world 
) const
virtual
virtual bool osgTerrain::Locator::convertModelToLocal ( const osg::Vec3d world,
osg::Vec3d local 
) const
virtual
const std::string& osgTerrain::Locator::getCoordinateSystem ( ) const
inline

Get the CoordinateSystem reference string.

CoordinateSystemType osgTerrain::Locator::getCoordinateSystemType ( ) const
inline

Get the CoordinatesSyetemType.

bool osgTerrain::Locator::getDefinedInFile ( ) const
inline
osg::EllipsoidModel* osgTerrain::Locator::getEllipsoidModel ( )
inline

Get the EllipsoidModel.

const osg::EllipsoidModel* osgTerrain::Locator::getEllipsoidModel ( ) const
inline

Get the const EllipsoidModel.

const std::string& osgTerrain::Locator::getFormat ( ) const
inline

Get the coordinate system format string.

const osg::Matrixd& osgTerrain::Locator::getTransform ( ) const
inline

Set the transformation from local coordinates to model coordinates.

bool osgTerrain::Locator::getTransformScaledByResolution ( ) const
inline
osgTerrain::Locator::META_Object ( osgTerrain  ,
Locator   
)
virtual bool osgTerrain::Locator::orientationOpenGL ( ) const
virtual
void osgTerrain::Locator::setCoordinateSystem ( const std::string &  cs)
inline

Set the CoordinateSystem reference string, should be stored in a form consistent with the Format.

void osgTerrain::Locator::setCoordinateSystemType ( CoordinateSystemType  type)
inline

Set the CoordinatesSyetemType.

Note, the user must keep the CoordinateSystemString consistent with the type of the CoordinateSystem.

void osgTerrain::Locator::setDefinedInFile ( bool  flag)
inline
void osgTerrain::Locator::setEllipsoidModel ( osg::EllipsoidModel ellipsode)
inline

Set EllipsoidModel to describe the model used to map lat, long and height into geocentric XYZ and back.

void osgTerrain::Locator::setFormat ( const std::string &  format)
inline

Set the coordinate system format string.

Typical values would be WKT, PROJ4, USGS etc.

void osgTerrain::Locator::setTransform ( const osg::Matrixd transform)
inline

Set the transformation from local coordinates to model coordinates.

References osg::Matrixd::invert().

void osgTerrain::Locator::setTransformAsExtents ( double  minX,
double  minY,
double  maxX,
double  maxY 
)

Set the extents of the local coords.

void osgTerrain::Locator::setTransformScaledByResolution ( bool  scaledByResolution)
inline

Member Data Documentation

CoordinateSystemType osgTerrain::Locator::_coordinateSystemType
protected
std::string osgTerrain::Locator::_cs
protected
bool osgTerrain::Locator::_definedInFile
protected
osg::ref_ptr<osg::EllipsoidModel> osgTerrain::Locator::_ellipsoidModel
protected
std::string osgTerrain::Locator::_format
protected
osg::Matrixd osgTerrain::Locator::_inverse
protected
osg::Matrixd osgTerrain::Locator::_transform
protected
bool osgTerrain::Locator::_transformScaledByResolution
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Sat Jan 12 2013 03:06:13 for the OpenSceneGraph by doxygen 1.8.1.1.