From Albert Luaces, typo fixes.
git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/trunk@14883 16af8721-9629-0410-8352-f15c8da7e697
This commit is contained in:
@@ -77,12 +77,12 @@ public:
|
||||
*/
|
||||
enum ThreadPriority {
|
||||
|
||||
THREAD_PRIORITY_MAX, /**< The maximum possible priority */
|
||||
THREAD_PRIORITY_HIGH, /**< A high (but not max) setting */
|
||||
THREAD_PRIORITY_NOMINAL, /**< An average priority */
|
||||
THREAD_PRIORITY_LOW, /**< A low (but not min) setting */
|
||||
THREAD_PRIORITY_MIN, /**< The miniumum possible priority */
|
||||
THREAD_PRIORITY_DEFAULT /**< Priority scheduling default */
|
||||
THREAD_PRIORITY_MAX, /**< The maximum possible priority */
|
||||
THREAD_PRIORITY_HIGH, /**< A high (but not max) setting */
|
||||
THREAD_PRIORITY_NOMINAL, /**< An average priority */
|
||||
THREAD_PRIORITY_LOW, /**< A low (but not min) setting */
|
||||
THREAD_PRIORITY_MIN, /**< The miniumum possible priority */
|
||||
THREAD_PRIORITY_DEFAULT /**< Priority scheduling default */
|
||||
|
||||
};
|
||||
|
||||
@@ -91,10 +91,10 @@ public:
|
||||
*/
|
||||
enum ThreadPolicy {
|
||||
|
||||
THREAD_SCHEDULE_FIFO, /**< First in, First out scheduling */
|
||||
THREAD_SCHEDULE_ROUND_ROBIN, /**< Round-robin scheduling (LINUX_DEFAULT) */
|
||||
THREAD_SCHEDULE_TIME_SHARE, /**< Time-share scheduling (IRIX DEFAULT) */
|
||||
THREAD_SCHEDULE_DEFAULT /**< Default scheduling */
|
||||
THREAD_SCHEDULE_FIFO, /**< First in, First out scheduling */
|
||||
THREAD_SCHEDULE_ROUND_ROBIN, /**< Round-robin scheduling (LINUX_DEFAULT) */
|
||||
THREAD_SCHEDULE_TIME_SHARE, /**< Time-share scheduling (IRIX DEFAULT) */
|
||||
THREAD_SCHEDULE_DEFAULT /**< Default scheduling */
|
||||
|
||||
};
|
||||
|
||||
@@ -342,7 +342,7 @@ public:
|
||||
*/
|
||||
int setProcessorAffinity( unsigned int cpunum );
|
||||
|
||||
/** microSleep method, equivilant to the posix usleep(microsec).
|
||||
/** microSleep method, equivalent to the posix usleep(microsec).
|
||||
* This is not strictly thread API but is used
|
||||
* so often with threads. It's basically UNIX usleep. Parameter is
|
||||
* number of microseconds we current thread to sleep. Returns 0 on
|
||||
|
||||
@@ -47,7 +47,7 @@ inline void clampLEQUAL(T& value,const T maxValue,const char* valueName)
|
||||
|
||||
/** If value is between or equal to minValue and maxValue do nothing - legal
|
||||
* value, Otherwise clamp value to specified range and warn that valueName
|
||||
* was clamped. Equivilant to calling
|
||||
* was clamped. Equivalent to calling
|
||||
* clampGEQUAL( value, minValue, valueName );
|
||||
* clampLEQUAL( value, maxValue, valueName ); */
|
||||
template <typename T>
|
||||
@@ -95,7 +95,7 @@ inline void clampArrayElementLEQUAL(A& value,unsigned int i,const T maxValue,con
|
||||
|
||||
/** If value[i] is between or equal to minValue and maxValue do nothing - legal
|
||||
* value, Otherwise clamp value[i] to specified range and warn that
|
||||
* valueName[i] was clamped. Equivilant to calling
|
||||
* valueName[i] was clamped. Equivalent to calling
|
||||
* clampArrayElementGEQUAL( value, i, minValue, valueName );
|
||||
* clampArrayElementLEQUAL( value, i, maxValue, valueName ); */
|
||||
template <typename A, typename T>
|
||||
|
||||
@@ -176,13 +176,13 @@ class OSG_EXPORT Geometry : public Drawable
|
||||
*/
|
||||
virtual void drawImplementation(RenderInfo& renderInfo) const;
|
||||
|
||||
/** Set up the vertex arrays for the purpose of rendering, called by drawImplemtation() prior to it calling drawPrimitivesImplementation().*/
|
||||
void drawVertexArraysImplementation(RenderInfo& renderInfo) const;
|
||||
/** Set up the vertex arrays for the purpose of rendering, called by drawImplemtation() prior to it calling drawPrimitivesImplementation().*/
|
||||
void drawVertexArraysImplementation(RenderInfo& renderInfo) const;
|
||||
|
||||
/** dispatch the primitives to OpenGL, called by drawImplemtation() after calling drawVertexArraysImplementation().*/
|
||||
void drawPrimitivesImplementation(RenderInfo& renderInfo) const;
|
||||
/** dispatch the primitives to OpenGL, called by drawImplemtation() after calling drawVertexArraysImplementation().*/
|
||||
void drawPrimitivesImplementation(RenderInfo& renderInfo) const;
|
||||
|
||||
/** Return true, osg::Geometry does support accept(Drawable::AttributeFunctor&). */
|
||||
/** Return true, osg::Geometry does support accept(Drawable::AttributeFunctor&). */
|
||||
virtual bool supports(const Drawable::AttributeFunctor&) const { return true; }
|
||||
|
||||
/** Accept an Drawable::AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has. */
|
||||
@@ -232,7 +232,7 @@ class OSG_EXPORT Geometry : public Drawable
|
||||
public:
|
||||
|
||||
|
||||
/** Return true if the deprecated use array indicies or BIND_PER_PRIMITIVE binding has been assigned to arrays.*/
|
||||
/** Return true if the deprecated use array indices or BIND_PER_PRIMITIVE binding has been assigned to arrays.*/
|
||||
bool containsDeprecatedData() const { return _containsDeprecatedData; }
|
||||
|
||||
/** fallback for deprecated functionality. Return true if the Geometry contains any array indices or BIND_PER_PRIMITIVE arrays. */
|
||||
@@ -294,7 +294,7 @@ inline Geometry* createTexturedQuadGeometry(const Vec3& corner,const Vec3& width
|
||||
namespace deprecated_osg {
|
||||
|
||||
/** Geometry class contaning deprecated features.
|
||||
* Users should only use deprecatged_osg::Geometry when absolutely neccessary for keeping things compiling,
|
||||
* Users should only use deprecated_osg::Geometry when absolutely necessary for keeping things compiling,
|
||||
* it is recommended that you should migrate your code to work just with osg::Geometry as existing
|
||||
* deprecated_osg::Geometry will be removed in future release.
|
||||
*/
|
||||
|
||||
@@ -224,7 +224,7 @@ class OSG_EXPORT Image : public BufferData
|
||||
* Typically used to copy to an already allocated image, such as creating
|
||||
* a 3D image from a stack 2D images.
|
||||
* If this Image is empty then image data is created to
|
||||
* accomodate the source image in its offset position.
|
||||
* accommodate the source image in its offset position.
|
||||
* If source is NULL then no operation happens, this Image is left unchanged.
|
||||
*/
|
||||
virtual void copySubImage(int s_offset, int t_offset, int r_offset, const osg::Image* source);
|
||||
|
||||
@@ -201,7 +201,7 @@ extern OSG_EXPORT bool clearImageToColor(osg::Image* image, const osg::Vec4& col
|
||||
|
||||
typedef std::vector< osg::ref_ptr<osg::Image> > ImageList;
|
||||
|
||||
/** Search through the list of Images and find the maximum number of components used amoung the images.*/
|
||||
/** Search through the list of Images and find the maximum number of components used among the images.*/
|
||||
extern OSG_EXPORT unsigned int maximimNumOfComponents(const ImageList& imageList);
|
||||
|
||||
/** create a 3D osg::Image from a list of osg::Image.*/
|
||||
|
||||
@@ -86,7 +86,7 @@ class OSG_EXPORT Object : public Referenced
|
||||
by derived classes.*/
|
||||
virtual const char* className() const = 0;
|
||||
|
||||
/** return the compound class name that combines the libary name and class name.*/
|
||||
/** return the compound class name that combines the library name and class name.*/
|
||||
std::string getCompoundClassName() const { return std::string(libraryName()) + std::string("::") + std::string(className()); }
|
||||
|
||||
|
||||
|
||||
@@ -95,7 +95,7 @@ class OSG_EXPORT TransferFunction1D : public osg::TransferFunction
|
||||
/** Set the color for a specified transfer function value.
|
||||
* updateImage defaults to true, and tells the setColor function to update the associate osg::Image that
|
||||
* tracks the color map. Pass in false as the updateImage parameter if you are setting up many values
|
||||
* at once to avoid recomputation of the image data, then once all setColor calls are made explictly call
|
||||
* at once to avoid recomputation of the image data, then once all setColor calls are made explicitly call
|
||||
* updateImage() to bring the osg::Image back into sync with the color map. */
|
||||
void setColor(float v, const osg::Vec4& color, bool updateImage=true);
|
||||
|
||||
|
||||
@@ -27,9 +27,9 @@ namespace osg {
|
||||
* To use the observer_ptr<> robustly in multi-threaded applications it is recommend to access the pointer via
|
||||
* the lock() method that passes back a ref_ptr<> that safely takes a reference to the object to prevent deletion
|
||||
* during usage of the object. In certain conditions it may be safe to use the pointer directly without using lock(),
|
||||
* which will confer a perfomance advantage, the conditions are:
|
||||
* which will confer a performance advantage, the conditions are:
|
||||
* 1) The data structure is only accessed/deleted in single threaded/serial way.
|
||||
* 2) The data strucutre is guarenteed by high level management of data strucutures and threads which avoid
|
||||
* 2) The data strucutre is guaranteed by high level management of data strucutures and threads which avoid
|
||||
* possible situations where the observer_ptr<>'s object may be deleted by one thread whilst being accessed
|
||||
* by another.
|
||||
* If you are in any doubt about whether it is safe to access the object safe then use the
|
||||
|
||||
@@ -97,7 +97,7 @@ class ref_ptr
|
||||
/** release the pointer from ownership by this ref_ptr<>, decrementing the objects refencedCount() via unref_nodelete() to prevent the Object
|
||||
* object from being deleted even if the reference count goes to zero. Use when using a local ref_ptr<> to an Object that you want to return
|
||||
* from a function/method via a C pointer, whilst preventing the normal ref_ptr<> destructor from cleaning up the object. When using release()
|
||||
* you are implicitly expecting other code to take over managment of the object, otherwise a memory leak will result. */
|
||||
* you are implicitly expecting other code to take over management of the object, otherwise a memory leak will result. */
|
||||
T* release() { T* tmp=_ptr; if (_ptr) _ptr->unref_nodelete(); _ptr=0; return tmp; }
|
||||
|
||||
void swap(ref_ptr& rp) { T* tmp=_ptr; _ptr=rp._ptr; rp._ptr=tmp; }
|
||||
|
||||
@@ -176,16 +176,16 @@ public:
|
||||
/// Properties supported for a range of classes, used for white and black lists
|
||||
typedef std::map<std::string, PropertyMap> ObjectPropertyMap;
|
||||
|
||||
/// Get the list of properties that are explictly defined as supported
|
||||
/// Get the list of properties that are explicitly defined as supported
|
||||
ObjectPropertyMap& getWhiteList() { return _whiteList; }
|
||||
|
||||
/// Get the const list of properties that are explictly defined as supported
|
||||
/// Get the const list of properties that are explicitly defined as supported
|
||||
const ObjectPropertyMap& getWhiteList() const { return _whiteList; }
|
||||
|
||||
/// Get the list of properties that are explictly defined as not supported
|
||||
/// Get the list of properties that are explicitly defined as not supported
|
||||
ObjectPropertyMap& getBlackList() { return _blackList; }
|
||||
|
||||
/// Get the const list of properties that are explictly defined as not supported
|
||||
/// Get the const list of properties that are explicitly defined as not supported
|
||||
const ObjectPropertyMap& getBlackList() const { return _blackList; }
|
||||
|
||||
osgDB::ObjectWrapper* getObjectWrapper(const osg::Object* object) const;
|
||||
|
||||
@@ -66,7 +66,7 @@ namespace osgDB
|
||||
ObjectData(const std::string & absolutePath, const std::string & relativePath, bool written) : absolutePath(absolutePath), relativePath(relativePath), written(written) {}
|
||||
std::string absolutePath;
|
||||
std::string relativePath;
|
||||
bool written; ///< Says if write succeded or not.
|
||||
bool written; ///< Says if write succeeded or not.
|
||||
};
|
||||
|
||||
/// Set of written objects, with their absolute writing path.
|
||||
|
||||
@@ -216,7 +216,7 @@ class OSGDB_EXPORT ReaderWriter : public osg::Object
|
||||
|
||||
typedef osgDB::Options Options;
|
||||
|
||||
/** Determine if a file exists, normally the default implementation will be appropiate for local file access
|
||||
/** Determine if a file exists, normally the default implementation will be appropriate for local file access
|
||||
* but with plugins like the libcurl based one it will return true if the file is accessible at the server. */
|
||||
virtual bool fileExists(const std::string& filename, const Options* options) const;
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ public:
|
||||
requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer
|
||||
to a specified x,y location on the window. This is used by some camera manipulators
|
||||
to initialise the mouse pointer when mouse position relative to a controls
|
||||
neutral mouse position is required, i.e when mimicking a aircrafts joystick.
|
||||
neutral mouse position is required, i.e when mimicking an aircraft joystick.
|
||||
*/
|
||||
virtual void requestWarpPointer(float x,float y) = 0;
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ class Scale2DCommand;
|
||||
class ScaleUniformCommand;
|
||||
class Rotate3DCommand;
|
||||
|
||||
/** Computes the nodepath from the given node all the way upto the root. */
|
||||
/** Computes the nodepath from the given node all the way up to the root. */
|
||||
extern OSGMANIPULATOR_EXPORT void computeNodePathToRoot(osg::Node& node, osg::NodePath& np);
|
||||
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ namespace osgParticle
|
||||
{
|
||||
|
||||
/** ConnectConnectedParticleSystem is a specialise ConnectedParticleSystem for effects
|
||||
* like missle trails, where the individual particles are rendered as
|
||||
* like missile trails, where the individual particles are rendered as
|
||||
* single ribbon.
|
||||
*/
|
||||
class OSGPARTICLE_EXPORT ConnectedParticleSystem: public osgParticle::ParticleSystem
|
||||
|
||||
@@ -78,13 +78,13 @@ virtual ViewDependentShadowTechnique::ViewData * initViewDependentData \
|
||||
unique CullVisitor used to cull the scene in every frame.
|
||||
|
||||
Based on CullVisitor ptr passed to cull method, associated Technique::ViewData
|
||||
object is created (if neccessary) and then seleced. Then control is passed to
|
||||
object is created (if necessary) and then seleced. Then control is passed to
|
||||
this ViewData object. So, each view has its associated unique ViewData
|
||||
(or derived) object performing dirty work of shadow resources management and
|
||||
shadow generation for the view.
|
||||
|
||||
To support creation of classes derived from ViewDependentShadowTechnique it
|
||||
was neccessary to provide mechanism to override ViewData and allow for
|
||||
was necessary to provide mechanism to override ViewData and allow for
|
||||
initialization of new derived ViewData objects. Creation and initialization
|
||||
is performed when ViewDependendentShadowTechnique::cull gets called with
|
||||
CullVistor ptr which does not yet have associated ViewData object. When it
|
||||
|
||||
@@ -149,7 +149,7 @@ class OSGTERRAIN_EXPORT TerrainTile : public osg::Group
|
||||
bool getRequiresNormals() const { return _requiresNormals; }
|
||||
|
||||
|
||||
/** Set the hint to whether the TerrainTechnique should treat the invalid Layer entries that at are neigbours to valid entries with the default value.*/
|
||||
/** Set the hint to whether the TerrainTechnique should treat the invalid Layer entries that at are neighbours to valid entries with the default value.*/
|
||||
void setTreatBoundariesToValidDataAsDefaultValue(bool flag) { _treatBoundariesToValidDataAsDefaultValue = flag; }
|
||||
|
||||
/** Get whether the TeatBoundariesToValidDataAsDefaultValue hint.*/
|
||||
|
||||
@@ -272,7 +272,7 @@ public:
|
||||
/** Resize any per context GLObject buffers to specified size. */
|
||||
virtual void resizeGLObjectBuffers(unsigned int maxSize);
|
||||
|
||||
/** create an image that maps all the associated Glyph's onto a single image, that is equivilant to what will be downloaded to the texture.*/
|
||||
/** create an image that maps all the associated Glyph's onto a single image, that is equivalent to what will be downloaded to the texture.*/
|
||||
osg::Image* createImage();
|
||||
|
||||
protected:
|
||||
|
||||
@@ -59,7 +59,7 @@ public:
|
||||
const GraphicsSubgraphMap& getGraphicsSubgraphMap() const { return _graphicsSubgraphMap; }
|
||||
|
||||
/** Set the WidgetStateSet is used internally by Widgets to manage state that decorates the subgraph.
|
||||
* WidgetStateSet is not serialized and is typically populated by teh Widget::createGraphics() implementation,
|
||||
* WidgetStateSet is not serialized and is typically populated by the Widget::createGraphics() implementation,
|
||||
* end users will not normally touoch the WidgetStateSet, use the normal Node::setStateSet() if you want to apply
|
||||
* your own state to the Widget and it's subgraphs.*/
|
||||
void setWidgetStateSet(osg::StateSet* stateset) { _widgetStateSet = stateset; }
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
|
||||
namespace osgUtil {
|
||||
|
||||
/** A class for assisting the building ascene graphs that is equivilant to OpenGL 1.0 style calls.
|
||||
/** A class for assisting the building a scene graph that is equivilant to OpenGL 1.0 style calls.
|
||||
*/
|
||||
class OSGUTIL_EXPORT SceneGraphBuilder
|
||||
{
|
||||
|
||||
@@ -27,7 +27,7 @@ namespace osgWidget {
|
||||
class Window;
|
||||
class WindowManager;
|
||||
|
||||
// A Widget is a rectangular region that recieves events about the state of various input
|
||||
// A Widget is a rectangular region that receives events about the state of various input
|
||||
// devices such as the pointer and keyboard. It is aware of it's width, height, and origin but
|
||||
// nothing else. It is the job of higher-level container objects to organize layouts and
|
||||
// the like, and to contextualize the meaning of the widgets "origin" (whether it is absolute
|
||||
@@ -468,7 +468,7 @@ public:
|
||||
point_type _padTop;
|
||||
point_type _padBottom;
|
||||
|
||||
// The alignments are used in conjuction when the widget is NOT set to fill.
|
||||
// The alignments are used in conjunction when the widget is NOT set to fill.
|
||||
VerticalAlignment _valign;
|
||||
HorizontalAlignment _halign;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user