From Chris Hanson, typo and comment clean ups

This commit is contained in:
Robert Osfield 2009-07-24 14:45:44 +00:00
parent 68c459ea30
commit 773ae51a45
14 changed files with 45 additions and 39 deletions

View File

@ -35,9 +35,12 @@ class OSG_EXPORT ApplicationUsage : public osg::Referenced
typedef std::map<std::string,std::string> UsageMap; typedef std::map<std::string,std::string> UsageMap;
/** The ApplicationName is often displayed when logging errors, and frequently incorporated into the Description (below). */
void setApplicationName(const std::string& name) { _applicationName = name; } void setApplicationName(const std::string& name) { _applicationName = name; }
const std::string& getApplicationName() const { return _applicationName; } const std::string& getApplicationName() const { return _applicationName; }
/** If non-empty, the Description is typically shown by the Help Handler
* as text on the Help display (which also lists keyboard abbreviations. */
void setDescription(const std::string& desc) { _description = desc; } void setDescription(const std::string& desc) { _description = desc; }
const std::string& getDescription() const { return _description; } const std::string& getDescription() const { return _description; }

View File

@ -72,13 +72,13 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
bool getAllowEventFocus() const { return _allowEventFocus; } bool getAllowEventFocus() const { return _allowEventFocus; }
/** Set the DsplaySettings object associated with this view.*/ /** Set the DisplaySettings object associated with this view.*/
void setDisplaySettings(osg::DisplaySettings* ds) { _displaySettings = ds; } void setDisplaySettings(osg::DisplaySettings* ds) { _displaySettings = ds; }
/** Set the DsplaySettings object associated with this view.*/ /** Get the DisplaySettings object associated with this view.*/
osg::DisplaySettings* getDisplaySettings() { return _displaySettings.get(); } osg::DisplaySettings* getDisplaySettings() { return _displaySettings.get(); }
/** Set the DsplaySettings object associated with this view.*/ /** Get the const DisplaySettings object associated with this view.*/
const osg::DisplaySettings* getDisplaySettings() const { return _displaySettings.get(); } const osg::DisplaySettings* getDisplaySettings() const { return _displaySettings.get(); }

View File

@ -505,7 +505,7 @@ class OSG_EXPORT HeightField : public Shape
/** Get the FloatArray height data.*/ /** Get the FloatArray height data.*/
osg::FloatArray* getFloatArray() { return _heights.get(); } osg::FloatArray* getFloatArray() { return _heights.get(); }
/** Get the const sFloatArray height data.*/ /** Get the const FloatArray height data.*/
const osg::FloatArray* getFloatArray() const { return _heights.get(); } const osg::FloatArray* getFloatArray() const { return _heights.get(); }
HeightList& getHeightList() { return _heights->asVector(); } HeightList& getHeightList() { return _heights->asVector(); }
@ -568,7 +568,7 @@ class OSG_EXPORT HeightField : public Shape
unsigned int _columns,_rows; unsigned int _columns,_rows;
osg::Vec3 _origin; osg::Vec3 _origin; // _origin is the min value of the X and Y coordinates.
float _dx; float _dx;
float _dy; float _dy;

View File

@ -88,6 +88,7 @@ namespace osgAnimation
* dirty the bounding sphere to force it to be recomputed on the next * dirty the bounding sphere to force it to be recomputed on the next
* call to \c getBound(). * call to \c getBound().
* @param morphTarget The \c MorphTarget to be added to the \c MorphGeometry. * @param morphTarget The \c MorphTarget to be added to the \c MorphGeometry.
* @param weight The weight to be added to the \c MorphGeometry.
* @return \c true for success; \c false otherwise. * @return \c true for success; \c false otherwise.
*/ */
virtual void addMorphTarget( osg::Geometry *morphTarget, float weight = 1.0 ) { _morphTargets.push_back(MorphTarget(morphTarget, weight)); _dirty = true; } virtual void addMorphTarget( osg::Geometry *morphTarget, float weight = 1.0 ) { _morphTargets.push_back(MorphTarget(morphTarget, weight)); _dirty = true; }

View File

@ -88,9 +88,9 @@ class OSGTERRAIN_EXPORT Locator : public osg::Object
virtual bool orientationOpenGL() const; virtual bool orientationOpenGL() const;
virtual bool convertLocalToModel(const osg::Vec3d& /*local*/, osg::Vec3d& /*world*/) const; virtual bool convertLocalToModel(const osg::Vec3d& local, osg::Vec3d& world) const;
virtual bool convertModelToLocal(const osg::Vec3d& /*world*/, osg::Vec3d& /*local*/) const; virtual bool convertModelToLocal(const osg::Vec3d& world, osg::Vec3d& local) const;
static bool convertLocalCoordBetween(const Locator& source, const osg::Vec3d& sourceNDC, static bool convertLocalCoordBetween(const Locator& source, const osg::Vec3d& sourceNDC,
const Locator& destination, osg::Vec3d& destinationNDC) const Locator& destination, osg::Vec3d& destinationNDC)

View File

@ -22,7 +22,7 @@
namespace osgTerrain { namespace osgTerrain {
/** Terrain provides a framework for loosely coupling height field data with height rendering algorithms. /** Terrain provides a framework for loosely coupling height field data with height rendering algorithms.
* This allows TerrainTechnique's to be plugged in at runtime.*/ * This allows TerrainTechniques to be plugged in at runtime.*/
class OSGTERRAIN_EXPORT Terrain : public osg::Group class OSGTERRAIN_EXPORT Terrain : public osg::Group
{ {
public: public:

View File

@ -117,7 +117,7 @@ class OSGTERRAIN_EXPORT TerrainTile : public osg::Group
/** Get the coordinate frame locator of the terrain node.*/ /** Get the coordinate frame locator of the terrain node.*/
Locator* getLocator() { return _locator.get(); } Locator* getLocator() { return _locator.get(); }
/** Get the coordinate frame locator of the terrain node.*/ /** Get the const coordinate frame locator of the terrain node.*/
const Locator* getLocator() const { return _locator.get(); } const Locator* getLocator() const { return _locator.get(); }
/** Set the layer to use to define the elevations of the terrain.*/ /** Set the layer to use to define the elevations of the terrain.*/

View File

@ -138,7 +138,7 @@ Vec3 HeightField::getNormal(unsigned int c,unsigned int r) const
Vec2 HeightField::getHeightDelta(unsigned int c,unsigned int r) const Vec2 HeightField::getHeightDelta(unsigned int c,unsigned int r) const
{ {
// four point normal generation. // four point height generation.
Vec2 heightDelta; Vec2 heightDelta;
if (c==0) if (c==0)
{ {

View File

@ -953,6 +953,7 @@ void DrawShapeVisitor::apply(const HeightField& field)
// draw each row of HeightField
for(unsigned int row=0;row<field.getNumRows()-1;++row,vBase+=dv) for(unsigned int row=0;row<field.getNumRows()-1;++row,vBase+=dv)
{ {
@ -962,7 +963,7 @@ void DrawShapeVisitor::apply(const HeightField& field)
glBegin(GL_QUAD_STRIP); glBegin(GL_QUAD_STRIP);
// draw skirt at beginning if required. // draw skirt at beginning of this row if required.
if (field.getSkirtHeight()!=0.0f) if (field.getSkirtHeight()!=0.0f)
{ {
vertTop.set(0.0f,dy*(float)(row+1),field.getHeight(0,row+1)-field.getSkirtHeight()); vertTop.set(0.0f,dy*(float)(row+1),field.getHeight(0,row+1)-field.getSkirtHeight());
@ -980,6 +981,7 @@ void DrawShapeVisitor::apply(const HeightField& field)
glVertex3fv(vertBase.ptr()); glVertex3fv(vertBase.ptr());
} }
// draw the actual row
for(unsigned int col=0;col<field.getNumColumns();++col,u+=du) for(unsigned int col=0;col<field.getNumColumns();++col,u+=du)
{ {
vertTop.set(dx*(float)col,dy*(float)(row+1),field.getHeight(col,row+1)); vertTop.set(dx*(float)col,dy*(float)(row+1),field.getHeight(col,row+1));
@ -998,7 +1000,7 @@ void DrawShapeVisitor::apply(const HeightField& field)
} }
// draw skirt at end if required. // draw skirt at end of this row if required.
if (field.getSkirtHeight()!=0.0f) if (field.getSkirtHeight()!=0.0f)
{ {

View File

@ -142,8 +142,8 @@ class ReaderWriter3DC : public osgDB::ReaderWriter
if (vertices->size()>=targetNumVertices) if (vertices->size()>=targetNumVertices)
{ {
// finishing setting up the current geometry and add it to the geode. // finishing setting up the current geometry and add it to the geode.
geometry->setUseDisplayList(true); geometry->setUseDisplayList(true);
geometry->setUseVertexBufferObjects(true); geometry->setUseVertexBufferObjects(true);
geometry->setVertexArray(vertices); geometry->setVertexArray(vertices);
geometry->setNormalArray(normals); geometry->setNormalArray(normals);
geometry->setNormalBinding(osg::Geometry::BIND_PER_VERTEX); geometry->setNormalBinding(osg::Geometry::BIND_PER_VERTEX);
@ -175,7 +175,7 @@ class ReaderWriter3DC : public osgDB::ReaderWriter
geometry->setUseDisplayList(true); geometry->setUseDisplayList(true);
geometry->setUseVertexBufferObjects(true); geometry->setUseVertexBufferObjects(true);
geometry->setVertexArray(vertices); geometry->setVertexArray(vertices);
geometry->setNormalArray(normals); geometry->setNormalArray(normals);
geometry->setNormalBinding(osg::Geometry::BIND_PER_VERTEX); geometry->setNormalBinding(osg::Geometry::BIND_PER_VERTEX);
@ -189,19 +189,19 @@ class ReaderWriter3DC : public osgDB::ReaderWriter
} }
virtual WriteResult writeNode(const osg::Node& node,const std::string& fileName,const Options* options =NULL) const virtual WriteResult writeNode(const osg::Node& node,const std::string& fileName,const Options* options =NULL) const
{ {
if (!acceptsExtension(osgDB::getFileExtension(fileName))) std::string ext = osgDB::getLowerCaseFileExtension(fileName);
return WriteResult(WriteResult::FILE_NOT_HANDLED); if( !acceptsExtension(ext)) return WriteResult::FILE_NOT_HANDLED;
osgDB::ofstream f(fileName.c_str()); osgDB::ofstream f(fileName.c_str());
Writer3DCNodeVisitor nv(f); Writer3DCNodeVisitor nv(f);
// we must cast away constness // we must cast away constness
(const_cast<osg::Node*>(&node))->accept(nv); (const_cast<osg::Node*>(&node))->accept(nv);
return WriteResult(WriteResult::FILE_SAVED); return WriteResult::FILE_SAVED;
} }
}; };

View File

@ -1,6 +1,6 @@
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2004 Robert Osfield /* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2004 Robert Osfield
* *
* This application is open source and may be redistributed and/or modified * This application is open source and may be redistributed and/or modified
* freely and without restriction, both in commericial and non commericial * freely and without restriction, both in commericial and non commericial
* applications, as long as this copyright notice is maintained. * applications, as long as this copyright notice is maintained.
* *
@ -55,7 +55,7 @@ static bool getFilenameAndParams(const std::string& input, std::string& filename
return false; return false;
} }
// clear the params sting of any brackets. // clear the params string of any brackets.
std::string::size_type params_pos = params.size(); std::string::size_type params_pos = params.size();
for(; params_pos>0; ) for(; params_pos>0; )
{ {
@ -81,10 +81,10 @@ static bool getFilenameAndParams(const std::string& input, std::string& filename
* This pseudo-loader make it simple to change the size of a saved model * This pseudo-loader make it simple to change the size of a saved model
* by specifying a correcting scale factor as part of the filename. * by specifying a correcting scale factor as part of the filename.
* *
* Usage: <modelfile.ext>.<sx>,<sy>,<sz>.globe * Usage: <modelfile.ext>.<sx>,<sy>,<sz>.scale
* <modelfile.ext>.<su>.globe * <modelfile.ext>.<su>.scale
* where: * where:
* <modelfile.ext> = an model filename. * <modelfile.ext> = a model filename.
* <sx> = scale factor along the X axis. * <sx> = scale factor along the X axis.
* <sy> = scale factor along the Y axis. * <sy> = scale factor along the Y axis.
* <sz> = scale factor along the Z axis. * <sz> = scale factor along the Z axis.
@ -104,7 +104,7 @@ public:
virtual const char* className() const { return "scaling pseudo-loader"; } virtual const char* className() const { return "scaling pseudo-loader"; }
virtual bool acceptsExtension(const std::string& extension) const virtual bool acceptsExtension(const std::string& extension) const
{ {
return osgDB::equalCaseInsensitive( extension, EXTENSION_NAME ); return osgDB::equalCaseInsensitive( extension, EXTENSION_NAME );
} }

View File

@ -36,7 +36,7 @@ osg::StateSet* getSingletonLightPointSystemSet()
if (!s_stateset) if (!s_stateset)
{ {
s_stateset = new osg::StateSet; s_stateset = new osg::StateSet;
// force light point nodes to be drawn after everything else by picking a renderin bin number after // force light point nodes to be drawn after everything else by picking a rendering bin number after
// the transparent bin. // the transparent bin.
s_stateset->setRenderBinDetails(20,"DepthSortedBin"); s_stateset->setRenderBinDetails(20,"DepthSortedBin");
} }
@ -147,7 +147,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
#endif #endif
// should we disabled small feature culling here? // should we disable small feature culling here?
if (cv /*&& !cv->isCulled(_bbox)*/) if (cv /*&& !cv->isCulled(_bbox)*/)
{ {
@ -158,7 +158,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
if (rg->leaves_empty()) if (rg->leaves_empty())
{ {
// this is first leaf to be added to StateGraph // this is first leaf to be added to StateGraph
// and therefore should not already know to current render bin, // and therefore should not already know current render bin,
// so need to add it. // so need to add it.
cv->getCurrentRenderBin()->addStateGraph(rg); cv->getCurrentRenderBin()->addStateGraph(rg);
} }
@ -210,7 +210,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
if (litr == rg->_leaves.end()) if (litr == rg->_leaves.end())
{ {
// havn't found the drawable added in the RenderLeaf list, there this my be the // haven't found the drawable added in the RenderLeaf list, therefore this may be the
// first time through LightPointNode in this frame, so need to add drawable into the StateGraph RenderLeaf list // first time through LightPointNode in this frame, so need to add drawable into the StateGraph RenderLeaf list
// and update its time signatures. // and update its time signatures.
@ -267,7 +267,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
float intensity = (_lightSystem.valid()) ? _lightSystem->getIntensity() : lp._intensity; float intensity = (_lightSystem.valid()) ? _lightSystem->getIntensity() : lp._intensity;
// slip light point if it is intensity is 0.0 or negative. // slip light point if its intensity is 0.0 or negative.
if (intensity<=minimumIntensity) continue; if (intensity<=minimumIntensity) continue;
// (SIB) Clip on distance, if close to limit, add transparancy // (SIB) Clip on distance, if close to limit, add transparancy
@ -286,7 +286,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
{ {
intensity *= (*lp._sector)(dv); intensity *= (*lp._sector)(dv);
// slip light point if it is intensity is 0.0 or negative. // skip light point if it is intensity is 0.0 or negative.
if (intensity<=minimumIntensity) continue; if (intensity<=minimumIntensity) continue;
} }
@ -308,7 +308,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
color[3] *= bs[3]; color[3] *= bs[3];
} }
// if alpha value is less than the min intentsive then skip // if alpha value is less than the min intentsity then skip
if (color[3]<=minimumIntensity) continue; if (color[3]<=minimumIntensity) continue;
float pixelSize = cv->pixelSize(position,lp._radius); float pixelSize = cv->pixelSize(position,lp._radius);
@ -318,7 +318,7 @@ void LightPointNode::traverse(osg::NodeVisitor& nv)
// adjust pixel size to account for intensity. // adjust pixel size to account for intensity.
if (intensity!=1.0) pixelSize *= sqrt(intensity); if (intensity!=1.0) pixelSize *= sqrt(intensity);
// adjust alfa to account for max range (Fade on distance) // adjust alpha to account for max range (Fade on distance)
color[3] *= distanceFactor; color[3] *= distanceFactor;
// round up to the minimum pixel size if required. // round up to the minimum pixel size if required.

View File

@ -1092,7 +1092,7 @@ void CullVisitor::apply(osg::ClearNode& node)
} }
else else
{ {
// we have an earth sky implementation to do the work for use // we have an earth sky implementation to do the work for us
// so we don't need to clear. // so we don't need to clear.
getCurrentRenderBin()->getStage()->setClearMask(0); getCurrentRenderBin()->getStage()->setClearMask(0);
} }

View File

@ -67,7 +67,7 @@ RenderBin* RenderBin::createRenderBin(const std::string& binName)
if (prototype) return dynamic_cast<RenderBin*>(prototype->clone(osg::CopyOp::DEEP_COPY_ALL)); if (prototype) return dynamic_cast<RenderBin*>(prototype->clone(osg::CopyOp::DEEP_COPY_ALL));
} }
osg::notify(osg::WARN) <<"Warning: RenderBin \""<<binName<<"\" implemention not found, using default RenderBin as a fallback."<<std::endl; osg::notify(osg::WARN) <<"Warning: RenderBin \""<<binName<<"\" implementation not found, using default RenderBin as a fallback."<<std::endl;
return new RenderBin; return new RenderBin;
} }
@ -382,7 +382,7 @@ RenderBin* RenderBin::find_or_insert(int binNum,const std::string& binName)
RenderBinList::iterator itr = _bins.find(binNum); RenderBinList::iterator itr = _bins.find(binNum);
if (itr!=_bins.end()) return itr->second.get(); if (itr!=_bins.end()) return itr->second.get();
// create a renderin bin and insert into bin list. // create a rendering bin and insert into bin list.
RenderBin* rb = RenderBin::createRenderBin(binName); RenderBin* rb = RenderBin::createRenderBin(binName);
if (rb) if (rb)
{ {