FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix of tabbing and typo

Browse Source
This commit is contained in:
Robert Osfield 2004-09-13 17:19:05 +00:00
parent 4c4be0a750
commit c204628d1a
2 changed files with 26 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
include/osg/State
View File

@ -48,7 +48,7 @@ namespace osg {
#endif
#endif
/** macro for use with osg::StateAttrbiute::apply methods for detecting and
/** macro for use with osg::StateAttribute::apply methods for detecting and
* reporting OpenGL error messages.*/
#define OSG_GL_DEBUG(message) \
if (state.getFineGrainedErrorDetection()) \
@ -69,17 +69,17 @@ class SG_EXPORT State : public Referenced
State();
/** push stateset onto state stack.*/
/** Push stateset onto state stack.*/
void pushStateSet(const StateSet* dstate);
/** pop stateset off state stack.*/
/** Pop stateset off state stack.*/
void popStateSet();
/** pop all statesets off state stack, ensuring it is empty ready for the next frame.
* note, to return OpenGL to default state, one should do any state.popAllStatSets(); state.apply().*/
* Note, to return OpenGL to default state, one should do any state.popAllStatSets(); state.apply().*/
void popAllStateSets();
/** copy the modes and attributes which captures the current state.*/
/** Copy the modes and attributes which capture the current state.*/
void captureCurrentState(StateSet& stateset) const;
/** reset the state object to an empty stack.*/
@ -273,8 +273,6 @@ class SG_EXPORT State : public Referenced
/** Get the current specified attribute, return NULL if one has not yet been applied.*/
const StateAttribute* getLastAppliedAttribute(StateAttribute::Type type) const;
/** texture Mode has been set externally, update state to reflect this setting.*/
void haveAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode,StateAttribute::GLModeValue value);
@ -307,7 +305,7 @@ class SG_EXPORT State : public Referenced
/** Dirty the modes attributes previously applied in osg::State.*/
void dirtyAllAttributes();
/** disable the vertex, normal, color, tex coords, secenday color, fog coord and index arrays.*/
/** disable the vertex, normal, color, tex coords, secondary color, fog coord and index arrays.*/
void disableAllVertexArrays();
/** dirty the vertex, normal, color, tex coords, secondary color, fog coord and index arrays.*/
@ -596,14 +594,14 @@ class SG_EXPORT State : public Referenced
}
}
/** set the current tex coord array texture unit, return true if selected,
* false if selection failed such as when multitexturing is not supported.
/** Set the current tex coord array texture unit, return true if selected,
* false if selection failed such as when multitexturing is not supported.
* note, only updates values that change.*/
bool setClientActiveTextureUnit( unsigned int unit );
/** set the current texture unit, return true if selected,
* false if selection failed such as when multitexturing is not supported.
* false if selection failed such as when multitexturing is not supported.
* note, only updates values that change.*/
bool setActiveTextureUnit( unsigned int unit );
@ -641,7 +639,7 @@ class SG_EXPORT State : public Referenced
for each context, the contextID simply acts as an index in local
arrays that they maintain for the purpose.
Typical settings for contextID are 0,1,2,3... up to the maximum
number of graphics contexts you have setup.
number of graphics contexts you have set up.
By default contextID is 0.*/
inline void setContextID(unsigned int contextID) { _contextID=contextID; }
@ -652,7 +650,7 @@ class SG_EXPORT State : public Referenced
/** Set the frame stamp for the current frame.*/
inline void setFrameStamp(FrameStamp* fs) { _frameStamp = fs; }
/** Set the frame stamp for the current frame.*/
/** Get the frame stamp for the current frame.*/
inline const FrameStamp* getFrameStamp() const { return _frameStamp.get(); }
@ -1026,7 +1024,7 @@ inline void State::applyModeList(ModeMap& modeMap,const StateSet::ModeList& mode
if (!ms.valueVec.empty() && (ms.valueVec.back() & StateAttribute::OVERRIDE) && !(ds_mitr->second & StateAttribute::PROTECTED))
{
// override is on, there just treat as a normal apply on modes.
// override is on, just treat as a normal apply on modes.
if (ms.changed)
{
@ -1124,8 +1122,8 @@ inline void State::applyAttributeList(AttributeMap& attributeMap,const StateSet:
else if (ds_aitr->first<this_aitr->first)
{
// ds_mitr->first is a new attribute, therefore
// need to insert a new attribute entry for ds_aistr->first.
// ds_aitr->first is a new attribute, therefore
// need to insert a new attribute entry for ds_aitr->first.
AttributeStack& as = attributeMap[ds_aitr->first];
const StateAttribute* new_attr = ds_aitr->second.first.get();
@ -1146,7 +1144,7 @@ inline void State::applyAttributeList(AttributeMap& attributeMap,const StateSet:
if (!as.attributeVec.empty() && (as.attributeVec.back().second & StateAttribute::OVERRIDE) && !(ds_aitr->second.second & StateAttribute::PROTECTED))
{
// override is on, there just treat as a normal apply on modes.
// override is on, just treat as a normal apply on modes.
if (as.changed)
{
@ -1197,8 +1195,8 @@ inline void State::applyAttributeList(AttributeMap& attributeMap,const StateSet:
ds_aitr!=attributeList.end();
++ds_aitr)
{
// ds_mitr->first is a new attribute, therefore
// need to insert a new attribute entry for ds_aistr->first.
// ds_aitr->first is a new attribute, therefore
// need to insert a new attribute entry for ds_aitr->first.
AttributeStack& as = attributeMap[ds_aitr->first];
const StateAttribute* new_attr = ds_aitr->second.first.get();

18
include/osg/StateSet
View File

@ -65,7 +65,7 @@ class SG_EXPORT StateSet : public Object
nodes which inherit all of their modes for the global state.*/
void setAllToInherit();
/** merge this stateset with stateset rhs, this overrides
/** merge this stateset with stateset rhs, this overrides
* the rhs if OVERRIDE is specified, otherwise rhs takes precedence.*/
void merge(const StateSet& rhs);
@ -76,7 +76,7 @@ class SG_EXPORT StateSet : public Object
void setMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value);
/** set this StateSet to inherit specified GLMode type from parents.
* Has the effect of deleting any GlMode of specified type from StateSet.*/
* Has the effect of deleting any GLMode of specified type from StateSet.*/
void setModeToInherit(StateAttribute::GLMode mode);
/** get specified GLModeValue for specified GLMode.
@ -105,15 +105,15 @@ class SG_EXPORT StateSet : public Object
void setAttributeToInherit(StateAttribute::Type type);
/** get specified StateAttribute for specified type.
* returns NULL if no type is contained within StateSet.*/
* Returns NULL if no type is contained within StateSet.*/
StateAttribute* getAttribute(StateAttribute::Type type);
/** get specified const StateAttribute for specified type.
* returns NULL if no type is contained within const StateSet.*/
* Returns NULL if no type is contained within const StateSet.*/
const StateAttribute* getAttribute(StateAttribute::Type type) const;
/** get specified RefAttributePair for specified type.
* returns NULL if no type is contained within StateSet.*/
* Returns NULL if no type is contained within StateSet.*/
const RefAttributePair* getAttributePair(StateAttribute::Type type) const;
/** return the list of all StateAttributes contained in this StateSet.*/
@ -129,7 +129,7 @@ class SG_EXPORT StateSet : public Object
/** set this StateSet to contain specified GLMode and value.*/
void setTextureMode(unsigned int unit,StateAttribute::GLMode mode, StateAttribute::GLModeValue value);
/** set this StateSet to inherit specified GLMode type from parents.
* has the effect of deleting any GlMode of specified type from StateSet.*/
* has the effect of deleting any GLMode of specified type from StateSet.*/
void setTextureModeToInherit(unsigned int unit,StateAttribute::GLMode mode);
/** get specified GLModeValue for specified GLMode.
@ -162,13 +162,13 @@ class SG_EXPORT StateSet : public Object
const StateAttribute* getTextureAttribute(unsigned int unit,StateAttribute::Type type) const;
/** get specified Texture related RefAttributePair for specified type.
* returns NULL if no type is contained within StateSet.*/
* Returns NULL if no type is contained within StateSet.*/
const RefAttributePair* getTextureAttributePair(unsigned int unit,StateAttribute::Type type) const;
/** return the list of all Texture related StateAttributes contained in this StateSet.*/
/** Return the list of all Texture related StateAttributes contained in this StateSet.*/
inline TextureAttributeList& getTextureAttributeList() { return _textureAttributeList; }
/** return the const list of all Texture related StateAttributes contained in this const StateSet.*/
/** Return the const list of all Texture related StateAttributes contained in this const StateSet.*/
inline const TextureAttributeList& getTextureAttributeList() const { return _textureAttributeList; }