OpenSceneGraph 3.6.5
osgViewer::Keystone Class Reference

#include <Keystone>

Inheritance diagram for osgViewer::Keystone:

Public Member Functions

 Keystone ()
 Keystone (const Keystone &rhs, const osg::CopyOp &copop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgViewer, Keystone) void reset()
Keystoneoperator= (const Keystone &rhs)
void setKeystoneEditingEnabled (bool flag)
bool getKeystoneEditingEnabled () const
void setGridColor (const osg::Vec4 &color)
osg::Vec4getGridColor ()
const osg::Vec4getGridColor () const
void setBottomLeft (const osg::Vec2d &v)
osg::Vec2dgetBottomLeft ()
const osg::Vec2dgetBottomLeft () const
void setBottomRight (const osg::Vec2d &v)
osg::Vec2dgetBottomRight ()
const osg::Vec2dgetBottomRight () const
void setTopLeft (const osg::Vec2d &v)
osg::Vec2dgetTopLeft ()
const osg::Vec2dgetTopLeft () const
void setTopRight (const osg::Vec2d &v)
osg::Vec2dgetTopRight ()
const osg::Vec2dgetTopRight () const
void compute3DPositions (osg::DisplaySettings *ds, osg::Vec3 &tl, osg::Vec3 &tr, osg::Vec3 &br, osg::Vec3 &bl) const
osg::GeodecreateKeystoneDistortionMesh ()
osg::NodecreateGrid ()
bool writeToFile ()
 Write the file specified by the "filename" user value field.
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.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
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.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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.
template<class T>
void setUserData (const ref_ptr< T > &ud)
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
 Convenience 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)
 Convenience 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.
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 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 no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer 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 loadKeystoneFiles (osg::DisplaySettings *ds)
 Convenience function that loads and assigns any keystone files specified in the DisplaySettings::KeystoneFileNames list, return true if Keystone's assigned to DisplaySettings.
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Protected Member Functions

virtual ~Keystone ()
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

bool keystoneEditingEnabled
osg::Vec4 gridColour
osg::Vec2d bottom_left
osg::Vec2d bottom_right
osg::Vec2d top_left
osg::Vec2d top_right
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

Additional Inherited Members

Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Constructor & Destructor Documentation

◆ Keystone() [1/2]

osgViewer::Keystone::Keystone ( )

Referenced by Keystone(), META_Object(), and operator=().

◆ Keystone() [2/2]

osgViewer::Keystone::Keystone ( const Keystone & rhs,
const osg::CopyOp & copop = osg::CopyOp::SHALLOW_COPY )

◆ ~Keystone()

virtual osgViewer::Keystone::~Keystone ( )
inlineprotectedvirtual

Member Function Documentation

◆ compute3DPositions()

void osgViewer::Keystone::compute3DPositions ( osg::DisplaySettings * ds,
osg::Vec3 & tl,
osg::Vec3 & tr,
osg::Vec3 & br,
osg::Vec3 & bl ) const

◆ createGrid()

osg::Node * osgViewer::Keystone::createGrid ( )

◆ createKeystoneDistortionMesh()

osg::Geode * osgViewer::Keystone::createKeystoneDistortionMesh ( )

◆ getBottomLeft() [1/2]

osg::Vec2d & osgViewer::Keystone::getBottomLeft ( )
inline

References bottom_left.

◆ getBottomLeft() [2/2]

const osg::Vec2d & osgViewer::Keystone::getBottomLeft ( ) const
inline

References bottom_left.

◆ getBottomRight() [1/2]

osg::Vec2d & osgViewer::Keystone::getBottomRight ( )
inline

References bottom_right.

◆ getBottomRight() [2/2]

const osg::Vec2d & osgViewer::Keystone::getBottomRight ( ) const
inline

References bottom_right.

◆ getGridColor() [1/2]

osg::Vec4 & osgViewer::Keystone::getGridColor ( )
inline

References gridColour.

◆ getGridColor() [2/2]

const osg::Vec4 & osgViewer::Keystone::getGridColor ( ) const
inline

References gridColour.

◆ getKeystoneEditingEnabled()

bool osgViewer::Keystone::getKeystoneEditingEnabled ( ) const
inline

◆ getTopLeft() [1/2]

osg::Vec2d & osgViewer::Keystone::getTopLeft ( )
inline

References top_left.

◆ getTopLeft() [2/2]

const osg::Vec2d & osgViewer::Keystone::getTopLeft ( ) const
inline

References top_left.

◆ getTopRight() [1/2]

osg::Vec2d & osgViewer::Keystone::getTopRight ( )
inline

References top_right.

◆ getTopRight() [2/2]

const osg::Vec2d & osgViewer::Keystone::getTopRight ( ) const
inline

References top_right.

◆ loadKeystoneFiles()

bool osgViewer::Keystone::loadKeystoneFiles ( osg::DisplaySettings * ds)
static

Convenience function that loads and assigns any keystone files specified in the DisplaySettings::KeystoneFileNames list, return true if Keystone's assigned to DisplaySettings.

◆ META_Object()

osgViewer::Keystone::META_Object ( osgViewer ,
Keystone  )

References Keystone().

◆ operator=()

Keystone & osgViewer::Keystone::operator= ( const Keystone & rhs)

References Keystone().

◆ setBottomLeft()

void osgViewer::Keystone::setBottomLeft ( const osg::Vec2d & v)
inline

References bottom_left.

◆ setBottomRight()

void osgViewer::Keystone::setBottomRight ( const osg::Vec2d & v)
inline

References bottom_right.

◆ setGridColor()

void osgViewer::Keystone::setGridColor ( const osg::Vec4 & color)
inline

References gridColour.

◆ setKeystoneEditingEnabled()

void osgViewer::Keystone::setKeystoneEditingEnabled ( bool flag)
inline

◆ setTopLeft()

void osgViewer::Keystone::setTopLeft ( const osg::Vec2d & v)
inline

References top_left.

◆ setTopRight()

void osgViewer::Keystone::setTopRight ( const osg::Vec2d & v)
inline

References top_right.

◆ writeToFile()

bool osgViewer::Keystone::writeToFile ( )

Write the file specified by the "filename" user value field.

Return true if file successfully written.

Member Data Documentation

◆ bottom_left

osg::Vec2d osgViewer::Keystone::bottom_left
protected

◆ bottom_right

osg::Vec2d osgViewer::Keystone::bottom_right
protected

◆ gridColour

osg::Vec4 osgViewer::Keystone::gridColour
protected

◆ keystoneEditingEnabled

bool osgViewer::Keystone::keystoneEditingEnabled
protected

◆ top_left

osg::Vec2d osgViewer::Keystone::top_left
protected

Referenced by getTopLeft(), getTopLeft(), and setTopLeft().

◆ top_right

osg::Vec2d osgViewer::Keystone::top_right
protected

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

osg logo
Generated at Sun Jul 27 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.