From c269cc88b2911caeccf9755114aa8044ac1bdfe9 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Thu, 17 Apr 2003 16:22:51 +0000 Subject: [PATCH] Added doc++ documentation. --- doc/doc++/osg/AlphaFunc.html | 263 ++++ doc/doc++/osg/AnimationPath.html | 250 ++++ doc/doc++/osg/AnimationPathCallback.html | 212 +++ doc/doc++/osg/ApplicationUsage.html | 212 +++ doc/doc++/osg/ApplicationUsageProxy.html | 38 + doc/doc++/osg/ArgumentParser.html | 318 ++++ doc/doc++/osg/Array.html | 273 ++++ doc/doc++/osg/ArrayVisitor.html | 108 ++ doc/doc++/osg/AttributeFunctor.html | 102 ++ doc/doc++/osg/Billboard.html | 550 +++++++ doc/doc++/osg/BlendFunc.html | 287 ++++ doc/doc++/osg/BoundingBox.html | 260 ++++ doc/doc++/osg/BoundingSphere.html | 214 +++ doc/doc++/osg/Box.html | 227 +++ .../osg/COMPARE_StateAttribute_Parameter.html | 22 + .../osg/COMPARE_StateAttribute_Types.html | 20 + doc/doc++/osg/Camera.html | 719 +++++++++ doc/doc++/osg/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osg/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osg/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osg/ClearNode.html | 375 +++++ doc/doc++/osg/ClipNode.html | 436 ++++++ doc/doc++/osg/ClipPlane.html | 294 ++++ doc/doc++/osg/CollectOccludersVisitor.html | 484 ++++++ doc/doc++/osg/ColorMask.html | 240 +++ doc/doc++/osg/ColorMatrix.html | 218 +++ doc/doc++/osg/CompositeShape.html | 229 +++ doc/doc++/osg/Cone.html | 251 ++++ doc/doc++/osg/ConstArrayVisitor.html | 42 + doc/doc++/osg/ConstAttributeFunctor.html | 42 + doc/doc++/osg/ConstShapeVisitor.html | 42 + doc/doc++/osg/ConstValueVisitor.html | 42 + doc/doc++/osg/ConvexHull.html | 156 ++ doc/doc++/osg/ConvexPlanarOccluder.html | 187 +++ doc/doc++/osg/ConvexPlanarPolygon.html | 75 + doc/doc++/osg/CopyOp.html | 185 +++ doc/doc++/osg/CullFace.html | 231 +++ doc/doc++/osg/CullStack.html | 557 +++++++ doc/doc++/osg/CullingSet.html | 284 ++++ doc/doc++/osg/Cylinder.html | 239 +++ doc/doc++/osg/DOFTransform.html | 727 +++++++++ doc/doc++/osg/DeleteHandler.html | 69 + doc/doc++/osg/Depth.html | 299 ++++ doc/doc++/osg/DisplaySettings.html | 491 ++++++ doc/doc++/osg/DrawArrayLengths.html | 245 +++ doc/doc++/osg/DrawArrays.html | 253 ++++ doc/doc++/osg/DrawElementsUByte.html | 214 +++ doc/doc++/osg/DrawElementsUInt.html | 214 +++ doc/doc++/osg/DrawElementsUShort.html | 220 +++ doc/doc++/osg/DrawPixels.html | 420 ++++++ doc/doc++/osg/Drawable.html | 785 ++++++++++ doc/doc++/osg/Endian.html | 37 + doc/doc++/osg/Extensions.2.html | 231 +++ doc/doc++/osg/Extensions.3.html | 123 ++ doc/doc++/osg/Extensions.4.html | 183 +++ doc/doc++/osg/Extensions.html | 327 ++++ doc/doc++/osg/Fog.html | 337 +++++ doc/doc++/osg/FrameStamp.html | 198 +++ doc/doc++/osg/FrontFace.html | 223 +++ doc/doc++/osg/General.html | 766 ++++++++++ doc/doc++/osg/GeoSet.html | 1327 +++++++++++++++++ doc/doc++/osg/Geode.html | 412 +++++ doc/doc++/osg/Geometry.html | 899 +++++++++++ doc/doc++/osg/Grid.html | 217 +++ doc/doc++/osg/Group.html | 427 ++++++ doc/doc++/osg/HIER.html | 232 +++ doc/doc++/osg/HIERjava.html | 331 ++++ doc/doc++/osg/HeightField.html | 279 ++++ doc/doc++/osg/Image.html | 596 ++++++++ doc/doc++/osg/Impostor.html | 488 ++++++ doc/doc++/osg/ImpostorSprite.html | 596 ++++++++ doc/doc++/osg/ImpostorSpriteManager.html | 178 +++ doc/doc++/osg/IndexArray.html | 174 +++ doc/doc++/osg/InfinitePlane.html | 198 +++ doc/doc++/osg/LOD.html | 483 ++++++ doc/doc++/osg/Light.html | 452 ++++++ doc/doc++/osg/LightModel.html | 275 ++++ doc/doc++/osg/LightSource.html | 424 ++++++ doc/doc++/osg/LineSegment.html | 211 +++ doc/doc++/osg/LineStipple.html | 224 +++ doc/doc++/osg/LineWidth.html | 204 +++ doc/doc++/osg/META_Node.html | 22 + doc/doc++/osg/META_Object.html | 23 + doc/doc++/osg/META_Shape.html | 24 + doc/doc++/osg/META_StateAttribute.html | 24 + doc/doc++/osg/Material.html | 481 ++++++ doc/doc++/osg/Matrix.html | 587 ++++++++ doc/doc++/osg/MatrixTransform.html | 457 ++++++ doc/doc++/osg/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osg/Node.html | 697 +++++++++ doc/doc++/osg/NodeAcceptOp.html | 51 + doc/doc++/osg/NodeCallback.html | 173 +++ doc/doc++/osg/NodePath.html | 20 + doc/doc++/osg/NodeVisitor.html | 535 +++++++ doc/doc++/osg/NotifySeverity.html | 73 + doc/doc++/osg/OSGUTX_ADD_TESTCASE.html | 22 + doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html | 22 + .../osg/OSGUTX_AUTOREGISTER_TESTSUITE.html | 20 + .../osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html | 20 + doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html | 22 + doc/doc++/osg/OSGUTX_END_TESTSUITE.html | 22 + doc/doc++/osg/OSGUTX_TESTSUITE.html | 20 + doc/doc++/osg/OSGUTX_TEST_E.html | 27 + doc/doc++/osg/OSGUTX_TEST_F.html | 27 + doc/doc++/osg/OSG_GL_DEBUG.html | 21 + doc/doc++/osg/Object.html | 244 +++ doc/doc++/osg/OccluderNode.html | 361 +++++ doc/doc++/osg/Plane.html | 295 ++++ doc/doc++/osg/Point.html | 250 ++++ doc/doc++/osg/PolygonMode.html | 265 ++++ doc/doc++/osg/PolygonOffset.html | 232 +++ doc/doc++/osg/PolygonStipple.html | 210 +++ doc/doc++/osg/Polytope.html | 321 ++++ doc/doc++/osg/PositionAttitudeTransform.html | 444 ++++++ doc/doc++/osg/PrimitiveFunctor.html | 102 ++ doc/doc++/osg/PrimitiveSet.html | 294 ++++ doc/doc++/osg/Projection.html | 369 +++++ doc/doc++/osg/QualifiedTestPrinter.html | 65 + doc/doc++/osg/Quat.html | 385 +++++ doc/doc++/osg/RefMatrix.html | 331 ++++ doc/doc++/osg/Referenced.html | 156 ++ doc/doc++/osg/Sequence.html | 519 +++++++ doc/doc++/osg/ShadeModel.html | 223 +++ doc/doc++/osg/ShadowVolumeOccluder.html | 222 +++ doc/doc++/osg/ShadowVolumeOccluderList.html | 20 + doc/doc++/osg/Shape.html | 187 +++ doc/doc++/osg/ShapeDrawable.html | 399 +++++ doc/doc++/osg/ShapeVisitor.html | 90 ++ doc/doc++/osg/Sphere.html | 191 +++ doc/doc++/osg/State.html | 1101 ++++++++++++++ doc/doc++/osg/StateAttribute.html | 524 +++++++ doc/doc++/osg/StateSet.html | 728 +++++++++ doc/doc++/osg/Statistics.html | 287 ++++ doc/doc++/osg/Stencil.html | 381 +++++ doc/doc++/osg/SubloadCallback.2.html | 77 + doc/doc++/osg/SubloadCallback.3.html | 77 + doc/doc++/osg/SubloadCallback.4.html | 77 + doc/doc++/osg/SubloadCallback.5.html | 77 + doc/doc++/osg/SubloadCallback.html | 77 + doc/doc++/osg/Switch.html | 477 ++++++ doc/doc++/osg/TemplateArray.html | 212 +++ doc/doc++/osg/TemplateIndexArray.html | 224 +++ doc/doc++/osg/TessellationHints.html | 295 ++++ doc/doc++/osg/Test.html | 119 ++ doc/doc++/osg/TestCase.html | 125 ++ doc/doc++/osg/TestCase_.html | 134 ++ doc/doc++/osg/TestContext.html | 98 ++ doc/doc++/osg/TestErrorX.html | 60 + doc/doc++/osg/TestFailureX.html | 57 + doc/doc++/osg/TestGraph.html | 77 + doc/doc++/osg/TestQualifier.html | 79 + doc/doc++/osg/TestRecord.html | 87 ++ doc/doc++/osg/TestReport.html | 43 + doc/doc++/osg/TestRunner.html | 103 ++ doc/doc++/osg/TestSuite.html | 143 ++ .../osg/TestSuiteAutoRegistrationAgent.html | 37 + doc/doc++/osg/TestVisitor.html | 85 ++ doc/doc++/osg/TestX.html | 65 + doc/doc++/osg/TexEnv.html | 263 ++++ doc/doc++/osg/TexEnvCombine.html | 637 ++++++++ doc/doc++/osg/TexGen.html | 311 ++++ doc/doc++/osg/TexMat.html | 222 +++ doc/doc++/osg/Texture.html | 712 +++++++++ doc/doc++/osg/Texture1D.html | 477 ++++++ doc/doc++/osg/Texture2D.html | 487 ++++++ doc/doc++/osg/Texture3D.html | 496 ++++++ doc/doc++/osg/TextureCubeMap.html | 511 +++++++ doc/doc++/osg/TextureRectangle.html | 437 ++++++ doc/doc++/osg/Timer.html | 80 + doc/doc++/osg/TraceStream.html | 60 + doc/doc++/osg/Transform.html | 538 +++++++ doc/doc++/osg/TriangleFunctor.html | 138 ++ doc/doc++/osg/TriangleMesh.html | 187 +++ doc/doc++/osg/UByte4.html | 218 +++ doc/doc++/osg/ValueVisitor.html | 102 ++ doc/doc++/osg/Vec2.html | 247 +++ doc/doc++/osg/Vec3.html | 267 ++++ doc/doc++/osg/Vec4.html | 289 ++++ doc/doc++/osg/VectorSizei.2.html | 31 + doc/doc++/osg/VectorSizei.html | 54 + doc/doc++/osg/VectorUByte.2.html | 31 + doc/doc++/osg/VectorUByte.html | 54 + doc/doc++/osg/VectorUInt.2.html | 31 + doc/doc++/osg/VectorUInt.html | 54 + doc/doc++/osg/VectorUShort.2.html | 31 + doc/doc++/osg/VectorUShort.html | 54 + doc/doc++/osg/VertexProgram.html | 344 +++++ doc/doc++/osg/Viewport.html | 279 ++++ doc/doc++/osg/buffered_object.html | 81 + doc/doc++/osg/buffered_value.html | 84 ++ doc/doc++/osg/clampArray3BetweenRange.html | 23 + doc/doc++/osg/clampArray3GEQUAL.html | 22 + doc/doc++/osg/clampArray3LEQUAL.html | 22 + doc/doc++/osg/clampArray4BetweenRange.html | 23 + doc/doc++/osg/clampArray4GEQUAL.html | 22 + doc/doc++/osg/clampArray4LEQUAL.html | 22 + .../osg/clampArrayElementBetweenRange.html | 23 + doc/doc++/osg/clampArrayElementGEQUAL.html | 22 + doc/doc++/osg/clampArrayElementLEQUAL.html | 22 + .../osg/clampArrayElementsBetweenRange.html | 23 + doc/doc++/osg/clampArrayElementsGEQUAL.html | 22 + doc/doc++/osg/clampArrayElementsLEQUAL.html | 22 + doc/doc++/osg/clampBetweenRange.html | 23 + doc/doc++/osg/clampGEQUAL.html | 22 + doc/doc++/osg/clampLEQUAL.html | 22 + doc/doc++/osg/computeEyeToLocal.html | 22 + doc/doc++/osg/computeLocalToEye.html | 22 + doc/doc++/osg/computeLocalToWorld.html | 21 + doc/doc++/osg/computeWorldToLocal.html | 21 + doc/doc++/osg/createGeodeForImage.2.html | 22 + doc/doc++/osg/createGeodeForImage.html | 22 + doc/doc++/osg/fast_back_stack.html | 131 ++ doc/doc++/osg/for_each_triangle.html | 22 + doc/doc++/osg/getGLExtensionFuncPtr.2.html | 23 + doc/doc++/osg/getGLExtensionFuncPtr.html | 25 + doc/doc++/osg/getNotifyLevel.html | 20 + doc/doc++/osg/globalnotifylevel..html | 16 + doc/doc++/osg/globalnotifynulstream..html | 16 + doc/doc++/osg/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osg/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osg/index.html | 299 ++++ doc/doc++/osg/initNotifyLevel.html | 20 + doc/doc++/osg/isGLExtensionSupported.html | 22 + doc/doc++/osg/isGLUExtensionSupported.html | 22 + doc/doc++/osg/notify.html | 32 + doc/doc++/osg/operator.2.html | 20 + doc/doc++/osg/operator.html | 20 + doc/doc++/osg/osg.html | 725 +++++++++ doc/doc++/osg/osgGetLibraryName.html | 21 + doc/doc++/osg/osgGetVersion.html | 34 + doc/doc++/osg/osgUtx.html | 73 + doc/doc++/osg/ref_ptr.html | 181 +++ doc/doc++/osg/setNotifyLevel.html | 21 + ...nSG_EXPORTNotifySeverityg_NotifyLevel.html | 16 + .../osg/xternSG_EXPORTboolg_NotifyInit.html | 16 + ...dauto_ptrstdofstreamg_NotifyNulStream.html | 16 + doc/doc++/osgDB/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgDB/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgDB/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgDB/DirectoryContents.html | 20 + doc/doc++/osgDB/DotOsgWrapper.html | 188 +++ doc/doc++/osgDB/DynamicLibrary.html | 171 +++ doc/doc++/osgDB/Field.html | 367 +++++ doc/doc++/osgDB/FieldReader.html | 92 ++ doc/doc++/osgDB/FieldReaderIterator.html | 252 ++++ doc/doc++/osgDB/FilePathList.html | 20 + doc/doc++/osgDB/General.html | 73 + doc/doc++/osgDB/HIER.html | 34 + doc/doc++/osgDB/HIERjava.html | 121 ++ doc/doc++/osgDB/Input.html | 189 +++ doc/doc++/osgDB/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgDB/Options.html | 82 + doc/doc++/osgDB/Output.html | 267 ++++ doc/doc++/osgDB/ParameterOutput.html | 87 ++ doc/doc++/osgDB/PushAndPopDataPath.html | 46 + doc/doc++/osgDB/ReadResult.html | 188 +++ doc/doc++/osgDB/ReaderWriter.html | 105 ++ .../osgDB/RegisterDotOsgWrapperProxy.html | 53 + .../osgDB/RegisterReaderWriterProxy.html | 53 + doc/doc++/osgDB/Registry.html | 579 +++++++ doc/doc++/osgDB/WriteResult.html | 122 ++ doc/doc++/osgDB/fileExists.html | 20 + doc/doc++/osgDB/findFileInDirectory.html | 23 + doc/doc++/osgDB/findFileInPath.html | 20 + doc/doc++/osgDB/getDirectoryContents.html | 21 + doc/doc++/osgDB/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgDB/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgDB/index.html | 49 + doc/doc++/osgDB/osgDB.html | 207 +++ doc/doc++/osgDB/osgDBGetLibraryName.html | 21 + doc/doc++/osgDB/osgDBGetVersion.html | 34 + doc/doc++/osgDB/readCommandLine.html | 20 + doc/doc++/osgDB/readImageFile.html | 25 + doc/doc++/osgDB/readNodeFile.html | 25 + doc/doc++/osgDB/readNodeFiles.2.html | 21 + doc/doc++/osgDB/readNodeFiles.html | 21 + doc/doc++/osgDB/readObjectFile.html | 25 + doc/doc++/osgDB/writeImageFile.html | 25 + doc/doc++/osgDB/writeNodeFile.html | 25 + doc/doc++/osgDB/writeObjectFile.html | 25 + doc/doc++/osgGA/AnimationPathManipulator.html | 209 +++ doc/doc++/osgGA/CameraManipulator.html | 181 +++ doc/doc++/osgGA/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgGA/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgGA/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgGA/CompositeGUIEventHandler.html | 140 ++ doc/doc++/osgGA/DriveManipulator.html | 271 ++++ doc/doc++/osgGA/FlightManipulator.html | 261 ++++ doc/doc++/osgGA/GUIActionAdapter.html | 97 ++ doc/doc++/osgGA/GUIEventAdapter.html | 852 +++++++++++ doc/doc++/osgGA/GUIEventHandler.html | 110 ++ doc/doc++/osgGA/GUIEventHandlerVisitor.html | 105 ++ doc/doc++/osgGA/General.html | 64 + doc/doc++/osgGA/HIER.html | 35 + doc/doc++/osgGA/HIERjava.html | 44 + .../osgGA/KeySwitchCameraManipulator.html | 192 +++ doc/doc++/osgGA/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgGA/SetSceneViewVisitor.html | 79 + doc/doc++/osgGA/StateSetManipulator.html | 147 ++ doc/doc++/osgGA/TrackballManipulator.html | 265 ++++ doc/doc++/osgGA/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgGA/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgGA/index.html | 50 + doc/doc++/osgGA/osgGA.html | 60 + doc/doc++/osgGA/osgGAGetLibraryName.html | 21 + doc/doc++/osgGA/osgGAGetVersion.html | 34 + doc/doc++/osgGA/spaceosgGA.html | 40 + doc/doc++/osgParticle/AccelOperator.html | 134 ++ doc/doc++/osgParticle/CenteredPlacer.html | 121 ++ doc/doc++/osgParticle/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgParticle/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgParticle/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgParticle/Counter.html | 93 ++ doc/doc++/osgParticle/Emitter.html | 187 +++ .../osgParticle/FluidFrictionOperator.html | 177 +++ doc/doc++/osgParticle/ForceOperator.html | 127 ++ doc/doc++/osgParticle/General.html | 115 ++ doc/doc++/osgParticle/HIER.html | 61 + doc/doc++/osgParticle/HIERjava.html | 79 + doc/doc++/osgParticle/Interpolator.html | 121 ++ doc/doc++/osgParticle/LinearInterpolator.html | 87 ++ doc/doc++/osgParticle/ModularEmitter.html | 225 +++ doc/doc++/osgParticle/ModularProgram.html | 183 +++ doc/doc++/osgParticle/MultiSegmentPlacer.html | 153 ++ doc/doc++/osgParticle/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgParticle/Operator.html | 141 ++ doc/doc++/osgParticle/Particle.html | 385 +++++ doc/doc++/osgParticle/ParticleProcessor.html | 247 +++ doc/doc++/osgParticle/ParticleSystem.html | 380 +++++ .../osgParticle/ParticleSystemUpdater.html | 152 ++ doc/doc++/osgParticle/Placer.html | 101 ++ doc/doc++/osgParticle/PointPlacer.html | 108 ++ doc/doc++/osgParticle/Program.html | 158 ++ doc/doc++/osgParticle/RadialShooter.html | 172 +++ doc/doc++/osgParticle/RandomRateCounter.html | 101 ++ doc/doc++/osgParticle/SectorPlacer.html | 156 ++ doc/doc++/osgParticle/SegmentPlacer.html | 154 ++ doc/doc++/osgParticle/Shooter.html | 100 ++ .../osgParticle/VariableRateCounter.html | 112 ++ doc/doc++/osgParticle/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgParticle/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgParticle/index.html | 61 + doc/doc++/osgParticle/osgParticle.html | 112 ++ doc/doc++/osgParticle/range.html | 81 + doc/doc++/osgParticle/rangef.html | 20 + doc/doc++/osgParticle/rangev2.html | 20 + doc/doc++/osgParticle/rangev3.html | 20 + doc/doc++/osgParticle/rangev4.html | 20 + doc/doc++/osgProducer/Callback.html | 52 + doc/doc++/osgProducer/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgProducer/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgProducer/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgProducer/EventAdapter.html | 352 +++++ doc/doc++/osgProducer/General.html | 49 + doc/doc++/osgProducer/HIER.html | 26 + doc/doc++/osgProducer/HIERjava.html | 65 + .../osgProducer/KeyboardMouseCallback.html | 250 ++++ doc/doc++/osgProducer/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgProducer/OsgCameraGroup.html | 438 ++++++ doc/doc++/osgProducer/OsgSceneHandler.html | 185 +++ doc/doc++/osgProducer/RealizeCallback.html | 60 + doc/doc++/osgProducer/Viewer.html | 504 +++++++ doc/doc++/osgProducer/ViewerEventHandler.html | 191 +++ doc/doc++/osgProducer/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgProducer/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgProducer/index.html | 41 + doc/doc++/osgProducer/osgProducer.html | 38 + .../osgProducerGetLibraryName.html | 21 + .../osgProducer/osgProducerGetVersion.html | 34 + doc/doc++/osgSim/AzimElevationSector.html | 116 ++ doc/doc++/osgSim/AzimRange.html | 88 ++ doc/doc++/osgSim/AzimSector.html | 91 ++ doc/doc++/osgSim/BlinkSequence.html | 172 +++ doc/doc++/osgSim/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgSim/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgSim/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgSim/ConeSector.html | 121 ++ doc/doc++/osgSim/ElevationRange.html | 100 ++ doc/doc++/osgSim/ElevationSector.html | 111 ++ doc/doc++/osgSim/General.html | 49 + doc/doc++/osgSim/HIER.html | 37 + doc/doc++/osgSim/HIERjava.html | 65 + doc/doc++/osgSim/LightPoint.html | 130 ++ doc/doc++/osgSim/LightPointNode.html | 201 +++ doc/doc++/osgSim/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgSim/Sector.html | 60 + doc/doc++/osgSim/SequenceGroup.html | 63 + doc/doc++/osgSim/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgSim/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgSim/index.html | 44 + doc/doc++/osgSim/osgSim.html | 45 + doc/doc++/osgSim/osgSimGetLibraryName.html | 21 + doc/doc++/osgSim/osgSimGetVersion.html | 34 + doc/doc++/osgText/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgText/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgText/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgText/Font.html | 341 +++++ doc/doc++/osgText/FontImplementation.html | 105 ++ doc/doc++/osgText/General.html | 40 + doc/doc++/osgText/Glyph.html | 253 ++++ doc/doc++/osgText/GlyphTexture.html | 179 +++ doc/doc++/osgText/HIER.html | 22 + doc/doc++/osgText/HIERjava.html | 58 + doc/doc++/osgText/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgText/String.html | 159 ++ doc/doc++/osgText/Text.html | 692 +++++++++ doc/doc++/osgText/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgText/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgText/index.html | 38 + doc/doc++/osgText/osgText.html | 35 + doc/doc++/osgText/osgTextGetLibraryName.html | 21 + doc/doc++/osgText/osgTextGetVersion.html | 34 + doc/doc++/osgText/readFontFile.html | 20 + doc/doc++/osgUtil/ClassGraph.class | Bin 0 -> 1237 bytes doc/doc++/osgUtil/ClassGraphPanel.class | Bin 0 -> 4084 bytes doc/doc++/osgUtil/ClassLayout.class | Bin 0 -> 2443 bytes doc/doc++/osgUtil/CombineLODsVisitor.html | 79 + .../ConvertGeoSetsToGeometryVisitor.html | 60 + doc/doc++/osgUtil/CubeMapGenerator.html | 125 ++ doc/doc++/osgUtil/CullVisitor.html | 612 ++++++++ doc/doc++/osgUtil/DelaunayTriangulator.html | 150 ++ doc/doc++/osgUtil/DisplayListVisitor.html | 151 ++ .../osgUtil/DisplayRequirementsVisitor.html | 104 ++ .../FlattenStaticTransformsVisitor.html | 128 ++ doc/doc++/osgUtil/General.html | 109 ++ doc/doc++/osgUtil/HIER.html | 59 + doc/doc++/osgUtil/HIERjava.html | 219 +++ doc/doc++/osgUtil/HalfWayMapGenerator.html | 105 ++ doc/doc++/osgUtil/HighlightMapGenerator.html | 105 ++ doc/doc++/osgUtil/Hit.html | 168 +++ doc/doc++/osgUtil/InsertImpostorsVisitor.html | 161 ++ doc/doc++/osgUtil/IntersectState.html | 127 ++ doc/doc++/osgUtil/IntersectVisitor.html | 210 +++ doc/doc++/osgUtil/LeafDepthSortFunctor.html | 31 + doc/doc++/osgUtil/MergeGeometryVisitor.html | 108 ++ doc/doc++/osgUtil/NavigatorButton.class | Bin 0 -> 1816 bytes doc/doc++/osgUtil/Optimizer.html | 99 ++ doc/doc++/osgUtil/PickIntersectVisitor.html | 130 ++ doc/doc++/osgUtil/PickVisitor.html | 94 ++ doc/doc++/osgUtil/ReflectionMapGenerator.html | 103 ++ doc/doc++/osgUtil/RegisterRenderBinProxy.html | 53 + .../osgUtil/RemoveEmptyNodesVisitor.html | 84 ++ .../osgUtil/RemoveRedundantNodesVisitor.html | 84 ++ doc/doc++/osgUtil/RenderBin.html | 390 +++++ doc/doc++/osgUtil/RenderGraph.html | 231 +++ doc/doc++/osgUtil/RenderLeaf.html | 99 ++ doc/doc++/osgUtil/RenderStage.html | 443 ++++++ doc/doc++/osgUtil/RenderStageLighting.html | 130 ++ doc/doc++/osgUtil/RenderToTextureStage.html | 310 ++++ doc/doc++/osgUtil/SceneView.html | 937 ++++++++++++ doc/doc++/osgUtil/SmoothingVisitor.html | 67 + doc/doc++/osgUtil/StateVisitor.html | 111 ++ doc/doc++/osgUtil/Tesselator.html | 325 ++++ doc/doc++/osgUtil/TransformCallback.html | 85 ++ doc/doc++/osgUtil/TriStripVisitor.html | 105 ++ doc/doc++/osgUtil/UpdateVisitor.html | 166 +++ doc/doc++/osgUtil/icon1.gif | Bin 0 -> 326 bytes doc/doc++/osgUtil/icon2.gif | Bin 0 -> 326 bytes doc/doc++/osgUtil/index.html | 61 + doc/doc++/osgUtil/osgUtil.html | 103 ++ doc/doc++/osgUtil/osgUtilGetLibraryName.html | 21 + doc/doc++/osgUtil/osgUtilGetVersion.html | 34 + 462 files changed, 73791 insertions(+) create mode 100644 doc/doc++/osg/AlphaFunc.html create mode 100644 doc/doc++/osg/AnimationPath.html create mode 100644 doc/doc++/osg/AnimationPathCallback.html create mode 100644 doc/doc++/osg/ApplicationUsage.html create mode 100644 doc/doc++/osg/ApplicationUsageProxy.html create mode 100644 doc/doc++/osg/ArgumentParser.html create mode 100644 doc/doc++/osg/Array.html create mode 100644 doc/doc++/osg/ArrayVisitor.html create mode 100644 doc/doc++/osg/AttributeFunctor.html create mode 100644 doc/doc++/osg/Billboard.html create mode 100644 doc/doc++/osg/BlendFunc.html create mode 100644 doc/doc++/osg/BoundingBox.html create mode 100644 doc/doc++/osg/BoundingSphere.html create mode 100644 doc/doc++/osg/Box.html create mode 100644 doc/doc++/osg/COMPARE_StateAttribute_Parameter.html create mode 100644 doc/doc++/osg/COMPARE_StateAttribute_Types.html create mode 100644 doc/doc++/osg/Camera.html create mode 100644 doc/doc++/osg/ClassGraph.class create mode 100644 doc/doc++/osg/ClassGraphPanel.class create mode 100644 doc/doc++/osg/ClassLayout.class create mode 100644 doc/doc++/osg/ClearNode.html create mode 100644 doc/doc++/osg/ClipNode.html create mode 100644 doc/doc++/osg/ClipPlane.html create mode 100644 doc/doc++/osg/CollectOccludersVisitor.html create mode 100644 doc/doc++/osg/ColorMask.html create mode 100644 doc/doc++/osg/ColorMatrix.html create mode 100644 doc/doc++/osg/CompositeShape.html create mode 100644 doc/doc++/osg/Cone.html create mode 100644 doc/doc++/osg/ConstArrayVisitor.html create mode 100644 doc/doc++/osg/ConstAttributeFunctor.html create mode 100644 doc/doc++/osg/ConstShapeVisitor.html create mode 100644 doc/doc++/osg/ConstValueVisitor.html create mode 100644 doc/doc++/osg/ConvexHull.html create mode 100644 doc/doc++/osg/ConvexPlanarOccluder.html create mode 100644 doc/doc++/osg/ConvexPlanarPolygon.html create mode 100644 doc/doc++/osg/CopyOp.html create mode 100644 doc/doc++/osg/CullFace.html create mode 100644 doc/doc++/osg/CullStack.html create mode 100644 doc/doc++/osg/CullingSet.html create mode 100644 doc/doc++/osg/Cylinder.html create mode 100644 doc/doc++/osg/DOFTransform.html create mode 100644 doc/doc++/osg/DeleteHandler.html create mode 100644 doc/doc++/osg/Depth.html create mode 100644 doc/doc++/osg/DisplaySettings.html create mode 100644 doc/doc++/osg/DrawArrayLengths.html create mode 100644 doc/doc++/osg/DrawArrays.html create mode 100644 doc/doc++/osg/DrawElementsUByte.html create mode 100644 doc/doc++/osg/DrawElementsUInt.html create mode 100644 doc/doc++/osg/DrawElementsUShort.html create mode 100644 doc/doc++/osg/DrawPixels.html create mode 100644 doc/doc++/osg/Drawable.html create mode 100644 doc/doc++/osg/Endian.html create mode 100644 doc/doc++/osg/Extensions.2.html create mode 100644 doc/doc++/osg/Extensions.3.html create mode 100644 doc/doc++/osg/Extensions.4.html create mode 100644 doc/doc++/osg/Extensions.html create mode 100644 doc/doc++/osg/Fog.html create mode 100644 doc/doc++/osg/FrameStamp.html create mode 100644 doc/doc++/osg/FrontFace.html create mode 100644 doc/doc++/osg/General.html create mode 100644 doc/doc++/osg/GeoSet.html create mode 100644 doc/doc++/osg/Geode.html create mode 100644 doc/doc++/osg/Geometry.html create mode 100644 doc/doc++/osg/Grid.html create mode 100644 doc/doc++/osg/Group.html create mode 100644 doc/doc++/osg/HIER.html create mode 100644 doc/doc++/osg/HIERjava.html create mode 100644 doc/doc++/osg/HeightField.html create mode 100644 doc/doc++/osg/Image.html create mode 100644 doc/doc++/osg/Impostor.html create mode 100644 doc/doc++/osg/ImpostorSprite.html create mode 100644 doc/doc++/osg/ImpostorSpriteManager.html create mode 100644 doc/doc++/osg/IndexArray.html create mode 100644 doc/doc++/osg/InfinitePlane.html create mode 100644 doc/doc++/osg/LOD.html create mode 100644 doc/doc++/osg/Light.html create mode 100644 doc/doc++/osg/LightModel.html create mode 100644 doc/doc++/osg/LightSource.html create mode 100644 doc/doc++/osg/LineSegment.html create mode 100644 doc/doc++/osg/LineStipple.html create mode 100644 doc/doc++/osg/LineWidth.html create mode 100644 doc/doc++/osg/META_Node.html create mode 100644 doc/doc++/osg/META_Object.html create mode 100644 doc/doc++/osg/META_Shape.html create mode 100644 doc/doc++/osg/META_StateAttribute.html create mode 100644 doc/doc++/osg/Material.html create mode 100644 doc/doc++/osg/Matrix.html create mode 100644 doc/doc++/osg/MatrixTransform.html create mode 100644 doc/doc++/osg/NavigatorButton.class create mode 100644 doc/doc++/osg/Node.html create mode 100644 doc/doc++/osg/NodeAcceptOp.html create mode 100644 doc/doc++/osg/NodeCallback.html create mode 100644 doc/doc++/osg/NodePath.html create mode 100644 doc/doc++/osg/NodeVisitor.html create mode 100644 doc/doc++/osg/NotifySeverity.html create mode 100644 doc/doc++/osg/OSGUTX_ADD_TESTCASE.html create mode 100644 doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html create mode 100644 doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_END_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_TESTSUITE.html create mode 100644 doc/doc++/osg/OSGUTX_TEST_E.html create mode 100644 doc/doc++/osg/OSGUTX_TEST_F.html create mode 100644 doc/doc++/osg/OSG_GL_DEBUG.html create mode 100644 doc/doc++/osg/Object.html create mode 100644 doc/doc++/osg/OccluderNode.html create mode 100644 doc/doc++/osg/Plane.html create mode 100644 doc/doc++/osg/Point.html create mode 100644 doc/doc++/osg/PolygonMode.html create mode 100644 doc/doc++/osg/PolygonOffset.html create mode 100644 doc/doc++/osg/PolygonStipple.html create mode 100644 doc/doc++/osg/Polytope.html create mode 100644 doc/doc++/osg/PositionAttitudeTransform.html create mode 100644 doc/doc++/osg/PrimitiveFunctor.html create mode 100644 doc/doc++/osg/PrimitiveSet.html create mode 100644 doc/doc++/osg/Projection.html create mode 100644 doc/doc++/osg/QualifiedTestPrinter.html create mode 100644 doc/doc++/osg/Quat.html create mode 100644 doc/doc++/osg/RefMatrix.html create mode 100644 doc/doc++/osg/Referenced.html create mode 100644 doc/doc++/osg/Sequence.html create mode 100644 doc/doc++/osg/ShadeModel.html create mode 100644 doc/doc++/osg/ShadowVolumeOccluder.html create mode 100644 doc/doc++/osg/ShadowVolumeOccluderList.html create mode 100644 doc/doc++/osg/Shape.html create mode 100644 doc/doc++/osg/ShapeDrawable.html create mode 100644 doc/doc++/osg/ShapeVisitor.html create mode 100644 doc/doc++/osg/Sphere.html create mode 100644 doc/doc++/osg/State.html create mode 100644 doc/doc++/osg/StateAttribute.html create mode 100644 doc/doc++/osg/StateSet.html create mode 100644 doc/doc++/osg/Statistics.html create mode 100644 doc/doc++/osg/Stencil.html create mode 100644 doc/doc++/osg/SubloadCallback.2.html create mode 100644 doc/doc++/osg/SubloadCallback.3.html create mode 100644 doc/doc++/osg/SubloadCallback.4.html create mode 100644 doc/doc++/osg/SubloadCallback.5.html create mode 100644 doc/doc++/osg/SubloadCallback.html create mode 100644 doc/doc++/osg/Switch.html create mode 100644 doc/doc++/osg/TemplateArray.html create mode 100644 doc/doc++/osg/TemplateIndexArray.html create mode 100644 doc/doc++/osg/TessellationHints.html create mode 100644 doc/doc++/osg/Test.html create mode 100644 doc/doc++/osg/TestCase.html create mode 100644 doc/doc++/osg/TestCase_.html create mode 100644 doc/doc++/osg/TestContext.html create mode 100644 doc/doc++/osg/TestErrorX.html create mode 100644 doc/doc++/osg/TestFailureX.html create mode 100644 doc/doc++/osg/TestGraph.html create mode 100644 doc/doc++/osg/TestQualifier.html create mode 100644 doc/doc++/osg/TestRecord.html create mode 100644 doc/doc++/osg/TestReport.html create mode 100644 doc/doc++/osg/TestRunner.html create mode 100644 doc/doc++/osg/TestSuite.html create mode 100644 doc/doc++/osg/TestSuiteAutoRegistrationAgent.html create mode 100644 doc/doc++/osg/TestVisitor.html create mode 100644 doc/doc++/osg/TestX.html create mode 100644 doc/doc++/osg/TexEnv.html create mode 100644 doc/doc++/osg/TexEnvCombine.html create mode 100644 doc/doc++/osg/TexGen.html create mode 100644 doc/doc++/osg/TexMat.html create mode 100644 doc/doc++/osg/Texture.html create mode 100644 doc/doc++/osg/Texture1D.html create mode 100644 doc/doc++/osg/Texture2D.html create mode 100644 doc/doc++/osg/Texture3D.html create mode 100644 doc/doc++/osg/TextureCubeMap.html create mode 100644 doc/doc++/osg/TextureRectangle.html create mode 100644 doc/doc++/osg/Timer.html create mode 100644 doc/doc++/osg/TraceStream.html create mode 100644 doc/doc++/osg/Transform.html create mode 100644 doc/doc++/osg/TriangleFunctor.html create mode 100644 doc/doc++/osg/TriangleMesh.html create mode 100644 doc/doc++/osg/UByte4.html create mode 100644 doc/doc++/osg/ValueVisitor.html create mode 100644 doc/doc++/osg/Vec2.html create mode 100644 doc/doc++/osg/Vec3.html create mode 100644 doc/doc++/osg/Vec4.html create mode 100644 doc/doc++/osg/VectorSizei.2.html create mode 100644 doc/doc++/osg/VectorSizei.html create mode 100644 doc/doc++/osg/VectorUByte.2.html create mode 100644 doc/doc++/osg/VectorUByte.html create mode 100644 doc/doc++/osg/VectorUInt.2.html create mode 100644 doc/doc++/osg/VectorUInt.html create mode 100644 doc/doc++/osg/VectorUShort.2.html create mode 100644 doc/doc++/osg/VectorUShort.html create mode 100644 doc/doc++/osg/VertexProgram.html create mode 100644 doc/doc++/osg/Viewport.html create mode 100644 doc/doc++/osg/buffered_object.html create mode 100644 doc/doc++/osg/buffered_value.html create mode 100644 doc/doc++/osg/clampArray3BetweenRange.html create mode 100644 doc/doc++/osg/clampArray3GEQUAL.html create mode 100644 doc/doc++/osg/clampArray3LEQUAL.html create mode 100644 doc/doc++/osg/clampArray4BetweenRange.html create mode 100644 doc/doc++/osg/clampArray4GEQUAL.html create mode 100644 doc/doc++/osg/clampArray4LEQUAL.html create mode 100644 doc/doc++/osg/clampArrayElementBetweenRange.html create mode 100644 doc/doc++/osg/clampArrayElementGEQUAL.html create mode 100644 doc/doc++/osg/clampArrayElementLEQUAL.html create mode 100644 doc/doc++/osg/clampArrayElementsBetweenRange.html create mode 100644 doc/doc++/osg/clampArrayElementsGEQUAL.html create mode 100644 doc/doc++/osg/clampArrayElementsLEQUAL.html create mode 100644 doc/doc++/osg/clampBetweenRange.html create mode 100644 doc/doc++/osg/clampGEQUAL.html create mode 100644 doc/doc++/osg/clampLEQUAL.html create mode 100644 doc/doc++/osg/computeEyeToLocal.html create mode 100644 doc/doc++/osg/computeLocalToEye.html create mode 100644 doc/doc++/osg/computeLocalToWorld.html create mode 100644 doc/doc++/osg/computeWorldToLocal.html create mode 100644 doc/doc++/osg/createGeodeForImage.2.html create mode 100644 doc/doc++/osg/createGeodeForImage.html create mode 100644 doc/doc++/osg/fast_back_stack.html create mode 100644 doc/doc++/osg/for_each_triangle.html create mode 100644 doc/doc++/osg/getGLExtensionFuncPtr.2.html create mode 100644 doc/doc++/osg/getGLExtensionFuncPtr.html create mode 100644 doc/doc++/osg/getNotifyLevel.html create mode 100644 doc/doc++/osg/globalnotifylevel..html create mode 100644 doc/doc++/osg/globalnotifynulstream..html create mode 100644 doc/doc++/osg/icon1.gif create mode 100644 doc/doc++/osg/icon2.gif create mode 100644 doc/doc++/osg/index.html create mode 100644 doc/doc++/osg/initNotifyLevel.html create mode 100644 doc/doc++/osg/isGLExtensionSupported.html create mode 100644 doc/doc++/osg/isGLUExtensionSupported.html create mode 100644 doc/doc++/osg/notify.html create mode 100644 doc/doc++/osg/operator.2.html create mode 100644 doc/doc++/osg/operator.html create mode 100644 doc/doc++/osg/osg.html create mode 100644 doc/doc++/osg/osgGetLibraryName.html create mode 100644 doc/doc++/osg/osgGetVersion.html create mode 100644 doc/doc++/osg/osgUtx.html create mode 100644 doc/doc++/osg/ref_ptr.html create mode 100644 doc/doc++/osg/setNotifyLevel.html create mode 100644 doc/doc++/osg/xternSG_EXPORTNotifySeverityg_NotifyLevel.html create mode 100644 doc/doc++/osg/xternSG_EXPORTboolg_NotifyInit.html create mode 100644 doc/doc++/osg/xternSG_EXPORTstdauto_ptrstdofstreamg_NotifyNulStream.html create mode 100644 doc/doc++/osgDB/ClassGraph.class create mode 100644 doc/doc++/osgDB/ClassGraphPanel.class create mode 100644 doc/doc++/osgDB/ClassLayout.class create mode 100644 doc/doc++/osgDB/DirectoryContents.html create mode 100644 doc/doc++/osgDB/DotOsgWrapper.html create mode 100644 doc/doc++/osgDB/DynamicLibrary.html create mode 100644 doc/doc++/osgDB/Field.html create mode 100644 doc/doc++/osgDB/FieldReader.html create mode 100644 doc/doc++/osgDB/FieldReaderIterator.html create mode 100644 doc/doc++/osgDB/FilePathList.html create mode 100644 doc/doc++/osgDB/General.html create mode 100644 doc/doc++/osgDB/HIER.html create mode 100644 doc/doc++/osgDB/HIERjava.html create mode 100644 doc/doc++/osgDB/Input.html create mode 100644 doc/doc++/osgDB/NavigatorButton.class create mode 100644 doc/doc++/osgDB/Options.html create mode 100644 doc/doc++/osgDB/Output.html create mode 100644 doc/doc++/osgDB/ParameterOutput.html create mode 100644 doc/doc++/osgDB/PushAndPopDataPath.html create mode 100644 doc/doc++/osgDB/ReadResult.html create mode 100644 doc/doc++/osgDB/ReaderWriter.html create mode 100644 doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html create mode 100644 doc/doc++/osgDB/RegisterReaderWriterProxy.html create mode 100644 doc/doc++/osgDB/Registry.html create mode 100644 doc/doc++/osgDB/WriteResult.html create mode 100644 doc/doc++/osgDB/fileExists.html create mode 100644 doc/doc++/osgDB/findFileInDirectory.html create mode 100644 doc/doc++/osgDB/findFileInPath.html create mode 100644 doc/doc++/osgDB/getDirectoryContents.html create mode 100644 doc/doc++/osgDB/icon1.gif create mode 100644 doc/doc++/osgDB/icon2.gif create mode 100644 doc/doc++/osgDB/index.html create mode 100644 doc/doc++/osgDB/osgDB.html create mode 100644 doc/doc++/osgDB/osgDBGetLibraryName.html create mode 100644 doc/doc++/osgDB/osgDBGetVersion.html create mode 100644 doc/doc++/osgDB/readCommandLine.html create mode 100644 doc/doc++/osgDB/readImageFile.html create mode 100644 doc/doc++/osgDB/readNodeFile.html create mode 100644 doc/doc++/osgDB/readNodeFiles.2.html create mode 100644 doc/doc++/osgDB/readNodeFiles.html create mode 100644 doc/doc++/osgDB/readObjectFile.html create mode 100644 doc/doc++/osgDB/writeImageFile.html create mode 100644 doc/doc++/osgDB/writeNodeFile.html create mode 100644 doc/doc++/osgDB/writeObjectFile.html create mode 100644 doc/doc++/osgGA/AnimationPathManipulator.html create mode 100644 doc/doc++/osgGA/CameraManipulator.html create mode 100644 doc/doc++/osgGA/ClassGraph.class create mode 100644 doc/doc++/osgGA/ClassGraphPanel.class create mode 100644 doc/doc++/osgGA/ClassLayout.class create mode 100644 doc/doc++/osgGA/CompositeGUIEventHandler.html create mode 100644 doc/doc++/osgGA/DriveManipulator.html create mode 100644 doc/doc++/osgGA/FlightManipulator.html create mode 100644 doc/doc++/osgGA/GUIActionAdapter.html create mode 100644 doc/doc++/osgGA/GUIEventAdapter.html create mode 100644 doc/doc++/osgGA/GUIEventHandler.html create mode 100644 doc/doc++/osgGA/GUIEventHandlerVisitor.html create mode 100644 doc/doc++/osgGA/General.html create mode 100644 doc/doc++/osgGA/HIER.html create mode 100644 doc/doc++/osgGA/HIERjava.html create mode 100644 doc/doc++/osgGA/KeySwitchCameraManipulator.html create mode 100644 doc/doc++/osgGA/NavigatorButton.class create mode 100644 doc/doc++/osgGA/SetSceneViewVisitor.html create mode 100644 doc/doc++/osgGA/StateSetManipulator.html create mode 100644 doc/doc++/osgGA/TrackballManipulator.html create mode 100644 doc/doc++/osgGA/icon1.gif create mode 100644 doc/doc++/osgGA/icon2.gif create mode 100644 doc/doc++/osgGA/index.html create mode 100644 doc/doc++/osgGA/osgGA.html create mode 100644 doc/doc++/osgGA/osgGAGetLibraryName.html create mode 100644 doc/doc++/osgGA/osgGAGetVersion.html create mode 100644 doc/doc++/osgGA/spaceosgGA.html create mode 100644 doc/doc++/osgParticle/AccelOperator.html create mode 100644 doc/doc++/osgParticle/CenteredPlacer.html create mode 100644 doc/doc++/osgParticle/ClassGraph.class create mode 100644 doc/doc++/osgParticle/ClassGraphPanel.class create mode 100644 doc/doc++/osgParticle/ClassLayout.class create mode 100644 doc/doc++/osgParticle/Counter.html create mode 100644 doc/doc++/osgParticle/Emitter.html create mode 100644 doc/doc++/osgParticle/FluidFrictionOperator.html create mode 100644 doc/doc++/osgParticle/ForceOperator.html create mode 100644 doc/doc++/osgParticle/General.html create mode 100644 doc/doc++/osgParticle/HIER.html create mode 100644 doc/doc++/osgParticle/HIERjava.html create mode 100644 doc/doc++/osgParticle/Interpolator.html create mode 100644 doc/doc++/osgParticle/LinearInterpolator.html create mode 100644 doc/doc++/osgParticle/ModularEmitter.html create mode 100644 doc/doc++/osgParticle/ModularProgram.html create mode 100644 doc/doc++/osgParticle/MultiSegmentPlacer.html create mode 100644 doc/doc++/osgParticle/NavigatorButton.class create mode 100644 doc/doc++/osgParticle/Operator.html create mode 100644 doc/doc++/osgParticle/Particle.html create mode 100644 doc/doc++/osgParticle/ParticleProcessor.html create mode 100644 doc/doc++/osgParticle/ParticleSystem.html create mode 100644 doc/doc++/osgParticle/ParticleSystemUpdater.html create mode 100644 doc/doc++/osgParticle/Placer.html create mode 100644 doc/doc++/osgParticle/PointPlacer.html create mode 100644 doc/doc++/osgParticle/Program.html create mode 100644 doc/doc++/osgParticle/RadialShooter.html create mode 100644 doc/doc++/osgParticle/RandomRateCounter.html create mode 100644 doc/doc++/osgParticle/SectorPlacer.html create mode 100644 doc/doc++/osgParticle/SegmentPlacer.html create mode 100644 doc/doc++/osgParticle/Shooter.html create mode 100644 doc/doc++/osgParticle/VariableRateCounter.html create mode 100644 doc/doc++/osgParticle/icon1.gif create mode 100644 doc/doc++/osgParticle/icon2.gif create mode 100644 doc/doc++/osgParticle/index.html create mode 100644 doc/doc++/osgParticle/osgParticle.html create mode 100644 doc/doc++/osgParticle/range.html create mode 100644 doc/doc++/osgParticle/rangef.html create mode 100644 doc/doc++/osgParticle/rangev2.html create mode 100644 doc/doc++/osgParticle/rangev3.html create mode 100644 doc/doc++/osgParticle/rangev4.html create mode 100644 doc/doc++/osgProducer/Callback.html create mode 100644 doc/doc++/osgProducer/ClassGraph.class create mode 100644 doc/doc++/osgProducer/ClassGraphPanel.class create mode 100644 doc/doc++/osgProducer/ClassLayout.class create mode 100644 doc/doc++/osgProducer/EventAdapter.html create mode 100644 doc/doc++/osgProducer/General.html create mode 100644 doc/doc++/osgProducer/HIER.html create mode 100644 doc/doc++/osgProducer/HIERjava.html create mode 100644 doc/doc++/osgProducer/KeyboardMouseCallback.html create mode 100644 doc/doc++/osgProducer/NavigatorButton.class create mode 100644 doc/doc++/osgProducer/OsgCameraGroup.html create mode 100644 doc/doc++/osgProducer/OsgSceneHandler.html create mode 100644 doc/doc++/osgProducer/RealizeCallback.html create mode 100644 doc/doc++/osgProducer/Viewer.html create mode 100644 doc/doc++/osgProducer/ViewerEventHandler.html create mode 100644 doc/doc++/osgProducer/icon1.gif create mode 100644 doc/doc++/osgProducer/icon2.gif create mode 100644 doc/doc++/osgProducer/index.html create mode 100644 doc/doc++/osgProducer/osgProducer.html create mode 100644 doc/doc++/osgProducer/osgProducerGetLibraryName.html create mode 100644 doc/doc++/osgProducer/osgProducerGetVersion.html create mode 100644 doc/doc++/osgSim/AzimElevationSector.html create mode 100644 doc/doc++/osgSim/AzimRange.html create mode 100644 doc/doc++/osgSim/AzimSector.html create mode 100644 doc/doc++/osgSim/BlinkSequence.html create mode 100644 doc/doc++/osgSim/ClassGraph.class create mode 100644 doc/doc++/osgSim/ClassGraphPanel.class create mode 100644 doc/doc++/osgSim/ClassLayout.class create mode 100644 doc/doc++/osgSim/ConeSector.html create mode 100644 doc/doc++/osgSim/ElevationRange.html create mode 100644 doc/doc++/osgSim/ElevationSector.html create mode 100644 doc/doc++/osgSim/General.html create mode 100644 doc/doc++/osgSim/HIER.html create mode 100644 doc/doc++/osgSim/HIERjava.html create mode 100644 doc/doc++/osgSim/LightPoint.html create mode 100644 doc/doc++/osgSim/LightPointNode.html create mode 100644 doc/doc++/osgSim/NavigatorButton.class create mode 100644 doc/doc++/osgSim/Sector.html create mode 100644 doc/doc++/osgSim/SequenceGroup.html create mode 100644 doc/doc++/osgSim/icon1.gif create mode 100644 doc/doc++/osgSim/icon2.gif create mode 100644 doc/doc++/osgSim/index.html create mode 100644 doc/doc++/osgSim/osgSim.html create mode 100644 doc/doc++/osgSim/osgSimGetLibraryName.html create mode 100644 doc/doc++/osgSim/osgSimGetVersion.html create mode 100644 doc/doc++/osgText/ClassGraph.class create mode 100644 doc/doc++/osgText/ClassGraphPanel.class create mode 100644 doc/doc++/osgText/ClassLayout.class create mode 100644 doc/doc++/osgText/Font.html create mode 100644 doc/doc++/osgText/FontImplementation.html create mode 100644 doc/doc++/osgText/General.html create mode 100644 doc/doc++/osgText/Glyph.html create mode 100644 doc/doc++/osgText/GlyphTexture.html create mode 100644 doc/doc++/osgText/HIER.html create mode 100644 doc/doc++/osgText/HIERjava.html create mode 100644 doc/doc++/osgText/NavigatorButton.class create mode 100644 doc/doc++/osgText/String.html create mode 100644 doc/doc++/osgText/Text.html create mode 100644 doc/doc++/osgText/icon1.gif create mode 100644 doc/doc++/osgText/icon2.gif create mode 100644 doc/doc++/osgText/index.html create mode 100644 doc/doc++/osgText/osgText.html create mode 100644 doc/doc++/osgText/osgTextGetLibraryName.html create mode 100644 doc/doc++/osgText/osgTextGetVersion.html create mode 100644 doc/doc++/osgText/readFontFile.html create mode 100644 doc/doc++/osgUtil/ClassGraph.class create mode 100644 doc/doc++/osgUtil/ClassGraphPanel.class create mode 100644 doc/doc++/osgUtil/ClassLayout.class create mode 100644 doc/doc++/osgUtil/CombineLODsVisitor.html create mode 100644 doc/doc++/osgUtil/ConvertGeoSetsToGeometryVisitor.html create mode 100644 doc/doc++/osgUtil/CubeMapGenerator.html create mode 100644 doc/doc++/osgUtil/CullVisitor.html create mode 100644 doc/doc++/osgUtil/DelaunayTriangulator.html create mode 100644 doc/doc++/osgUtil/DisplayListVisitor.html create mode 100644 doc/doc++/osgUtil/DisplayRequirementsVisitor.html create mode 100644 doc/doc++/osgUtil/FlattenStaticTransformsVisitor.html create mode 100644 doc/doc++/osgUtil/General.html create mode 100644 doc/doc++/osgUtil/HIER.html create mode 100644 doc/doc++/osgUtil/HIERjava.html create mode 100644 doc/doc++/osgUtil/HalfWayMapGenerator.html create mode 100644 doc/doc++/osgUtil/HighlightMapGenerator.html create mode 100644 doc/doc++/osgUtil/Hit.html create mode 100644 doc/doc++/osgUtil/InsertImpostorsVisitor.html create mode 100644 doc/doc++/osgUtil/IntersectState.html create mode 100644 doc/doc++/osgUtil/IntersectVisitor.html create mode 100644 doc/doc++/osgUtil/LeafDepthSortFunctor.html create mode 100644 doc/doc++/osgUtil/MergeGeometryVisitor.html create mode 100644 doc/doc++/osgUtil/NavigatorButton.class create mode 100644 doc/doc++/osgUtil/Optimizer.html create mode 100644 doc/doc++/osgUtil/PickIntersectVisitor.html create mode 100644 doc/doc++/osgUtil/PickVisitor.html create mode 100644 doc/doc++/osgUtil/ReflectionMapGenerator.html create mode 100644 doc/doc++/osgUtil/RegisterRenderBinProxy.html create mode 100644 doc/doc++/osgUtil/RemoveEmptyNodesVisitor.html create mode 100644 doc/doc++/osgUtil/RemoveRedundantNodesVisitor.html create mode 100644 doc/doc++/osgUtil/RenderBin.html create mode 100644 doc/doc++/osgUtil/RenderGraph.html create mode 100644 doc/doc++/osgUtil/RenderLeaf.html create mode 100644 doc/doc++/osgUtil/RenderStage.html create mode 100644 doc/doc++/osgUtil/RenderStageLighting.html create mode 100644 doc/doc++/osgUtil/RenderToTextureStage.html create mode 100644 doc/doc++/osgUtil/SceneView.html create mode 100644 doc/doc++/osgUtil/SmoothingVisitor.html create mode 100644 doc/doc++/osgUtil/StateVisitor.html create mode 100644 doc/doc++/osgUtil/Tesselator.html create mode 100644 doc/doc++/osgUtil/TransformCallback.html create mode 100644 doc/doc++/osgUtil/TriStripVisitor.html create mode 100644 doc/doc++/osgUtil/UpdateVisitor.html create mode 100644 doc/doc++/osgUtil/icon1.gif create mode 100644 doc/doc++/osgUtil/icon2.gif create mode 100644 doc/doc++/osgUtil/index.html create mode 100644 doc/doc++/osgUtil/osgUtil.html create mode 100644 doc/doc++/osgUtil/osgUtilGetLibraryName.html create mode 100644 doc/doc++/osgUtil/osgUtilGetVersion.html diff --git a/doc/doc++/osg/AlphaFunc.html b/doc/doc++/osg/AlphaFunc.html new file mode 100644 index 000000000..64e5175d8 --- /dev/null +++ b/doc/doc++/osg/AlphaFunc.html @@ -0,0 +1,263 @@ + + + + + class SG_EXPORT osg::AlphaFunc + + + + +

class SG_EXPORT osg::AlphaFunc

Encapsulate OpenGL glAlphaFunc
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AlphaFunc() +
+[more] AlphaFunc(const AlphaFunc& af, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, AlphaFunc, ALPHAFUNC) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setFunction(ComparisonFunction func, float ref) +
+[more]inline ComparisonFunction getFunction() const +
+[more]inline float getReferenceValue() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum ComparisonFunction +

+ +

+

Protected Fields

+[more]ComparisonFunction _comparisonFunc +
+[more]float _referenceValue +

+ +

+

Protected Methods

+[more]virtual ~AlphaFunc() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Encapsulate OpenGL glAlphaFunc
+
+ + + +
o AlphaFunc() +

+ + +

o AlphaFunc(const AlphaFunc& af, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, AlphaFunc, ALPHAFUNC) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum ComparisonFunction +

+ + + +
o NEVER +

+ + +

o LESS +

+ + +

o EQUAL +

+ + +

o LEQUAL +

+ + +

o GREATER +

+ + +

o NOTEQUAL +

+ + +

o GEQUAL +

+ + +

o ALWAYS +

+ + + +
oinline void setFunction(ComparisonFunction func, float ref) +

+ + +

oinline ComparisonFunction getFunction() const +

+ + +

oinline float getReferenceValue() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~AlphaFunc() +

+ + +

oComparisonFunction _comparisonFunc +

+ + +

ofloat _referenceValue +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/AnimationPath.html b/doc/doc++/osg/AnimationPath.html new file mode 100644 index 000000000..18f50d0e8 --- /dev/null +++ b/doc/doc++/osg/AnimationPath.html @@ -0,0 +1,250 @@ + + + + + class SG_EXPORT osg::AnimationPath + + + + +

class SG_EXPORT osg::AnimationPath

AnimationPath for specify the time varying transformation pathway to use when update camera and model objects.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AnimationPath() +
+[more] AnimationPath(const AnimationPath& ap, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Object(osg, AnimationPath) +
+[more]bool getMatrix(double time, Matrix& matrix) const +
get the transformation matrix for a point in time +
+[more]bool getInverse(double time, Matrix& matrix) const +
get the inverse transformation matrix for a point in time +
+[more]virtual bool getInterpolatedControlPoint(double time, ControlPoint& controlPoint) const +
get the local ControlPoint frame for a point in time +
+[more]void insert(double time, const ControlPoint& controlPoint) +
+[more]double getFirstTime() const +
+[more]double getLastTime() const +
+[more]double getPeriod() const +
+[more]void setLoopMode(LoopMode lm) +
+[more]LoopMode getLoopMode() const +
+[more]TimeControlPointMap& getTimeControlPointMap() +
+[more]const TimeControlPointMap& getTimeControlPointMap() const +

+ +

+

Public Members

+[more]enum LoopMode +
+[more]typedef std::map<double,ControlPoint> TimeControlPointMap +

+ +

+

Protected Fields

+[more]TimeControlPointMap _timeControlPointMap +
+[more]LoopMode _loopMode +

+ +

+

Protected Methods

+[more]virtual ~AnimationPath() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
AnimationPath for specify the time varying transformation pathway to use when update camera and model objects. +Subclassed from Transform::ComputeTransformCallback allows AnimationPath to +be attached directly to Transform nodes to move subgraphs around the scene.
+
+ + + +
o AnimationPath() +

+ + +

o AnimationPath(const AnimationPath& ap, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osg, AnimationPath) +

+ + +

obool getMatrix(double time, Matrix& matrix) const +
get the transformation matrix for a point in time +

+ + +

obool getInverse(double time, Matrix& matrix) const +
get the inverse transformation matrix for a point in time +

+ + +

ovirtual bool getInterpolatedControlPoint(double time, ControlPoint& controlPoint) const +
get the local ControlPoint frame for a point in time +

+ + +

ovoid insert(double time, const ControlPoint& controlPoint) +

+ + +

odouble getFirstTime() const +

+ + +

odouble getLastTime() const +

+ + +

odouble getPeriod() const +

+ + +

oenum LoopMode +

+ + + +
o SWING +

+ + +

o LOOP +

+ + +

o NO_LOOPING +

+ + + +
ovoid setLoopMode(LoopMode lm) +

+ + +

oLoopMode getLoopMode() const +

+ + +

otypedef std::map<double,ControlPoint> TimeControlPointMap +

+ + +

oTimeControlPointMap& getTimeControlPointMap() +

+ + +

oconst TimeControlPointMap& getTimeControlPointMap() const +

+ + +

ovirtual ~AnimationPath() +

+ + +

oTimeControlPointMap _timeControlPointMap +

+ + +

oLoopMode _loopMode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/AnimationPathCallback.html b/doc/doc++/osg/AnimationPathCallback.html new file mode 100644 index 000000000..15b066664 --- /dev/null +++ b/doc/doc++/osg/AnimationPathCallback.html @@ -0,0 +1,212 @@ + + + + + class SG_EXPORT osg::AnimationPathCallback + + + + +

class SG_EXPORT osg::AnimationPathCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]ref_ptr<AnimationPath> _animationPath +
+[more]double _timeOffset +
+[more]double _timeMultiplier +
+[more]double _firstTime +
+[more]mutable double _animationTime +

+ +

+

Public Methods

+[more] AnimationPathCallback() +
+[more] AnimationPathCallback(const AnimationPathCallback& apc, const CopyOp& copyop) +
+[more]META_Object (osg, AnimationPathCallback)(AnimationPath* ap, double timeOffset=0.0f, double timeMultiplier=1.0f) +
+[more]void setAnimationPath(AnimationPath* path) +
+[more]AnimationPath* getAnimationPath() +
+[more]const AnimationPath* getAnimationPath() const +
+[more]virtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ +

+

Protected Methods

+[more] ~AnimationPathCallback() +

+ +
+

Inherited from NodeCallback:

+
+

+

Public Fields

+oref_ptr<NodeCallback> _nestedCallback +

+ +

+

Public Methods

+oMETA_Object(osg, NodeCallback) ()(Node* node, NodeVisitor* nv) +
+ovoid traverse(Node* node, NodeVisitor* nv) +
+ovoid setNestedCallback(NodeCallback* nc) +
+oNodeCallback* getNestedCallback() +
+oinline void addNestedCallback(NodeCallback* nc) +
+oinline void removeNestedCallback(NodeCallback* nc) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o AnimationPathCallback() +

+ + +

o AnimationPathCallback(const AnimationPathCallback& apc, const CopyOp& copyop) +

+ + +

oMETA_Object (osg, AnimationPathCallback)(AnimationPath* ap, double timeOffset=0.0f, double timeMultiplier=1.0f) +

+ + +

ovoid setAnimationPath(AnimationPath* path) +

+ + +

oAnimationPath* getAnimationPath() +

+ + +

oconst AnimationPath* getAnimationPath() const +

+ + +

ovirtual void operator()(Node* node, NodeVisitor* nv) +
implements the callback +

+ + +

oref_ptr<AnimationPath> _animationPath +

+ + +

odouble _timeOffset +

+ + +

odouble _timeMultiplier +

+ + +

odouble _firstTime +

+ + +

omutable double _animationTime +

+ + +

o ~AnimationPathCallback() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ApplicationUsage.html b/doc/doc++/osg/ApplicationUsage.html new file mode 100644 index 000000000..74f55b3a7 --- /dev/null +++ b/doc/doc++/osg/ApplicationUsage.html @@ -0,0 +1,212 @@ + + + + + class SG_EXPORT osg::ApplicationUsage + + + + +

class SG_EXPORT osg::ApplicationUsage

+ +
+

+

Public Methods

+[more]static ApplicationUsage* instance() +
+[more] ApplicationUsage() +
+[more] ApplicationUsage(const std::string& commandLineUsage) +
+[more]void setApplicationName(const std::string& name) +
+[more]const std::string& getApplicationName() const +
+[more]void setDescription(const std::string& desc) +
+[more]const std::string& getDescription() const +
+[more]void addUsageExplanation(Type type, const std::string& option, const std::string& explanation) +
+[more]void setCommandLineUsage(const std::string& explanation) +
+[more]const std::string& getCommandLineUsage() const +
+[more]void addCommandLineOption(const std::string& option, const std::string& explanation) +
+[more]const UsageMap& getCommandLineOptions() const +
+[more]void addEnvironmentalVariable(const std::string& option, const std::string& explanation) +
+[more]const UsageMap& getEnvironmentalVariables() const +
+[more]void addKeyboardMouseBinding(const std::string& option, const std::string& explanation) +
+[more]const UsageMap& getKeyboardMouseBindings() const +
+[more]void getFormatedString(std::string& str, const UsageMap& um, unsigned int widthOfOutput=80) +
+[more]void write(std::ostream& output, const UsageMap& um, unsigned int widthOfOutput=80) +
+[more]void write(std::ostream& output, unsigned int type=COMMAND_LINE_OPTION|ENVIRONMENTAL_VARIABLE|KEYBOARD_MOUSE_BINDING, unsigned int widthOfOutput=80) +

+ +

+

Public Members

+[more]typedef std::map<std::string,std::string> UsageMap +
+[more]enum Type +

+ +

+

Protected Fields

+[more]std::string _applicationName +
+[more]std::string _description +
+[more]std::string _commandLineUsage +
+[more]UsageMap _commandLineOptions +
+[more]UsageMap _environmentalVariables +
+[more]UsageMap _keyboardMouse +

+ +
+ + +
+

Documentation

+
+ + + +
ostatic ApplicationUsage* instance() +

+ + +

o ApplicationUsage() +

+ + +

o ApplicationUsage(const std::string& commandLineUsage) +

+ + +

otypedef std::map<std::string,std::string> UsageMap +

+ + +

ovoid setApplicationName(const std::string& name) +

+ + +

oconst std::string& getApplicationName() const +

+ + +

ovoid setDescription(const std::string& desc) +

+ + +

oconst std::string& getDescription() const +

+ + +

oenum Type +

+ + + +
o COMMAND_LINE_OPTION +

+ + +

o ENVIRONMENTAL_VARIABLE +

+ + +

o KEYBOARD_MOUSE_BINDING +

+ + + +
ovoid addUsageExplanation(Type type, const std::string& option, const std::string& explanation) +

+ + +

ovoid setCommandLineUsage(const std::string& explanation) +

+ + +

oconst std::string& getCommandLineUsage() const +

+ + +

ovoid addCommandLineOption(const std::string& option, const std::string& explanation) +

+ + +

oconst UsageMap& getCommandLineOptions() const +

+ + +

ovoid addEnvironmentalVariable(const std::string& option, const std::string& explanation) +

+ + +

oconst UsageMap& getEnvironmentalVariables() const +

+ + +

ovoid addKeyboardMouseBinding(const std::string& option, const std::string& explanation) +

+ + +

oconst UsageMap& getKeyboardMouseBindings() const +

+ + +

ovoid getFormatedString(std::string& str, const UsageMap& um, unsigned int widthOfOutput=80) +

+ + +

ovoid write(std::ostream& output, const UsageMap& um, unsigned int widthOfOutput=80) +

+ + +

ovoid write(std::ostream& output, unsigned int type=COMMAND_LINE_OPTION|ENVIRONMENTAL_VARIABLE|KEYBOARD_MOUSE_BINDING, unsigned int widthOfOutput=80) +

+ + +

ostd::string _applicationName +

+ + +

ostd::string _description +

+ + +

ostd::string _commandLineUsage +

+ + +

oUsageMap _commandLineOptions +

+ + +

oUsageMap _environmentalVariables +

+ + +

oUsageMap _keyboardMouse +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ApplicationUsageProxy.html b/doc/doc++/osg/ApplicationUsageProxy.html new file mode 100644 index 000000000..e14352af5 --- /dev/null +++ b/doc/doc++/osg/ApplicationUsageProxy.html @@ -0,0 +1,38 @@ + + + + + class osg::ApplicationUsageProxy + + + + +

class osg::ApplicationUsageProxy

+ +
+

+

Public Methods

+[more] ApplicationUsageProxy(ApplicationUsage::Type type, const std::string& option, const std::string& explanation) +
register an explanation of commandline/evironmentalvaraible/keyboard mouse usage +

+ +
+ + +
+

Documentation

+
+ + + +
o ApplicationUsageProxy(ApplicationUsage::Type type, const std::string& option, const std::string& explanation) +
register an explanation of commandline/evironmentalvaraible/keyboard mouse usage +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ArgumentParser.html b/doc/doc++/osg/ArgumentParser.html new file mode 100644 index 000000000..4f94dc21c --- /dev/null +++ b/doc/doc++/osg/ArgumentParser.html @@ -0,0 +1,318 @@ + + + + + class SG_EXPORT osg::ArgumentParser + + + + +

class SG_EXPORT osg::ArgumentParser

+ +
+

+

Public Methods

+[more] ArgumentParser(int* argc, char** argv) +
+[more]void setApplicationUsage(ApplicationUsage* usage) +
+[more]ApplicationUsage* getApplicationUsage() +
+[more]const ApplicationUsage* getApplicationUsage() const +
+[more]int& argc() +
return the argument count +
+[more]char** argv() +
return the argument array +
+[more]char* operator [] (int pos) +
return char* argument at specificed position +
+[more]const char* operator [] (int pos) const +
return const char* argument at specificed position +
+[more]std::string getApplicationName() const +
return the application name, as specified by argv[0] +
+[more]int find(const std::string& str) const +
return the position of an occurance of a string in the argument list. +
+[more]bool match(int pos, const std::string& str) const +
return true if specified argument matches string +
+[more]bool isOption(int pos) const +
return return true if specified parameter is an option in the form of -option or --option +
+[more]bool isString(int pos) const +
return return true if specified parameter is an string, which can be any other string apart from an option +
+[more]bool isNumber(int pos) const +
return return true if specified parameter is an number +
+[more]bool containsOptions() const +
+[more]void remove(int pos, int num=1) +
remove one or more arguments from the argv argument list, and decrement the argc respectively +
+[more]bool read(const std::string& str) +
search for an occurance of a string in the argument list, on sucess remove that occurance from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, std::string& value1) +
search for an occurance of a string in the argument list followed by a string, on sucess set the value string with the second parameters and then remove the two entries from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, std::string& value1, std::string& value2) +
search for an occurance of a string in the argument list followed by a two strings, on sucess set the value strings with the second & third parameters and then remove the three entries from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, std::string& value1, std::string& value2, std::string& value3) +
search for an occurance of a string in the argument list followed by a three strings, on sucess set the value strings with the second & third & fourth parameters and then remove the four entries from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, float& value) +
search for an occurance of a string in the argument list followed by a numeric value, on sucess set the values with the second parameter and then remove the two entries from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, float& value1, float& value2) +
search for an occurance of a string in the argument list followed by two numeric values, on sucess set the values with the second & third parameters and then remove the three entries from the list and return true, otherwise return false +
+[more]bool read(const std::string& str, float& value1, float& value2, float& value3) +
search for an occurance of a string in the argument list followed by three numeric values, on sucess set the values with the second & third & fourth parameters and then remove the four entries from the list and return true, otherwise return false +
+[more]bool errors(ErrorSeverity severity=BENIGN) const +
return the error flag, true if an error has occured when reading arguments +
+[more]void reportError(const std::string& message, ErrorSeverity severity=CRITICAL) +
report an error message by adding to the ErrorMessageMap +
+[more]void reportRemainingOptionsAsUnrecognized(ErrorSeverity severity=BENIGN) +
for each remaining option report it as an unrecongnized +
+[more]ErrorMessageMap& getErrorMessageMap() +
return the error message, if any has occured +
+[more]const ErrorMessageMap& getErrorMessageMap() const +
return the error message, if any has occured +
+[more]void writeErrorMessages(std::ostream& output, ErrorSeverity sevrity=BENIGN) +
write out error messages at an above specified +

+ +

+

Public Members

+[more]enum ErrorSeverity +
+[more]typedef std::map<std::string,ErrorSeverity> ErrorMessageMap +

+ +

+

Protected Fields

+[more]int* _argc +
+[more]char** _argv +
+[more]ErrorMessageMap _errorMessageMap +
+[more]ApplicationUsage* _usage +

+ +
+ + +
+

Documentation

+
+ + + +
o ArgumentParser(int* argc, char** argv) +

+ + +

ovoid setApplicationUsage(ApplicationUsage* usage) +

+ + +

oApplicationUsage* getApplicationUsage() +

+ + +

oconst ApplicationUsage* getApplicationUsage() const +

+ + +

oint& argc() +
return the argument count +

+ + +

ochar** argv() +
return the argument array +

+ + +

ochar* operator [] (int pos) +
return char* argument at specificed position +

+ + +

oconst char* operator [] (int pos) const +
return const char* argument at specificed position +

+ + +

ostd::string getApplicationName() const +
return the application name, as specified by argv[0] +

+ + +

oint find(const std::string& str) const +
return the position of an occurance of a string in the argument list. +return -1 when no string is found. +

+ + +

obool match(int pos, const std::string& str) const +
return true if specified argument matches string +

+ + +

obool isOption(int pos) const +
return return true if specified parameter is an option in the form of -option or --option +

+ + +

obool isString(int pos) const +
return return true if specified parameter is an string, which can be any other string apart from an option +

+ + +

obool isNumber(int pos) const +
return return true if specified parameter is an number +

+ + +

obool containsOptions() const +

+ + +

ovoid remove(int pos, int num=1) +
remove one or more arguments from the argv argument list, and decrement the argc respectively +

+ + +

obool read(const std::string& str) +
search for an occurance of a string in the argument list, on sucess +remove that occurance from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, std::string& value1) +
search for an occurance of a string in the argument list followed by a string, +on sucess set the value string with the second parameters and then +remove the two entries from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, std::string& value1, std::string& value2) +
search for an occurance of a string in the argument list followed by a two strings, +on sucess set the value strings with the second & third parameters and then +remove the three entries from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, std::string& value1, std::string& value2, std::string& value3) +
search for an occurance of a string in the argument list followed by a three strings, +on sucess set the value strings with the second & third & fourth parameters and then +remove the four entries from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, float& value) +
search for an occurance of a string in the argument list followed by a numeric value, +on sucess set the values with the second parameter and then +remove the two entries from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, float& value1, float& value2) +
search for an occurance of a string in the argument list followed by two numeric values, +on sucess set the values with the second & third parameters and then +remove the three entries from the list and return true, otherwise return false +

+ + +

obool read(const std::string& str, float& value1, float& value2, float& value3) +
search for an occurance of a string in the argument list followed by three numeric values, +on sucess set the values with the second & third & fourth parameters and then +remove the four entries from the list and return true, otherwise return false +

+ + +

oenum ErrorSeverity +

+ + + +
o BENIGN +

+ + +

o CRITICAL +

+ + + +
otypedef std::map<std::string,ErrorSeverity> ErrorMessageMap +

+ + +

obool errors(ErrorSeverity severity=BENIGN) const +
return the error flag, true if an error has occured when reading arguments +

+ + +

ovoid reportError(const std::string& message, ErrorSeverity severity=CRITICAL) +
report an error message by adding to the ErrorMessageMap +

+ + +

ovoid reportRemainingOptionsAsUnrecognized(ErrorSeverity severity=BENIGN) +
for each remaining option report it as an unrecongnized +

+ + +

oErrorMessageMap& getErrorMessageMap() +
return the error message, if any has occured +

+ + +

oconst ErrorMessageMap& getErrorMessageMap() const +
return the error message, if any has occured +

+ + +

ovoid writeErrorMessages(std::ostream& output, ErrorSeverity sevrity=BENIGN) +
write out error messages at an above specified +

+ + +

oint* _argc +

+ + +

ochar** _argv +

+ + +

oErrorMessageMap _errorMessageMap +

+ + +

oApplicationUsage* _usage +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Array.html b/doc/doc++/osg/Array.html new file mode 100644 index 000000000..4d2214570 --- /dev/null +++ b/doc/doc++/osg/Array.html @@ -0,0 +1,273 @@ + + + + + class SG_EXPORT osg::Array + + + + +

class SG_EXPORT osg::Array

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Array(Type arrayType=ArrayType, GLint dataSize=0, GLenum dataType=0) +
+[more] Array(const Array& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void accept(ArrayVisitor&) = 0 +
+[more]virtual void accept(ConstArrayVisitor&) const = 0 +
+[more]virtual void accept(unsigned int index, ValueVisitor&) = 0 +
+[more]virtual void accept(unsigned int index, ConstValueVisitor&) const = 0 +
+[more]Type getType() const +
+[more]GLint getDataSize() const +
+[more]GLenum getDataType() const +
+[more]virtual const GLvoid* getDataPointer() const = 0 +
+[more]virtual unsigned int getNumElements() const = 0 +

+ +

+

Public Members

+[more]enum Type +

+ +

+

Protected Fields

+[more]Type _arrayType +
+[more]GLint _dataSize +
+[more]GLenum _dataType +

+ +

+

Protected Methods

+[more]virtual ~Array() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
oenum Type +

+ + + +
o ArrayType +

+ + +

o ByteArrayType +

+ + +

o ShortArrayType +

+ + +

o IntArrayType +

+ + +

o UByteArrayType +

+ + +

o UShortArrayType +

+ + +

o UIntArrayType +

+ + +

o UByte4ArrayType +

+ + +

o FloatArrayType +

+ + +

o Vec2ArrayType +

+ + +

o Vec3ArrayType +

+ + +

o Vec4ArrayType +

+ + + +
o Array(Type arrayType=ArrayType, GLint dataSize=0, GLenum dataType=0) +

+ + +

o Array(const Array& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void accept(ArrayVisitor&) = 0 +

+ + +

ovirtual void accept(ConstArrayVisitor&) const = 0 +

+ + +

ovirtual void accept(unsigned int index, ValueVisitor&) = 0 +

+ + +

ovirtual void accept(unsigned int index, ConstValueVisitor&) const = 0 +

+ + +

oType getType() const +

+ + +

oGLint getDataSize() const +

+ + +

oGLenum getDataType() const +

+ + +

ovirtual const GLvoid* getDataPointer() const = 0 +

+ + +

ovirtual unsigned int getNumElements() const = 0 +

+ + +

ovirtual ~Array() +

+ + +

oType _arrayType +

+ + +

oGLint _dataSize +

+ + +

oGLenum _dataType +

+
+
Direct child classes: +
TemplateArray
+IndexArray
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ArrayVisitor.html b/doc/doc++/osg/ArrayVisitor.html new file mode 100644 index 000000000..c573ca6cb --- /dev/null +++ b/doc/doc++/osg/ArrayVisitor.html @@ -0,0 +1,108 @@ + + + + + class osg::ArrayVisitor + + + + +

class osg::ArrayVisitor

+ +
+

+

Public Methods

+[more] ArrayVisitor() +
+[more]virtual void apply(Array&) +
+[more]virtual void apply(ByteArray&) +
+[more]virtual void apply(ShortArray&) +
+[more]virtual void apply(IntArray&) +
+[more]virtual void apply(UByteArray&) +
+[more]virtual void apply(UShortArray&) +
+[more]virtual void apply(UIntArray&) +
+[more]virtual void apply(UByte4Array&) +
+[more]virtual void apply(FloatArray&) +
+[more]virtual void apply(Vec2Array&) +
+[more]virtual void apply(Vec3Array&) +
+[more]virtual void apply(Vec4Array&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ArrayVisitor() +

+ + +

ovirtual void apply(Array&) +

+ + +

ovirtual void apply(ByteArray&) +

+ + +

ovirtual void apply(ShortArray&) +

+ + +

ovirtual void apply(IntArray&) +

+ + +

ovirtual void apply(UByteArray&) +

+ + +

ovirtual void apply(UShortArray&) +

+ + +

ovirtual void apply(UIntArray&) +

+ + +

ovirtual void apply(UByte4Array&) +

+ + +

ovirtual void apply(FloatArray&) +

+ + +

ovirtual void apply(Vec2Array&) +

+ + +

ovirtual void apply(Vec3Array&) +

+ + +

ovirtual void apply(Vec4Array&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/AttributeFunctor.html b/doc/doc++/osg/AttributeFunctor.html new file mode 100644 index 000000000..072a417c7 --- /dev/null +++ b/doc/doc++/osg/AttributeFunctor.html @@ -0,0 +1,102 @@ + + + + + class osg::Drawable::AttributeFunctor + + + + +

class AttributeFunctor

+ +
+

+

Public Methods

+[more]virtual ~AttributeFunctor() +
+[more]virtual void apply(AttributeType, unsigned int, GLbyte*) +
+[more]virtual void apply(AttributeType, unsigned int, GLshort*) +
+[more]virtual void apply(AttributeType, unsigned int, GLint*) +
+[more]virtual void apply(AttributeType, unsigned int, GLubyte*) +
+[more]virtual void apply(AttributeType, unsigned int, GLushort*) +
+[more]virtual void apply(AttributeType, unsigned int, GLuint*) +
+[more]virtual void apply(AttributeType, unsigned int, float*) +
+[more]virtual void apply(AttributeType, unsigned int, Vec2*) +
+[more]virtual void apply(AttributeType, unsigned int, Vec3*) +
+[more]virtual void apply(AttributeType, unsigned int, Vec4*) +
+[more]virtual void apply(AttributeType, unsigned int, UByte4*) +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual ~AttributeFunctor() +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLbyte*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLshort*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLint*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLubyte*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLushort*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, GLuint*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, float*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, Vec2*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, Vec3*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, Vec4*) +

+ + +

ovirtual void apply(AttributeType, unsigned int, UByte4*) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Billboard.html b/doc/doc++/osg/Billboard.html new file mode 100644 index 000000000..e958fd275 --- /dev/null +++ b/doc/doc++/osg/Billboard.html @@ -0,0 +1,550 @@ + + + + + class SG_EXPORT osg::Billboard + + + + +

class SG_EXPORT osg::Billboard

Billboard - a Geode which orientates its child osg::Drawable's to face the eye point.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Billboard() +
+[more] Billboard(const Billboard&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Billboard) +
+[more]void setMode(Mode mode) +
Set the billboard rotation mode. +
+[more]inline Mode getMode() const +
Get the billboard rotation mode. +
+[more]void setAxis(const Vec3& axis) +
Set the axis about which all the billboard's drawable rotate. +
+[more]inline const Vec3& getAxis() const +
Get the axis about which all the billboard's drawable rotate. +
+[more]void setNormal(const Vec3& normal) +
Set the normal which defines the billboard's drawable front face, when unrotated. +
+[more]inline const Vec3& getNormal() const +
Get the normal of billboard's drawable front face. +
+[more]inline void setPos(unsigned int i, const Vec3& pos) +
Set the position of specified drawable. +
+[more]inline const Vec3& getPos(unsigned int i) const +
Get the position of specified drawable. +
+[more]inline PositionList& getPositionList() +
Get the PositionList from the billboard +
+[more]inline const PositionList& getPositionList() const +
Get a const PositionList from the billboard +
+[more]virtual bool addDrawable( Drawable* gset ) +
Add Drawable to Billboard with default position(0,0,0); If gset not NULL and is not contained in Billboard then increment its reference count, and dirty the bounding box to cause it to recompute on next getBound() and return true for success. +
+[more]virtual bool addDrawable(Drawable* gset, const Vec3& pos) +
Add Drawable to Geode at position pos. +
+[more]virtual bool removeDrawable( Drawable* gset ) +
Remove Drawable and associated position from Billboard. +
+[more]inline bool getMatrix(Matrix& modelview, const Vec3& eye_local, const Vec3& pos_local) const +
+[more]virtual bool computeMatrix(Matrix& modelview, const Vec3& eye_local, const Vec3& pos_local) const +

+ +

+

Public Members

+[more]enum Mode +
+[more]typedef std::vector<Vec3> PositionList +
PositionList represents a list of pivot points for each drawable +

+ +

+

Protected Fields

+[more]Mode _mode +
+[more]Vec3 _axis +
+[more]Vec3 _normal +
+[more]PositionList _positionList +
+[more]int _cachedMode +
+[more]Vec3 _side +

+ +

+

Protected Methods

+[more]virtual ~Billboard() +
+[more]virtual bool computeBound() const +
+[more]void updateCache() +

+ +

+

Protected Members

+[more]enum AxisAligned +

+ +
+

Inherited from Geode:

+
+

+

Public Methods

+ovirtual bool replaceDrawable( Drawable* origDraw, Drawable* newDraw ) +
+ovirtual bool setDrawable( unsigned int i, Drawable* drawable ) +
+oinline unsigned int getNumDrawables() const +
+oinline Drawable* getDrawable( unsigned int i ) +
+oinline const Drawable* getDrawable( unsigned int i ) const +
+oinline bool containsDrawable(const Drawable* gset) const +
+oinline unsigned int getDrawableIndex( const Drawable* node ) const +
+ovoid compileDrawables(State& state) +

+ +

+

Public Members

+otypedef std::vector< ref_ptr<Drawable> > DrawableList +

+ +

+

Protected Fields

+oDrawableList _drawables +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+ovirtual void traverse(NodeVisitor& ) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Billboard - a Geode which orientates its child osg::Drawable's to face +the eye point. Typical uses are for trees, or particle explosions.
+
+ + + +
oenum Mode +

+ + + +
o POINT_ROT_EYE +

+ + +

o POINT_ROT_WORLD +

+ + +

o AXIAL_ROT +

+ + + +
o Billboard() +

+ + +

o Billboard(const Billboard&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Billboard) +

+ + +

ovoid setMode(Mode mode) +
Set the billboard rotation mode. +

+ + +

oinline Mode getMode() const +
Get the billboard rotation mode. +

+ + +

ovoid setAxis(const Vec3& axis) +
Set the axis about which all the billboard's drawable rotate. Only utlized when mode==AXIAL_ROT +

+ + +

oinline const Vec3& getAxis() const +
Get the axis about which all the billboard's drawable rotate. +

+ + +

ovoid setNormal(const Vec3& normal) +
Set the normal which defines the billboard's drawable front face, when unrotated. +

+ + +

oinline const Vec3& getNormal() const +
Get the normal of billboard's drawable front face. +

+ + +

oinline void setPos(unsigned int i, const Vec3& pos) +
Set the position of specified drawable. +

+ + +

oinline const Vec3& getPos(unsigned int i) const +
Get the position of specified drawable. +

+ + +

otypedef std::vector<Vec3> PositionList +
PositionList represents a list of pivot points for each drawable +

+ + +

oinline PositionList& getPositionList() +
Get the PositionList from the billboard +

+ + +

oinline const PositionList& getPositionList() const +
Get a const PositionList from the billboard +

+ + +

ovirtual bool addDrawable( Drawable* gset ) +
Add Drawable to Billboard with default position(0,0,0); +If gset not NULL and is not contained in Billboard then increment its +reference count, and dirty the bounding box to cause it to recompute on +next getBound() and return true for success. Otherwise return false. +

+ + +

ovirtual bool addDrawable(Drawable* gset, const Vec3& pos) +
Add Drawable to Geode at position pos. +If gset not NULL and is not contained in Billboard then increment its +reference count, and dirty the bounding box to cause it to recompute on +next getBound() and return true for success. Otherwise return false. +

+ + +

ovirtual bool removeDrawable( Drawable* gset ) +
Remove Drawable and associated position from Billboard. +If gset is contained in Billboard then remove it from the geoset +list and decrement its reference count, and dirty the +bounding box to cause it to recompute on next getBound() and +return true for success. If gset is not found then return false +and do not the reference count of gset is left unchanged. +

+ + +

oinline bool getMatrix(Matrix& modelview, const Vec3& eye_local, const Vec3& pos_local) const +

+ + +

ovirtual bool computeMatrix(Matrix& modelview, const Vec3& eye_local, const Vec3& pos_local) const +

+ + +

ovirtual ~Billboard() +

+ + +

ovirtual bool computeBound() const +

+ + +

oenum AxisAligned +

+ + + +
o AXIAL_ROT_X_AXIS +

+ + +

o AXIAL_ROT_Y_AXIS +

+ + +

o AXIAL_ROT_Z_AXIS +

+ + +

o CACHE_DIRTY +

+ + + +
oMode _mode +

+ + +

oVec3 _axis +

+ + +

oVec3 _normal +

+ + +

oPositionList _positionList +

+ + +

oint _cachedMode +

+ + +

oVec3 _side +

+ + +

ovoid updateCache() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/BlendFunc.html b/doc/doc++/osg/BlendFunc.html new file mode 100644 index 000000000..631876b14 --- /dev/null +++ b/doc/doc++/osg/BlendFunc.html @@ -0,0 +1,287 @@ + + + + + class SG_EXPORT osg::BlendFunc + + + + +

class SG_EXPORT osg::BlendFunc

BlendFunc - encapsulates the OpenGL blend/transparency state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] BlendFunc() +
+[more] BlendFunc(const BlendFunc& trans, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, BlendFunc, BLENDFUNC) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setFunction( GLenum source, GLenum destination ) +
+[more]void setSource(GLenum source) +
+[more]inline GLenum getSource() const +
+[more]void setDestination(GLenum destination) +
+[more]inline GLenum getDestination() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum BlendFuncMode +

+ +

+

Protected Fields

+[more]GLenum _source_factor +
+[more]GLenum _destination_factor +

+ +

+

Protected Methods

+[more]virtual ~BlendFunc() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
BlendFunc - encapsulates the OpenGL blend/transparency state
+
+ + + +
o BlendFunc() +

+ + +

o BlendFunc(const BlendFunc& trans, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, BlendFunc, BLENDFUNC) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum BlendFuncMode +

+ + + +
o DST_ALPHA +

+ + +

o DST_COLOR +

+ + +

o ONE +

+ + +

o ONE_MINUS_DST_ALPHA +

+ + +

o ONE_MINUS_DST_COLOR +

+ + +

o ONE_MINUS_SRC_ALPHA +

+ + +

o ONE_MINUS_SRC_COLOR +

+ + +

o SRC_ALPHA +

+ + +

o SRC_ALPHA_SATURATE +

+ + +

o SRC_COLOR +

+ + +

o ZERO +

+ + + +
oinline void setFunction( GLenum source, GLenum destination ) +

+ + +

ovoid setSource(GLenum source) +

+ + +

oinline GLenum getSource() const +

+ + +

ovoid setDestination(GLenum destination) +

+ + +

oinline GLenum getDestination() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~BlendFunc() +

+ + +

oGLenum _source_factor +

+ + +

oGLenum _destination_factor +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/BoundingBox.html b/doc/doc++/osg/BoundingBox.html new file mode 100644 index 000000000..edd6d82ea --- /dev/null +++ b/doc/doc++/osg/BoundingBox.html @@ -0,0 +1,260 @@ + + + + + class SG_EXPORT osg::BoundingBox + + + + +

class SG_EXPORT osg::BoundingBox

General purpose axis-aligned bounding box class for enclosing objects/vertices.
+
+ +
+

+

Public Fields

+[more]Vec3 _min +
The corner with the smallest values for each coordinate of the bounding box +
+[more]Vec3 _max +
The corner with the largest values for each coordinate of the bounding box +

+ +

+

Public Methods

+[more]inline BoundingBox() +
construct to invalid values to represent an unset bounding box +
+[more]inline BoundingBox(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) +
construct to with specified min and max values +
+[more]inline BoundingBox(const Vec3& min, const Vec3& max) +
construct to with specified min and max values +
+[more]inline void init() +
initialize to invalid values to represent an unset bounding box +
+[more]inline bool valid() const +
+[more]inline void set(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) +
+[more]inline void set(const Vec3& min, const Vec3& max) +
construct to with specified min and max values +
+[more]inline float& xMin() +
+[more]inline float xMin() const +
+[more]inline float& yMin() +
+[more]inline float yMin() const +
+[more]inline float& zMin() +
+[more]inline float zMin() const +
+[more]inline float& xMax() +
+[more]inline float xMax() const +
+[more]inline float& yMax() +
+[more]inline float yMax() const +
+[more]inline float& zMax() +
+[more]inline float zMax() const +
+[more]inline const Vec3 center() const +
Calculate and return the center of the bounding box +
+[more]inline float radius() const +
Calculate and return the radius of the bounding box +
+[more]inline float radius2() const +
Calculate and return the radius squared of the bounding box. +
+[more]inline const Vec3 corner(unsigned int pos) const +
return the corner of the bounding box. +
+[more]inline void expandBy(const Vec3& v) +
If the vertex is out-with the box expand to encompass vertex. +
+[more]inline void expandBy(float x, float y, float z) +
If the vertex is out-with the box expand to encompass vertex. +
+[more]void expandBy(const BoundingBox& bb) +
If incoming box is out-with the box expand to encompass incoming box. +
+[more]void expandBy(const BoundingSphere& sh) +
If incoming sphere is out-with the box expand to encompass incoming sphere. +
+[more]inline bool contains(const Vec3& v) const +
return true is vertex v is within the box +

+ +
+ + +
+

Documentation

+
General purpose axis-aligned bounding box class for enclosing objects/vertices. +Used to bounding the leaf objects in the scene, +i.e. osg::Drawable's to assist in view frustum culling etc.
+
+ + + +
oVec3 _min +
The corner with the smallest values for each coordinate of the +bounding box +

+ + +

oVec3 _max +
The corner with the largest values for each coordinate of the +bounding box +

+ + +

oinline BoundingBox() +
construct to invalid values to represent an unset bounding box +

+ + +

oinline BoundingBox(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) +
construct to with specified min and max values +

+ + +

oinline BoundingBox(const Vec3& min, const Vec3& max) +
construct to with specified min and max values +

+ + +

oinline void init() +
initialize to invalid values to represent an unset bounding box +

+ + +

oinline bool valid() const +

+ + +

oinline void set(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) +

+ + +

oinline void set(const Vec3& min, const Vec3& max) +
construct to with specified min and max values +

+ + +

oinline float& xMin() +

+ + +

oinline float xMin() const +

+ + +

oinline float& yMin() +

+ + +

oinline float yMin() const +

+ + +

oinline float& zMin() +

+ + +

oinline float zMin() const +

+ + +

oinline float& xMax() +

+ + +

oinline float xMax() const +

+ + +

oinline float& yMax() +

+ + +

oinline float yMax() const +

+ + +

oinline float& zMax() +

+ + +

oinline float zMax() const +

+ + +

oinline const Vec3 center() const +
Calculate and return the center of the bounding box +

+ + +

oinline float radius() const +
Calculate and return the radius of the bounding box +

+ + +

oinline float radius2() const +
Calculate and return the radius squared of the bounding box. +Note, radius2() is faster to calculate than radius(). +

+ + +

oinline const Vec3 corner(unsigned int pos) const +
return the corner of the bounding box. +Position (pos) is specified by a number between 0 and 7, +the first bit toggles between x min and x max, second +bit toggles between y min and y max, third bit toggles +between z min and z max. +

+ + +

oinline void expandBy(const Vec3& v) +
If the vertex is out-with the box expand to encompass vertex. +If this box is empty then move set this box's min max to vertex. +

+ + +

oinline void expandBy(float x, float y, float z) +
If the vertex is out-with the box expand to encompass vertex. +If this box is empty then move set this box's min max to vertex. +

+ + +

ovoid expandBy(const BoundingBox& bb) +
If incoming box is out-with the box expand to encompass incoming box. +If this box is empty then move set this box to incoming box. +

+ + +

ovoid expandBy(const BoundingSphere& sh) +
If incoming sphere is out-with the box expand to encompass incoming sphere. +If this box is empty then move set this box to encompass the sphere. +

+ + +

oinline bool contains(const Vec3& v) const +
return true is vertex v is within the box +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/BoundingSphere.html b/doc/doc++/osg/BoundingSphere.html new file mode 100644 index 000000000..8b6eccaae --- /dev/null +++ b/doc/doc++/osg/BoundingSphere.html @@ -0,0 +1,214 @@ + + + + + class SG_EXPORT osg::BoundingSphere + + + + +

class SG_EXPORT osg::BoundingSphere

General purpose bounding sphere class for enclosing nodes/objects/vertices.
+
+ +
+

+

Public Fields

+[more]Vec3 _center +
+[more]float _radius +

+ +

+

Public Methods

+[more] BoundingSphere() +
construct to invalid values to represent an unset bounding sphere +
+[more] BoundingSphere(const Vec3& center, float radius) +
construct to specified bounding sphere +
+[more]inline void init() +
initialize to invalid values to represent an unset bounding sphere +
+[more]inline bool valid() const +
return true if the bounding sphere contains valid values, false if the bounding sphere is effectively unset +
+[more]inline void set(const Vec3& center, float radius) +
set bounding sphere +
+[more]inline Vec3& center() +
return the center of the bounding sphere +
+[more]inline const Vec3& center() const +
return the const center of the bounding sphere +
+[more]inline float& radius() +
return the radius of the bounding sphere +
+[more]inline float radius() const +
return the const radius of the bounding sphere +
+[more]inline float radius2() const +
return the radius squared. +
+[more]void expandBy(const Vec3& v) +
If the vertex is out-with the sphere expand to encompass vertex. +
+[more]void expandRadiusBy(const Vec3& v) +
If the vertex is outwith the sphere expand radius to ecompass vertex. +
+[more]void expandBy(const BoundingSphere& sh) +
If incomming sphere is outwith the sphere expand to ecompass incomming sphere. +
+[more]void expandRadiusBy(const BoundingSphere& sh) +
If incomming sphere is outwith the sphere expand radius to ecompass incomming sphere. +
+[more]void expandBy(const BoundingBox& bb) +
If incomming box is outwith the sphere expand to ecompass incomming box. +
+[more]void expandRadiusBy(const BoundingBox& bb) +
If incomming box is outwith the sphere expand radius to ecompass incomming box. +
+[more]inline bool contains(const Vec3& v) const +
return true is vertex v is within the sphere +
+[more]inline bool intersects( const BoundingSphere& bs ) const +
return true if bounding sphere's intersect each other +

+ +
+ + +
+

Documentation

+
General purpose bounding sphere class for enclosing nodes/objects/vertices. +Used to bound internal osg::Node's in the scene, +to assist in view frustum culling etc. Similar in function to BoundingBox +but is quicker for evaluating culling, but generally encloses a greater volume +than a BoundingBox so will not cull so aggressively.
+
+ + + +
oVec3 _center +

+ + +

ofloat _radius +

+ + +

o BoundingSphere() +
construct to invalid values to represent an unset bounding sphere +

+ + +

o BoundingSphere(const Vec3& center, float radius) +
construct to specified bounding sphere +

+ + +

oinline void init() +
initialize to invalid values to represent an unset bounding sphere +

+ + +

oinline bool valid() const +
return true if the bounding sphere contains valid values, +false if the bounding sphere is effectively unset +

+ + +

oinline void set(const Vec3& center, float radius) +
set bounding sphere +

+ + +

oinline Vec3& center() +
return the center of the bounding sphere +

+ + +

oinline const Vec3& center() const +
return the const center of the bounding sphere +

+ + +

oinline float& radius() +
return the radius of the bounding sphere +

+ + +

oinline float radius() const +
return the const radius of the bounding sphere +

+ + +

oinline float radius2() const +
return the radius squared. +Note, for performance reasons, assumes the calling method has ensured +that the sphere is valid before calling radius2(), i.e. has _radius>=0.0, +as it does not check th validity of sphere and will erroneously return a positive value. +

+ + +

ovoid expandBy(const Vec3& v) +
If the vertex is out-with the sphere expand to encompass vertex. +Calculates the combination of movement of center and radius which +minimizes the radius increase. If this sphere is empty then +move the center to v and set radius to 0. +

+ + +

ovoid expandRadiusBy(const Vec3& v) +
If the vertex is outwith the sphere expand radius to ecompass vertex. +Unlike update, does not move the center, just increasing the radius. +If this sphere is empty then move the centrer to v and set radius to 0 +

+ + +

ovoid expandBy(const BoundingSphere& sh) +
If incomming sphere is outwith the sphere expand to ecompass incomming sphere. +calculates the combination of movement of center and radius which +minimizes the radius increase. If this sphere is empty then +move the centrer to v and set radius to 0. +

+ + +

ovoid expandRadiusBy(const BoundingSphere& sh) +
If incomming sphere is outwith the sphere expand radius to ecompass incomming sphere. +Unlike update, does not move the center, just increasing the radius. +If this sphere is empty then move the centrer to v and set radius to 0. +

+ + +

ovoid expandBy(const BoundingBox& bb) +
If incomming box is outwith the sphere expand to ecompass incomming box. +calculates the combination of movement of center and radius which +minimizes the radius increase. If this boz is empty then +move the centrer to v and set radius to 0. +

+ + +

ovoid expandRadiusBy(const BoundingBox& bb) +
If incomming box is outwith the sphere expand radius to ecompass incomming box. +Unlike update, does not move the center, just increasing the radius. +If this sphere is empty then move the centrer to v and set radius to 0. +

+ + +

oinline bool contains(const Vec3& v) const +
return true is vertex v is within the sphere +

+ + +

oinline bool intersects( const BoundingSphere& bs ) const +
return true if bounding sphere's intersect each other +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Box.html b/doc/doc++/osg/Box.html new file mode 100644 index 000000000..031874b41 --- /dev/null +++ b/doc/doc++/osg/Box.html @@ -0,0 +1,227 @@ + + + + + class osg::Box + + + + +

class osg::Box

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Box() +
+[more] Box(const osg::Vec3& center, float width) +
+[more] Box(const osg::Vec3& center, float lengthX, float lengthY, float lengthZ) +
+[more] Box(const Box& box, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, Box)() const +
+[more]inline void set(const Vec3& center, const Vec3& halfLengths) +
+[more]inline void setCenter(const Vec3& center) +
+[more]inline const Vec3& getCenter() const +
+[more]inline void setHalfLengths(const Vec3& halfLengths) +
+[more]inline const Vec3& getHalfLengths() const +
+[more]inline void setRotation(const Quat& quat) +
+[more]inline const Quat& getRotation() const +
+[more]inline Matrix getRotationMatrix() const +
+[more]inline bool zeroRotation() const +

+ +

+

Protected Fields

+[more]Vec3 _center +
+[more]Vec3 _halfLengths +
+[more]Quat _rotation +

+ +

+

Protected Methods

+[more]virtual ~Box() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Box() +

+ + +

o Box(const osg::Vec3& center, float width) +

+ + +

o Box(const osg::Vec3& center, float lengthX, float lengthY, float lengthZ) +

+ + +

o Box(const Box& box, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, Box)() const +

+ + +

oinline void set(const Vec3& center, const Vec3& halfLengths) +

+ + +

oinline void setCenter(const Vec3& center) +

+ + +

oinline const Vec3& getCenter() const +

+ + +

oinline void setHalfLengths(const Vec3& halfLengths) +

+ + +

oinline const Vec3& getHalfLengths() const +

+ + +

oinline void setRotation(const Quat& quat) +

+ + +

oinline const Quat& getRotation() const +

+ + +

oinline Matrix getRotationMatrix() const +

+ + +

oinline bool zeroRotation() const +

+ + +

ovirtual ~Box() +

+ + +

oVec3 _center +

+ + +

oVec3 _halfLengths +

+ + +

oQuat _rotation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/COMPARE_StateAttribute_Parameter.html b/doc/doc++/osg/COMPARE_StateAttribute_Parameter.html new file mode 100644 index 000000000..273c21e69 --- /dev/null +++ b/doc/doc++/osg/COMPARE_StateAttribute_Parameter.html @@ -0,0 +1,22 @@ + + + + + #define osg::COMPARE_StateAttribute_Parameter + + + + +

#define osg::COMPARE_StateAttribute_Parameter

(parameter)

COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare() method.
+ + +
+

Documentation

+
COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare() method. +Macro assumes that variable rhs has been corrected defined by code preceesing +macro.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/COMPARE_StateAttribute_Types.html b/doc/doc++/osg/COMPARE_StateAttribute_Types.html new file mode 100644 index 000000000..6215519b3 --- /dev/null +++ b/doc/doc++/osg/COMPARE_StateAttribute_Types.html @@ -0,0 +1,20 @@ + + + + + #define osg::COMPARE_StateAttribute_Types + + + + +

#define osg::COMPARE_StateAttribute_Types

(TYPE, rhs_attribute)

COMPARE_StateAttribute_Types macro is a helper for implementing the StatateAtribute::compare() method
+ + +
+

Documentation

+
COMPARE_StateAttribute_Types macro is a helper for implementing the StatateAtribute::compare() method
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Camera.html b/doc/doc++/osg/Camera.html new file mode 100644 index 000000000..8d57a291c --- /dev/null +++ b/doc/doc++/osg/Camera.html @@ -0,0 +1,719 @@ + + + + + class SG_EXPORT osg::Camera + + + + +

class SG_EXPORT osg::Camera

Camera class for encapsulating the view position and orientation and projection (lens) used.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Camera(DisplaySettings* ds=NULL) +
+[more] Camera(const Camera&) +
+[more]Camera& operator=(const Camera&) +
+[more]ProjectionType getProjectionType() const +
Get the projection type set by setOtho,setOtho2D,setFrustum, and set perspective methods +
+[more]void setOrtho(double left, double right, double bottom, double top, double zNear, double zFar) +
Set a orthographic projection. +
+[more]void setOrtho2D(double left, double right, double bottom, double top) +
Set a 2D orthographic projection. +
+[more]void setFrustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Set a perspective projection. +
+[more]void setPerspective(double fovy, double aspectRatio, double zNear, double zFar) +
Set a symmetrical perspective projection, See gluPerspective for further details. +
+[more]void setFOV(double fovx, double fovy, double zNear, double zFar) +
Set a sysmmetical perspective projection using field of view +
+[more]void setNearFar(double zNear, double zFar) +
Set the near and far clipping planes +
+[more]void setAdjustAspectRatioMode(AdjustAspectRatioMode aam) +
Set the way that the vertical or horizontal dimensions of the window are adjusted on a resize. +
+[more]AdjustAspectRatioMode getAdjustAspectRatioMode() const +
Get the way that the vertical or horizontal dimensions of the window are adjusted on a resize. +
+[more]void adjustAspectRatio(double newAspectRatio) +
Adjust the clipping planes to account for a new window aspect ratio. +
+[more]void adjustAspectRatio(double newAspectRatio, AdjustAspectRatioMode aa) +
Adjust the clipping planes to account for a new window aspect ratio. +
+[more]double left() const +
+[more]double right() const +
+[more]double bottom() const +
+[more]double top() const +
+[more]double zNear() const +
+[more]double zFar() const +
+[more]double calc_fovy() const +
Calculate and return the equivalent fovx for the current project setting. +
+[more]double calc_fovx() const +
Calculate and return the equivalent fovy for the current project setting. +
+[more]double calc_aspectRatio() const +
Calculate and return the projection aspect ratio. +
+[more]LookAtType getLookAtType() const +
+[more]void home() +
hardwired home view for now, looking straight down the Z axis at the origin, with 'up' being the y axis +
+[more]void setView(const Vec3& eyePoint, const Vec3& lookPoint, const Vec3& upVector) +
Set the View, the up vector should be orthogonal to the look vector. +
+[more]void setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
set the position and orientation of the camera, using the same convention as gluLookAt +
+[more]void setLookAt(double eyeX, double eyeY, double eyeZ, double centerX, double centerY, double centerZ, double upX, double upY, double upZ) +
set the position and orientation of the camera, using the same convention as gluLookAt +
+[more]void transformLookAt(const Matrix& matrix) +
post multiple the existing eye point and orientation by matrix. +
+[more]void ensureOrthogonalUpVector() +
+[more]inline const Vec3& getEyePoint() const +
get the eye point. +
+[more]inline const Vec3& getCenterPoint() const +
get the center point. +
+[more]inline const Vec3& getUpVector() const +
get the up vector +
+[more]Vec3 getLookVector() const +
calculate look vector +
+[more]Vec3 getSideVector() const +
calculate side vector +
+[more]inline float getLookDistance() const +
calculate the look distance which is the distance between the eye and the center +
+[more]void attachTransform(TransformMode mode, RefMatrix* modelTransform=0) +
Attach a transform matrix which is applied after the camera look at. +
+[more]Matrix* getTransform(TransformMode mode) +
+[more]const Matrix* getTransform(TransformMode mode) const +
+[more]void setFusionDistanceMode(FusionDistanceMode mode) +
Set the mode of the fusion distance function which in use to calculate the fusion distance used in stereo rendering. +
+[more]FusionDistanceMode getFusionDistanceMode() const +
Get the mode of the fusion distance function +
+[more]void setFusionDistanceRatio(float ratio) +
Set the ratio of the fusion distance function which in use to calculate the fusion distance used in stereo rendering. +
+[more]float getFusionDistanceRatio() const +
Get the ratio of the fusion distance function +
+[more]float getFusionDistance() const +
Calculate and return the fusion distance, using the FusionDistanceFunction +
+[more]void setScreenDistance(float screenDistance) +
Set the physical distance between the viewers eyes and the display system. +
+[more]float getScreenDistance() const +
Get the physical distance between the viewers eyes and the display system +
+[more]Matrix getProjectionMatrix() const +
Get the Projection Matrix +
+[more]Matrix getModelViewMatrix() const +
Get the ModelView matrix. +
+[more]inline Polytope getViewFrustum() const +
Get the camera view frustum +

+ +

+

Public Members

+[more]enum ProjectionType +
Range of projection types. +
+[more]enum AdjustAspectRatioMode +
Use in combination with adjustAspectRatio, to control the change in frustum clipping planes to account for changes in windows aspect ratio, +
+[more]enum LookAtType +
+[more]enum TransformMode +
+[more]enum FusionDistanceMode +

+ +

+

Protected Fields

+[more]ProjectionType _projectionType +
+[more]AdjustAspectRatioMode _adjustAspectRatioMode +
+[more]double _left +
+[more]double _right +
+[more]double _bottom +
+[more]double _top +
+[more]double _zNear +
+[more]double _zFar +
+[more]LookAtType _lookAtType +
+[more]Vec3 _eye +
+[more]Vec3 _center +
+[more]Vec3 _up +
+[more]TransformMode _attachedTransformMode +
+[more]ref_ptr<RefMatrix> _eyeToModelTransform +
+[more]ref_ptr<RefMatrix> _modelToEyeTransform +
+[more]float _screenDistance +
+[more]FusionDistanceMode _fusionDistanceMode +
+[more]float _fusionDistanceRatio +

+ +

+

Protected Methods

+[more]virtual ~Camera() +
+[more]void copy(const Camera&) +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Camera class for encapsulating the view position and orientation and +projection (lens) used. Creates a projection and modelview matrices +which can be used to set OpenGL's PROJECTION and MODELVIEW matrices +respectively.
+
+ + + +
o Camera(DisplaySettings* ds=NULL) +

+ + +

o Camera(const Camera&) +

+ + +

oCamera& operator=(const Camera&) +

+ + +

oenum ProjectionType +
Range of projection types. +ORTHO2D is a special case of ORTHO where the near and far planes +are equal to -1 and 1 respectively. +PERSPECTIVE is a special case of FRUSTUM where the left & right +and bottom and top and symmetrical. +

+ + + +
o ORTHO +

+ + +

o ORTHO2D +

+ + +

o FRUSTUM +

+ + +

o PERSPECTIVE +

+ + + +
oProjectionType getProjectionType() const +
Get the projection type set by setOtho,setOtho2D,setFrustum, +and set perspective methods +

+ + +

ovoid setOrtho(double left, double right, double bottom, double top, double zNear, double zFar) +
Set a orthographic projection. See glOrtho for further details. +

+ + +

ovoid setOrtho2D(double left, double right, double bottom, double top) +
Set a 2D orthographic projection. See gluOrtho2D for further details. +

+ + +

ovoid setFrustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Set a perspective projection. See glFrustum for further details. +

+ + +

ovoid setPerspective(double fovy, double aspectRatio, double zNear, double zFar) +
Set a symmetrical perspective projection, See gluPerspective for further details. +Aspect ratio is defined as width/height. +

+ + +

ovoid setFOV(double fovx, double fovy, double zNear, double zFar) +
Set a sysmmetical perspective projection using field of view +

+ + +

ovoid setNearFar(double zNear, double zFar) +
Set the near and far clipping planes +

+ + +

oenum AdjustAspectRatioMode +
Use in combination with adjustAspectRatio, to control +the change in frustum clipping planes to account for +changes in windows aspect ratio, +

+ + + +
o ADJUST_VERTICAL +

+ + +

o ADJUST_HORIZONTAL +

+ + +

o ADJUST_NONE +

+ + + +
ovoid setAdjustAspectRatioMode(AdjustAspectRatioMode aam) +
Set the way that the vertical or horizontal dimensions of the window +are adjusted on a resize. +

+ + +

oAdjustAspectRatioMode getAdjustAspectRatioMode() const +
Get the way that the vertical or horizontal dimensions of the window +are adjusted on a resize. +

+ + +

ovoid adjustAspectRatio(double newAspectRatio) +
Adjust the clipping planes to account for a new window aspect ratio. +Typically used after resizing a window. Aspect ratio is defined as +width/height. +

+ + +

ovoid adjustAspectRatio(double newAspectRatio, AdjustAspectRatioMode aa) +
Adjust the clipping planes to account for a new window aspect ratio. +Typicall used after resizeing a window. Aspect ratio is defined as +width/height. +

+ + +

odouble left() const +

+ + +

odouble right() const +

+ + +

odouble bottom() const +

+ + +

odouble top() const +

+ + +

odouble zNear() const +

+ + +

odouble zFar() const +

+ + +

odouble calc_fovy() const +
Calculate and return the equivalent fovx for the current project setting. +This value is only valid for when a symmetric perspective projection exists. +i.e. getProjectionType()==PERSPECTIVE. +

+ + +

odouble calc_fovx() const +
Calculate and return the equivalent fovy for the current project setting. +This value is only valid for when a symmetric perspective projection exists. +i.e. getProjectionType()==PERSPECTIVE. +

+ + +

odouble calc_aspectRatio() const +
Calculate and return the projection aspect ratio. +Aspect ratio is defined as width/height. +

+ + +

oenum LookAtType +

+ + + +
o USE_HOME_POSITION +

+ + +

o USE_EYE_AND_QUATERNION +

+ + +

o USE_EYE_CENTER_AND_UP +

+ + + +
oLookAtType getLookAtType() const +

+ + +

ovoid home() +
+hardwired home view for now, looking straight down the +Z axis at the origin, with 'up' being the y axis +

+ + +

ovoid setView(const Vec3& eyePoint, const Vec3& lookPoint, const Vec3& upVector) +
+Set the View, the up vector should be orthogonal to the look vector. +setView is now mapped to setLookAt(eye,center,up), and is only +kept for backwards compatibility. +

+ + +

ovoid setLookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
set the position and orientation of the camera, using the same convention as +gluLookAt +

+ + +

ovoid setLookAt(double eyeX, double eyeY, double eyeZ, double centerX, double centerY, double centerZ, double upX, double upY, double upZ) +
set the position and orientation of the camera, using the same convention as +gluLookAt +

+ + +

ovoid transformLookAt(const Matrix& matrix) +
post multiple the existing eye point and orientation by matrix. +note, does not affect any ModelTransforms that are applied. +

+ + +

ovoid ensureOrthogonalUpVector() +

+ + +

oinline const Vec3& getEyePoint() const +
get the eye point. +

+ + +

oinline const Vec3& getCenterPoint() const +
get the center point. +

+ + +

oinline const Vec3& getUpVector() const +
get the up vector +

+ + +

oVec3 getLookVector() const +
calculate look vector +

+ + +

oVec3 getSideVector() const +
calculate side vector +

+ + +

oinline float getLookDistance() const +
calculate the look distance which is the distance between the eye and the center +

+ + +

oenum TransformMode +

+ + + +
o EYE_TO_MODEL +

+ + +

o MODEL_TO_EYE +

+ + +

o NO_ATTACHED_TRANSFORM +

+ + + +
ovoid attachTransform(TransformMode mode, RefMatrix* modelTransform=0) +
Attach a transform matrix which is applied after the camera look at. +The attached matrix can work in two ways, either as transform of the eye +into the model coordinates - EYE_TO_MODEL, or as a transform of the +model to the eye - MODEL_TO_EYE. The former is equivalent to attaching +a camera internal to the scene graph. The later is equivalent to adding +a osg::Transform at root of the scene to move the scene to the eye point. +Typical used in conjunction with the LookAt position set to home, +in which case it is simply treated as a model view matrix. +If the same behavior as IRIS Performer's setViewMat is desired +then set the LookAt to be (0,0,0),(0,1,0),(0,0,1) since Performer's +default direction is along the y axis, unlike OpenGL and the default OSG. +If modelTransfor is NULL then do not use any model transform - just use the +basic LookAt values. +note: Camera internals maintains the both EYE_TO_MODEL and MODEL_TO_EYE +internally and ensures that they are the inverse of one another. +

+ + +

oMatrix* getTransform(TransformMode mode) +

+ + +

oconst Matrix* getTransform(TransformMode mode) const +

+ + +

oenum FusionDistanceMode +

+ + + +
o PROPORTIONAL_TO_LOOK_DISTANCE +

+ + +

o PROPORTIONAL_TO_SCREEN_DISTANCE +

+ + + +
ovoid setFusionDistanceMode(FusionDistanceMode mode) +
Set the mode of the fusion distance function which in use to calculate the +fusion distance used in stereo rendering. Default value is +PROPORTIONAL_TO_LOOK_DISTANCE. Use in conjunction with setFusionDistanceRatio(float). +

+ + +

oFusionDistanceMode getFusionDistanceMode() const +
Get the mode of the fusion distance function +

+ + +

ovoid setFusionDistanceRatio(float ratio) +
Set the ratio of the fusion distance function which in use to calculate the +fusion distance used in stereo rendering. Default value is 1.0f +Use in conjunction with setFusionDistanceMode(..). +

+ + +

ofloat getFusionDistanceRatio() const +
Get the ratio of the fusion distance function +

+ + +

ofloat getFusionDistance() const +
Calculate and return the fusion distance, using the FusionDistanceFunction +

+ + +

ovoid setScreenDistance(float screenDistance) +
Set the physical distance between the viewers eyes and the display system. +Note, only used when rendering in stereo. +

+ + +

ofloat getScreenDistance() const +
Get the physical distance between the viewers eyes and the display system +

+ + +

oMatrix getProjectionMatrix() const +
Get the Projection Matrix +

+ + +

oMatrix getModelViewMatrix() const +
Get the ModelView matrix. +If a ModelTransform is supplied then the ModelView matrix is +created by multiplying the current LookAt by ModelTransform. +Otherwise it is simply created by using the current LookAt, +equivalent to using gluLookAt. +

+ + +

oinline Polytope getViewFrustum() const +
Get the camera view frustum +

+ + +

ovirtual ~Camera() +

+ + +

ovoid copy(const Camera&) +

+ + +

oProjectionType _projectionType +

+ + +

oAdjustAspectRatioMode _adjustAspectRatioMode +

+ + +

odouble _left +

+ + +

odouble _right +

+ + +

odouble _bottom +

+ + +

odouble _top +

+ + +

odouble _zNear +

+ + +

odouble _zFar +

+ + +

oLookAtType _lookAtType +

+ + +

oVec3 _eye +

+ + +

oVec3 _center +

+ + +

oVec3 _up +

+ + +

oTransformMode _attachedTransformMode +

+ + +

oref_ptr<RefMatrix> _eyeToModelTransform +

+ + +

oref_ptr<RefMatrix> _modelToEyeTransform +

+ + +

ofloat _screenDistance +

+ + +

oFusionDistanceMode _fusionDistanceMode +

+ + +

ofloat _fusionDistanceRatio +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ClassGraph.class b/doc/doc++/osg/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..c6a7b6c79eefb07545a0b85e767db0a34067477d GIT binary patch literal 1237 zcma)6*-{fh6g@+hnS_afK|w^^#V{;!Ux zT+h!a)b2v}DxTm%X4(`QsclfhP)G8~Xw_zCWBVEWk6WrC% z+sJ92m^PjDN?b#NZYz*X$O3b#R&t&NRAdse&V07V8-1gWC{c{gs#ZqSPrp^7-UQnZ z?KrFRIdy|VGDj%h1IMLHu6NL0Y^2g$ccS9+UGDq5ly|-mxv0;BhLH$3@hyHT`(9Ph z8e-%(i$Uk6j})Y#zB-aUWUpeHWQM#$#1J9v+E%27i#gj0lUlW{9#U(z6(uzjwyhB9 zZ@6IpLUKD)hgHKU*~a$7aCmacu3?aVLv;-Nz_4w9$8Zhjw_3)f8b&DB+_tnj`fIrS bmF6i%^l#B((N9`2jM#PbwZroS^x)|~2>C-7 literal 0 HcmV?d00001 diff --git a/doc/doc++/osg/ClassGraphPanel.class b/doc/doc++/osg/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..94b21b47a2a4b19b981fbe8827197a5d71dffc7a GIT binary patch literal 4084 zcmbtWX>eOt75<*}q^IS@c9f{CsBM;#)Rq&Qlwuk?DI`uC3{KL!~;QmGKkLv@kkI~3F3P}{5*)?2JsgIA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR44!k~$D@F9+4PkU* zJdAGa3u7bphtQ4#B5nyGid)0jfP*rf5OJGC91`ttnBqtnSK#(Ax-coWDG^7-<&7c4 z@Ftla3*$w2vuH_)utH2eEfJ|Ou0~qmZHbtX)mag90-BLpj?3x^an6dEm(`p= zv^zq$3I!2G6Zd0T#Ct@%PsIC8d=~F8@i{zf;`1WPc+kWbuxR3oIAh{VIA!9?a7;Xk z(I?{#OhTeL4qxo#UFe27OlXZR}pR;q$NW+(m z=Bq~ek~+lRg0(Q0Nfi~!Rjn4>w2cXBF=Jzw)-2Ur-GDQ0-I*^r`>dQbYrD0^yjAt3 z2d0mc%8@>jbZw*Eqp^{cv7BQIMr+U3l{hUhFZH~9i?y(jwVlCTY8cJ4qGe~q4bRbj z=-{{_a`*G5t$MjJE#ao7T*|NUK$=4u`$M?awrB|K$mBB4jhu{X2#;p1Vo~jphK~AV zK)Slga*LI-vl=4G$K59l`e;6FYgosRE3(C%!&bJ$xwePMH!Y{^1&7C>NCVG`HcrR! zhH&mpr}t$%J#Kqyh+fLChW7D%%E}(L3K?rUYZI_zzqOc|wVZrmcgb<`Il>=g&WU`f zkg{*iWTgmpN!w8-jvlRNalM&&gJ*1Hh%v`_2(5HlgWsBQ>;l=EwrBDM!uhAOR_cTp z@}*pwB^c8xGc`Sx$~mMa#TDna{0ZIygd&J9ogsvt&M&dRkPN#Dh5V9+V7g!}jc0Pi z4cK>-tSkfkGnqn>Fxnh>nzM@gn6?TQn6oppb6gB$a%mn`B4lc8chqj6Di`fFi(-`& zG#I?2-E7P`7OP>gb^Z7;YM<~Zrs(`p93uJ|4ht%lqmqze#L3X3Mmqpw0Xbw@W9gQLjVQ8^5T~xO` zyRo#uwka)mfqJPR`)(}Cp*b+an%NotrA%6C(paE&H^7(lO3DcT`6NeMwq8j-es*&%d8u^l`k&h@xga7yAy~O<}!JmQ2mmS*0#2Q|b=#1^rK8{VMvZdewk#v>ee53f^prM4$lu$liVZikpAINPKwVFp(% z*DFhimh-r|f>#~ThCAZz6>NV98!w=HG9HMxui={EjxzKkzM)RKE7QRp{_N0teJC0?qiq!oK8S#CC`yMuNqGUClks)&j<`S88H>i&)22!pSi{RE5|i}M zldG(rA9~&CXQK%QbWE<{#Z#*os^GQ0p-34wBm^xMVd9q`@zl;9L5f8NIBZr++x^+( zTrASrGgraL$%qz29MM9!OU8YB+zDwF+mKkU5n-*^r%jb9VkFd*N`& z?uPVtN%rP&{_1nXeGjnjLxAr-vb2r=eLm8=YXz@N>$0JK-%z0JOULzCAQsS*(tU?Qx*F@L(I3otzg;z8wi+Gp1NWR3pHH`(pY=$mj|l6tys zywNjy_)^TCa@$i(&ju%HQ+3#;-1JvlSgq~9%2{qZ#soYsOmL{bt6I%vCy-(#p_IV- zbu|-;DtL9dt&P|`nZ(|Inb=K>u+XoW14HSa-L+fR6(g17#U zngzLmo2{2{gTFElZv%2OcbRz_zp(+k+Dr|m7U`ClE}+uQ*ExA^8>@ZeZO~XfZEF6% zw67bu^JJhc7KpPEw(IFL|2pMf5gLAqcY0@h5dr=I$NSIW+6rFd8`8_Tl~oL_;0Ax% zcOJvM?{>y?N;xLda+_m1Px4M`eM;*c_Q(Az7!&cj2nih82>HF?q-+mL1DoFse%e^QYffI4N#SGSZ!&wS_MV3O}6RQWH)X$EyY{w zecz&Z;B=;=pVVmsBQuVl^)K+B5ufMXBu$0P>~p`*{l59@-{1d01bc8X23tizg`;9d z#j`42Qt`5iS5&;J;x!cuDqdIdhKe^;yrtr874PV1$L%^|xI;%L4lqbFxKo3MyL3cx zw+P>yBgt;Cs{VCqXT2?`5_JK@i2pN15-G~;0%MDfhsHplLltt8kj@Yz*#(EV4m4? zs2F$-rwu&M)C(+o5fcX9W9oedAK);2HQ7PaF6Qj~e)#V|>Yquh{rJ zgRdEUgU1bAVCq{uVcUs8^>}l1wf#tZif3PK7Ye8GCZ%l6b>Kc*8=;Vx@3mQ&ZGCNY8nj-K2 zGp|=$k9j?Fv(LYSt0rVo z@V&WVdx|v5wCxn8nQ+AJQVz{EZ#rEotnW{&u(>~!PxE+q8R+UXC1GhJmTMJkpE}f3 zh#Nw8NeI?YN)=zQ!T1>ttxt{>#7y{^Uz84Q>um=M+n3RBI#%%xs0vT zX*rTsmN1brl^V8Z)VNy1?o5o)&Wskx& zph%{YxOnyFB*nXdLhYb0l?`J?uON1+Zy7hymn6?w!h7l4LXNVRu<;j4mVfk@RWD(d z+N+XehO<8$8Cb%ZRDu%z6LKaRk8;j(Ji3fNIWAMS93~shGb&!j&DpfV%EWn?rb5CU zi`bSl6>9bpx`ZUP2u(;*3lS-?{o>WdMu$IYwy}!_#vN9;q+MZ-65eg(C?%-P>uEL{ zM9K9;snJW=oiZs!ku2rM$trP$`j()mf*4qcN@kS8{u4>dOZYowl9jM0L$;^6P+78Q z-;ZdIt0B39eQ`yo7XF)mWhr!`Z%040*vm{02*i<;0KkC}q*6CIis4)QD5 zzXUTLW1~J(3r9sl3P3a7Z-x;$gG62~W^1_RH{5y!ou^FsGWsuJQs_8(Zl|D6Z9j5;Sf~rkj literal 0 HcmV?d00001 diff --git a/doc/doc++/osg/ClearNode.html b/doc/doc++/osg/ClearNode.html new file mode 100644 index 000000000..76ac669a0 --- /dev/null +++ b/doc/doc++/osg/ClearNode.html @@ -0,0 +1,375 @@ + + + + + class SG_EXPORT osg::ClearNode + + + + +

class SG_EXPORT osg::ClearNode

ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ClearNode() +
+[more] ClearNode(const ClearNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, ClearNode) +
+[more]inline void setRequiresClear(bool requiresClear) +
Sets the flag which control whether a glClear is required at the beginning of each frame. +
+[more]inline bool getRequiresClear() const +
Gets the flag which control whether a glClear is required at the beginning of each frame. +
+[more]inline void setClearColor(const Vec4& color) +
Sets the clear color. +
+[more]inline const Vec4& getClearColor() const +
Returns the clear color. +

+ +

+

Protected Fields

+[more]bool _requiresClear +
+[more]Vec4 _clearColor +

+ +

+

Protected Methods

+[more]virtual ~ClearNode() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
ClearNode is a Group node which controls the clearing of the color and depth +buffers at the start of each frame. +The earth sky by default is empty and simply holds the clear color of +the background. However, if the uses wants to add their own clearing of +the color and depth buffers then the children can be added, and the +background clear turned off. The ClearNode by default has StateSet attached +to it which sets the default ClearNode bin number to -1, so that all drawables +below it are placed in a separate bin from the rest of the scene graph, and +are rendered prior to standard opaque and transparent drawables.
+
+ + + +
o ClearNode() +

+ + +

o ClearNode(const ClearNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, ClearNode) +

+ + +

oinline void setRequiresClear(bool requiresClear) +
Sets the flag which control whether a glClear is required at the beginning of each frame. +

+ + +

oinline bool getRequiresClear() const +
Gets the flag which control whether a glClear is required at the beginning of each frame. +

+ + +

oinline void setClearColor(const Vec4& color) +
Sets the clear color. +

+ + +

oinline const Vec4& getClearColor() const +
Returns the clear color. +

+ + +

ovirtual ~ClearNode() +

+ + +

obool _requiresClear +

+ + +

oVec4 _clearColor +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ClipNode.html b/doc/doc++/osg/ClipNode.html new file mode 100644 index 000000000..241bb1ef2 --- /dev/null +++ b/doc/doc++/osg/ClipNode.html @@ -0,0 +1,436 @@ + + + + + class SG_EXPORT osg::ClipNode + + + + +

class SG_EXPORT osg::ClipNode

Leaf Node for defining the position of ClipPlanes in the scene
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ClipNode() +
+[more] ClipNode(const ClipNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, ClipNode) +
+[more]void createClipBox(const BoundingBox& bb, unsigned int clipPlaneNumberBase=0) +
Create a 6 clip planes to create a clip box +
+[more]bool addClipPlane(ClipPlane* clipplane) +
Add a ClipPlane to a ClipNode. +
+[more]bool removeClipPlane(ClipPlane* clipplane) +
Remove ClipPlane from a ClipNode. +
+[more]bool removeClipPlane(unsigned int pos) +
Remove ClipPlane, at specified index, from a ClipNode. +
+[more]inline unsigned int getNumClipPlanes() const +
return the number of ClipPlanes +
+[more]inline ClipPlane* getClipPlane(unsigned int pos) +
Get ClipPlane at specificed index position +
+[more]inline const ClipPlane* getClipPlane(unsigned int pos) const +
Get const ClipPlane at specificed index position +
+[more]inline ClipPlaneList& getClipPlaneList() +
Get the ClipPlaneList +
+[more]inline const ClipPlaneList& getClipPlaneList() const +
Get the const ClipPlaneList +
+[more]void setStateSetModes(StateSet&, StateAttribute::GLModeValue) const +
Set the GLModes on StateSet associated with the ClipPlanes +
+[more]void setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON) +
Set up the local StateSet +

+ +

+

Public Members

+[more]typedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList +

+ +

+

Protected Fields

+[more]StateAttribute::GLModeValue _value +
+[more]ClipPlaneList _planes +

+ +

+

Protected Methods

+[more]virtual ~ClipNode() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Leaf Node for defining the position of ClipPlanes in the scene
+
+ + + +
otypedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList +

+ + +

o ClipNode() +

+ + +

o ClipNode(const ClipNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, ClipNode) +

+ + +

ovoid createClipBox(const BoundingBox& bb, unsigned int clipPlaneNumberBase=0) +
Create a 6 clip planes to create a clip box +

+ + +

obool addClipPlane(ClipPlane* clipplane) +
Add a ClipPlane to a ClipNode. Return true if plane is added, +return false if plane already exists in ClipNode, or clipplane is false. +

+ + +

obool removeClipPlane(ClipPlane* clipplane) +
Remove ClipPlane from a ClipNode. Return true if plane is removed, +return false if plane does not exists in ClipNode. +

+ + +

obool removeClipPlane(unsigned int pos) +
Remove ClipPlane, at specified index, from a ClipNode. Return true if plane is removed, +return false if plane does not exists in ClipNode. +

+ + +

oinline unsigned int getNumClipPlanes() const +
return the number of ClipPlanes +

+ + +

oinline ClipPlane* getClipPlane(unsigned int pos) +
Get ClipPlane at specificed index position +

+ + +

oinline const ClipPlane* getClipPlane(unsigned int pos) const +
Get const ClipPlane at specificed index position +

+ + +

oinline ClipPlaneList& getClipPlaneList() +
Get the ClipPlaneList +

+ + +

oinline const ClipPlaneList& getClipPlaneList() const +
Get the const ClipPlaneList +

+ + +

ovoid setStateSetModes(StateSet&, StateAttribute::GLModeValue) const +
Set the GLModes on StateSet associated with the ClipPlanes +

+ + +

ovoid setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON) +
Set up the local StateSet +

+ + +

ovirtual ~ClipNode() +

+ + +

ovirtual bool computeBound() const +

+ + +

oStateAttribute::GLModeValue _value +

+ + +

oClipPlaneList _planes +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ClipPlane.html b/doc/doc++/osg/ClipPlane.html new file mode 100644 index 000000000..aa97c4de7 --- /dev/null +++ b/doc/doc++/osg/ClipPlane.html @@ -0,0 +1,294 @@ + + + + + class SG_EXPORT osg::ClipPlane + + + + +

class SG_EXPORT osg::ClipPlane

ClipPlane state class which encapsulates OpenGL glClipPlane() functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ClipPlane() +
+[more]inline ClipPlane(unsigned int no, const Vec4& plane) +
+[more]inline ClipPlane(unsigned int no, const Plane& plane) +
+[more]inline ClipPlane(unsigned int no, double a, double b, double c, double d) +
+[more] ClipPlane(const ClipPlane& cp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum)) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setClipPlane(const Vec4& plane) +
Set the clip plane, using a Vec4 to define plane. +
+[more]void setClipPlane(const Plane& plane) +
Set the clip plane, using a Plane to define plane. +
+[more]void setClipPlane(const double* plane) +
Set the clip plane, using a double[4] to define plane. +
+[more]void setClipPlane(double a, double b, double c, double d) +
Set the clip plane, using a a to define plane. +
+[more]void getClipPlane(Vec4& plane) const +
Get the clip plane, values entered into a Vec4 passed to the getClipPlane. +
+[more]void getClipPlane(Plane& plane) const +
Get the clip plane, values entered into a Plane passed to the getClipPlane. +
+[more]void getClipPlane(double* plane) const +
Get the clip plane, values entered into a double[4] passed to the getClipPlane. +
+[more]void setClipPlaneNum(unsigned int num) +
Set the clip plane number. +
+[more]unsigned int getClipPlaneNum() const +
Get the clip plane number. +
+[more]virtual void apply(State& state) const +
Apply the clip plane's state to the OpenGL state machine. +

+ +

+

Protected Fields

+[more]double _clipPlane[4] +
+[more]unsigned int _clipPlaneNum +

+ +

+

Protected Methods

+[more]virtual ~ClipPlane() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
ClipPlane state class which encapsulates OpenGL glClipPlane() functionality
+
+ + + +
o ClipPlane() +

+ + +

oinline ClipPlane(unsigned int no, const Vec4& plane) +

+ + +

oinline ClipPlane(unsigned int no, const Plane& plane) +

+ + +

oinline ClipPlane(unsigned int no, double a, double b, double c, double d) +

+ + +

o ClipPlane(const ClipPlane& cp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, ClipPlane, (Type)(CLIPPLANE+_clipPlaneNum)) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setClipPlane(const Vec4& plane) +
Set the clip plane, using a Vec4 to define plane. +

+ + +

ovoid setClipPlane(const Plane& plane) +
Set the clip plane, using a Plane to define plane. +

+ + +

ovoid setClipPlane(const double* plane) +
Set the clip plane, using a double[4] to define plane. +

+ + +

ovoid setClipPlane(double a, double b, double c, double d) +
Set the clip plane, using a a to define plane. +

+ + +

ovoid getClipPlane(Vec4& plane) const +
Get the clip plane, values entered into a Vec4 passed to the getClipPlane. +

+ + +

ovoid getClipPlane(Plane& plane) const +
Get the clip plane, values entered into a Plane passed to the getClipPlane. +

+ + +

ovoid getClipPlane(double* plane) const +
Get the clip plane, values entered into a double[4] passed to the getClipPlane. +

+ + +

ovoid setClipPlaneNum(unsigned int num) +
Set the clip plane number. +

+ + +

ounsigned int getClipPlaneNum() const +
Get the clip plane number. +

+ + +

ovirtual void apply(State& state) const +
Apply the clip plane's state to the OpenGL state machine. +

+ + +

ovirtual ~ClipPlane() +

+ + +

odouble _clipPlane[4] +

+ + +

ounsigned int _clipPlaneNum +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CollectOccludersVisitor.html b/doc/doc++/osg/CollectOccludersVisitor.html new file mode 100644 index 000000000..862eaa47d --- /dev/null +++ b/doc/doc++/osg/CollectOccludersVisitor.html @@ -0,0 +1,484 @@ + + + + + class SG_EXPORT osg::CollectOccludersVisitor + + + + +

class SG_EXPORT osg::CollectOccludersVisitor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CollectOccludersVisitor() +
+[more]virtual ~CollectOccludersVisitor() +
+[more]virtual CollectOccludersVisitor* cloneType() const +
+[more]virtual void reset() +
+[more]virtual float getDistanceToEyePoint(const Vec3& pos, bool withLODScale) const +
+[more]virtual float getDistanceFromEyePoint(const Vec3& pos, bool withLODScale) const +
+[more]virtual void apply(osg::Node&) +
+[more]virtual void apply(osg::Transform& node) +
+[more]virtual void apply(osg::Projection& node) +
+[more]virtual void apply(osg::Switch& node) +
+[more]virtual void apply(osg::LOD& node) +
+[more]virtual void apply(osg::OccluderNode& node) +
+[more]void setMinimumShadowOccluderVolume(float vol) +
+[more]float getMinimumShadowOccluderVolume() const +
+[more]void setCreateDrawablesOnOccludeNodes(bool flag) +
+[more]bool getCreateDrawablesOnOccludeNodes() const +
+[more]void setCollectedOcculderList(const ShadowVolumeOccluderSet& svol) +
+[more]ShadowVolumeOccluderSet& getCollectedOccluderSet() +
+[more]const ShadowVolumeOccluderSet& getCollectedOccluderSet() const +
+[more]void removeOccludedOccluders() +
remove occluded occluders for the collected occluders list +

+ +

+

Public Members

+[more]typedef std::set<ShadowVolumeOccluder> ShadowVolumeOccluderSet +

+ +

+

Protected Fields

+[more]float _minimumShadowOccluderVolume +
+[more]bool _createDrawables +
+[more]ShadowVolumeOccluderSet _occluderSet +

+ +

+

Protected Methods

+[more] CollectOccludersVisitor(const CollectOccludersVisitor&) +
prevent unwanted copy construction +
+[more]CollectOccludersVisitor& operator = (const CollectOccludersVisitor&) +
prevent unwanted copy operator +
+[more]inline void handle_cull_callbacks_and_traverse(osg::Node& node) +
+[more]inline void handle_cull_callbacks_and_accept(osg::Node& node, osg::Node* acceptNode) +

+ +
+

Inherited from NodeVisitor:

+
+

+

Public Methods

+oinline void setVisitorType(VisitorType type) +
+oinline VisitorType getVisitorType() const +
+oinline void setTraversalNumber(int fn) +
+oinline int getTraversalNumber() const +
+oinline void setFrameStamp(FrameStamp* fs) +
+oinline const FrameStamp* getFrameStamp() const +
+oinline void setTraversalMask(Node::NodeMask mask) +
+oinline Node::NodeMask getTraversalMask() const +
+oinline void setNodeMaskOverride(Node::NodeMask mask) +
+oinline Node::NodeMask getNodeMaskOverride() const +
+oinline bool validNodeMask(const osg::Node& node) const +
+oinline void setTraversalMode(TraversalMode mode) +
+oinline TraversalMode getTraversalMode() const +
+oinline void traverse(Node& node) +
+oinline void pushOntoNodePath(Node* node) +
+oinline void popFromNodePath() +
+oNodePath& getNodePath() +
+oconst NodePath& getNodePath() const +
+ovirtual bool getLocalToWorldMatrix(Matrix& matrix, Node* node) +
+ovirtual bool getWorldToLocalMatrix(Matrix& matrix, Node* node) +
+ovirtual osg::Vec3 getEyePoint() const +

+ +

+

Public Members

+oenum TraversalMode +
+oenum VisitorType +

+ +

+

Protected Fields

+oVisitorType _visitorType +
+oint _traversalNumber +
+oref_ptr<FrameStamp> _frameStamp +
+oTraversalMode _traversalMode +
+oNode::NodeMask _traversalMask +
+oNode::NodeMask _nodeMaskOverride +
+oNodePath _nodePath +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+

Inherited from CullStack:

+
+

+

Public Methods

+ovoid setOccluderList(const ShadowVolumeOccluderList& svol) +
+oShadowVolumeOccluderList& getOccluderList() +
+oconst ShadowVolumeOccluderList& getOccluderList() const +
+ovoid pushViewport(osg::Viewport* viewport) +
+ovoid popViewport() +
+ovoid pushProjectionMatrix(osg::RefMatrix* matrix) +
+ovoid popProjectionMatrix() +
+ovoid pushModelViewMatrix(osg::RefMatrix* matrix) +
+ovoid popModelViewMatrix() +
+oinline float getFrustumVolume() +
+ovoid setCullingMode(CullingMode mode) +
+oCullingMode getCullingMode() const +
+ovoid setLODScale(float bias) +
+ofloat getLODScale() const +
+ovoid setSmallFeatureCullingPixelSize(float value) +
+ofloat getSmallFeatureCullingPixelSize() const +
+ofloat pixelSize(const Vec3& v, float radius) const +
+ofloat pixelSize(const BoundingSphere& bs) const +
+oinline void disableAndPushOccludersCurrentMask(NodePath& nodePath) +
+oinline void popOccludersCurrentMask(NodePath& nodePath) +
+oinline bool isCulled(const std::vector<Vec3>& vertices) +
+oinline bool isCulled(const BoundingBox& bb) +
+oinline bool isCulled(const BoundingSphere& bs) +
+oinline bool isCulled(const osg::Node& node) +
+oinline void pushCurrentMask() +
+oinline void popCurrentMask() +
+oCullingStack& getClipSpaceCullingStack() +
+oCullingStack& getProjectionCullingStack() +
+oCullingStack& getModelViewCullingStack() +
+oCullingSet& getCurrentCullingSet() +
+oinline osg::Viewport* getViewport() +
+oinline osg::RefMatrix& getModelViewMatrix() +
+oinline osg::RefMatrix& getProjectionMatrix() +
+oinline osg::Matrix getWindowMatrix() +
+oinline const osg::RefMatrix& getMVPW() +
+oinline const osg::Vec3& getEyeLocal() const +
+oinline const osg::Vec3 getUpLocal() const +
+oinline const osg::Vec3 getLookVectorLocal() const +
+oinline Viewport* getViewport() +
+oinline RefMatrix& getModelViewMatrix() +
+oinline RefMatrix& getProjectionMatrix() +
+oinline Matrix getWindowMatrix() +
+oinline const RefMatrix& getMVPW() +
+oinline RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+ +

+

Public Members

+otypedef std::vector<ShadowVolumeOccluder> OccluderList +
+oenum CullingModeValues +
+otypedef unsigned int CullingMode +
+otypedef fast_back_stack<ref_ptr<CullingSet> > CullingStack +

+ +

+

Protected Fields

+oCullingMode _cullingMode +
+ofloat _LODScale +
+ofloat _smallFeatureCullingPixelSize +
+oShadowVolumeOccluderList _occluderList +
+oMatrixStack _projectionStack +
+oMatrixStack _modelviewStack +
+oMatrixStack _MVPW_Stack +
+oViewportStack _viewportStack +
+oEyePointStack _eyePointStack +
+oCullingStack _clipspaceCullingStack +
+oCullingStack _projectionCullingStack +
+oCullingStack _modelviewCullingStack +
+ofloat _frustumVolume +
+ounsigned int _bbCornerNear +
+ounsigned int _bbCornerFar +
+oref_ptr<osg::RefMatrix> _identity +
+oMatrixList _reuseMatrixList +
+ounsigned int _currentReuseMatrixIndex +

+ +

+

Protected Methods

+ovoid pushCullingSet() +
+ovoid popCullingSet() +
+ovoid computeFrustumVolume() +
+oinline osg::RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+ +

+

Protected Members

+otypedef fast_back_stack< ref_ptr<RefMatrix> > MatrixStack +
+otypedef fast_back_stack<ref_ptr<Viewport> > ViewportStack +
+otypedef fast_back_stack<Vec3> EyePointStack +
+otypedef std::vector< osg::ref_ptr<osg::RefMatrix> > MatrixList +

+ +
+ + +
+

Documentation

+
+ + + +
otypedef std::set<ShadowVolumeOccluder> ShadowVolumeOccluderSet +

+ + +

o CollectOccludersVisitor() +

+ + +

ovirtual ~CollectOccludersVisitor() +

+ + +

ovirtual CollectOccludersVisitor* cloneType() const +

+ + +

ovirtual void reset() +

+ + +

ovirtual float getDistanceToEyePoint(const Vec3& pos, bool withLODScale) const +

+ + +

ovirtual float getDistanceFromEyePoint(const Vec3& pos, bool withLODScale) const +

+ + +

ovirtual void apply(osg::Node&) +

+ + +

ovirtual void apply(osg::Transform& node) +

+ + +

ovirtual void apply(osg::Projection& node) +

+ + +

ovirtual void apply(osg::Switch& node) +

+ + +

ovirtual void apply(osg::LOD& node) +

+ + +

ovirtual void apply(osg::OccluderNode& node) +

+ + +

ovoid setMinimumShadowOccluderVolume(float vol) +

+ + +

ofloat getMinimumShadowOccluderVolume() const +

+ + +

ovoid setCreateDrawablesOnOccludeNodes(bool flag) +

+ + +

obool getCreateDrawablesOnOccludeNodes() const +

+ + +

ovoid setCollectedOcculderList(const ShadowVolumeOccluderSet& svol) +

+ + +

oShadowVolumeOccluderSet& getCollectedOccluderSet() +

+ + +

oconst ShadowVolumeOccluderSet& getCollectedOccluderSet() const +

+ + +

ovoid removeOccludedOccluders() +
remove occluded occluders for the collected occluders list +

+ + +

o CollectOccludersVisitor(const CollectOccludersVisitor&) +
prevent unwanted copy construction +

+ + +

oCollectOccludersVisitor& operator = (const CollectOccludersVisitor&) +
prevent unwanted copy operator +

+ + +

oinline void handle_cull_callbacks_and_traverse(osg::Node& node) +

+ + +

oinline void handle_cull_callbacks_and_accept(osg::Node& node, osg::Node* acceptNode) +

+ + +

ofloat _minimumShadowOccluderVolume +

+ + +

obool _createDrawables +

+ + +

oShadowVolumeOccluderSet _occluderSet +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ColorMask.html b/doc/doc++/osg/ColorMask.html new file mode 100644 index 000000000..2a5de2afb --- /dev/null +++ b/doc/doc++/osg/ColorMask.html @@ -0,0 +1,240 @@ + + + + + class SG_EXPORT osg::ColorMask + + + + +

class SG_EXPORT osg::ColorMask

Encapsulate OpenGL glColorMaskFunc/Op/Mask functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ColorMask() +
+[more] ColorMask(const ColorMask& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, ColorMask, COLORMASK) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setMask(bool red, bool green, bool blue, bool alpha) +
+[more]inline bool getRedMask() const +
+[more]inline bool getGreenMask() const +
+[more]inline bool getBlueMask() const +
+[more]inline bool getAlphaMask() const +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]bool _red +
+[more]bool _green +
+[more]bool _blue +
+[more]bool _alpha +

+ +

+

Protected Methods

+[more]virtual ~ColorMask() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Encapsulate OpenGL glColorMaskFunc/Op/Mask functions
+
+ + + +
o ColorMask() +

+ + +

o ColorMask(const ColorMask& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, ColorMask, COLORMASK) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oinline void setMask(bool red, bool green, bool blue, bool alpha) +

+ + +

oinline bool getRedMask() const +

+ + +

oinline bool getGreenMask() const +

+ + +

oinline bool getBlueMask() const +

+ + +

oinline bool getAlphaMask() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~ColorMask() +

+ + +

obool _red +

+ + +

obool _green +

+ + +

obool _blue +

+ + +

obool _alpha +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ColorMatrix.html b/doc/doc++/osg/ColorMatrix.html new file mode 100644 index 000000000..7e6a14ae6 --- /dev/null +++ b/doc/doc++/osg/ColorMatrix.html @@ -0,0 +1,218 @@ + + + + + class SG_EXPORT osg::ColorMatrix + + + + +

class SG_EXPORT osg::ColorMatrix

Texture Matrix state class for encapsulating OpenGL texture matrix functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ColorMatrix() +
+[more] ColorMatrix(const ColorMatrix& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, ColorMatrix, COLORMATRIX) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setMatrix(const Matrix& matrix) +
Set the color matrix +
+[more]inline Matrix& getMatrix() +
Get the color matrix +
+[more]inline const Matrix& getMatrix() const +
Get the const color matrix +
+[more]virtual void apply(State& state) const +
apply as OpenGL texture matrix +

+ +

+

Protected Fields

+[more]Matrix _matrix +

+ +

+

Protected Methods

+[more]virtual ~ColorMatrix( void ) +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture Matrix state class for encapsulating OpenGL texture matrix functionality
+
+ + + +
o ColorMatrix() +

+ + +

o ColorMatrix(const ColorMatrix& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, ColorMatrix, COLORMATRIX) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oinline void setMatrix(const Matrix& matrix) +
Set the color matrix +

+ + +

oinline Matrix& getMatrix() +
Get the color matrix +

+ + +

oinline const Matrix& getMatrix() const +
Get the const color matrix +

+ + +

ovirtual void apply(State& state) const +
apply as OpenGL texture matrix +

+ + +

ovirtual ~ColorMatrix( void ) +

+ + +

oMatrix _matrix +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CompositeShape.html b/doc/doc++/osg/CompositeShape.html new file mode 100644 index 000000000..c745291c8 --- /dev/null +++ b/doc/doc++/osg/CompositeShape.html @@ -0,0 +1,229 @@ + + + + + class osg::CompositeShape + + + + +

class osg::CompositeShape

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CompositeShape() +
+[more] CompositeShape(const CompositeShape& cs, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, CompositeShape)(Shape* shape) +
+[more]Shape* getShape() +
Get the shape that encloses all of the children +
+[more]const Shape* getShape() const +
Get the const shape that encloses all of the children +
+[more]unsigned int getNumChildren() const +
Get the number of children of this composite shape +
+[more]Shape* getChild(unsigned int i) +
Get a child +
+[more]const Shape* getChild(unsigned int i) const +
Get a const child +
+[more]void addChild(Shape* shape) +
Add a child to the list +
+[more]void removeChild(unsigned int i) +
remove a child from the list +
+[more]unsigned int findChildNo(Shape* shape) const +
find the index number of child, if child is not found then it returns getNumChildren(), so should be used in similar sytle of STL's result!=end() +

+ +

+

Public Members

+[more]typedef std::vector< ref_ptr<Shape> > ChildList +

+ +

+

Protected Fields

+[more]ref_ptr<Shape> _shape +
+[more]ChildList _children +

+ +

+

Protected Methods

+[more] ~CompositeShape() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
otypedef std::vector< ref_ptr<Shape> > ChildList +

+ + +

o CompositeShape() +

+ + +

o CompositeShape(const CompositeShape& cs, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, CompositeShape)(Shape* shape) +

+ + +

oShape* getShape() +
Get the shape that encloses all of the children +

+ + +

oconst Shape* getShape() const +
Get the const shape that encloses all of the children +

+ + +

ounsigned int getNumChildren() const +
Get the number of children of this composite shape +

+ + +

oShape* getChild(unsigned int i) +
Get a child +

+ + +

oconst Shape* getChild(unsigned int i) const +
Get a const child +

+ + +

ovoid addChild(Shape* shape) +
Add a child to the list +

+ + +

ovoid removeChild(unsigned int i) +
remove a child from the list +

+ + +

ounsigned int findChildNo(Shape* shape) const +
find the index number of child, if child is not found then it returns getNumChildren(), +so should be used in similar sytle of STL's result!=end() +

+ + +

o ~CompositeShape() +

+ + +

oref_ptr<Shape> _shape +

+ + +

oChildList _children +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Cone.html b/doc/doc++/osg/Cone.html new file mode 100644 index 000000000..5add37c83 --- /dev/null +++ b/doc/doc++/osg/Cone.html @@ -0,0 +1,251 @@ + + + + + class osg::Cone + + + + +

class osg::Cone

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Cone() +
+[more] Cone(const osg::Vec3& center, float radius, float height) +
+[more] Cone(const Cone& cone, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, Cone)() const +
+[more]inline void set(const Vec3& center, float radius, float height) +
+[more]inline void setCenter(const Vec3& center) +
+[more]inline const Vec3& getCenter() const +
+[more]inline void setRadius(float radius) +
+[more]inline float getRadius() const +
+[more]inline void setHeight(float height) +
+[more]inline float getHeight() const +
+[more]inline void setRotation(const Quat& quat) +
+[more]inline const Quat& getRotation() const +
+[more]inline Matrix getRotationMatrix() const +
+[more]inline bool zeroRotation() const +
+[more]inline float getBaseOffsetFactor() const +
+[more]inline float getBaseOffset() const +

+ +

+

Protected Fields

+[more]Vec3 _center +
+[more]float _radius +
+[more]float _height +
+[more]Quat _rotation +

+ +

+

Protected Methods

+[more]virtual ~Cone() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Cone() +

+ + +

o Cone(const osg::Vec3& center, float radius, float height) +

+ + +

o Cone(const Cone& cone, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, Cone)() const +

+ + +

oinline void set(const Vec3& center, float radius, float height) +

+ + +

oinline void setCenter(const Vec3& center) +

+ + +

oinline const Vec3& getCenter() const +

+ + +

oinline void setRadius(float radius) +

+ + +

oinline float getRadius() const +

+ + +

oinline void setHeight(float height) +

+ + +

oinline float getHeight() const +

+ + +

oinline void setRotation(const Quat& quat) +

+ + +

oinline const Quat& getRotation() const +

+ + +

oinline Matrix getRotationMatrix() const +

+ + +

oinline bool zeroRotation() const +

+ + +

oinline float getBaseOffsetFactor() const +

+ + +

oinline float getBaseOffset() const +

+ + +

ovirtual ~Cone() +

+ + +

oVec3 _center +

+ + +

ofloat _radius +

+ + +

ofloat _height +

+ + +

oQuat _rotation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConstArrayVisitor.html b/doc/doc++/osg/ConstArrayVisitor.html new file mode 100644 index 000000000..d71160952 --- /dev/null +++ b/doc/doc++/osg/ConstArrayVisitor.html @@ -0,0 +1,42 @@ + + + + + class osg::ConstArrayVisitor + + + + +

class osg::ConstArrayVisitor

+ +
+

+

Public Methods

+[more] ConstArrayVisitor() +
+[more]virtual void apply(const Vec4Array&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ConstArrayVisitor() +

+ + +

ovirtual void apply(const Vec4Array&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConstAttributeFunctor.html b/doc/doc++/osg/ConstAttributeFunctor.html new file mode 100644 index 000000000..2692b8ae7 --- /dev/null +++ b/doc/doc++/osg/ConstAttributeFunctor.html @@ -0,0 +1,42 @@ + + + + + class osg::Drawable::ConstAttributeFunctor + + + + +

class ConstAttributeFunctor

+ +
+

+

Public Methods

+[more]virtual ~ConstAttributeFunctor() +
+[more]virtual void apply(AttributeType, const unsigned int, const UByte4*) +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual ~ConstAttributeFunctor() +

+ + +

ovirtual void apply(AttributeType, const unsigned int, const UByte4*) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConstShapeVisitor.html b/doc/doc++/osg/ConstShapeVisitor.html new file mode 100644 index 000000000..24faae239 --- /dev/null +++ b/doc/doc++/osg/ConstShapeVisitor.html @@ -0,0 +1,42 @@ + + + + + class osg::ConstShapeVisitor + + + + +

class osg::ConstShapeVisitor

+ +
+

+

Public Methods

+[more] ConstShapeVisitor() +
+[more]virtual void apply(const CompositeShape&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ConstShapeVisitor() +

+ + +

ovirtual void apply(const CompositeShape&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConstValueVisitor.html b/doc/doc++/osg/ConstValueVisitor.html new file mode 100644 index 000000000..a77eb6858 --- /dev/null +++ b/doc/doc++/osg/ConstValueVisitor.html @@ -0,0 +1,42 @@ + + + + + class osg::ConstValueVisitor + + + + +

class osg::ConstValueVisitor

+ +
+

+

Public Methods

+[more] ConstValueVisitor() +
+[more]virtual void apply(const Vec4&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ConstValueVisitor() +

+ + +

ovirtual void apply(const Vec4&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConvexHull.html b/doc/doc++/osg/ConvexHull.html new file mode 100644 index 000000000..0107db5cf --- /dev/null +++ b/doc/doc++/osg/ConvexHull.html @@ -0,0 +1,156 @@ + + + + + class osg::ConvexHull + + + + +

class osg::ConvexHull

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ConvexHull() +
+[more] ConvexHull(const ConvexHull& hull, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Shape(osg, TriangleMesh) +

+ +
+

Inherited from TriangleMesh:

+
+

+

Public Methods

+oMETA_Shape (osg, TriangleMesh)(Vec3Array* vertices) +
+oVec3Array* getVertices() +
+oconst Vec3Array* getVertices() const +
+ovoid setIndices(IndexArray* indices) +
+oIndexArray* getIndices() +
+oconst IndexArray* getIndices() const +

+ +

+

Protected Fields

+oref_ptr<Vec3Array> _vertices +
+oref_ptr<IndexArray> _indices +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o ConvexHull() +

+ + +

o ConvexHull(const ConvexHull& hull, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Shape(osg, TriangleMesh) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConvexPlanarOccluder.html b/doc/doc++/osg/ConvexPlanarOccluder.html new file mode 100644 index 000000000..28fa29603 --- /dev/null +++ b/doc/doc++/osg/ConvexPlanarOccluder.html @@ -0,0 +1,187 @@ + + + + + class SG_EXPORT osg::ConvexPlanarOccluder + + + + +

class SG_EXPORT osg::ConvexPlanarOccluder

A class for representing convex clipping volumes made up.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ConvexPlanarOccluder() +
+[more] ConvexPlanarOccluder(const ConvexPlanarOccluder& cpo, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Object (osg, ConvexPlanarOccluder)(const ConvexPlanarPolygon& cpp) +
+[more]ConvexPlanarPolygon& getOccluder() +
+[more]const ConvexPlanarPolygon& getOccluder() const +
+[more]void addHole(const ConvexPlanarPolygon& cpp) +
+[more]HoleList& getHoleList() +
+[more]const HoleList& getHoleList() const +

+ +

+

Public Members

+[more]typedef std::vector<ConvexPlanarPolygon> HoleList +

+ +

+

Protected Fields

+[more]ConvexPlanarPolygon _occluder +
+[more]HoleList _holeList +

+ +

+

Protected Methods

+[more] ~ConvexPlanarOccluder() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
A class for representing convex clipping volumes made up. +When adding planes, their normals should point inwards (into the volume)
+
+ + + +
o ConvexPlanarOccluder() +

+ + +

o ConvexPlanarOccluder(const ConvexPlanarOccluder& cpo, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Object (osg, ConvexPlanarOccluder)(const ConvexPlanarPolygon& cpp) +

+ + +

oConvexPlanarPolygon& getOccluder() +

+ + +

oconst ConvexPlanarPolygon& getOccluder() const +

+ + +

otypedef std::vector<ConvexPlanarPolygon> HoleList +

+ + +

ovoid addHole(const ConvexPlanarPolygon& cpp) +

+ + +

oHoleList& getHoleList() +

+ + +

oconst HoleList& getHoleList() const +

+ + +

o ~ConvexPlanarOccluder() +

+ + +

oConvexPlanarPolygon _occluder +

+ + +

oHoleList _holeList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ConvexPlanarPolygon.html b/doc/doc++/osg/ConvexPlanarPolygon.html new file mode 100644 index 000000000..511d26484 --- /dev/null +++ b/doc/doc++/osg/ConvexPlanarPolygon.html @@ -0,0 +1,75 @@ + + + + + class SG_EXPORT osg::ConvexPlanarPolygon + + + + +

class SG_EXPORT osg::ConvexPlanarPolygon

A class for representing convex clipping volumes made up.
+
+ +
+

+

Public Methods

+[more] ConvexPlanarPolygon() +
+[more]void add(const Vec3& v) +
+[more]VertexList& getVertexList() +
+[more]const VertexList& getVertexList() const +

+ +

+

Public Members

+[more]typedef std::vector<osg::Vec3> VertexList +

+ +

+

Protected Fields

+[more]VertexList _vertexList +

+ +
+ + +
+

Documentation

+
A class for representing convex clipping volumes made up. +When adding planes, their normals should point inwards (into the volume)
+
+ + + +
o ConvexPlanarPolygon() +

+ + +

otypedef std::vector<osg::Vec3> VertexList +

+ + +

ovoid add(const Vec3& v) +

+ + +

oVertexList& getVertexList() +

+ + +

oconst VertexList& getVertexList() const +

+ + +

oVertexList _vertexList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CopyOp.html b/doc/doc++/osg/CopyOp.html new file mode 100644 index 000000000..7eb6687f4 --- /dev/null +++ b/doc/doc++/osg/CopyOp.html @@ -0,0 +1,185 @@ + + + + + class SG_EXPORT osg::CopyOp + + + + +

class SG_EXPORT osg::CopyOp

Copy Op(erator) used to control the whether shallow or deep copy is used during copy construction and clone operation
+
+ +
+

+

Public Methods

+[more]inline CopyOp(CopyFlags flags=SHALLOW_COPY) +
+[more]virtual ~CopyOp() +
+[more]virtual Referenced* operator() (const Referenced* ref) const +
+[more]virtual Object* operator() (const Object* obj) const +
+[more]virtual Node* operator() (const Node* node) const +
+[more]virtual Drawable* operator() (const Drawable* drawable) const +
+[more]virtual StateSet* operator() (const StateSet* stateset) const +
+[more]virtual StateAttribute* operator() (const StateAttribute* attr) const +
+[more]virtual Texture* operator() (const Texture* text) const +
+[more]virtual Image* operator() (const Image* image) const +
+[more]virtual Array* operator() (const Array* array) const +
+[more]virtual PrimitiveSet* operator() (const PrimitiveSet* primitives) const +
+[more]virtual Shape* operator() (const Shape* shape) const +

+ +

+

Public Members

+[more]enum Options +
+[more]typedef unsigned int CopyFlags +

+ +

+

Protected Fields

+[more]CopyFlags _flags +

+ +
+ + +
+

Documentation

+
Copy Op(erator) used to control the whether shallow or deep copy is used +during copy construction and clone operation
+
+ + + +
oenum Options +

+ + + +
o SHALLOW_COPY +

+ + +

o DEEP_COPY_OBJECTS +

+ + +

o DEEP_COPY_NODES +

+ + +

o DEEP_COPY_DRAWABLES +

+ + +

o DEEP_COPY_STATESETS +

+ + +

o DEEP_COPY_STATEATTRIBUTES +

+ + +

o DEEP_COPY_TEXTURES +

+ + +

o DEEP_COPY_IMAGES +

+ + +

o DEEP_COPY_ARRAYS +

+ + +

o DEEP_COPY_PRIMITIVES +

+ + +

o DEEP_COPY_SHAPES +

+ + +

o DEEP_COPY_ALL +

+ + + +
otypedef unsigned int CopyFlags +

+ + +

oinline CopyOp(CopyFlags flags=SHALLOW_COPY) +

+ + +

ovirtual ~CopyOp() +

+ + +

ovirtual Referenced* operator() (const Referenced* ref) const +

+ + +

ovirtual Object* operator() (const Object* obj) const +

+ + +

ovirtual Node* operator() (const Node* node) const +

+ + +

ovirtual Drawable* operator() (const Drawable* drawable) const +

+ + +

ovirtual StateSet* operator() (const StateSet* stateset) const +

+ + +

ovirtual StateAttribute* operator() (const StateAttribute* attr) const +

+ + +

ovirtual Texture* operator() (const Texture* text) const +

+ + +

ovirtual Image* operator() (const Image* image) const +

+ + +

ovirtual Array* operator() (const Array* array) const +

+ + +

ovirtual PrimitiveSet* operator() (const PrimitiveSet* primitives) const +

+ + +

ovirtual Shape* operator() (const Shape* shape) const +

+ + +

oCopyFlags _flags +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CullFace.html b/doc/doc++/osg/CullFace.html new file mode 100644 index 000000000..1156c9ccd --- /dev/null +++ b/doc/doc++/osg/CullFace.html @@ -0,0 +1,231 @@ + + + + + class SG_EXPORT osg::CullFace + + + + +

class SG_EXPORT osg::CullFace

Class to globally enable/disable OpenGL's polygon culling mode=
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CullFace() +
+[more] CullFace(const CullFace& cf, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, CullFace, CULLFACE) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setMode(Mode mode) +
+[more]inline Mode getMode() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Mode +

+ +

+

Protected Fields

+[more]Mode _mode +

+ +

+

Protected Methods

+[more]virtual ~CullFace() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Class to globally enable/disable OpenGL's polygon culling mode=
+
+ + + +
o CullFace() +

+ + +

o CullFace(const CullFace& cf, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, CullFace, CULLFACE) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum Mode +

+ + + +
o FRONT +

+ + +

o BACK +

+ + +

o FRONT_AND_BACK +

+ + + +
oinline void setMode(Mode mode) +

+ + +

oinline Mode getMode() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~CullFace() +

+ + +

oMode _mode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CullStack.html b/doc/doc++/osg/CullStack.html new file mode 100644 index 000000000..36282a566 --- /dev/null +++ b/doc/doc++/osg/CullStack.html @@ -0,0 +1,557 @@ + + + + + class SG_EXPORT osg::CullStack + + + + +

class SG_EXPORT osg::CullStack

A CullStack class which accumulates the current project, modelview matrices and the CullingSet.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CullStack() +
+[more] ~CullStack() +
+[more]void reset() +
+[more]void setOccluderList(const ShadowVolumeOccluderList& svol) +
+[more]ShadowVolumeOccluderList& getOccluderList() +
+[more]const ShadowVolumeOccluderList& getOccluderList() const +
+[more]void pushViewport(osg::Viewport* viewport) +
+[more]void popViewport() +
+[more]void pushProjectionMatrix(osg::RefMatrix* matrix) +
+[more]void popProjectionMatrix() +
+[more]void pushModelViewMatrix(osg::RefMatrix* matrix) +
+[more]void popModelViewMatrix() +
+[more]inline float getFrustumVolume() +
+[more]void setCullingMode(CullingMode mode) +
Sets the current CullingMode +
+[more]CullingMode getCullingMode() const +
Returns the current CullingMode +
+[more]void setLODScale(float bias) +
+[more]float getLODScale() const +
+[more]void setSmallFeatureCullingPixelSize(float value) +
+[more]float getSmallFeatureCullingPixelSize() const +
+[more]float pixelSize(const Vec3& v, float radius) const +
Compute the pixel of an object at position v, with specified radius +
+[more]float pixelSize(const BoundingSphere& bs) const +
Compute the pixel of an bounding sphere +
+[more]inline void disableAndPushOccludersCurrentMask(NodePath& nodePath) +
+[more]inline void popOccludersCurrentMask(NodePath& nodePath) +
+[more]inline bool isCulled(const std::vector<Vec3>& vertices) +
+[more]inline bool isCulled(const BoundingBox& bb) +
+[more]inline bool isCulled(const BoundingSphere& bs) +
+[more]inline bool isCulled(const osg::Node& node) +
+[more]inline void pushCurrentMask() +
+[more]inline void popCurrentMask() +
+[more]CullingStack& getClipSpaceCullingStack() +
+[more]CullingStack& getProjectionCullingStack() +
+[more]CullingStack& getModelViewCullingStack() +
+[more]CullingSet& getCurrentCullingSet() +
+[more]inline osg::Viewport* getViewport() +
+[more]inline osg::RefMatrix& getModelViewMatrix() +
+[more]inline osg::RefMatrix& getProjectionMatrix() +
+[more]inline osg::Matrix getWindowMatrix() +
+[more]inline const osg::RefMatrix& getMVPW() +
+[more]inline const osg::Vec3& getEyeLocal() const +
+[more]inline const osg::Vec3 getUpLocal() const +
+[more]inline const osg::Vec3 getLookVectorLocal() const +
+[more]inline Viewport* getViewport() +
+[more]inline RefMatrix& getModelViewMatrix() +
+[more]inline RefMatrix& getProjectionMatrix() +
+[more]inline Matrix getWindowMatrix() +
+[more]inline const RefMatrix& getMVPW() +
+[more]inline RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+ +

+

Public Members

+[more]typedef std::vector<ShadowVolumeOccluder> OccluderList +
+[more]enum CullingModeValues +
+[more]typedef unsigned int CullingMode +
+[more]typedef fast_back_stack<ref_ptr<CullingSet> > CullingStack +

+ +

+

Protected Fields

+[more]CullingMode _cullingMode +
+[more]float _LODScale +
+[more]float _smallFeatureCullingPixelSize +
+[more]ShadowVolumeOccluderList _occluderList +
+[more]MatrixStack _projectionStack +
+[more]MatrixStack _modelviewStack +
+[more]MatrixStack _MVPW_Stack +
+[more]ViewportStack _viewportStack +
+[more]EyePointStack _eyePointStack +
+[more]CullingStack _clipspaceCullingStack +
+[more]CullingStack _projectionCullingStack +
+[more]CullingStack _modelviewCullingStack +
+[more]float _frustumVolume +
+[more]unsigned int _bbCornerNear +
+[more]unsigned int _bbCornerFar +
+[more]ref_ptr<osg::RefMatrix> _identity +
+[more]MatrixList _reuseMatrixList +
+[more]unsigned int _currentReuseMatrixIndex +

+ +

+

Protected Methods

+[more]void pushCullingSet() +
+[more]void popCullingSet() +
+[more]void computeFrustumVolume() +
+[more]inline osg::RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+ +

+

Protected Members

+[more]typedef fast_back_stack< ref_ptr<RefMatrix> > MatrixStack +
+[more]typedef fast_back_stack<ref_ptr<Viewport> > ViewportStack +
+[more]typedef fast_back_stack<Vec3> EyePointStack +
+[more]typedef std::vector< osg::ref_ptr<osg::RefMatrix> > MatrixList +

+ +
+ + +
+

Documentation

+
A CullStack class which accumulates the current project, modelview matrices +and the CullingSet.
+
+ + + +
o CullStack() +

+ + +

o ~CullStack() +

+ + +

otypedef std::vector<ShadowVolumeOccluder> OccluderList +

+ + +

oenum CullingModeValues +

+ + + +
o NO_CULLING +

+ + +

o VIEW_FRUSTUM_CULLING +

+ + +

o NEAR_PLANE_CULLING +

+ + +

o FAR_PLANE_CULLING +

+ + +

o SMALL_FEATURE_CULLING +

+ + +

o SHADOW_OCCLUSION_CULLING +

+ + +

o ENABLE_ALL_CULLING +

+ + + +
otypedef unsigned int CullingMode +

+ + +

ovoid reset() +

+ + +

ovoid setOccluderList(const ShadowVolumeOccluderList& svol) +

+ + +

oShadowVolumeOccluderList& getOccluderList() +

+ + +

oconst ShadowVolumeOccluderList& getOccluderList() const +

+ + +

ovoid pushViewport(osg::Viewport* viewport) +

+ + +

ovoid popViewport() +

+ + +

ovoid pushProjectionMatrix(osg::RefMatrix* matrix) +

+ + +

ovoid popProjectionMatrix() +

+ + +

ovoid pushModelViewMatrix(osg::RefMatrix* matrix) +

+ + +

ovoid popModelViewMatrix() +

+ + +

oinline float getFrustumVolume() +

+ + +

ovoid setCullingMode(CullingMode mode) +
Sets the current CullingMode +

+ + +

oCullingMode getCullingMode() const +
Returns the current CullingMode +

+ + +

ovoid setLODScale(float bias) +

+ + +

ofloat getLODScale() const +

+ + +

ovoid setSmallFeatureCullingPixelSize(float value) +

+ + +

ofloat getSmallFeatureCullingPixelSize() const +

+ + +

ofloat pixelSize(const Vec3& v, float radius) const +
Compute the pixel of an object at position v, with specified radius +

+ + +

ofloat pixelSize(const BoundingSphere& bs) const +
Compute the pixel of an bounding sphere +

+ + +

oinline void disableAndPushOccludersCurrentMask(NodePath& nodePath) +

+ + +

oinline void popOccludersCurrentMask(NodePath& nodePath) +

+ + +

oinline bool isCulled(const std::vector<Vec3>& vertices) +

+ + +

oinline bool isCulled(const BoundingBox& bb) +

+ + +

oinline bool isCulled(const BoundingSphere& bs) +

+ + +

oinline bool isCulled(const osg::Node& node) +

+ + +

oinline void pushCurrentMask() +

+ + +

oinline void popCurrentMask() +

+ + +

otypedef fast_back_stack<ref_ptr<CullingSet> > CullingStack +

+ + +

oCullingStack& getClipSpaceCullingStack() +

+ + +

oCullingStack& getProjectionCullingStack() +

+ + +

oCullingStack& getModelViewCullingStack() +

+ + +

oCullingSet& getCurrentCullingSet() +

+ + +

oinline osg::Viewport* getViewport() +

+ + +

oinline osg::RefMatrix& getModelViewMatrix() +

+ + +

oinline osg::RefMatrix& getProjectionMatrix() +

+ + +

oinline osg::Matrix getWindowMatrix() +

+ + +

oinline const osg::RefMatrix& getMVPW() +

+ + +

oinline const osg::Vec3& getEyeLocal() const +

+ + +

oinline const osg::Vec3 getUpLocal() const +

+ + +

oinline const osg::Vec3 getLookVectorLocal() const +

+ + +

ovoid pushCullingSet() +

+ + +

ovoid popCullingSet() +

+ + +

oCullingMode _cullingMode +

+ + +

ofloat _LODScale +

+ + +

ofloat _smallFeatureCullingPixelSize +

+ + +

oShadowVolumeOccluderList _occluderList +

+ + +

otypedef fast_back_stack< ref_ptr<RefMatrix> > MatrixStack +

+ + +

oMatrixStack _projectionStack +

+ + +

oMatrixStack _modelviewStack +

+ + +

oMatrixStack _MVPW_Stack +

+ + +

otypedef fast_back_stack<ref_ptr<Viewport> > ViewportStack +

+ + +

oViewportStack _viewportStack +

+ + +

otypedef fast_back_stack<Vec3> EyePointStack +

+ + +

oEyePointStack _eyePointStack +

+ + +

oCullingStack _clipspaceCullingStack +

+ + +

oCullingStack _projectionCullingStack +

+ + +

oCullingStack _modelviewCullingStack +

+ + +

ovoid computeFrustumVolume() +

+ + +

ofloat _frustumVolume +

+ + +

ounsigned int _bbCornerNear +

+ + +

ounsigned int _bbCornerFar +

+ + +

oref_ptr<osg::RefMatrix> _identity +

+ + +

otypedef std::vector< osg::ref_ptr<osg::RefMatrix> > MatrixList +

+ + +

oMatrixList _reuseMatrixList +

+ + +

ounsigned int _currentReuseMatrixIndex +

+ + +

oinline osg::RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+ + +

oinline Viewport* getViewport() +

+ + +

oinline RefMatrix& getModelViewMatrix() +

+ + +

oinline RefMatrix& getProjectionMatrix() +

+ + +

oinline Matrix getWindowMatrix() +

+ + +

oinline const RefMatrix& getMVPW() +

+ + +

oinline RefMatrix* createOrReuseMatrix(const osg::Matrix& value) +

+
+
Direct child classes: +
CollectOccludersVisitor
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/CullingSet.html b/doc/doc++/osg/CullingSet.html new file mode 100644 index 000000000..1e1a27acf --- /dev/null +++ b/doc/doc++/osg/CullingSet.html @@ -0,0 +1,284 @@ + + + + + class SG_EXPORT osg::CullingSet + + + + +

class SG_EXPORT osg::CullingSet

A CullingSet class which contains a frustum and a list of occluder.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CullingSet() +
+[more] CullingSet(const CullingSet& cs, const Matrix& matrix, const Vec4& pixelSizeVector) +
+[more]void setCullingMask(Mask mask) +
+[more]void setFrustum(Polytope& cv) +
+[more]Polytope& getFrustum() +
+[more]const Polytope& getFrustum() const +
+[more]void addOccluder(ShadowVolumeOccluder& cv) +
+[more]void setPixelSizeVector(const Vec4& v) +
+[more]Vec4& getPixelSizeVector() +
+[more]const Vec4& getPixelSizeVector() const +
+[more]void setSmallFeatureCullingPixelSize(float value) +
+[more]float& getSmallFeatureCullingPixelSize() +
+[more]float getSmallFeatureCullingPixelSize() const +
+[more]float pixelSize(const Vec3& v, float radius) const +
Compute the pixel of an object at position v, with specified radius +
+[more]float pixelSize(const BoundingSphere& bs) const +
Compute the pixel of an bounding sphere +
+[more]inline bool isCulled(const std::vector<Vec3>& vertices) +
+[more]inline bool isCulled(const BoundingBox& bb) +
+[more]inline bool isCulled(const BoundingSphere& bs) +
+[more]inline void pushCurrentMask() +
+[more]inline void popCurrentMask() +
+[more]void disableAndPushOccludersCurrentMask(NodePath& nodePath) +
+[more]void popOccludersCurrentMask(NodePath& nodePath) +

+ +

+

Public Members

+[more]typedef std::vector<ShadowVolumeOccluder> OccluderList +
+[more]typedef unsigned int Mask +
+[more]enum MaskValues +

+ +

+

Protected Fields

+[more]Mask _mask +
+[more]Polytope _frustum +
+[more]OccluderList _occluderList +
+[more]Vec4 _pixelSizeVector +
+[more]float _smallFeatureCullingPixelSize +

+ +

+

Protected Methods

+[more]virtual ~CullingSet() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
A CullingSet class which contains a frustum and a list of occluder.
+
+ + + +
o CullingSet() +

+ + +

o CullingSet(const CullingSet& cs, const Matrix& matrix, const Vec4& pixelSizeVector) +

+ + +

otypedef std::vector<ShadowVolumeOccluder> OccluderList +

+ + +

otypedef unsigned int Mask +

+ + +

oenum MaskValues +

+ + + +
o VIEW_FRUSTUM_CULLING +

+ + +

o SMALL_FEATURE_CULLING +

+ + +

o SHADOW_OCCLUSION_CULLING +

+ + +

o ALL_CULLING +

+ + + +
ovoid setCullingMask(Mask mask) +

+ + +

ovoid setFrustum(Polytope& cv) +

+ + +

oPolytope& getFrustum() +

+ + +

oconst Polytope& getFrustum() const +

+ + +

ovoid addOccluder(ShadowVolumeOccluder& cv) +

+ + +

ovoid setPixelSizeVector(const Vec4& v) +

+ + +

oVec4& getPixelSizeVector() +

+ + +

oconst Vec4& getPixelSizeVector() const +

+ + +

ovoid setSmallFeatureCullingPixelSize(float value) +

+ + +

ofloat& getSmallFeatureCullingPixelSize() +

+ + +

ofloat getSmallFeatureCullingPixelSize() const +

+ + +

ofloat pixelSize(const Vec3& v, float radius) const +
Compute the pixel of an object at position v, with specified radius +

+ + +

ofloat pixelSize(const BoundingSphere& bs) const +
Compute the pixel of an bounding sphere +

+ + +

oinline bool isCulled(const std::vector<Vec3>& vertices) +

+ + +

oinline bool isCulled(const BoundingBox& bb) +

+ + +

oinline bool isCulled(const BoundingSphere& bs) +

+ + +

oinline void pushCurrentMask() +

+ + +

oinline void popCurrentMask() +

+ + +

ovoid disableAndPushOccludersCurrentMask(NodePath& nodePath) +

+ + +

ovoid popOccludersCurrentMask(NodePath& nodePath) +

+ + +

ovirtual ~CullingSet() +

+ + +

oMask _mask +

+ + +

oPolytope _frustum +

+ + +

oOccluderList _occluderList +

+ + +

oVec4 _pixelSizeVector +

+ + +

ofloat _smallFeatureCullingPixelSize +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Cylinder.html b/doc/doc++/osg/Cylinder.html new file mode 100644 index 000000000..9ea3a556c --- /dev/null +++ b/doc/doc++/osg/Cylinder.html @@ -0,0 +1,239 @@ + + + + + class osg::Cylinder + + + + +

class osg::Cylinder

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Cylinder() +
+[more] Cylinder(const osg::Vec3& center, float radius, float height) +
+[more] Cylinder(const Cylinder& cylinder, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, Cylinder)() const +
+[more]inline void set(const Vec3& center, float radius, float height) +
+[more]inline void setCenter(const Vec3& center) +
+[more]inline const Vec3& getCenter() const +
+[more]inline void setRadius(float radius) +
+[more]inline float getRadius() const +
+[more]inline void setHeight(float height) +
+[more]inline float getHeight() const +
+[more]inline void setRotation(const Quat& quat) +
+[more]inline const Quat& getRotation() const +
+[more]inline Matrix getRotationMatrix() const +
+[more]bool zeroRotation() const +

+ +

+

Protected Fields

+[more]Vec3 _center +
+[more]float _radius +
+[more]float _height +
+[more]Quat _rotation +

+ +

+

Protected Methods

+[more]virtual ~Cylinder() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Cylinder() +

+ + +

o Cylinder(const osg::Vec3& center, float radius, float height) +

+ + +

o Cylinder(const Cylinder& cylinder, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, Cylinder)() const +

+ + +

oinline void set(const Vec3& center, float radius, float height) +

+ + +

oinline void setCenter(const Vec3& center) +

+ + +

oinline const Vec3& getCenter() const +

+ + +

oinline void setRadius(float radius) +

+ + +

oinline float getRadius() const +

+ + +

oinline void setHeight(float height) +

+ + +

oinline float getHeight() const +

+ + +

oinline void setRotation(const Quat& quat) +

+ + +

oinline const Quat& getRotation() const +

+ + +

oinline Matrix getRotationMatrix() const +

+ + +

obool zeroRotation() const +

+ + +

ovirtual ~Cylinder() +

+ + +

oVec3 _center +

+ + +

ofloat _radius +

+ + +

ofloat _height +

+ + +

oQuat _rotation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DOFTransform.html b/doc/doc++/osg/DOFTransform.html new file mode 100644 index 000000000..bea8ba097 --- /dev/null +++ b/doc/doc++/osg/DOFTransform.html @@ -0,0 +1,727 @@ + + + + + class SG_EXPORT osg::DOFTransform + + + + +

class SG_EXPORT osg::DOFTransform

DOFTransform - encapsulates Multigen DOF behavior
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DOFTransform() +
constructor +
+[more] DOFTransform(const DOFTransform& dof, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
copy constructor +
+[more] META_Node(osg, DOFTransform) +
+[more]virtual DOFTransform* asDOFTransform() +
+[more]virtual const DOFTransform* asDOFTransform() const +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]void setMinHPR(const Vec3& hpr) +
+[more]const Vec3& getMinHPR() const +
+[more]void setMaxHPR(const Vec3& hpr) +
+[more]const Vec3& getMaxHPR() const +
+[more]void setIncrementHPR(const Vec3& hpr) +
+[more]const Vec3& getIncrementHPR() const +
+[more]void setCurrentHPR(const Vec3& hpr) +
+[more]const Vec3& getCurrentHPR() const +
+[more]void updateCurrentHPR(const Vec3& hpr) +
+[more]void setMinTranslate(const Vec3& translate) +
+[more]const Vec3& getMinTranslate() const +
+[more]void setMaxTranslate(const Vec3& translate) +
+[more]const Vec3& getMaxTranslate() const +
+[more]void setIncrementTranslate(const Vec3& translate) +
+[more]const Vec3& getIncrementTranslate() const +
+[more]void setCurrentTranslate(const Vec3& translate) +
+[more]inline const Vec3& getCurrentTranslate() const +
+[more]void updateCurrentTranslate(const Vec3& translate) +
+[more]void setMinScale(const Vec3& scale) +
+[more]const Vec3& getMinScale() const +
+[more]void setMaxScale(const Vec3& scale) +
+[more]const Vec3& getMaxScale() const +
+[more]void setIncrementScale(const Vec3& scale) +
+[more]const Vec3& getIncrementScale() const +
+[more]void setCurrentScale(const Vec3& scale) +
+[more]inline const Vec3& getCurrentScale() const +
+[more]void updateCurrentScale(const Vec3& scale) +
+[more]void setPutMatrix(const Matrix& put) +
+[more]inline const Matrix& getPutMatrix() const +
+[more]void setInversePutMatrix(const Matrix& inversePut) +
+[more]inline const Matrix& getInversePutMatrix() const +
+[more]void setLimitationFlags(unsigned long flags) +
+[more]inline unsigned long getLimitationFlags() const +
+[more]inline void setAnimationOn(bool do_animate) +
+[more]inline bool getAnimationOn() const +
+[more]void animate() +
+[more]virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+[more]virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Protected Fields

+[more]Vec3 _minHPR +
+[more]Vec3 _maxHPR +
+[more]Vec3 _currentHPR +
+[more]Vec3 _incrementHPR +
+[more]Vec3 _minTranslate +
+[more]Vec3 _maxTranslate +
+[more]Vec3 _currentTranslate +
+[more]Vec3 _incrementTranslate +
+[more]Vec3 _minScale +
+[more]Vec3 _maxScale +
+[more]Vec3 _currentScale +
+[more]Vec3 _incrementScale +
+[more]Matrix _Put +
+[more]Matrix _inversePut +
+[more]unsigned long _limitationFlags +
+[more]bool _animationOn +
+[more]unsigned short _increasingFlags +
flags indicating whether value is incerasing or decreasing in animation bits form right to left, 1 means increasing while 0 is decreasing 0 = x translation 1 = y translation 2 = z translation 3 = pitch 4 = roll 5 = yaw 6 = x scale 7 = y scale 8 = z scale +

+ +

+

Protected Methods

+[more]virtual ~DOFTransform() +

+ +
+

Inherited from Transform:

+
+

+

Public Methods

+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual MatrixTransform* asMatrixTransform() +
+ovirtual const MatrixTransform* asMatrixTransform() const +
+ovirtual PositionAttitudeTransform* asPositionAttitudeTransform() +
+ovirtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +
+ovoid setReferenceFrame(ReferenceFrame rf) +
+oReferenceFrame getReferenceFrame() const +
+ovoid setComputeTransformCallback(ComputeTransformCallback* ctc) +
+oComputeTransformCallback* getComputeTransformCallback() +
+oconst ComputeTransformCallback* getComputeTransformCallback() const +
+oinline bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+oinline bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Public Members

+oenum ReferenceFrame +
+ostruct ComputeTransformCallback: public virtual osg::Referenced +

+ +

+

Protected Fields

+oref_ptr<ComputeTransformCallback> _computeTransformCallback +
+oReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
DOFTransform - encapsulates Multigen DOF behavior
+
+ + + +
o DOFTransform() +
constructor +

+ + +

o DOFTransform(const DOFTransform& dof, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
copy constructor +

+ + +

o META_Node(osg, DOFTransform) +

+ + +

ovirtual DOFTransform* asDOFTransform() +

+ + +

ovirtual const DOFTransform* asDOFTransform() const +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovoid setMinHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getMinHPR() const +

+ + +

ovoid setMaxHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getMaxHPR() const +

+ + +

ovoid setIncrementHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getIncrementHPR() const +

+ + +

ovoid setCurrentHPR(const Vec3& hpr) +

+ + +

oconst Vec3& getCurrentHPR() const +

+ + +

ovoid updateCurrentHPR(const Vec3& hpr) +

+ + +

ovoid setMinTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getMinTranslate() const +

+ + +

ovoid setMaxTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getMaxTranslate() const +

+ + +

ovoid setIncrementTranslate(const Vec3& translate) +

+ + +

oconst Vec3& getIncrementTranslate() const +

+ + +

ovoid setCurrentTranslate(const Vec3& translate) +

+ + +

oinline const Vec3& getCurrentTranslate() const +

+ + +

ovoid updateCurrentTranslate(const Vec3& translate) +

+ + +

ovoid setMinScale(const Vec3& scale) +

+ + +

oconst Vec3& getMinScale() const +

+ + +

ovoid setMaxScale(const Vec3& scale) +

+ + +

oconst Vec3& getMaxScale() const +

+ + +

ovoid setIncrementScale(const Vec3& scale) +

+ + +

oconst Vec3& getIncrementScale() const +

+ + +

ovoid setCurrentScale(const Vec3& scale) +

+ + +

oinline const Vec3& getCurrentScale() const +

+ + +

ovoid updateCurrentScale(const Vec3& scale) +

+ + +

ovoid setPutMatrix(const Matrix& put) +

+ + +

oinline const Matrix& getPutMatrix() const +

+ + +

ovoid setInversePutMatrix(const Matrix& inversePut) +

+ + +

oinline const Matrix& getInversePutMatrix() const +

+ + +

ovoid setLimitationFlags(unsigned long flags) +

+ + +

oinline unsigned long getLimitationFlags() const +

+ + +

oinline void setAnimationOn(bool do_animate) +

+ + +

oinline bool getAnimationOn() const +

+ + +

ovoid animate() +

+ + +

ovirtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual ~DOFTransform() +

+ + +

oVec3 _minHPR +

+ + +

oVec3 _maxHPR +

+ + +

oVec3 _currentHPR +

+ + +

oVec3 _incrementHPR +

+ + +

oVec3 _minTranslate +

+ + +

oVec3 _maxTranslate +

+ + +

oVec3 _currentTranslate +

+ + +

oVec3 _incrementTranslate +

+ + +

oVec3 _minScale +

+ + +

oVec3 _maxScale +

+ + +

oVec3 _currentScale +

+ + +

oVec3 _incrementScale +

+ + +

oMatrix _Put +

+ + +

oMatrix _inversePut +

+ + +

ounsigned long _limitationFlags +

+ + +

obool _animationOn +

+ + +

ounsigned short _increasingFlags +
flags indicating whether value is incerasing or decreasing in animation +bits form right to left, 1 means increasing while 0 is decreasing +0 = x translation +1 = y translation +2 = z translation +3 = pitch +4 = roll +5 = yaw +6 = x scale +7 = y scale +8 = z scale +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DeleteHandler.html b/doc/doc++/osg/DeleteHandler.html new file mode 100644 index 000000000..c16804a04 --- /dev/null +++ b/doc/doc++/osg/DeleteHandler.html @@ -0,0 +1,69 @@ + + + + + class osg::DeleteHandler + + + + +

class osg::DeleteHandler

Class for override the default delete behavior so that users can implment their own object deletion schemes.
+
+ +
+

+

Public Methods

+[more]virtual ~DeleteHandler() +
+[more]virtual void flush() +
flush any cache of objects that need to be deleted by doing an actual delete +
+[more]inline void doDelete(const Referenced* object) +
+[more]virtual void requestDelete(const Referenced* object) +
Request the deletion of an object. +

+ +
+ + +
+

Documentation

+
Class for override the default delete behavior so that users can implment their own object +deletion schemes. This might be done to help implement protection of multiple threads from deleting +objects unintentionally. +Note, the DeleteHandler cannot itself be reference counted, otherwise it +would be responsible for deleting itself! +An static auto_ptr<> is used internally in Referenced.cpp to manage the +DeleteHandler's memory.
+
+ + + +
ovirtual ~DeleteHandler() +

+ + +

ovirtual void flush() +
flush any cache of objects that need to be deleted by doing an actual delete +

+ + +

oinline void doDelete(const Referenced* object) +

+ + +

ovirtual void requestDelete(const Referenced* object) +
Request the deletion of an object. +Depending on users implementation of DeleteHandler, the delete of the object may occur +straight away or be delayed until doDelete is called. +The default implementation does a delete straight away. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Depth.html b/doc/doc++/osg/Depth.html new file mode 100644 index 000000000..0a6903297 --- /dev/null +++ b/doc/doc++/osg/Depth.html @@ -0,0 +1,299 @@ + + + + + class SG_EXPORT osg::Depth + + + + +

class SG_EXPORT osg::Depth

Encapsulate OpenGL glDepthFunc/Mask/Range functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Depth() +
+[more] Depth(const Depth& dp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Depth, DEPTH) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setFunction(Function func) +
+[more]inline Function getFunction() const +
+[more]inline void setWriteMask(bool mask) +
+[more]inline bool getWriteMask() const +
+[more]inline void setRange(double zNear, double zFar) +
+[more]inline double getZNear() const +
+[more]inline double getZFar() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Function +

+ +

+

Protected Fields

+[more]Function _func +
+[more]bool _depthWriteMask +
+[more]double _zNear +
+[more]double _zFar +

+ +

+

Protected Methods

+[more]virtual ~Depth() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Encapsulate OpenGL glDepthFunc/Mask/Range functions
+
+ + + +
o Depth() +

+ + +

o Depth(const Depth& dp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Depth, DEPTH) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum Function +

+ + + +
o NEVER +

+ + +

o LESS +

+ + +

o EQUAL +

+ + +

o LEQUAL +

+ + +

o GREATER +

+ + +

o NOTEQUAL +

+ + +

o GEQUAL +

+ + +

o ALWAYS +

+ + + +
oinline void setFunction(Function func) +

+ + +

oinline Function getFunction() const +

+ + +

oinline void setWriteMask(bool mask) +

+ + +

oinline bool getWriteMask() const +

+ + +

oinline void setRange(double zNear, double zFar) +

+ + +

oinline double getZNear() const +

+ + +

oinline double getZFar() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~Depth() +

+ + +

oFunction _func +

+ + +

obool _depthWriteMask +

+ + +

odouble _zNear +

+ + +

odouble _zFar +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DisplaySettings.html b/doc/doc++/osg/DisplaySettings.html new file mode 100644 index 000000000..2446dc513 --- /dev/null +++ b/doc/doc++/osg/DisplaySettings.html @@ -0,0 +1,491 @@ + + + + + class SG_EXPORT osg::DisplaySettings + + + + +

class SG_EXPORT osg::DisplaySettings

DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]static DisplaySettings* instance() +
Maintain a DisplaySettings singleton for objects to querry at runtime +
+[more] DisplaySettings() +
+[more] DisplaySettings(ArgumentParser& arguments) +
+[more] DisplaySettings(const DisplaySettings& vs) +
+[more]DisplaySettings& operator = (const DisplaySettings& vs) +
+[more]void merge(const DisplaySettings& vs) +
+[more]void setDefaults() +
+[more]void readEnvironmentalVariables() +
+[more]void readCommandLine(ArgumentParser& arguments) +
read the commandline arguments +
+[more]void setStereo(bool on) +
+[more]bool getStereo() const +
+[more]void setStereoMode(StereoMode mode) +
+[more]StereoMode getStereoMode() const +
+[more]void setEyeSeparation(float eyeSeparation) +
+[more]float getEyeSeparation() const +
+[more]void setScreenDistance(float distance) +
+[more]float getScreenDistance() const +
+[more]void setSplitStereoHorizontalEyeMapping(SplitStereoHorizontalEyeMapping m) +
+[more]SplitStereoHorizontalEyeMapping getSplitStereoHorizontalEyeMapping() const +
+[more]void setSplitStereoHorizontalSeparation(int s) +
+[more]int getSplitStereoHorizontalSeparation() const +
+[more]void setSplitStereoVerticalEyeMapping(SplitStereoVerticalEyeMapping m) +
+[more]SplitStereoVerticalEyeMapping getSplitStereoVerticalEyeMapping() const +
+[more]void setSplitStereoVerticalSeparation(int s) +
+[more]int getSplitStereoVerticalSeparation() const +
+[more]void setScreenHeight(float height) +
+[more]float getScreenHeight() const +
+[more]void setDoubleBuffer(bool flag) +
+[more]bool getDoubleBuffer() const +
+[more]void setRGB(bool flag) +
+[more]bool getRGB() const +
+[more]void setDepthBuffer(bool flag) +
+[more]bool getDepthBuffer() const +
+[more]void setMinimumNumAlphaBits(unsigned int bits) +
+[more]unsigned int getMinimumNumAlphaBits() const +
+[more]bool getAlphaBuffer() const +
+[more]void setMinimumNumStencilBits(unsigned int bits) +
+[more]unsigned int getMinimumNumStencilBits() const +
+[more]bool getStencilBuffer() const +
+[more]void setMaxNumberOfGraphicsContexts(unsigned int num) +
+[more]unsigned int getMaxNumberOfGraphicsContexts() const +

+ +

+

Public Members

+[more]enum StereoMode +
+[more]enum SplitStereoHorizontalEyeMapping +
+[more]enum SplitStereoVerticalEyeMapping +

+ +

+

Protected Fields

+[more]bool _stereo +
+[more]StereoMode _stereoMode +
+[more]float _eyeSeparation +
+[more]float _screenDistance +
+[more]float _screenHeight +
+[more]SplitStereoHorizontalEyeMapping _splitStereoHorizontalEyeMapping +
+[more]int _splitStereoHorizontalSeparation +
+[more]SplitStereoVerticalEyeMapping _splitStereoVerticalEyeMapping +
+[more]int _splitStereoVerticalSeparation +
+[more]bool _doubleBuffer +
+[more]bool _RGB +
+[more]bool _depthBuffer +
+[more]unsigned int _minimumNumberAlphaBits +
+[more]unsigned int _minimumNumberStencilBits +
+[more]unsigned int _maxNumOfGraphicsContexts +

+ +

+

Protected Methods

+[more]virtual ~DisplaySettings() +
+[more]void copy(const DisplaySettings& vs) +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
DisplaySettings class for encapsulating what visuals are required and +have been set up, and the status of stereo viewing
+
+ + + +
ostatic DisplaySettings* instance() +
Maintain a DisplaySettings singleton for objects to querry at runtime +

+ + +

o DisplaySettings() +

+ + +

o DisplaySettings(ArgumentParser& arguments) +

+ + +

o DisplaySettings(const DisplaySettings& vs) +

+ + +

oDisplaySettings& operator = (const DisplaySettings& vs) +

+ + +

ovoid merge(const DisplaySettings& vs) +

+ + +

ovoid setDefaults() +

+ + +

ovoid readEnvironmentalVariables() +

+ + +

ovoid readCommandLine(ArgumentParser& arguments) +
read the commandline arguments +

+ + +

ovoid setStereo(bool on) +

+ + +

obool getStereo() const +

+ + +

oenum StereoMode +

+ + + +
o QUAD_BUFFER +

+ + +

o ANAGLYPHIC +

+ + +

o HORIZONTAL_SPLIT +

+ + +

o VERTICAL_SPLIT +

+ + +

o LEFT_EYE +

+ + +

o RIGHT_EYE +

+ + + +
ovoid setStereoMode(StereoMode mode) +

+ + +

oStereoMode getStereoMode() const +

+ + +

ovoid setEyeSeparation(float eyeSeparation) +

+ + +

ofloat getEyeSeparation() const +

+ + +

ovoid setScreenDistance(float distance) +

+ + +

ofloat getScreenDistance() const +

+ + +

oenum SplitStereoHorizontalEyeMapping +

+ + + +
o LEFT_EYE_LEFT_VIEWPORT +

+ + +

o LEFT_EYE_RIGHT_VIEWPORT +

+ + + +
ovoid setSplitStereoHorizontalEyeMapping(SplitStereoHorizontalEyeMapping m) +

+ + +

oSplitStereoHorizontalEyeMapping getSplitStereoHorizontalEyeMapping() const +

+ + +

ovoid setSplitStereoHorizontalSeparation(int s) +

+ + +

oint getSplitStereoHorizontalSeparation() const +

+ + +

oenum SplitStereoVerticalEyeMapping +

+ + + +
o LEFT_EYE_TOP_VIEWPORT +

+ + +

o LEFT_EYE_BOTTOM_VIEWPORT +

+ + + +
ovoid setSplitStereoVerticalEyeMapping(SplitStereoVerticalEyeMapping m) +

+ + +

oSplitStereoVerticalEyeMapping getSplitStereoVerticalEyeMapping() const +

+ + +

ovoid setSplitStereoVerticalSeparation(int s) +

+ + +

oint getSplitStereoVerticalSeparation() const +

+ + +

ovoid setScreenHeight(float height) +

+ + +

ofloat getScreenHeight() const +

+ + +

ovoid setDoubleBuffer(bool flag) +

+ + +

obool getDoubleBuffer() const +

+ + +

ovoid setRGB(bool flag) +

+ + +

obool getRGB() const +

+ + +

ovoid setDepthBuffer(bool flag) +

+ + +

obool getDepthBuffer() const +

+ + +

ovoid setMinimumNumAlphaBits(unsigned int bits) +

+ + +

ounsigned int getMinimumNumAlphaBits() const +

+ + +

obool getAlphaBuffer() const +

+ + +

ovoid setMinimumNumStencilBits(unsigned int bits) +

+ + +

ounsigned int getMinimumNumStencilBits() const +

+ + +

obool getStencilBuffer() const +

+ + +

ovoid setMaxNumberOfGraphicsContexts(unsigned int num) +

+ + +

ounsigned int getMaxNumberOfGraphicsContexts() const +

+ + +

ovirtual ~DisplaySettings() +

+ + +

ovoid copy(const DisplaySettings& vs) +

+ + +

obool _stereo +

+ + +

oStereoMode _stereoMode +

+ + +

ofloat _eyeSeparation +

+ + +

ofloat _screenDistance +

+ + +

ofloat _screenHeight +

+ + +

oSplitStereoHorizontalEyeMapping _splitStereoHorizontalEyeMapping +

+ + +

oint _splitStereoHorizontalSeparation +

+ + +

oSplitStereoVerticalEyeMapping _splitStereoVerticalEyeMapping +

+ + +

oint _splitStereoVerticalSeparation +

+ + +

obool _doubleBuffer +

+ + +

obool _RGB +

+ + +

obool _depthBuffer +

+ + +

ounsigned int _minimumNumberAlphaBits +

+ + +

ounsigned int _minimumNumberStencilBits +

+ + +

ounsigned int _maxNumOfGraphicsContexts +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawArrayLengths.html b/doc/doc++/osg/DrawArrayLengths.html new file mode 100644 index 000000000..be96f7f0b --- /dev/null +++ b/doc/doc++/osg/DrawArrayLengths.html @@ -0,0 +1,245 @@ + + + + + class SG_EXPORT osg::DrawArrayLengths + + + + +

class SG_EXPORT osg::DrawArrayLengths

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawArrayLengths(GLenum mode=0) +
+[more] DrawArrayLengths(const DrawArrayLengths& dal, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] DrawArrayLengths(GLenum mode, GLint first, unsigned int no, GLsizei* ptr) +
+[more] DrawArrayLengths(GLenum mode, GLint first, unsigned int no) +
+[more] DrawArrayLengths(GLenum mode, GLint first) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]void setFirst(GLint first) +
+[more]GLint getFirst() const +
+[more]virtual void draw() const +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const +
+[more]virtual unsigned int getNumIndices() const +
+[more]virtual unsigned int index(unsigned int pos) const +
+[more]virtual void offsetIndices(int offset) +
+[more]virtual unsigned int getNumPrimitives() const +

+ +

+

Protected Fields

+[more]GLint _first +

+ +

+

Protected Methods

+[more]virtual ~DrawArrayLengths() +

+ +
+

Inherited from PrimitiveSet:

+
+

+

Public Methods

+oType getType() const +
+ovoid setMode(GLenum mode) +
+oGLenum getMode() const +

+ +

+

Public Members

+oenum Type +
+oenum Mode +

+ +

+

Protected Fields

+oType _primitiveType +
+oGLenum _mode +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o DrawArrayLengths(GLenum mode=0) +

+ + +

o DrawArrayLengths(const DrawArrayLengths& dal, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o DrawArrayLengths(GLenum mode, GLint first, unsigned int no, GLsizei* ptr) +

+ + +

o DrawArrayLengths(GLenum mode, GLint first, unsigned int no) +

+ + +

o DrawArrayLengths(GLenum mode, GLint first) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovoid setFirst(GLint first) +

+ + +

oGLint getFirst() const +

+ + +

ovirtual void draw() const +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const +

+ + +

ovirtual unsigned int getNumIndices() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual void offsetIndices(int offset) +

+ + +

ovirtual unsigned int getNumPrimitives() const +

+ + +

ovirtual ~DrawArrayLengths() +

+ + +

oGLint _first +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawArrays.html b/doc/doc++/osg/DrawArrays.html new file mode 100644 index 000000000..a406d6a3d --- /dev/null +++ b/doc/doc++/osg/DrawArrays.html @@ -0,0 +1,253 @@ + + + + + class SG_EXPORT osg::DrawArrays + + + + +

class SG_EXPORT osg::DrawArrays

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawArrays(GLenum mode=0) +
+[more] DrawArrays(GLenum mode, GLint first, GLsizei count) +
+[more] DrawArrays(const DrawArrays& da, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]void set(GLenum mode, GLint first, GLsizei count) +
+[more]void setFirst(GLint first) +
+[more]GLint getFirst() const +
+[more]void setCount(GLsizei count) +
+[more]GLsizei getCount() const +
+[more]virtual void draw() const +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const +
+[more]virtual unsigned int getNumIndices() const +
+[more]virtual unsigned int index(unsigned int pos) const +
+[more]virtual void offsetIndices(int offset) +

+ +

+

Protected Fields

+[more]GLint _first +
+[more]GLsizei _count +

+ +

+

Protected Methods

+[more]virtual ~DrawArrays() +

+ +
+

Inherited from PrimitiveSet:

+
+

+

Public Methods

+oType getType() const +
+ovoid setMode(GLenum mode) +
+oGLenum getMode() const +
+ovirtual unsigned int getNumPrimitives() const +

+ +

+

Public Members

+oenum Type +
+oenum Mode +

+ +

+

Protected Fields

+oType _primitiveType +
+oGLenum _mode +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o DrawArrays(GLenum mode=0) +

+ + +

o DrawArrays(GLenum mode, GLint first, GLsizei count) +

+ + +

o DrawArrays(const DrawArrays& da, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovoid set(GLenum mode, GLint first, GLsizei count) +

+ + +

ovoid setFirst(GLint first) +

+ + +

oGLint getFirst() const +

+ + +

ovoid setCount(GLsizei count) +

+ + +

oGLsizei getCount() const +

+ + +

ovirtual void draw() const +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const +

+ + +

ovirtual unsigned int getNumIndices() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual void offsetIndices(int offset) +

+ + +

ovirtual ~DrawArrays() +

+ + +

oGLint _first +

+ + +

oGLsizei _count +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawElementsUByte.html b/doc/doc++/osg/DrawElementsUByte.html new file mode 100644 index 000000000..899877bf6 --- /dev/null +++ b/doc/doc++/osg/DrawElementsUByte.html @@ -0,0 +1,214 @@ + + + + + class SG_EXPORT osg::DrawElementsUByte + + + + +

class SG_EXPORT osg::DrawElementsUByte

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawElementsUByte(GLenum mode=0) +
+[more] DrawElementsUByte(const DrawElementsUByte& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] DrawElementsUByte(GLenum mode, unsigned int no, GLubyte* ptr) +
+[more] DrawElementsUByte(GLenum mode, unsigned int no) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void draw() const +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const +
+[more]virtual unsigned int getNumIndices() const +
+[more]virtual unsigned int index(unsigned int pos) const +
+[more]virtual void offsetIndices(int offset) +

+ +

+

Protected Methods

+[more]virtual ~DrawElementsUByte() +

+ +
+

Inherited from PrimitiveSet:

+
+

+

Public Methods

+oType getType() const +
+ovoid setMode(GLenum mode) +
+oGLenum getMode() const +
+ovirtual unsigned int getNumPrimitives() const +

+ +

+

Public Members

+oenum Type +
+oenum Mode +

+ +

+

Protected Fields

+oType _primitiveType +
+oGLenum _mode +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o DrawElementsUByte(GLenum mode=0) +

+ + +

o DrawElementsUByte(const DrawElementsUByte& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o DrawElementsUByte(GLenum mode, unsigned int no, GLubyte* ptr) +

+ + +

o DrawElementsUByte(GLenum mode, unsigned int no) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void draw() const +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const +

+ + +

ovirtual unsigned int getNumIndices() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual void offsetIndices(int offset) +

+ + +

ovirtual ~DrawElementsUByte() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawElementsUInt.html b/doc/doc++/osg/DrawElementsUInt.html new file mode 100644 index 000000000..84e484a31 --- /dev/null +++ b/doc/doc++/osg/DrawElementsUInt.html @@ -0,0 +1,214 @@ + + + + + class SG_EXPORT osg::DrawElementsUInt + + + + +

class SG_EXPORT osg::DrawElementsUInt

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawElementsUInt(GLenum mode=0) +
+[more] DrawElementsUInt(const DrawElementsUInt& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] DrawElementsUInt(GLenum mode, unsigned int no, GLuint* ptr) +
+[more] DrawElementsUInt(GLenum mode, unsigned int no) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void draw() const +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const +
+[more]virtual unsigned int getNumIndices() const +
+[more]virtual unsigned int index(unsigned int pos) const +
+[more]virtual void offsetIndices(int offset) +

+ +

+

Protected Methods

+[more]virtual ~DrawElementsUInt() +

+ +
+

Inherited from PrimitiveSet:

+
+

+

Public Methods

+oType getType() const +
+ovoid setMode(GLenum mode) +
+oGLenum getMode() const +
+ovirtual unsigned int getNumPrimitives() const +

+ +

+

Public Members

+oenum Type +
+oenum Mode +

+ +

+

Protected Fields

+oType _primitiveType +
+oGLenum _mode +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o DrawElementsUInt(GLenum mode=0) +

+ + +

o DrawElementsUInt(const DrawElementsUInt& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o DrawElementsUInt(GLenum mode, unsigned int no, GLuint* ptr) +

+ + +

o DrawElementsUInt(GLenum mode, unsigned int no) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void draw() const +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const +

+ + +

ovirtual unsigned int getNumIndices() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual void offsetIndices(int offset) +

+ + +

ovirtual ~DrawElementsUInt() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawElementsUShort.html b/doc/doc++/osg/DrawElementsUShort.html new file mode 100644 index 000000000..0805da521 --- /dev/null +++ b/doc/doc++/osg/DrawElementsUShort.html @@ -0,0 +1,220 @@ + + + + + class SG_EXPORT osg::DrawElementsUShort + + + + +

class SG_EXPORT osg::DrawElementsUShort

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawElementsUShort(GLenum mode=0) +
+[more] DrawElementsUShort(const DrawElementsUShort& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] DrawElementsUShort(GLenum mode, unsigned int no, GLushort* ptr) +
+[more] DrawElementsUShort(GLenum mode, unsigned int no) +
+[more]template<class InputIterator> DrawElementsUShort(GLenum mode, InputIterator first, InputIterator last) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void draw() const +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const +
+[more]virtual unsigned int getNumIndices() const +
+[more]virtual unsigned int index(unsigned int pos) const +
+[more]virtual void offsetIndices(int offset) +

+ +

+

Protected Methods

+[more]virtual ~DrawElementsUShort() +

+ +
+

Inherited from PrimitiveSet:

+
+

+

Public Methods

+oType getType() const +
+ovoid setMode(GLenum mode) +
+oGLenum getMode() const +
+ovirtual unsigned int getNumPrimitives() const +

+ +

+

Public Members

+oenum Type +
+oenum Mode +

+ +

+

Protected Fields

+oType _primitiveType +
+oGLenum _mode +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o DrawElementsUShort(GLenum mode=0) +

+ + +

o DrawElementsUShort(const DrawElementsUShort& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o DrawElementsUShort(GLenum mode, unsigned int no, GLushort* ptr) +

+ + +

o DrawElementsUShort(GLenum mode, unsigned int no) +

+ + +

otemplate<class InputIterator> DrawElementsUShort(GLenum mode, InputIterator first, InputIterator last) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void draw() const +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const +

+ + +

ovirtual unsigned int getNumIndices() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual void offsetIndices(int offset) +

+ + +

ovirtual ~DrawElementsUShort() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/DrawPixels.html b/doc/doc++/osg/DrawPixels.html new file mode 100644 index 000000000..ee35547dd --- /dev/null +++ b/doc/doc++/osg/DrawPixels.html @@ -0,0 +1,420 @@ + + + + + class SG_EXPORT osg::DrawPixels + + + + +

class SG_EXPORT osg::DrawPixels

DrawPixels is an osg::Drawable subclass which encapsulates the drawing of images using glDrawPixels
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DrawPixels() +
+[more] DrawPixels(const DrawPixels& drawimage, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]void setPosition(const osg::Vec3& position) +
+[more]osg::Vec3& getPosition() +
+[more]const osg::Vec3& getPosition() const +
+[more]void setImage(osg::Image* image) +
+[more]osg::Image* getImage() +
+[more]const osg::Image* getImage() const +
+[more]void setUseCompleteImage() +
+[more]void setSubImageDimensions(unsigned int offsetX, unsigned int offsetY, unsigned int width, unsigned int height) +
+[more]void getSubImageDimensions(unsigned int& offsetX, unsigned int& offsetY, unsigned int& width, unsigned int& height) const +
+[more]bool getUseSubImage() const +
+[more]virtual void drawImplementation(State& state) const +

+ +

+

Protected Fields

+[more]Vec3 _position +
+[more]ref_ptr<Image> _image +
+[more]bool _useSubImage +
+[more]unsigned int _offsetX +
+[more]unsigned int _offsetY +
+[more]unsigned int _width +
+[more]unsigned int _height +

+ +

+

Protected Methods

+[more]DrawPixels& operator = (const DrawPixels&) +
+[more]virtual ~DrawPixels() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Drawable:

+
+

+

Public Methods

+ovirtual Geometry* asGeometry() +
+ovirtual const Geometry* asGeometry() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Node* getParent(unsigned int i) +
+oinline const Node* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+oinline void setStateSet(StateSet* state) +
+oinline StateSet* getStateSet() +
+oinline const StateSet* getStateSet() const +
+oStateSet* getOrCreateStateSet() +
+ovoid dirtyBound() +
+oinline const BoundingBox& getBound() const +
+oinline void setShape(Shape* shape) +
+oinline Shape* getShape() +
+oinline const Shape* getShape() const +
+ovoid setSupportsDisplayList(bool flag) +
+oinline bool getSupportsDisplayList() const +
+ovoid setUseDisplayList(bool flag) +
+oinline bool getUseDisplayList() const +
+ovoid dirtyDisplayList() +
+ovirtual void compile(State& state) const +
+ovoid setUpdateCallback(UpdateCallback* ac) +
+oUpdateCallback* getUpdateCallback() +
+ovoid setAppCallback(AppCallback* ac) +
+oAppCallback* getAppCallback() +
+oconst AppCallback* getAppCallback() const +
+ovoid setCullCallback(CullCallback* cc) +
+oCullCallback* getCullCallback() +
+oconst CullCallback* getCullCallback() const +
+ovoid setDrawCallback(DrawCallback* dc) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
+ostatic void flushDeletedDisplayLists(unsigned int contextID) +
+ovirtual bool supports(AttributeFunctor&) const +
+ovirtual void accept(AttributeFunctor&) +
+ovirtual bool supports(ConstAttributeFunctor&) const +
+ovirtual void accept(ConstAttributeFunctor&) const +
+ovirtual bool supports(PrimitiveFunctor&) const +
+ovirtual void accept(PrimitiveFunctor&) const +
+oinline void draw(State& state) const +

+ +

+

Public Members

+otypedef std::vector<Node*> ParentList +
+ostruct UpdateCallback: public virtual osg::Referenced +
+ostruct AppCallback: public UpdateCallback +
+ostruct CullCallback: public virtual osg::Referenced +
+ostruct DrawCallback: public virtual osg::Referenced +
+oenum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+oParentList _parents +
+oref_ptr<StateSet> _stateset +
+omutable BoundingBox _bbox +
+omutable bool _bbox_computed +
+oref_ptr<Shape> _shape +
+obool _supportsDisplayList +
+obool _useDisplayList +
+omutable GLObjectList _globjList +
+oref_ptr<UpdateCallback> _updateCallback +
+oref_ptr<DrawCallback> _drawCallback +
+oref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+ovoid setBound(const BoundingBox& bb) const +
+ovoid addParent(osg::Node* node) +
+ovoid removeParent(osg::Node* node) +

+ +

+

Protected Members

+otypedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
DrawPixels is an osg::Drawable subclass which encapsulates the drawing of +images using glDrawPixels
+
+ + + +
o DrawPixels() +

+ + +

o DrawPixels(const DrawPixels& drawimage, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovoid setPosition(const osg::Vec3& position) +

+ + +

oosg::Vec3& getPosition() +

+ + +

oconst osg::Vec3& getPosition() const +

+ + +

ovoid setImage(osg::Image* image) +

+ + +

oosg::Image* getImage() +

+ + +

oconst osg::Image* getImage() const +

+ + +

ovoid setUseCompleteImage() +

+ + +

ovoid setSubImageDimensions(unsigned int offsetX, unsigned int offsetY, unsigned int width, unsigned int height) +

+ + +

ovoid getSubImageDimensions(unsigned int& offsetX, unsigned int& offsetY, unsigned int& width, unsigned int& height) const +

+ + +

obool getUseSubImage() const +

+ + +

ovirtual void drawImplementation(State& state) const +

+ + +

oDrawPixels& operator = (const DrawPixels&) +

+ + +

ovirtual ~DrawPixels() +

+ + +

ovirtual bool computeBound() const +

+ + +

oVec3 _position +

+ + +

oref_ptr<Image> _image +

+ + +

obool _useSubImage +

+ + +

ounsigned int _offsetX +

+ + +

ounsigned int _offsetY +

+ + +

ounsigned int _width +

+ + +

ounsigned int _height +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Drawable.html b/doc/doc++/osg/Drawable.html new file mode 100644 index 000000000..006509a11 --- /dev/null +++ b/doc/doc++/osg/Drawable.html @@ -0,0 +1,785 @@ + + + + + class SG_EXPORT osg::Drawable + + + + +

class SG_EXPORT osg::Drawable

Pure virtual base class for drawable Geometry.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Drawable() +
+[more] Drawable(const Drawable& drawable, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual Geometry* asGeometry() +
convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. +
+[more]virtual const Geometry* asGeometry() const +
convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. +
+[more]inline const ParentList& getParents() const +
Get the parent list of drawable. +
+[more]inline ParentList getParents() +
Get the a copy of parent list of node. +
+[more]inline Node* getParent(unsigned int i) +
Get a single parent of Drawable. +
+[more]inline const Node* getParent(unsigned int i) const +
Get a single const parent of Drawable. +
+[more]inline unsigned int getNumParents() const +
Get the number of parents of node. +
+[more]inline void setStateSet(StateSet* state) +
Set the StateSet attached to the Drawable. +
+[more]inline StateSet* getStateSet() +
Get the attached StateSet +
+[more]inline const StateSet* getStateSet() const +
Get the attached const StateSet +
+[more]StateSet* getOrCreateStateSet() +
Get the attached const StateSet, if one is not already attach create one, attach it to the drawable and return a pointer to it +
+[more]void dirtyBound() +
Dirty the bounding box, forcing a computeBound() on the next call to getBound(). +
+[more]inline const BoundingBox& getBound() const +
get bounding box of geoset. +
+[more]inline void setShape(Shape* shape) +
Set the Shape of the drawable. +
+[more]inline Shape* getShape() +
Get the Shape of the Drawable +
+[more]inline const Shape* getShape() const +
Get the const Shape of the const Drawable +
+[more]void setSupportsDisplayList(bool flag) +
Set the drawable to it can or cannot be used in conjunction with OpenGL display lists. +
+[more]inline bool getSupportsDisplayList() const +
Get whether display lists are supported for this drawable instance +
+[more]void setUseDisplayList(bool flag) +
When set to true, force the draw method to use OpenGL Display List for rendering. +
+[more]inline bool getUseDisplayList() const +
Return whether OpenGL display lists are being used for rendering +
+[more]void dirtyDisplayList() +
Force a recompile on next draw() of any OpenGL display list associated with this geoset +
+[more]virtual void compile(State& state) const +
Immediately compile this drawable into an OpenGL Display List. +
+[more]void setUpdateCallback(UpdateCallback* ac) +
Set the UpdateCallback which allows users to attach customize the undating of an object during the app traversal +
+[more]UpdateCallback* getUpdateCallback() +
Get the non const UpdateCallback +
+[more]void setAppCallback(AppCallback* ac) +
deprecated +
+[more]AppCallback* getAppCallback() +
deprecated +
+[more]const AppCallback* getAppCallback() const +
deprecated +
+[more]void setCullCallback(CullCallback* cc) +
Set the CullCallback which allows users to attach customize the culling of Drawable during the cull traversal +
+[more]CullCallback* getCullCallback() +
Get the non const CullCallback +
+[more]const CullCallback* getCullCallback() const +
Get the const CullCallback +
+[more]void setDrawCallback(DrawCallback* dc) +
Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object +
+[more]DrawCallback* getDrawCallback() +
Get the non const DrawCallback +
+[more]const DrawCallback* getDrawCallback() const +
Get the const DrawCallback +
+[more]virtual void drawImplementation(State& state) const = 0 +
draw directly ignoring an OpenGL display list which could be attached. +
+[more]static void deleteDisplayList(unsigned int contextID, GLuint globj) +
use deleteDisplayList instead of glDeleteList to allow OpenGL display list to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID +
+[more]static void flushDeletedDisplayLists(unsigned int contextID) +
flush all the cached display list which need to be deleted in the OpenGL context related to contextID +
+[more]virtual bool supports(AttributeFunctor&) const +
return true if the Drawable subclass supports accept(AttributeFunctor&) +
+[more]virtual void accept(AttributeFunctor&) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has. +
+[more]virtual bool supports(ConstAttributeFunctor&) const +
return true if the Drawable subclass supports accept(ConstAttributeFunctor&) +
+[more]virtual void accept(ConstAttributeFunctor&) const +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has. +
+[more]virtual bool supports(PrimitiveFunctor&) const +
return true if the Drawable subclass supports accept(PrimitiveFunctor&) +
+[more]virtual void accept(PrimitiveFunctor&) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has. +
+[more]inline void draw(State& state) const +
draw OpenGL primitives. +

+ +

+

Public Members

+[more]typedef std::vector<Node*> ParentList +
A vector of osg::Node pointers which is used to store the parent(s) of drawable +
+[more]struct UpdateCallback: public virtual osg::Referenced +
+[more]struct AppCallback: public UpdateCallback +
+[more]struct CullCallback: public virtual osg::Referenced +
+[more]struct DrawCallback: public virtual osg::Referenced +
Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. +
+[more]enum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+[more]ParentList _parents +
+[more]ref_ptr<StateSet> _stateset +
+[more]mutable BoundingBox _bbox +
+[more]mutable bool _bbox_computed +
+[more]ref_ptr<Shape> _shape +
+[more]bool _supportsDisplayList +
+[more]bool _useDisplayList +
+[more]mutable GLObjectList _globjList +
+[more]ref_ptr<UpdateCallback> _updateCallback +
+[more]ref_ptr<DrawCallback> _drawCallback +
+[more]ref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+[more]Drawable& operator = (const Drawable&) +
+[more]virtual ~Drawable() +
+[more]virtual bool computeBound() const +
compute the bounding box of the drawable. +
+[more]void setBound(const BoundingBox& bb) const +
set the bounding box +
+[more]void addParent(osg::Node* node) +
+[more]void removeParent(osg::Node* node) +

+ +

+

Protected Members

+[more]typedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Pure virtual base class for drawable Geometry. Contains no drawing primitives +directly, these are provided by subclasses such as osg::Geometry. State attributes +for a Drawable are maintained in StateSet which the Drawable maintains +a referenced counted pointer to. Both Drawable's and StateSet's can +be shared for optimal memory usage and graphics performance.
+
+ + + +
o Drawable() +

+ + +

o Drawable(const Drawable& drawable, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual Geometry* asGeometry() +
convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

ovirtual const Geometry* asGeometry() const +
convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

otypedef std::vector<Node*> ParentList +
A vector of osg::Node pointers which is used to store the parent(s) of drawable +

+ + +

oinline const ParentList& getParents() const +
Get the parent list of drawable. +

+ + +

oinline ParentList getParents() +
Get the a copy of parent list of node. A copy is returned to +prevent modification of the parent list. +

+ + +

oinline Node* getParent(unsigned int i) +
Get a single parent of Drawable. + +
Parameters:
i - index of the parent to get. +
Returns:
the parent i.

+ + +

oinline const Node* getParent(unsigned int i) const +
Get a single const parent of Drawable. + +
Parameters:
i - index of the parent to get. +
Returns:
the parent i.

+ + +

oinline unsigned int getNumParents() const +
+Get the number of parents of node. + +
Returns:
the number of parents of this node.

+ + +

oinline void setStateSet(StateSet* state) +
Set the StateSet attached to the Drawable. +Previously attached StateSet are automatically unreferenced on +assignment of a new drawstate. +

+ + +

oinline StateSet* getStateSet() +
Get the attached StateSet +

+ + +

oinline const StateSet* getStateSet() const +
Get the attached const StateSet +

+ + +

oStateSet* getOrCreateStateSet() +
Get the attached const StateSet, +if one is not already attach create one, +attach it to the drawable and return a pointer to it +

+ + +

ovoid dirtyBound() +
Dirty the bounding box, forcing a computeBound() on the next call +to getBound(). Should be called in the internal geometry of the Drawable +is modified. +

+ + +

oinline const BoundingBox& getBound() const +
get bounding box of geoset. +Note, now made virtual to make it possible to implement user-drawn +objects albeit so what crudely, to be improved later. +

+ + +

oinline void setShape(Shape* shape) +
Set the Shape of the drawable. The shape can be used to +speed up collision detection or as a guide for produral +geometry generation - see osg::ProduralGeometry. +

+ + +

oinline Shape* getShape() +
Get the Shape of the Drawable +

+ + +

oinline const Shape* getShape() const +
Get the const Shape of the const Drawable +

+ + +

ovoid setSupportsDisplayList(bool flag) +
Set the drawable to it can or cannot be used in conjunction with OpenGL +display lists. With set to true, calls to Drawable::setUseDisplayList, +whereas when set to false, no display lists can be created and calls +to setUseDisplayList are ignored, and a warning is produced. The later +is typically used to guard against the switching on of display lists +on objects with dynamic internal data such as continuous Level of Detail +algorithms. +

+ + +

oinline bool getSupportsDisplayList() const +
Get whether display lists are supported for this drawable instance +

+ + +

ovoid setUseDisplayList(bool flag) +
When set to true, force the draw method to use OpenGL Display List for rendering. +If false rendering directly. If the display list has not been already +compile the next call to draw will automatically create the display list. +

+ + +

oinline bool getUseDisplayList() const +
Return whether OpenGL display lists are being used for rendering +

+ + +

ovoid dirtyDisplayList() +
Force a recompile on next draw() of any OpenGL display list associated with this geoset +

+ + +

ovirtual void compile(State& state) const +
Immediately compile this drawable into an OpenGL Display List. +Note I, operation is ignored if _useDisplayList to false. +Note II, compile is not intended to be overridden in subclasses. +

+ + +

ostruct UpdateCallback: public virtual osg::Referenced +

+ + + +
ovirtual void update(osg::NodeVisitor* visitor, osg::Drawable* drawable) = 0 +
do customized app code +

+ + + +
ovoid setUpdateCallback(UpdateCallback* ac) +
Set the UpdateCallback which allows users to attach customize the undating of an object during the app traversal +

+ + +

oUpdateCallback* getUpdateCallback() +
Get the non const UpdateCallback +

+ + +

ostruct AppCallback: public UpdateCallback +

+ + + +
ovirtual void app(osg::NodeVisitor* visitor, osg::Drawable* drawable) = 0 +
do customized app code +

+ + +

ovirtual void update(osg::NodeVisitor* visitor, osg::Drawable* drawable) +

+ + + +
ovoid setAppCallback(AppCallback* ac) +
deprecated +

+ + +

oAppCallback* getAppCallback() +
deprecated +

+ + +

oconst AppCallback* getAppCallback() const +
deprecated +

+ + +

ostruct CullCallback: public virtual osg::Referenced +

+ + + +
ovirtual bool cull(osg::NodeVisitor* visitor, osg::Drawable* drawable, osg::State* state=NULL) const = 0 +
do customized cull code +

+ + + +
ovoid setCullCallback(CullCallback* cc) +
Set the CullCallback which allows users to attach customize the culling of Drawable during the cull traversal +

+ + +

oCullCallback* getCullCallback() +
Get the non const CullCallback +

+ + +

oconst CullCallback* getCullCallback() const +
Get the const CullCallback +

+ + +

ostruct DrawCallback: public virtual osg::Referenced +
Callback attached to an Drawable which allows the users to customize the drawing of an exist Drawable object. +The draw callback is implement as a replacement to the Drawable's own drawImplementation() method, if the +the user intends to decorate the exist draw code then simple call the drawable->drawImplementation() from +with the callbacks drawImplementation() method. This allows the users to do both pre and post callbacks +without fuss and can even diable the inner draw in required. +

+ + + +
ovirtual void drawImplementation(State& state, const osg::Drawable* drawable) const = 0 +
do customized draw code +

+ + + +
ovoid setDrawCallback(DrawCallback* dc) +
Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object +

+ + +

oDrawCallback* getDrawCallback() +
Get the non const DrawCallback +

+ + +

oconst DrawCallback* getDrawCallback() const +
Get the const DrawCallback +

+ + +

ovirtual void drawImplementation(State& state) const = 0 +
draw directly ignoring an OpenGL display list which could be attached. +This is the internal draw method which does the drawing itself, +and is the method to override when deriving from Drawable. +

+ + +

ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
use deleteDisplayList instead of glDeleteList to allow +OpenGL display list to cached until they can be deleted +by the OpenGL context in which they were created, specified +by contextID +

+ + +

ostatic void flushDeletedDisplayLists(unsigned int contextID) +
flush all the cached display list which need to be deleted +in the OpenGL context related to contextID +

+ + +

oenum AttributeType +

+ + + +
o VERTICES +

+ + +

o NORMALS +

+ + +

o COLORS +

+ + +

o TEXTURE_COORDS +

+ + +

o TEXTURE_COORDS_0 +

+ + +

o TEXTURE_COORDS_1 +

+ + +

o TEXTURE_COORDS_2 +

+ + +

o TEXTURE_COORDS_3 +

+ + +

o TEXTURE_COORDS_4 +

+ + +

o TEXTURE_COORDS_5 +

+ + +

o TEXTURE_COORDS_6 +

+ + +

o TEXTURE_COORDS_7 +

+ + + +
ovirtual bool supports(AttributeFunctor&) const +
return true if the Drawable subclass supports accept(AttributeFunctor&) +

+ + +

ovirtual void accept(AttributeFunctor&) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has. +return true if functor handled by drawable, return false on failure of drawable to generate functor calls. +

+ + +

ovirtual bool supports(ConstAttributeFunctor&) const +
return true if the Drawable subclass supports accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(ConstAttributeFunctor&) const +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has. +return true if functor handled by drawable, return false on failure of drawable to generate functor calls. +

+ + +

ovirtual bool supports(PrimitiveFunctor&) const +
return true if the Drawable subclass supports accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(PrimitiveFunctor&) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has. +return true if functor handled by drawable, return false on failure of drawable to generate functor calls. +Note, PrimtiveFunctor only provide const access of the primtives, as primitives may be procedurally generated +so one cannot modify it. +

+ + +

oDrawable& operator = (const Drawable&) +

+ + +

ovirtual ~Drawable() +

+ + +

ovirtual bool computeBound() const +
compute the bounding box of the drawable. Method must be +implemented by subclasses. +

+ + +

ovoid setBound(const BoundingBox& bb) const +
set the bounding box +

+ + +

ovoid addParent(osg::Node* node) +

+ + +

ovoid removeParent(osg::Node* node) +

+ + +

oParentList _parents +

+ + +

oref_ptr<StateSet> _stateset +

+ + +

omutable BoundingBox _bbox +

+ + +

omutable bool _bbox_computed +

+ + +

oref_ptr<Shape> _shape +

+ + +

obool _supportsDisplayList +

+ + +

obool _useDisplayList +

+ + +

otypedef osg::buffered_value<GLuint> GLObjectList +

+ + +

omutable GLObjectList _globjList +

+ + +

oref_ptr<UpdateCallback> _updateCallback +

+ + +

oref_ptr<DrawCallback> _drawCallback +

+ + +

oref_ptr<CullCallback> _cullCallback +

+ + +

oinline void draw(State& state) const +
draw OpenGL primitives. +If the drawable has _useDisplayList set to true then use an OpenGL display +list, automatically compiling one if required. +Otherwise call drawImplementation(). +Note, draw method should *not* be overridden in subclasses as it +manages the optional display list. +

+
+
Direct child classes: +
ShapeDrawable
+ImpostorSprite
+Geometry
+GeoSet
+DrawPixels
+
+ +
Friends:
class Node
class Geode

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Endian.html b/doc/doc++/osg/Endian.html new file mode 100644 index 000000000..6ddfaf385 --- /dev/null +++ b/doc/doc++/osg/Endian.html @@ -0,0 +1,37 @@ + + + + + enum osg::Endian + + + + +

enum osg::Endian

+
+

+
+[more] BigEndian +
+[more] LittleEndian +

+ + + +
+

Documentation

+
+ + + +
o BigEndian +

+ + +

o LittleEndian +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Extensions.2.html b/doc/doc++/osg/Extensions.2.html new file mode 100644 index 000000000..8e34789f5 --- /dev/null +++ b/doc/doc++/osg/Extensions.2.html @@ -0,0 +1,231 @@ + + + + + class SG_EXPORT osg::Texture3D::Extensions + + + + +

class SG_EXPORT Extensions

Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Extensions() +
+[more] Extensions(const Extensions& rhs) +
+[more]void lowestCommonDenominator(const Extensions& rhs) +
+[more]void setupGLExtenions() +
+[more]void setTexture3DSupported(bool flag) +
+[more]bool isTexture3DSupported() const +
+[more]void setTexture3DFast(bool flag) +
+[more]bool isTexture3DFast() const +
+[more]void setMaxTexture3DSize(GLint maxsize) +
+[more]GLint maxTexture3DSize() const +
+[more]void setTexImage3DProc(void* ptr) +
+[more]void glTexImage3D( GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum format, GLenum type, const GLvoid* pixels) const +
+[more]void setTexSubImage3DProc(void* ptr) +
+[more]void glTexSubImage3D( GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const GLvoid* pixels) const +
+[more]void setCopyTexSubImage3DProc(void* ptr) +
+[more]void glCopyTexSubImage3D( GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLint x, GLint y, GLsizei width, GLsizei height ) const +
+[more]void setBuild3DMipmapsProc(void* ptr) +
+[more]void gluBuild3DMipmaps( GLenum target, GLint internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const GLvoid* data) const +

+ +

+

Protected Fields

+[more]bool _isTexture3DSupported +
+[more]bool _isTexture3DFast +
+[more]GLint _maxTexture3DSize +
+[more]void* _glTexImage3D +
+[more]void* _glTexSubImage3D +
+[more]void* _glCopyTexSubImage3D +
+[more]void* _gluBuild3DMipmaps +

+ +

+

Protected Methods

+[more] ~Extensions() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Extensions class which encapsulates the querring of extensions and +associated function pointers, and provide convinience wrappers to +check for the extensions or use the associated functions
+
+ + + +
o Extensions() +

+ + +

o Extensions(const Extensions& rhs) +

+ + +

ovoid lowestCommonDenominator(const Extensions& rhs) +

+ + +

ovoid setupGLExtenions() +

+ + +

ovoid setTexture3DSupported(bool flag) +

+ + +

obool isTexture3DSupported() const +

+ + +

ovoid setTexture3DFast(bool flag) +

+ + +

obool isTexture3DFast() const +

+ + +

ovoid setMaxTexture3DSize(GLint maxsize) +

+ + +

oGLint maxTexture3DSize() const +

+ + +

ovoid setTexImage3DProc(void* ptr) +

+ + +

ovoid glTexImage3D( GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum format, GLenum type, const GLvoid* pixels) const +

+ + +

ovoid setTexSubImage3DProc(void* ptr) +

+ + +

ovoid glTexSubImage3D( GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const GLvoid* pixels) const +

+ + +

ovoid setCopyTexSubImage3DProc(void* ptr) +

+ + +

ovoid glCopyTexSubImage3D( GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLint x, GLint y, GLsizei width, GLsizei height ) const +

+ + +

ovoid setBuild3DMipmapsProc(void* ptr) +

+ + +

ovoid gluBuild3DMipmaps( GLenum target, GLint internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const GLvoid* data) const +

+ + +

o ~Extensions() +

+ + +

obool _isTexture3DSupported +

+ + +

obool _isTexture3DFast +

+ + +

oGLint _maxTexture3DSize +

+ + +

ovoid* _glTexImage3D +

+ + +

ovoid* _glTexSubImage3D +

+ + +

ovoid* _glCopyTexSubImage3D +

+ + +

ovoid* _gluBuild3DMipmaps +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Extensions.3.html b/doc/doc++/osg/Extensions.3.html new file mode 100644 index 000000000..9ee7d52fe --- /dev/null +++ b/doc/doc++/osg/Extensions.3.html @@ -0,0 +1,123 @@ + + + + + class SG_EXPORT osg::TextureCubeMap::Extensions + + + + +

class SG_EXPORT Extensions

Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Extensions() +
+[more] Extensions(const Extensions& rhs) +
+[more]void lowestCommonDenominator(const Extensions& rhs) +
+[more]void setupGLExtenions() +
+[more]void setCubeMapSupported(bool flag) +
+[more]bool isCubeMapSupported() const +

+ +

+

Protected Fields

+[more]bool _isCubeMapSupported +

+ +

+

Protected Methods

+[more] ~Extensions() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Extensions class which encapsulates the querring of extensions and +associated function pointers, and provide convinience wrappers to +check for the extensions or use the associated functions
+
+ + + +
o Extensions() +

+ + +

o Extensions(const Extensions& rhs) +

+ + +

ovoid lowestCommonDenominator(const Extensions& rhs) +

+ + +

ovoid setupGLExtenions() +

+ + +

ovoid setCubeMapSupported(bool flag) +

+ + +

obool isCubeMapSupported() const +

+ + +

o ~Extensions() +

+ + +

obool _isCubeMapSupported +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Extensions.4.html b/doc/doc++/osg/Extensions.4.html new file mode 100644 index 000000000..b0d65b8e5 --- /dev/null +++ b/doc/doc++/osg/Extensions.4.html @@ -0,0 +1,183 @@ + + + + + class SG_EXPORT osg::VertexProgram::Extensions + + + + +

class SG_EXPORT Extensions

Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Extensions() +
+[more] Extensions(const Extensions& rhs) +
+[more]void lowestCommonDenominator(const Extensions& rhs) +
+[more]void setupGLExtenions() +
+[more]void setVertexProgramSupported(bool flag) +
+[more]bool isVertexProgramSupported() const +
+[more]void glBindProgram(GLenum target, GLuint id) const +
+[more]void glGenPrograms(GLsizei n, GLuint* programs) const +
+[more]void glDeletePrograms(GLsizei n, GLuint* programs) const +
+[more]void glProgramString(GLenum target, GLenum format, GLsizei len, const void* string) const +
+[more]void glProgramLocalParameter4fv(GLenum target, GLuint index, const GLfloat* params) const +

+ +

+

Protected Fields

+[more]bool _isVertexProgramSupported +
+[more]void* _glBindProgram +
+[more]void* _glGenPrograms +
+[more]void* _glDeletePrograms +
+[more]void* _glProgramString +
+[more]void* _glProgramLocalParameter4fv +

+ +

+

Protected Methods

+[more] ~Extensions() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Extensions class which encapsulates the querring of extensions and +associated function pointers, and provide convinience wrappers to +check for the extensions or use the associated functions
+
+ + + +
o Extensions() +

+ + +

o Extensions(const Extensions& rhs) +

+ + +

ovoid lowestCommonDenominator(const Extensions& rhs) +

+ + +

ovoid setupGLExtenions() +

+ + +

ovoid setVertexProgramSupported(bool flag) +

+ + +

obool isVertexProgramSupported() const +

+ + +

ovoid glBindProgram(GLenum target, GLuint id) const +

+ + +

ovoid glGenPrograms(GLsizei n, GLuint* programs) const +

+ + +

ovoid glDeletePrograms(GLsizei n, GLuint* programs) const +

+ + +

ovoid glProgramString(GLenum target, GLenum format, GLsizei len, const void* string) const +

+ + +

ovoid glProgramLocalParameter4fv(GLenum target, GLuint index, const GLfloat* params) const +

+ + +

o ~Extensions() +

+ + +

obool _isVertexProgramSupported +

+ + +

ovoid* _glBindProgram +

+ + +

ovoid* _glGenPrograms +

+ + +

ovoid* _glDeletePrograms +

+ + +

ovoid* _glProgramString +

+ + +

ovoid* _glProgramLocalParameter4fv +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Extensions.html b/doc/doc++/osg/Extensions.html new file mode 100644 index 000000000..48d0eefc6 --- /dev/null +++ b/doc/doc++/osg/Extensions.html @@ -0,0 +1,327 @@ + + + + + class SG_EXPORT osg::Texture::Extensions + + + + +

class SG_EXPORT Extensions

Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Extensions() +
+[more] Extensions(const Extensions& rhs) +
+[more]void lowestCommonDenominator(const Extensions& rhs) +
+[more]void setupGLExtenions() +
+[more]void setMultiTexturingSupported(bool flag) +
+[more]bool isMultiTexturingSupported() const +
+[more]void setTextureFilterAnisotropicSupported(bool flag) +
+[more]bool isTextureFilterAnisotropicSupported() const +
+[more]void setTextureCompressionARBSupported(bool flag) +
+[more]bool isTextureCompressionARBSupported() const +
+[more]void setTextureCompressionS3TCSupported(bool flag) +
+[more]bool isTextureCompressionS3TCSupported() const +
+[more]void setTextureMirroredRepeatSupported(bool flag) +
+[more]bool isTextureMirroredRepeatSupported() const +
+[more]void setTextureEdgeClampSupported(bool flag) +
+[more]bool isTextureEdgeClampSupported() const +
+[more]void setTextureBorderClampSupported(bool flag) +
+[more]bool isTextureBorderClampSupported() const +
+[more]void setGenerateMipMapSupported(bool flag) +
+[more]bool isGenerateMipMapSupported() const +
+[more]void setMaxTextureSize(GLint maxsize) +
+[more]GLint maxTextureSize() const +
+[more]bool isCompressedTexImage2DSupported() const +
+[more]void setCompressedTexImage2DProc(void* ptr) +
+[more]void glCompressedTexImage2D(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border, GLsizei imageSize, const GLvoid* data) const +
+[more]void setCompressedTexSubImage2DProc(void* ptr) +
+[more]void glCompressedTexSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLsizei type, const GLvoid* data) const +
+[more]void setGetCompressedTexImageProc(void* ptr) +
+[more]void glGetCompressedTexImage(GLenum target, GLint level, GLvoid* data) const +

+ +

+

Protected Fields

+[more]bool _isMultiTexturingSupported +
+[more]bool _isTextureFilterAnisotropicSupported +
+[more]bool _isTextureCompressionARBSupported +
+[more]bool _isTextureCompressionS3TCSupported +
+[more]bool _isTextureMirroredRepeatSupported +
+[more]bool _isTextureEdgeClampSupported +
+[more]bool _isTextureBorderClampSupported +
+[more]bool _isGenerateMipMapSupported +
+[more]GLint _maxTextureSize +
+[more]void* _glCompressedTexImage2D +
+[more]void* _glCompressedTexSubImage2D +
+[more]void* _glGetCompressedTexImage +

+ +

+

Protected Methods

+[more] ~Extensions() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Extensions class which encapsulates the querring of extensions and +associated function pointers, and provide convinience wrappers to +check for the extensions or use the associated functions
+
+ + + +
o Extensions() +

+ + +

o Extensions(const Extensions& rhs) +

+ + +

ovoid lowestCommonDenominator(const Extensions& rhs) +

+ + +

ovoid setupGLExtenions() +

+ + +

ovoid setMultiTexturingSupported(bool flag) +

+ + +

obool isMultiTexturingSupported() const +

+ + +

ovoid setTextureFilterAnisotropicSupported(bool flag) +

+ + +

obool isTextureFilterAnisotropicSupported() const +

+ + +

ovoid setTextureCompressionARBSupported(bool flag) +

+ + +

obool isTextureCompressionARBSupported() const +

+ + +

ovoid setTextureCompressionS3TCSupported(bool flag) +

+ + +

obool isTextureCompressionS3TCSupported() const +

+ + +

ovoid setTextureMirroredRepeatSupported(bool flag) +

+ + +

obool isTextureMirroredRepeatSupported() const +

+ + +

ovoid setTextureEdgeClampSupported(bool flag) +

+ + +

obool isTextureEdgeClampSupported() const +

+ + +

ovoid setTextureBorderClampSupported(bool flag) +

+ + +

obool isTextureBorderClampSupported() const +

+ + +

ovoid setGenerateMipMapSupported(bool flag) +

+ + +

obool isGenerateMipMapSupported() const +

+ + +

ovoid setMaxTextureSize(GLint maxsize) +

+ + +

oGLint maxTextureSize() const +

+ + +

obool isCompressedTexImage2DSupported() const +

+ + +

ovoid setCompressedTexImage2DProc(void* ptr) +

+ + +

ovoid glCompressedTexImage2D(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border, GLsizei imageSize, const GLvoid* data) const +

+ + +

ovoid setCompressedTexSubImage2DProc(void* ptr) +

+ + +

ovoid glCompressedTexSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLsizei type, const GLvoid* data) const +

+ + +

ovoid setGetCompressedTexImageProc(void* ptr) +

+ + +

ovoid glGetCompressedTexImage(GLenum target, GLint level, GLvoid* data) const +

+ + +

o ~Extensions() +

+ + +

obool _isMultiTexturingSupported +

+ + +

obool _isTextureFilterAnisotropicSupported +

+ + +

obool _isTextureCompressionARBSupported +

+ + +

obool _isTextureCompressionS3TCSupported +

+ + +

obool _isTextureMirroredRepeatSupported +

+ + +

obool _isTextureEdgeClampSupported +

+ + +

obool _isTextureBorderClampSupported +

+ + +

obool _isGenerateMipMapSupported +

+ + +

oGLint _maxTextureSize +

+ + +

ovoid* _glCompressedTexImage2D +

+ + +

ovoid* _glCompressedTexSubImage2D +

+ + +

ovoid* _glGetCompressedTexImage +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Fog.html b/doc/doc++/osg/Fog.html new file mode 100644 index 000000000..0c87b7000 --- /dev/null +++ b/doc/doc++/osg/Fog.html @@ -0,0 +1,337 @@ + + + + + class SG_EXPORT osg::Fog + + + + +

class SG_EXPORT osg::Fog

Fog - encapsulates OpenGL fog state.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Fog() +
+[more] Fog(const Fog& fog, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Fog, FOG) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setMode( Mode mode ) +
+[more]inline Mode getMode() const +
+[more]inline void setDensity( float density ) +
+[more]inline float getDensity() const +
+[more]inline void setStart( float start ) +
+[more]inline float getStart() const +
+[more]inline void setEnd( float end ) +
+[more]inline float getEnd() const +
+[more]inline void setColor( const Vec4 &color ) +
+[more]inline const Vec4& getColor() const +
+[more]inline void setFogCoordinateSource(GLint source) +
+[more]inline GLint getFogCoordinateSource() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Mode +
+[more]enum FogCoordinateSource +

+ +

+

Protected Fields

+[more]Mode _mode +
+[more]float _density +
+[more]float _start +
+[more]float _end +
+[more]Vec4 _color +
+[more]GLint _fogCoordinateSource +

+ +

+

Protected Methods

+[more]virtual ~Fog() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Fog - encapsulates OpenGL fog state.
+
+ + + +
o Fog() +

+ + +

o Fog(const Fog& fog, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Fog, FOG) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum Mode +

+ + + +
o LINEAR +

+ + +

o EXP +

+ + +

o EXP2 +

+ + + +
oinline void setMode( Mode mode ) +

+ + +

oinline Mode getMode() const +

+ + +

oinline void setDensity( float density ) +

+ + +

oinline float getDensity() const +

+ + +

oinline void setStart( float start ) +

+ + +

oinline float getStart() const +

+ + +

oinline void setEnd( float end ) +

+ + +

oinline float getEnd() const +

+ + +

oinline void setColor( const Vec4 &color ) +

+ + +

oinline const Vec4& getColor() const +

+ + +

oenum FogCoordinateSource +

+ + + +
o FOG_COORDINATE +

+ + +

o FRAGMENT_DEPTH +

+ + + +
oinline void setFogCoordinateSource(GLint source) +

+ + +

oinline GLint getFogCoordinateSource() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~Fog() +

+ + +

oMode _mode +

+ + +

ofloat _density +

+ + +

ofloat _start +

+ + +

ofloat _end +

+ + +

oVec4 _color +

+ + +

oGLint _fogCoordinateSource +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/FrameStamp.html b/doc/doc++/osg/FrameStamp.html new file mode 100644 index 000000000..a68ad5f11 --- /dev/null +++ b/doc/doc++/osg/FrameStamp.html @@ -0,0 +1,198 @@ + + + + + class SG_EXPORT osg::FrameStamp + + + + +

class SG_EXPORT osg::FrameStamp

Class which encapsulates the frame number, reference time and calander time of specific frame, used to synchonize operations on the scene graph and other machines when using a graphics cluster.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FrameStamp() +
+[more] FrameStamp(const FrameStamp& fs) +
+[more]FrameStamp& operator = (const FrameStamp& fs) +
+[more]void setFrameNumber(int fnum) +
+[more]int getFrameNumber() const +
+[more]void setReferenceTime(double refTime) +
+[more]double getReferenceTime() const +
+[more]void setCalendarTime(const tm& calendarTime) +
+[more]void getCalendarTime(tm& calendarTime) const +
+[more]virtual ~FrameStamp() +

+ +

+

Protected Fields

+[more]int _frameNumber +
+[more]double _referenceTime +
+[more]int tm_sec +
+[more]int tm_min +
+[more]int tm_hour +
+[more]int tm_mday +
+[more]int tm_mon +
+[more]int tm_year +
+[more]int tm_wday +
+[more]int tm_yday +
+[more]int tm_isdst +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Class which encapsulates the frame number, reference time and calander +time of specific frame, used to synchonize operations on the scene graph +and other machines when using a graphics cluster. Note the calander +time can be an artificial simulation time or capture the real time +of day etc.
+
+ + + +
o FrameStamp() +

+ + +

o FrameStamp(const FrameStamp& fs) +

+ + +

oFrameStamp& operator = (const FrameStamp& fs) +

+ + +

ovoid setFrameNumber(int fnum) +

+ + +

oint getFrameNumber() const +

+ + +

ovoid setReferenceTime(double refTime) +

+ + +

odouble getReferenceTime() const +

+ + +

ovoid setCalendarTime(const tm& calendarTime) +

+ + +

ovoid getCalendarTime(tm& calendarTime) const +

+ + +

ovirtual ~FrameStamp() +

+ + +

oint _frameNumber +

+ + +

odouble _referenceTime +

+ + +

oint tm_sec +

+ + +

oint tm_min +

+ + +

oint tm_hour +

+ + +

oint tm_mday +

+ + +

oint tm_mon +

+ + +

oint tm_year +

+ + +

oint tm_wday +

+ + +

oint tm_yday +

+ + +

oint tm_isdst +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/FrontFace.html b/doc/doc++/osg/FrontFace.html new file mode 100644 index 000000000..281e8de75 --- /dev/null +++ b/doc/doc++/osg/FrontFace.html @@ -0,0 +1,223 @@ + + + + + class SG_EXPORT osg::FrontFace + + + + +

class SG_EXPORT osg::FrontFace

Class to specifies the orientation of front-facing polygons
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FrontFace() +
+[more] FrontFace(const FrontFace& ff, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, FrontFace, FRONTFACE) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setMode(Mode mode) +
+[more]inline const Mode getMode() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Mode +

+ +

+

Protected Fields

+[more]Mode _mode +

+ +

+

Protected Methods

+[more]virtual ~FrontFace() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Class to specifies the orientation of front-facing polygons
+
+ + + +
o FrontFace() +

+ + +

o FrontFace(const FrontFace& ff, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, FrontFace, FRONTFACE) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum Mode +

+ + + +
o CLOCKWISE +

+ + +

o COUNTER_CLOCKWISE +

+ + + +
oinline void setMode(Mode mode) +

+ + +

oinline const Mode getMode() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~FrontFace() +

+ + +

oMode _mode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/General.html b/doc/doc++/osg/General.html new file mode 100644 index 000000000..7043e1fe5 --- /dev/null +++ b/doc/doc++/osg/General.html @@ -0,0 +1,766 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSG_ALPHAFUNC
+ +o#define +OSG_ANIMATIONPATH
+ +o#define +OSG_APPLICATIONUSAGE
+ +o#define +OSG_ARGUMENTPARSER
+ +o#define +OSG_ARRAY
+ +o#define +OSG_BILLBOARD
+ +o#define +OSG_BLENDFUNC
+ +o#define +OSG_BOUNDINGBOX
+ +o#define +OSG_BOUNDINGSPHERE
+ +o#define +OSG_BOUNDSCHECKING
+ +o#define +OSG_CAMERA
+ +o#define +OSG_CLEARNODE
+ +o#define +OSG_CLIPNODE
+ +o#define +OSG_CLIPPLANE
+ +o#define +OSG_COLLECTOCCLUDERSVISITOR
+ +o#define +OSG_COLORMASK
+ +o#define +OSG_COLORMATRIX
+ +o#define +OSG_CONVEXPLANAROCCLUDER
+ +o#define +OSG_CONVEXPLANARPOLYGON
+ +o#define +OSG_COPYOP
+ +o#define +OSG_CULLFACE
+ +o#define +OSG_CULLSTACK
+ +o#define +OSG_CullingSet
+ +o#define +OSG_DOFTRANSFORM
+ +o#define +OSG_DEPTH
+ +o#define +OSG_DisplaySettings
+ +o#define +OSG_DRAWPIXELS
+ +o#define +OSG_DRAWABLE
+ +o#define +OSG_ENDIAN
+ +o#define +OSG_EXPORT
+ +o#define +SG_EXPORT(dllexport)
+ +o#define +SG_EXPORT(dllimport)
+ +o#define +SG_EXPORT
+ +o#define +__STL_MEMBER_TEMPLATES
+ +o#define +NULL
+ +o#define +NULL((void *)
+ +o#define +OSG_FOG
+ +o#define +GL_FOG_COORDINATE
+ +o#define +GL_FRAGMENT_DEPTH
+ +o#define +OSG_FRAMESTAMP
+ +ousing +std::tm
+ +o#define +OSG_FRONTFACE
+ +o#define +OSG_GL
+ +o#define +APIENTRY
+ +oifdefined(__CYGWIN__) +(__MINGW32__)(dllimport)
+ +o#define +OSG_GLEXTENSIONS
+ +o#define +WIN32_LEAN_AND_MEAN
+ +o#define +NOMINMAX
+ +o#define +OSG_GLU
+ +o#define +OSG_GEOSET
+ +o#define +OSG_GEODE
+ +o#define +OSG_GEOMETRY
+ +o#define +OSG_GROUP
+ +o#define +OSG_IMAGE
+ +o#define +OSG_IMPOSTOR
+ +o#define +OSG_ImpostorSprite
+ +o#define +OSG_LOD
+ +o#define +OSG_LIGHT
+ +o#define +OSG_LIGHTMODEL
+ +o#define +OSG_LIGHTSOURCE
+ +o#define +OSG_LINESEGMENT
+ +o#define +OSG_LINESTIPPLE
+ +o#define +OSG_LineWidth
+ +o#define +OSG_MATERIAL
+ +o#define +__OSG_MATH
+ +odefined(sun)(__DARWIN_OSX__)(float)(float)(float)(float)(float)(float)(float)(float)(sun)(float)(sun)(__hpux__) +(DARWIN_OSX_PRE_10_2)(float)
+ +o#define +OSG_MATRIXTRANSFORM
+ +o#define +OSG_NODE
+ +o#define +OSG_NODECALLBACK
+ +o#define +OSG_NODEVISITOR
+ +o#define +OSG_NOTIFY
+ +o#define +OSG_OBJECT
+ +o#define +OSG_OCCLUDERNODE
+ +o#define +OSG_PLANE
+ +o#define +OSG_POINT
+ +o#define +OSG_POLYGONMODE
+ +o#define +OSG_POLYGONOFFSET
+ +o#define +OSG_POLYGONSTIPPLE
+ +o#define +OSG_POLYTOPE
+ +o#define +OSG_POSITIONATTITIDETRANSFORM
+ +o#define +OSG_PRIMTIVESET
+ +o#define +OSG_PROJECTION
+ +o#define +OSG_QUAT
+ +o#define +OSG_REFERENCED
+ +o#define +OSG_SEQUENCE
+ +o#define +OSG_SHADEMODEL
+ +o#define +OSG_SHADOWVOLUMEOCCLUDER
+ +o#define +OSG_SHAPE
+ +o#define +OSG_SHAPEDRAWABLE
+ +o#define +OSG_STATE
+ +o#define +OSG_STATEATTRIBUTE
+ +o#define +OSG_STATESET
+ +o#define +OSGUTIL_STATISTICS
+ +o#define +OSG_STENCIL
+ +o#define +OSG_SWITCH
+ +o#define +OSG_TEXENV
+ +o#define +OSG_TEXENVCOMBINE
+ +o#define +GL_COMBINE_ARB
+ +o#define +GL_COMBINE_RGB_ARB
+ +o#define +GL_COMBINE_ALPHA_ARB
+ +o#define +GL_SOURCE0_RGB_ARB
+ +o#define +GL_SOURCE1_RGB_ARB
+ +o#define +GL_SOURCE2_RGB_ARB
+ +o#define +GL_SOURCE0_ALPHA_ARB
+ +o#define +GL_SOURCE1_ALPHA_ARB
+ +o#define +GL_SOURCE2_ALPHA_ARB
+ +o#define +GL_OPERAND0_RGB_ARB
+ +o#define +GL_OPERAND1_RGB_ARB
+ +o#define +GL_OPERAND2_RGB_ARB
+ +o#define +GL_OPERAND0_ALPHA_ARB
+ +o#define +GL_OPERAND1_ALPHA_ARB
+ +o#define +GL_OPERAND2_ALPHA_ARB
+ +o#define +GL_RGB_SCALE_ARB
+ +o#define +GL_ADD_SIGNED_ARB
+ +o#define +GL_INTERPOLATE_ARB
+ +o#define +GL_SUBTRACT_ARB
+ +o#define +GL_CONSTANT_ARB
+ +o#define +GL_PRIMARY_COLOR_ARB
+ +o#define +GL_PREVIOUS_ARB
+ +o#define +GL_DOT3_RGB_ARB
+ +o#define +GL_DOT3_RGBA_ARB
+ +o#define +GL_TEXTURE0
+ +o#define +OSG_TEXGEN
+ +o#define +OSG_TEXMAT
+ +o#define +OSG_TEXTURE
+ +o#define +GL_TEXTURE_MAX_ANISOTROPY_EXT
+ +o#define +GL_COMPRESSED_ALPHA_ARB
+ +o#define +GL_COMPRESSED_LUMINANCE_ARB
+ +o#define +GL_COMPRESSED_LUMINANCE_ALPHA_ARB
+ +o#define +GL_COMPRESSED_INTENSITY_ARB
+ +o#define +GL_COMPRESSED_RGB_ARB
+ +o#define +GL_COMPRESSED_RGBA_ARB
+ +o#define +GL_TEXTURE_COMPRESSION_HINT_ARB
+ +o#define +GL_TEXTURE_COMPRESSED_IMAGE_SIZE_ARB
+ +o#define +GL_TEXTURE_COMPRESSED_ARB
+ +o#define +GL_NUM_COMPRESSED_TEXTURE_FORMATS_ARB
+ +o#define +GL_COMPRESSED_TEXTURE_FORMATS_ARB
+ +o#define +GL_COMPRESSED_RGB_S3TC_DXT1_EXT
+ +o#define +GL_COMPRESSED_RGBA_S3TC_DXT1_EXT
+ +o#define +GL_COMPRESSED_RGBA_S3TC_DXT3_EXT
+ +o#define +GL_COMPRESSED_RGBA_S3TC_DXT5_EXT
+ +o#define +GL_MIRRORED_REPEAT_IBM
+ +o#define +GL_CLAMP_TO_EDGE
+ +o#define +GL_CLAMP_TO_BORDER_ARB
+ +o#define +GL_GENERATE_MIPMAP_SGIS
+ +o#define +GL_GENERATE_MIPMAP_HINT_SGIS
+ +o#define +GL_TEXTURE_3D
+ +o#define +OSG_TEXTURE1D
+ +o#define +OSG_TEXTURE2D
+ +o#define +OSG_TEXTURE3D
+ +o#define +OSG_TEXTURECUBEMAP
+ +o#define +GL_TEXTURE_CUBE_MAP
+ +o#define +OSG_TEXTURERECTANGLE
+ +o#define +GL_TEXTURE_RECTANGLE_NV
+ +o#define +OSG_TIMER
+ +opragma +optimize("", off)
+ +opragmaoptimize("", on) +(x)(".byte 0x0f, 0x31" : "=A" (x))
+ +odefineCLK(x)((x)=0) +(x)(".byte 0x0f, 0x31" : "=A" (x))
+ +o#define +OSG_TRANSFORM
+ +o#define +OSG_TRIANGLEFUNCTOR
+ +o#define +OSG_UBYTE4
+ +o#define +OSG_UNITTESTFRAMEWORK
+ +o#define +OSG_VEC2
+ +o#define +OSG_VEC3
+ +o#define +OSG_VEC4
+ +o#define +OSG_VERSION_
+ +o#define +OSG_VERTEXPROGRAM
+ +o#define +GL_VERTEX_PROGRAM_ARB
+ +o#define +GL_VERTEX_PROGRAM_POINT_SIZE_ARB
+ +o#define +GL_VERTEX_PROGRAM_TWO_SIDE_ARB
+ +o#define +GL_COLOR_SUM_ARB
+ +o#define +GL_PROGRAM_FORMAT_ASCII_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_ENABLED_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_SIZE_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_STRIDE_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_TYPE_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_NORMALIZED_ARB
+ +o#define +GL_CURRENT_VERTEX_ATTRIB_ARB
+ +o#define +GL_VERTEX_ATTRIB_ARRAY_POINTER_ARB
+ +o#define +GL_PROGRAM_LENGTH_ARB
+ +o#define +GL_PROGRAM_FORMAT_ARB
+ +o#define +GL_PROGRAM_BINDING_ARB
+ +o#define +GL_PROGRAM_INSTRUCTIONS_ARB
+ +o#define +GL_MAX_PROGRAM_INSTRUCTIONS_ARB
+ +o#define +GL_PROGRAM_NATIVE_INSTRUCTIONS_ARB
+ +o#define +GL_MAX_PROGRAM_NATIVE_INSTRUCTIONS_ARB
+ +o#define +GL_PROGRAM_TEMPORARIES_ARB
+ +o#define +GL_MAX_PROGRAM_TEMPORARIES_ARB
+ +o#define +GL_PROGRAM_NATIVE_TEMPORARIES_ARB
+ +o#define +GL_MAX_PROGRAM_NATIVE_TEMPORARIES_ARB
+ +o#define +GL_PROGRAM_PARAMETERS_ARB
+ +o#define +GL_MAX_PROGRAM_PARAMETERS_ARB
+ +o#define +GL_PROGRAM_NATIVE_PARAMETERS_ARB
+ +o#define +GL_MAX_PROGRAM_NATIVE_PARAMETERS_ARB
+ +o#define +GL_PROGRAM_ATTRIBS_ARB
+ +o#define +GL_MAX_PROGRAM_ATTRIBS_ARB
+ +o#define +GL_PROGRAM_NATIVE_ATTRIBS_ARB
+ +o#define +GL_MAX_PROGRAM_NATIVE_ATTRIBS_ARB
+ +o#define +GL_PROGRAM_ADDRESS_REGISTERS_ARB
+ +o#define +GL_MAX_PROGRAM_ADDRESS_REGISTERS_ARB
+ +o#define +GL_PROGRAM_NATIVE_ADDRESS_REGISTERS_ARB
+ +o#define +GL_MAX_PROGRAM_NATIVE_ADDRESS_REGISTERS_ARB
+ +o#define +GL_MAX_PROGRAM_LOCAL_PARAMETERS_ARB
+ +o#define +GL_MAX_PROGRAM_ENV_PARAMETERS_ARB
+ +o#define +GL_PROGRAM_UNDER_NATIVE_LIMITS_ARB
+ +o#define +GL_PROGRAM_STRING_ARB
+ +o#define +GL_PROGRAM_ERROR_POSITION_ARB
+ +o#define +GL_CURRENT_MATRIX_ARB
+ +o#define +GL_TRANSPOSE_CURRENT_MATRIX_ARB
+ +o#define +GL_CURRENT_MATRIX_STACK_DEPTH_ARB
+ +o#define +GL_MAX_VERTEX_ATTRIBS_ARB
+ +o#define +GL_MAX_PROGRAM_MATRICES_ARB
+ +o#define +GL_MAX_PROGRAM_MATRIX_STACK_DEPTH_ARB
+ +o#define +GL_PROGRAM_ERROR_STRING_ARB
+ +o#define +GL_MATRIX0_ARB
+ +o#define +GL_MATRIX1_ARB
+ +o#define +GL_MATRIX2_ARB
+ +o#define +GL_MATRIX3_ARB
+ +o#define +GL_MATRIX4_ARB
+ +o#define +GL_MATRIX5_ARB
+ +o#define +GL_MATRIX6_ARB
+ +o#define +GL_MATRIX7_ARB
+ +o#define +GL_MATRIX8_ARB
+ +o#define +GL_MATRIX9_ARB
+ +o#define +GL_MATRIX10_ARB
+ +o#define +GL_MATRIX11_ARB
+ +o#define +GL_MATRIX12_ARB
+ +o#define +GL_MATRIX13_ARB
+ +o#define +GL_MATRIX14_ARB
+ +o#define +GL_MATRIX15_ARB
+ +o#define +GL_MATRIX16_ARB
+ +o#define +GL_MATRIX17_ARB
+ +o#define +GL_MATRIX18_ARB
+ +o#define +GL_MATRIX19_ARB
+ +o#define +GL_MATRIX20_ARB
+ +o#define +GL_MATRIX21_ARB
+ +o#define +GL_MATRIX22_ARB
+ +o#define +GL_MATRIX23_ARB
+ +o#define +GL_MATRIX24_ARB
+ +o#define +GL_MATRIX25_ARB
+ +o#define +GL_MATRIX26_ARB
+ +o#define +GL_MATRIX27_ARB
+ +o#define +GL_MATRIX28_ARB
+ +o#define +GL_MATRIX29_ARB
+ +o#define +GL_MATRIX30_ARB
+ +o#define +GL_MATRIX31_ARB
+ +o#define +OSG_VIEWPORT
+ +o#define +OSG_BUFFERED_VALUE
+ +o#define +OSG_FAST_BACK_STACK
+ +o#define +OSG_REF_PTR
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/GeoSet.html b/doc/doc++/osg/GeoSet.html new file mode 100644 index 000000000..fdab28fc8 --- /dev/null +++ b/doc/doc++/osg/GeoSet.html @@ -0,0 +1,1327 @@ + + + + + class SG_EXPORT osg::GeoSet + + + + +

class SG_EXPORT osg::GeoSet

Note, osg::GeoSet is now deprecated, please use osg::Geometry instead.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] GeoSet() +
+[more] GeoSet(const GeoSet& geoset, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]inline void setNumPrims( int n ) +
+[more]inline int getNumPrims() const +
+[more]void setPrimType( PrimitiveType type ) +
+[more]inline PrimitiveType getPrimType() const +
+[more]inline void setPrimLengths( int* lens ) +
+[more]inline int* getPrimLengths() const +
+[more]void computeNumVerts() const +
+[more]inline int getNumCoords() const +
get the number of coords required by the defined primitives. +
+[more]inline Vec3* getCoords() +
get a pointer to Vec3 coord array. +
+[more]inline const Vec3* getCoords() const +
get a const pointer to Vec3 coord array. +
+[more]inline int getNumCoordIndices() const +
get the number of indices required by the defined primitives. +
+[more]inline IndexPointer& getCoordIndices() +
get the coord index array. +
+[more]inline const IndexPointer& getCoordIndices() const +
get the const coord index array. +
+[more]void setCoords( Vec3* cp ) +
set the coords (ie the geometry) of the geoset +
+[more]void setCoords( Vec3* cp, GLushort* ci ) +
set the coords (ie the geometry) and ushort indices of the geoset. +
+[more]void setCoords( Vec3* cp, GLuint* ci ) +
set the coords (ie the geometry) and unsigned int indices of the geoset. +
+[more]void setCoords( Vec3* cp, IndexPointer& ip ) +
set the coords (ie the geometry) and indices of the geoset +
+[more]inline int getNumNormals() const +
get the number of normals required by the defined primitives and normals binding +
+[more]inline Vec3* getNormals() +
get a pointer to Vec3 normal array. +
+[more]inline const Vec3* getNormals() const +
get a const pointer to Vec3 normal array. +
+[more]inline int getNumNormalIndices() const +
get the number of normal indices required by the defined primitives and normals binding +
+[more]inline IndexPointer& getNormalIndices() +
get the normal index array. +
+[more]inline const IndexPointer& getNormalIndices() const +
get the const normal index array. +
+[more]void setNormals( Vec3* np ) +
set the normals of the geoset +
+[more]void setNormals( Vec3* np, GLushort* ni ) +
set the normals and normal indices of the geoset +
+[more]void setNormals( Vec3* np, GLuint* ni ) +
set the normals and normal indices of the geoset +
+[more]void setNormals( Vec3* np, IndexPointer& ip ) +
set the normals and normal indices of the geoset +
+[more]void setNormalBinding( BindingType binding ) +
set the normals binding to the vertices/primitives/overall +
+[more]inline BindingType getNormalBinding() const +
+[more]inline int getNumColors() const +
get the number of colors required by the defined primitives and color binding +
+[more]inline Vec4* getColors() +
get a pointer to Vec4 color array. +
+[more]inline const Vec4* getColors() const +
get a pointer to Vec4 color array. +
+[more]inline int getNumColorIndices() const +
get the number of colors indices required by the defined primitives and color binding +
+[more]inline IndexPointer& getColorIndices() +
get the color index array. +
+[more]inline const IndexPointer& getColorIndices() const +
get the const color index array. +
+[more]void setColors( Vec4* cp ) +
set the colors of the geoset +
+[more]void setColors( Vec4* cp, GLushort* li ) +
set the colors and color indices of the geoset +
+[more]void setColors( Vec4* cp, GLuint* li ) +
set the colors and color indices of the geoset +
+[more]void setColors( Vec4* cp, IndexPointer& ip ) +
set the colors and color indices of the geoset +
+[more]void setColorBinding( BindingType binding ) +
set the color binding to the vertices/primitives/overall +
+[more]inline BindingType getColorBinding() const +
+[more]inline int getNumTextureCoords() const +
get the number of texture coords required by the defined primitives and textures binding +
+[more]inline Vec2* getTextureCoords() +
get a pointer to Vec4 color array. +
+[more]inline const Vec2* getTextureCoords() const +
get a pointer to Vec4 color array. +
+[more]inline int getNumTextureIndices() const +
get the number of texture coord indices required by the defined primitives and texture binding +
+[more]inline IndexPointer& getTextureIndices() +
get the texture index array. +
+[more]inline const IndexPointer& getTextureIndices() const +
get the texture index array. +
+[more]void setTextureCoords( Vec2* tc ) +
set the texture coords of the geoset +
+[more]void setTextureCoords( Vec2* tc, GLushort* ti ) +
set the texture coords and texture coord indices of the geoset +
+[more]void setTextureCoords( Vec2* tc, GLuint* ti ) +
set the texture coords and texture coord indices of the geoset +
+[more]void setTextureCoords( Vec2* tc, IndexPointer& ip ) +
set the texture coords and texture indices of the geoset +
+[more]void setTextureBinding( BindingType binding ) +
set the texture coord binding to the vertices/primitives/overall +
+[more]inline BindingType getTextureBinding() const +
+[more]inline int getNumInterleavedCoords() const +
get the number of texture coords required by the defined primitives and textures binding +
+[more]inline void* getInterleavedArray() +
get a pointer to interleaved float array. +
+[more]inline const void* getInterleavedArray() const +
get a const pointer to interleaved float array. +
+[more]inline int getNumInterleavedIndices() const +
get the number of texture coord indices required by the defined primitives and texture binding +
+[more]inline IndexPointer& getInterleavedIndices() +
get the texture index array. +
+[more]inline const IndexPointer& getInterleavedIndices() const +
get the interleaved index array. +
+[more]inline InterleaveArrayType getInterleavedFormat() const +
get the interleaved array storage format. +
+[more]void setInterleavedArray( InterleaveArrayType format, float* ia ) +
set the interleaved arrays of the geoset +
+[more]void setInterleavedArray( InterleaveArrayType format, float* ia, GLushort* iai ) +
+[more]void setInterleavedArray( InterleaveArrayType format, float* ia, GLuint* iai ) +
+[more]void setInterleavedArray( InterleaveArrayType format, float* ia, IndexPointer& iai ) +
+[more]virtual void drawImplementation(State& state) const +
draw geoset directly ignoring an OpenGL display list which could be attached. +
+[more]bool check() const +
+[more]void setAttributeDeleteFunctor(AttributeDeleteFunctor* adf) +
set an alternative AttributeDeleteFunction to handle attribute arrays attached to this Geoset +
+[more]AttributeDeleteFunctor* getAttributeDeleteFunctor() +
get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset +
+[more]const AttributeDeleteFunctor* getAttributeDeleteFunctor() const +
get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset +
+[more]virtual bool supports(AttributeFunctor&) const +
return true, osg::GeoSet does support accept(AttributeFunctor&) +
+[more]virtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(ConstAttributeFunctor&) const +
return true, osg::GeoSet does support accept(ConstAttributeFunctor&) +
+[more]virtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(PrimitiveFunctor&) const +
return true, osg::GeoSet does support accept(PrimitiveFunctor&) +
+[more]virtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +
+[more]Geometry* convertToGeometry() +
convinience function for converting GeoSet's to equivilant Geometry nodes +

+ +

+

Public Members

+[more]enum PrimitiveType +
+[more]enum BindingType +
+[more]enum InterleaveArrayType +
+[more]struct SG_EXPORT IndexPointer +
+[more]struct SG_EXPORT AttributeDeleteFunctor: public osg::Referenced +
function object which is used to handling the clean up of attribute arrays associated with GeoSet's. +

+ +

+

Protected Fields

+[more]ref_ptr<AttributeDeleteFunctor> _adf +
+[more]int _numprims +
+[more]PrimitiveType _primtype +
+[more]int _needprimlen +
+[more]unsigned int _oglprimtype +
+[more]int* _primLengths +
+[more]mutable unsigned char _primlength +
+[more]unsigned char _flat_shaded_skip +
+[more]mutable int _numcoords +
+[more]Vec3* _coords +
+[more]mutable IndexPointer _cindex +
+[more]BindingType _normal_binding +
+[more]mutable int _numnormals +
+[more]Vec3* _normals +
+[more]IndexPointer _nindex +
+[more]BindingType _color_binding +
+[more]mutable int _numcolors +
+[more]Vec4* _colors +
+[more]IndexPointer _colindex +
+[more]BindingType _texture_binding +
+[more]mutable int _numtcoords +
+[more]Vec2* _tcoords +
+[more]IndexPointer _tindex +
+[more]void* _iarray +
+[more]IndexPointer _iaindex +
+[more]InterleaveArrayType _iaformat +
+[more]unsigned int _ogliaformat +
+[more]int _fast_path +

+ +

+

Protected Methods

+[more]GeoSet& operator = (const GeoSet&) +
+[more]virtual ~GeoSet() +
+[more]virtual bool computeBound() const +
+[more]void set_fast_path( void ) +
+[more]void draw_fast_path( State& state ) const +
+[more]void draw_alternate_path( State& state ) const +

+ +
+

Inherited from Drawable:

+
+

+

Public Methods

+ovirtual Geometry* asGeometry() +
+ovirtual const Geometry* asGeometry() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Node* getParent(unsigned int i) +
+oinline const Node* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+oinline void setStateSet(StateSet* state) +
+oinline StateSet* getStateSet() +
+oinline const StateSet* getStateSet() const +
+oStateSet* getOrCreateStateSet() +
+ovoid dirtyBound() +
+oinline const BoundingBox& getBound() const +
+oinline void setShape(Shape* shape) +
+oinline Shape* getShape() +
+oinline const Shape* getShape() const +
+ovoid setSupportsDisplayList(bool flag) +
+oinline bool getSupportsDisplayList() const +
+ovoid setUseDisplayList(bool flag) +
+oinline bool getUseDisplayList() const +
+ovoid dirtyDisplayList() +
+ovirtual void compile(State& state) const +
+ovoid setUpdateCallback(UpdateCallback* ac) +
+oUpdateCallback* getUpdateCallback() +
+ovoid setAppCallback(AppCallback* ac) +
+oAppCallback* getAppCallback() +
+oconst AppCallback* getAppCallback() const +
+ovoid setCullCallback(CullCallback* cc) +
+oCullCallback* getCullCallback() +
+oconst CullCallback* getCullCallback() const +
+ovoid setDrawCallback(DrawCallback* dc) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
+ostatic void flushDeletedDisplayLists(unsigned int contextID) +
+oinline void draw(State& state) const +

+ +

+

Public Members

+otypedef std::vector<Node*> ParentList +
+ostruct UpdateCallback: public virtual osg::Referenced +
+ostruct AppCallback: public UpdateCallback +
+ostruct CullCallback: public virtual osg::Referenced +
+ostruct DrawCallback: public virtual osg::Referenced +
+oenum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+oParentList _parents +
+oref_ptr<StateSet> _stateset +
+omutable BoundingBox _bbox +
+omutable bool _bbox_computed +
+oref_ptr<Shape> _shape +
+obool _supportsDisplayList +
+obool _useDisplayList +
+omutable GLObjectList _globjList +
+oref_ptr<UpdateCallback> _updateCallback +
+oref_ptr<DrawCallback> _drawCallback +
+oref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+ovoid setBound(const BoundingBox& bb) const +
+ovoid addParent(osg::Node* node) +
+ovoid removeParent(osg::Node* node) +

+ +

+

Protected Members

+otypedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Note, osg::GeoSet is now deprecated, please use osg::Geometry instead. +osg::GeoSet will be kept through to the beta release for +backwards compatability only. + +

Encapsulates OpenGL drawing primitives, geometry and +optional binding of normal, color and texture coordinates. Used +for representing the visible objects in the scene. State attributes +for a GeoSet are maintained in StateSet which the GeoSet maintains +a referenced counted pointer to. Both GeoSet's and StateSet's can +be shared for optimal memory usage and graphics performance.

+
+ + + +
oenum PrimitiveType +

+ + + +
o NO_TYPE +

+ + +

o POINTS +

+ + +

o LINES +

+ + +

o LINE_STRIP +

+ + +

o FLAT_LINE_STRIP +

+ + +

o LINE_LOOP +

+ + +

o TRIANGLES +

+ + +

o TRIANGLE_STRIP +

+ + +

o FLAT_TRIANGLE_STRIP +

+ + +

o TRIANGLE_FAN +

+ + +

o FLAT_TRIANGLE_FAN +

+ + +

o QUADS +

+ + +

o QUAD_STRIP +

+ + +

o POLYGON +

+ + + +
oenum BindingType +

+ + + +
o BIND_OFF +

+ + +

o BIND_OVERALL +

+ + +

o BIND_PERPRIM +

+ + +

o BIND_PERVERTEX +

+ + +

o BIND_DEFAULT +

+ + + +
oenum InterleaveArrayType +

+ + + +
o IA_OFF +

+ + +

o IA_V2F +

+ + +

o IA_V3F +

+ + +

o IA_C4UB_V2F +

+ + +

o IA_C4UB_V3F +

+ + +

o IA_C3F_V3F +

+ + +

o IA_N3F_V3F +

+ + +

o IA_C4F_N3F_V3F +

+ + +

o IA_T2F_V3F +

+ + +

o IA_T4F_V4F +

+ + +

o IA_T2F_C4UB_V3F +

+ + +

o IA_T2F_C3F_V3F +

+ + +

o IA_T2F_N3F_V3F +

+ + +

o IA_T2F_C4F_N3F_V3F +

+ + +

o IA_T4F_C4F_N3F_V4F +

+ + + +
ostruct SG_EXPORT IndexPointer +

+ + + +
omutable unsigned int _size +

+ + +

obool _is_ushort +

+ + +

ounion _TPtr +

+ + + +
oGLushort* _ushort +

+ + +

oGLuint* _uint +

+ + + +
o IndexPointer() +

+ + +

oinline bool operator == (const IndexPointer& ip) const +

+ + +

oinline bool valid() const +

+ + +

oinline bool null() const +

+ + +

oinline void setToNull() +

+ + +

oinline void set(unsigned int size, GLushort* data) +

+ + +

ovoid set(unsigned int size, GLuint* data) +

+ + +

oinline unsigned int maxIndex() const +

+ + +

oinline GLint operator [] (const GLuint pos) const +

+ + + +
o GeoSet() +

+ + +

o GeoSet(const GeoSet& geoset, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

oinline void setNumPrims( int n ) +

+ + +

oinline int getNumPrims() const +

+ + +

ovoid setPrimType( PrimitiveType type ) +

+ + +

oinline PrimitiveType getPrimType() const +

+ + +

oinline void setPrimLengths( int* lens ) +

+ + +

oinline int* getPrimLengths() const +

+ + +

ovoid computeNumVerts() const +

+ + +

oinline int getNumCoords() const +
get the number of coords required by the defined primitives. +

+ + +

oinline Vec3* getCoords() +
get a pointer to Vec3 coord array. +

+ + +

oinline const Vec3* getCoords() const +
get a const pointer to Vec3 coord array. +

+ + +

oinline int getNumCoordIndices() const +
get the number of indices required by the defined primitives. +

+ + +

oinline IndexPointer& getCoordIndices() +
get the coord index array. +

+ + +

oinline const IndexPointer& getCoordIndices() const +
get the const coord index array. +

+ + +

ovoid setCoords( Vec3* cp ) +
set the coords (ie the geometry) of the geoset +

+ + +

ovoid setCoords( Vec3* cp, GLushort* ci ) +
set the coords (ie the geometry) and ushort indices of the geoset. +To reduce memory footprint and bandwidth for small datasets it is +recommended the ushort indices are used instead of unit indices. +

+ + +

ovoid setCoords( Vec3* cp, GLuint* ci ) +
set the coords (ie the geometry) and unsigned int indices of the geoset. +Unless your data set exceeds 65536 indices prefer ushort indices +over unsigned int indices, only use this unit indices version if necessary. +

+ + +

ovoid setCoords( Vec3* cp, IndexPointer& ip ) +
set the coords (ie the geometry) and indices of the geoset +

+ + +

oinline int getNumNormals() const +
get the number of normals required by the defined primitives and normals binding +

+ + +

oinline Vec3* getNormals() +
get a pointer to Vec3 normal array. +

+ + +

oinline const Vec3* getNormals() const +
get a const pointer to Vec3 normal array. +

+ + +

oinline int getNumNormalIndices() const +
get the number of normal indices required by the defined primitives and normals binding +

+ + +

oinline IndexPointer& getNormalIndices() +
get the normal index array. +

+ + +

oinline const IndexPointer& getNormalIndices() const +
get the const normal index array. +

+ + +

ovoid setNormals( Vec3* np ) +
set the normals of the geoset +

+ + +

ovoid setNormals( Vec3* np, GLushort* ni ) +
set the normals and normal indices of the geoset +

+ + +

ovoid setNormals( Vec3* np, GLuint* ni ) +
set the normals and normal indices of the geoset +

+ + +

ovoid setNormals( Vec3* np, IndexPointer& ip ) +
set the normals and normal indices of the geoset +

+ + +

ovoid setNormalBinding( BindingType binding ) +
set the normals binding to the vertices/primitives/overall +

+ + +

oinline BindingType getNormalBinding() const +

+ + +

oinline int getNumColors() const +
get the number of colors required by the defined primitives and color binding +

+ + +

oinline Vec4* getColors() +
get a pointer to Vec4 color array. +

+ + +

oinline const Vec4* getColors() const +
get a pointer to Vec4 color array. +

+ + +

oinline int getNumColorIndices() const +
get the number of colors indices required by the defined primitives and color binding +

+ + +

oinline IndexPointer& getColorIndices() +
get the color index array. +

+ + +

oinline const IndexPointer& getColorIndices() const +
get the const color index array. +

+ + +

ovoid setColors( Vec4* cp ) +
set the colors of the geoset +

+ + +

ovoid setColors( Vec4* cp, GLushort* li ) +
set the colors and color indices of the geoset +

+ + +

ovoid setColors( Vec4* cp, GLuint* li ) +
set the colors and color indices of the geoset +

+ + +

ovoid setColors( Vec4* cp, IndexPointer& ip ) +
set the colors and color indices of the geoset +

+ + +

ovoid setColorBinding( BindingType binding ) +
set the color binding to the vertices/primitives/overall +

+ + +

oinline BindingType getColorBinding() const +

+ + +

oinline int getNumTextureCoords() const +
get the number of texture coords required by the defined primitives and textures binding +

+ + +

oinline Vec2* getTextureCoords() +
get a pointer to Vec4 color array. +

+ + +

oinline const Vec2* getTextureCoords() const +
get a pointer to Vec4 color array. +

+ + +

oinline int getNumTextureIndices() const +
get the number of texture coord indices required by the defined primitives and texture binding +

+ + +

oinline IndexPointer& getTextureIndices() +
get the texture index array. +

+ + +

oinline const IndexPointer& getTextureIndices() const +
get the texture index array. +

+ + +

ovoid setTextureCoords( Vec2* tc ) +
set the texture coords of the geoset +

+ + +

ovoid setTextureCoords( Vec2* tc, GLushort* ti ) +
set the texture coords and texture coord indices of the geoset +

+ + +

ovoid setTextureCoords( Vec2* tc, GLuint* ti ) +
set the texture coords and texture coord indices of the geoset +

+ + +

ovoid setTextureCoords( Vec2* tc, IndexPointer& ip ) +
set the texture coords and texture indices of the geoset +

+ + +

ovoid setTextureBinding( BindingType binding ) +
set the texture coord binding to the vertices/primitives/overall +

+ + +

oinline BindingType getTextureBinding() const +

+ + +

oinline int getNumInterleavedCoords() const +
get the number of texture coords required by the defined primitives and textures binding +

+ + +

oinline void* getInterleavedArray() +
get a pointer to interleaved float array. +

+ + +

oinline const void* getInterleavedArray() const +
get a const pointer to interleaved float array. +

+ + +

oinline int getNumInterleavedIndices() const +
get the number of texture coord indices required by the defined primitives and texture binding +

+ + +

oinline IndexPointer& getInterleavedIndices() +
get the texture index array. +

+ + +

oinline const IndexPointer& getInterleavedIndices() const +
get the interleaved index array. +

+ + +

oinline InterleaveArrayType getInterleavedFormat() const +
get the interleaved array storage format. +

+ + +

ovoid setInterleavedArray( InterleaveArrayType format, float* ia ) +
set the interleaved arrays of the geoset +

+ + +

ovoid setInterleavedArray( InterleaveArrayType format, float* ia, GLushort* iai ) +

+ + +

ovoid setInterleavedArray( InterleaveArrayType format, float* ia, GLuint* iai ) +

+ + +

ovoid setInterleavedArray( InterleaveArrayType format, float* ia, IndexPointer& iai ) +

+ + +

ovirtual void drawImplementation(State& state) const +
draw geoset directly ignoring an OpenGL display list which could be attached. +This is the internal draw method which does the drawing itself, +and is the method to override when deriving from GeoSet for user-drawn objects. +

+ + +

obool check() const +

+ + +

ostruct SG_EXPORT AttributeDeleteFunctor: public osg::Referenced +
function object which is used to handling the clean up of attribute arrays +associated with GeoSet's. A default is provided which assumes that all +momory attached to the GeoSet is owned by this GeoSet and can be deleted +using delete []. If this is not the cause derive your own AttributeDeleteFunctor +a specify your own memory deletion operation. +

+ + + +
ovirtual void operator() (GeoSet* gset) +

+ + + +
ovoid setAttributeDeleteFunctor(AttributeDeleteFunctor* adf) +
set an alternative AttributeDeleteFunction to handle attribute arrays attached to this Geoset +

+ + +

oAttributeDeleteFunctor* getAttributeDeleteFunctor() +
get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset +

+ + +

oconst AttributeDeleteFunctor* getAttributeDeleteFunctor() const +
get the current AttributeDeleteFunction to handle attribute arrays attached to this Geoset +

+ + +

ovirtual bool supports(AttributeFunctor&) const +
return true, osg::GeoSet does support accept(AttributeFunctor&) +

+ + +

ovirtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(ConstAttributeFunctor&) const +
return true, osg::GeoSet does support accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(PrimitiveFunctor&) const +
return true, osg::GeoSet does support accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ + +

oGeometry* convertToGeometry() +
convinience function for converting GeoSet's to equivilant Geometry nodes +

+ + +

oGeoSet& operator = (const GeoSet&) +

+ + +

ovirtual ~GeoSet() +

+ + +

ovirtual bool computeBound() const +

+ + +

oref_ptr<AttributeDeleteFunctor> _adf +

+ + +

oint _numprims +

+ + +

oPrimitiveType _primtype +

+ + +

oint _needprimlen +

+ + +

ounsigned int _oglprimtype +

+ + +

oint* _primLengths +

+ + +

omutable unsigned char _primlength +

+ + +

ounsigned char _flat_shaded_skip +

+ + +

omutable int _numcoords +

+ + +

oVec3* _coords +

+ + +

omutable IndexPointer _cindex +

+ + +

oBindingType _normal_binding +

+ + +

omutable int _numnormals +

+ + +

oVec3* _normals +

+ + +

oIndexPointer _nindex +

+ + +

oBindingType _color_binding +

+ + +

omutable int _numcolors +

+ + +

oVec4* _colors +

+ + +

oIndexPointer _colindex +

+ + +

oBindingType _texture_binding +

+ + +

omutable int _numtcoords +

+ + +

oVec2* _tcoords +

+ + +

oIndexPointer _tindex +

+ + +

ovoid* _iarray +

+ + +

oIndexPointer _iaindex +

+ + +

oInterleaveArrayType _iaformat +

+ + +

ounsigned int _ogliaformat +

+ + +

oint _fast_path +

+ + +

ovoid set_fast_path( void ) +

+ + +

ovoid draw_fast_path( State& state ) const +

+ + +

ovoid draw_alternate_path( State& state ) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Geode.html b/doc/doc++/osg/Geode.html new file mode 100644 index 000000000..a999e6c76 --- /dev/null +++ b/doc/doc++/osg/Geode.html @@ -0,0 +1,412 @@ + + + + + class SG_EXPORT osg::Geode + + + + +

class SG_EXPORT osg::Geode

Leaf Node for grouping Drawables
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Geode() +
+[more] Geode(const Geode&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Geode) +
+[more]virtual bool addDrawable( Drawable* drawable ) +
Add Drawable to Geode. +
+[more]virtual bool removeDrawable( Drawable* drawable ) +
Remove Drawable from Geode. +
+[more]virtual bool removeDrawable(unsigned int i, unsigned int numDrawablesToRemove=1) +
Remove drawable(s) from the specified position in Geode's drawable list +
+[more]virtual bool replaceDrawable( Drawable* origDraw, Drawable* newDraw ) +
Replace specified Drawable with another Drawable. +
+[more]virtual bool setDrawable( unsigned int i, Drawable* drawable ) +
set drawable at position i. +
+[more]inline unsigned int getNumDrawables() const +
return the number of drawable's +
+[more]inline Drawable* getDrawable( unsigned int i ) +
return drawable at position i +
+[more]inline const Drawable* getDrawable( unsigned int i ) const +
return drawable at position i +
+[more]inline bool containsDrawable(const Drawable* gset) const +
return true if drawable is contained within Geode +
+[more]inline unsigned int getDrawableIndex( const Drawable* node ) const +
Get the index number of drawable, return a value between 0 and _drawablessize()-1 if found, if not found then return _drawablessize() +
+[more]void compileDrawables(State& state) +
compile OpenGL Display List for each drawable +

+ +

+

Public Members

+[more]typedef std::vector< ref_ptr<Drawable> > DrawableList +

+ +

+

Protected Fields

+[more]DrawableList _drawables +

+ +

+

Protected Methods

+[more]virtual ~Geode() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+ovirtual void traverse(NodeVisitor& ) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Leaf Node for grouping Drawables
+
+ + + +
otypedef std::vector< ref_ptr<Drawable> > DrawableList +

+ + +

o Geode() +

+ + +

o Geode(const Geode&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Geode) +

+ + +

ovirtual bool addDrawable( Drawable* drawable ) +
Add Drawable to Geode. +If gset is not NULL and is not contained in Geode then increment its +reference count, add it to the drawables list and dirty the bounding +sphere to force it to recompute on next getBound() and return true for success. +Otherwise return false. +

+ + +

ovirtual bool removeDrawable( Drawable* drawable ) +
Remove Drawable from Geode. +Equivalent to setDrawabke(getDrawableIndex(orignChild),node), +see docs for setNode for futher details on implementation. +

+ + +

ovirtual bool removeDrawable(unsigned int i, unsigned int numDrawablesToRemove=1) +
Remove drawable(s) from the specified position in Geode's drawable list +

+ + +

ovirtual bool replaceDrawable( Drawable* origDraw, Drawable* newDraw ) +
Replace specified Drawable with another Drawable. +Equivalent to setDrawable(getDrawableIndex(orignChild),node), +see docs for setDrawable for futher details on implementation. +

+ + +

ovirtual bool setDrawable( unsigned int i, Drawable* drawable ) +
set drawable at position i. +return true if set correctly, false on failure (if node==NULL || i is out of range). +Decrement the reference count origGSet and increments the +reference count of newGset, and dirty the bounding sphere +to force it to recompute on next getBound() and returns true. +If origDrawable is not found then return false and do not +add newGset. If newGset is NULL then return false and do +not remove origGset. +

+ + +

oinline unsigned int getNumDrawables() const +
return the number of drawable's +

+ + +

oinline Drawable* getDrawable( unsigned int i ) +
return drawable at position i +

+ + +

oinline const Drawable* getDrawable( unsigned int i ) const +
return drawable at position i +

+ + +

oinline bool containsDrawable(const Drawable* gset) const +
return true if drawable is contained within Geode +

+ + +

oinline unsigned int getDrawableIndex( const Drawable* node ) const +
Get the index number of drawable, return a value between +0 and _drawablessize()-1 if found, if not found then +return _drawablessize() +

+ + +

ovoid compileDrawables(State& state) +
compile OpenGL Display List for each drawable +

+ + +

ovirtual ~Geode() +

+ + +

ovirtual bool computeBound() const +

+ + +

oDrawableList _drawables +

+
+
Direct child classes: +
Billboard
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Geometry.html b/doc/doc++/osg/Geometry.html new file mode 100644 index 000000000..5521530f4 --- /dev/null +++ b/doc/doc++/osg/Geometry.html @@ -0,0 +1,899 @@ + + + + + class SG_EXPORT osg::Geometry + + + + +

class SG_EXPORT osg::Geometry

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Geometry() +
+[more] Geometry(const Geometry& geometry, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual Geometry* asGeometry() +
+[more]virtual const Geometry* asGeometry() const +
+[more]void setVertexArray(Vec3Array* array) +
+[more]Vec3Array* getVertexArray() +
+[more]const Vec3Array* getVertexArray() const +
+[more]void setVertexIndices(IndexArray* array) +
+[more]IndexArray* getVertexIndices() +
+[more]const IndexArray* getVertexIndices() const +
+[more]void setNormalBinding(AttributeBinding ab) +
+[more]AttributeBinding getNormalBinding() const +
+[more]void setNormalArray(Vec3Array* array) +
+[more]Vec3Array* getNormalArray() +
+[more]const Vec3Array* getNormalArray() const +
+[more]void setNormalIndices(IndexArray* array) +
+[more]IndexArray* getNormalIndices() +
+[more]const IndexArray* getNormalIndices() const +
+[more]void setColorBinding(AttributeBinding ab) +
+[more]AttributeBinding getColorBinding() const +
+[more]void setColorArray(Array* array) +
+[more]Array* getColorArray() +
+[more]const Array* getColorArray() const +
+[more]void setColorIndices(IndexArray* array) +
+[more]IndexArray* getColorIndices() +
+[more]const IndexArray* getColorIndices() const +
+[more]void setSecondaryColorBinding(AttributeBinding ab) +
+[more]AttributeBinding getSecondaryColorBinding() const +
+[more]void setSecondaryColorArray(Array* array) +
+[more]Array* getSecondaryColorArray() +
+[more]const Array* getSecondaryColorArray() const +
+[more]void setSecondaryColorIndices(IndexArray* array) +
+[more]IndexArray* getSecondaryColorIndices() +
+[more]const IndexArray* getSecondaryColorIndices() const +
+[more]void setFogCoordBinding(AttributeBinding ab) +
+[more]AttributeBinding getFogCoordBinding() const +
+[more]void setFogCoordArray(Array* array) +
+[more]Array* getFogCoordArray() +
+[more]const Array* getFogCoordArray() const +
+[more]void setFogCoordIndices(IndexArray* array) +
+[more]IndexArray* getFogCoordIndices() +
+[more]const IndexArray* getFogCoordIndices() const +
+[more]void setTexCoordArray(unsigned int unit, Array*) +
+[more]Array* getTexCoordArray(unsigned int unit) +
+[more]const Array* getTexCoordArray(unsigned int unit) const +
+[more]void setTexCoordIndices(unsigned int unit, IndexArray*) +
+[more]IndexArray* getTexCoordIndices(unsigned int unit) +
+[more]const IndexArray* getTexCoordIndices(unsigned int unit) const +
+[more]unsigned int getNumTexCoordArrays() const +
+[more]TexCoordArrayList& getTexCoordArrayList() +
+[more]const TexCoordArrayList& getTexCoordArrayList() const +
+[more]void setPrimitiveSetList(const PrimitiveSetList& primitives) +
+[more]PrimitiveSetList& getPrimitiveSetList() +
+[more]const PrimitiveSetList& getPrimitiveSetList() const +
+[more]unsigned int getNumPrimitiveSets() const +
+[more]PrimitiveSet* getPrimitiveSet(unsigned int pos) +
+[more]const PrimitiveSet* getPrimitiveSet(unsigned int pos) const +
+[more]bool addPrimitiveSet(PrimitiveSet* primitiveset) +
Add a primitive set to the geometry +
+[more]bool setPrimitiveSet(unsigned int i, PrimitiveSet* primitiveset) +
Set a primitive set to the specified position in geometry's primitive set list +
+[more]bool insertPrimitiveSet(unsigned int i, PrimitiveSet* primitiveset) +
Insert a primitive set to the specified position in geometry's primitive set list +
+[more]bool removePrimitiveSet(unsigned int i, unsigned int numElementsToRemove=1) +
Remove primitive set(s) from the specified position in geometry's primitive set list +
+[more]unsigned int getPrimitiveSetIndex(const PrimitiveSet* primitiveset) const +
Get the index number of a primitive set, return a value between 0 and getNumPrimitiveSet()-1 if found, if not found then return getNumPrimitiveSet(). +
+[more]bool areFastPathsUsed() const +
return true if OpenGL fast paths will be used with drawing this Geometry. +
+[more]bool verifyBindings() const +
+[more]void computeCorrectBindingsAndArraySizes() +
+[more]virtual void drawImplementation(State& state) const +
draw Geometry directly ignoring an OpenGL display list which could be attached. +
+[more]virtual bool supports(AttributeFunctor&) const +
return true, osg::Geometry does support accept(AttributeFunctor&) +
+[more]virtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(ConstAttributeFunctor&) const +
return true, osg::Geometry does support accept(ConstAttributeFunctor&) +
+[more]virtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(PrimitiveFunctor&) const +
return true, osg::Geometry does support accept(PrimitiveFunctor&) +
+[more]virtual void accept(PrimitiveFunctor& pf) const +
accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has +

+ +

+

Public Members

+[more]enum AttributeBinding +
+[more]typedef std::pair< ref_ptr<Array>, ref_ptr<IndexArray> > TexCoordArrayPair +
+[more]typedef std::vector< TexCoordArrayPair > TexCoordArrayList +
+[more]typedef std::vector< ref_ptr<PrimitiveSet> > PrimitiveSetList +

+ +

+

Protected Fields

+[more]PrimitiveSetList _primitives +
+[more]ref_ptr<Vec3Array> _vertexArray +
+[more]ref_ptr<IndexArray> _vertexIndices +
+[more]mutable AttributeBinding _normalBinding +
+[more]ref_ptr<Vec3Array> _normalArray +
+[more]ref_ptr<IndexArray> _normalIndices +
+[more]mutable AttributeBinding _colorBinding +
+[more]ref_ptr<Array> _colorArray +
+[more]ref_ptr<IndexArray> _colorIndices +
+[more]mutable AttributeBinding _secondaryColorBinding +
+[more]ref_ptr<Array> _secondaryColorArray +
+[more]ref_ptr<IndexArray> _secondaryColorIndices +
+[more]mutable AttributeBinding _fogCoordBinding +
+[more]ref_ptr<Array> _fogCoordArray +
+[more]ref_ptr<IndexArray> _fogCoordIndices +
+[more]TexCoordArrayList _texCoordList +
+[more]mutable bool _fastPathComputed +
+[more]mutable bool _fastPath +

+ +

+

Protected Methods

+[more]Geometry& operator = (const Geometry&) +
+[more]virtual ~Geometry() +

+ +
+

Inherited from Drawable:

+
+

+

Public Methods

+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Node* getParent(unsigned int i) +
+oinline const Node* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+oinline void setStateSet(StateSet* state) +
+oinline StateSet* getStateSet() +
+oinline const StateSet* getStateSet() const +
+oStateSet* getOrCreateStateSet() +
+ovoid dirtyBound() +
+oinline const BoundingBox& getBound() const +
+oinline void setShape(Shape* shape) +
+oinline Shape* getShape() +
+oinline const Shape* getShape() const +
+ovoid setSupportsDisplayList(bool flag) +
+oinline bool getSupportsDisplayList() const +
+ovoid setUseDisplayList(bool flag) +
+oinline bool getUseDisplayList() const +
+ovoid dirtyDisplayList() +
+ovirtual void compile(State& state) const +
+ovoid setUpdateCallback(UpdateCallback* ac) +
+oUpdateCallback* getUpdateCallback() +
+ovoid setAppCallback(AppCallback* ac) +
+oAppCallback* getAppCallback() +
+oconst AppCallback* getAppCallback() const +
+ovoid setCullCallback(CullCallback* cc) +
+oCullCallback* getCullCallback() +
+oconst CullCallback* getCullCallback() const +
+ovoid setDrawCallback(DrawCallback* dc) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
+ostatic void flushDeletedDisplayLists(unsigned int contextID) +
+oinline void draw(State& state) const +

+ +

+

Public Members

+otypedef std::vector<Node*> ParentList +
+ostruct UpdateCallback: public virtual osg::Referenced +
+ostruct AppCallback: public UpdateCallback +
+ostruct CullCallback: public virtual osg::Referenced +
+ostruct DrawCallback: public virtual osg::Referenced +
+oenum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+oParentList _parents +
+oref_ptr<StateSet> _stateset +
+omutable BoundingBox _bbox +
+omutable bool _bbox_computed +
+oref_ptr<Shape> _shape +
+obool _supportsDisplayList +
+obool _useDisplayList +
+omutable GLObjectList _globjList +
+oref_ptr<UpdateCallback> _updateCallback +
+oref_ptr<DrawCallback> _drawCallback +
+oref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +
+ovoid setBound(const BoundingBox& bb) const +
+ovoid addParent(osg::Node* node) +
+ovoid removeParent(osg::Node* node) +

+ +

+

Protected Members

+otypedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Geometry() +

+ + +

o Geometry(const Geometry& geometry, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual Geometry* asGeometry() +

+ + +

ovirtual const Geometry* asGeometry() const +

+ + +

oenum AttributeBinding +

+ + + +
o BIND_OFF +

+ + +

o BIND_OVERALL +

+ + +

o BIND_PER_PRIMITIVE_SET +

+ + +

o BIND_PER_PRIMITIVE +

+ + +

o BIND_PER_VERTEX +

+ + + +
ovoid setVertexArray(Vec3Array* array) +

+ + +

oVec3Array* getVertexArray() +

+ + +

oconst Vec3Array* getVertexArray() const +

+ + +

ovoid setVertexIndices(IndexArray* array) +

+ + +

oIndexArray* getVertexIndices() +

+ + +

oconst IndexArray* getVertexIndices() const +

+ + +

ovoid setNormalBinding(AttributeBinding ab) +

+ + +

oAttributeBinding getNormalBinding() const +

+ + +

ovoid setNormalArray(Vec3Array* array) +

+ + +

oVec3Array* getNormalArray() +

+ + +

oconst Vec3Array* getNormalArray() const +

+ + +

ovoid setNormalIndices(IndexArray* array) +

+ + +

oIndexArray* getNormalIndices() +

+ + +

oconst IndexArray* getNormalIndices() const +

+ + +

ovoid setColorBinding(AttributeBinding ab) +

+ + +

oAttributeBinding getColorBinding() const +

+ + +

ovoid setColorArray(Array* array) +

+ + +

oArray* getColorArray() +

+ + +

oconst Array* getColorArray() const +

+ + +

ovoid setColorIndices(IndexArray* array) +

+ + +

oIndexArray* getColorIndices() +

+ + +

oconst IndexArray* getColorIndices() const +

+ + +

ovoid setSecondaryColorBinding(AttributeBinding ab) +

+ + +

oAttributeBinding getSecondaryColorBinding() const +

+ + +

ovoid setSecondaryColorArray(Array* array) +

+ + +

oArray* getSecondaryColorArray() +

+ + +

oconst Array* getSecondaryColorArray() const +

+ + +

ovoid setSecondaryColorIndices(IndexArray* array) +

+ + +

oIndexArray* getSecondaryColorIndices() +

+ + +

oconst IndexArray* getSecondaryColorIndices() const +

+ + +

ovoid setFogCoordBinding(AttributeBinding ab) +

+ + +

oAttributeBinding getFogCoordBinding() const +

+ + +

ovoid setFogCoordArray(Array* array) +

+ + +

oArray* getFogCoordArray() +

+ + +

oconst Array* getFogCoordArray() const +

+ + +

ovoid setFogCoordIndices(IndexArray* array) +

+ + +

oIndexArray* getFogCoordIndices() +

+ + +

oconst IndexArray* getFogCoordIndices() const +

+ + +

otypedef std::pair< ref_ptr<Array>, ref_ptr<IndexArray> > TexCoordArrayPair +

+ + +

otypedef std::vector< TexCoordArrayPair > TexCoordArrayList +

+ + +

ovoid setTexCoordArray(unsigned int unit, Array*) +

+ + +

oArray* getTexCoordArray(unsigned int unit) +

+ + +

oconst Array* getTexCoordArray(unsigned int unit) const +

+ + +

ovoid setTexCoordIndices(unsigned int unit, IndexArray*) +

+ + +

oIndexArray* getTexCoordIndices(unsigned int unit) +

+ + +

oconst IndexArray* getTexCoordIndices(unsigned int unit) const +

+ + +

ounsigned int getNumTexCoordArrays() const +

+ + +

oTexCoordArrayList& getTexCoordArrayList() +

+ + +

oconst TexCoordArrayList& getTexCoordArrayList() const +

+ + +

otypedef std::vector< ref_ptr<PrimitiveSet> > PrimitiveSetList +

+ + +

ovoid setPrimitiveSetList(const PrimitiveSetList& primitives) +

+ + +

oPrimitiveSetList& getPrimitiveSetList() +

+ + +

oconst PrimitiveSetList& getPrimitiveSetList() const +

+ + +

ounsigned int getNumPrimitiveSets() const +

+ + +

oPrimitiveSet* getPrimitiveSet(unsigned int pos) +

+ + +

oconst PrimitiveSet* getPrimitiveSet(unsigned int pos) const +

+ + +

obool addPrimitiveSet(PrimitiveSet* primitiveset) +
Add a primitive set to the geometry +

+ + +

obool setPrimitiveSet(unsigned int i, PrimitiveSet* primitiveset) +
Set a primitive set to the specified position in geometry's primitive set list +

+ + +

obool insertPrimitiveSet(unsigned int i, PrimitiveSet* primitiveset) +
Insert a primitive set to the specified position in geometry's primitive set list +

+ + +

obool removePrimitiveSet(unsigned int i, unsigned int numElementsToRemove=1) +
Remove primitive set(s) from the specified position in geometry's primitive set list +

+ + +

ounsigned int getPrimitiveSetIndex(const PrimitiveSet* primitiveset) const +
Get the index number of a primitive set, return a value between +0 and getNumPrimitiveSet()-1 if found, if not found then return getNumPrimitiveSet(). +When checking for a valid find value use if ((value=geoemtry->getPrimitiveSetIndex(primitive))!=geometry.getNumPrimitiveSet()) as +

+ + +

obool areFastPathsUsed() const +
return true if OpenGL fast paths will be used with drawing this Geometry. +Fast paths use vertex arrays, and glDrawArrays/glDrawElements. Slow paths +use glBegin()/glVertex.../glEnd(). Use of per primitive bindings or per vertex indexed +arrays will drop the rendering path off the fast path. +

+ + +

obool verifyBindings() const +

+ + +

ovoid computeCorrectBindingsAndArraySizes() +

+ + +

ovirtual void drawImplementation(State& state) const +
draw Geometry directly ignoring an OpenGL display list which could be attached. +This is the internal draw method which does the drawing itself, +and is the method to override when deriving from Geometry for user-drawn objects. +

+ + +

ovirtual bool supports(AttributeFunctor&) const +
return true, osg::Geometry does support accept(AttributeFunctor&) +

+ + +

ovirtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(ConstAttributeFunctor&) const +
return true, osg::Geometry does support accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(PrimitiveFunctor&) const +
return true, osg::Geometry does support accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(PrimitiveFunctor& pf) const +
accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has +

+ + +

oGeometry& operator = (const Geometry&) +

+ + +

ovirtual ~Geometry() +

+ + +

oPrimitiveSetList _primitives +

+ + +

oref_ptr<Vec3Array> _vertexArray +

+ + +

oref_ptr<IndexArray> _vertexIndices +

+ + +

omutable AttributeBinding _normalBinding +

+ + +

oref_ptr<Vec3Array> _normalArray +

+ + +

oref_ptr<IndexArray> _normalIndices +

+ + +

omutable AttributeBinding _colorBinding +

+ + +

oref_ptr<Array> _colorArray +

+ + +

oref_ptr<IndexArray> _colorIndices +

+ + +

omutable AttributeBinding _secondaryColorBinding +

+ + +

oref_ptr<Array> _secondaryColorArray +

+ + +

oref_ptr<IndexArray> _secondaryColorIndices +

+ + +

omutable AttributeBinding _fogCoordBinding +

+ + +

oref_ptr<Array> _fogCoordArray +

+ + +

oref_ptr<IndexArray> _fogCoordIndices +

+ + +

oTexCoordArrayList _texCoordList +

+ + +

omutable bool _fastPathComputed +

+ + +

omutable bool _fastPath +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Grid.html b/doc/doc++/osg/Grid.html new file mode 100644 index 000000000..e46e1d08c --- /dev/null +++ b/doc/doc++/osg/Grid.html @@ -0,0 +1,217 @@ + + + + + class SG_EXPORT osg::Grid + + + + +

class SG_EXPORT osg::Grid

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Grid() +
+[more] Grid(const Grid& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, Grid)(unsigned int numColumns, unsigned int numRows) +
+[more]void setHeight(unsigned int c, unsigned int r, float value) +
+[more]virtual float getHeight(unsigned int c, unsigned int r) const +

+ +

+

Protected Fields

+[more]HeightList _heights +

+ +

+

Protected Methods

+[more] ~Grid() +

+ +

+

Protected Members

+[more]typedef std::vector<float> HeightList +

+ +
+

Inherited from HeightField:

+
+

+

Public Methods

+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(osg::ShapeVisitor& sv) +
+ovirtual void accept(osg::ConstShapeVisitor& csv) const +
+oinline unsigned int getNumColumns() const +
+oinline unsigned int getNumRows() const +
+oinline void setOrigin(const osg::Vec3& origin) +
+oinline const osg::Vec3& getOrigin() const +
+oinline void setXInterval(float dx) +
+oinline float getXInterval() const +
+oinline void setYInterval(float dy) +
+oinline float getYInterval() const +
+ovirtual Vec3 getNormal(unsigned int c, unsigned int r) const +
+oinline void setRotation(const Quat& quat) +
+oinline const Quat& getRotation() const +
+oinline Matrix getRotationMatrix() const +
+oinline bool zeroRotation() const +

+ +

+

Protected Fields

+ounsigned int _columns +
+ounsigned int _rows +
+oosg::Vec3 _origin +
+ofloat _dx +
+ofloat _dy +
+oQuat _rotation +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Grid() +

+ + +

o Grid(const Grid& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, Grid)(unsigned int numColumns, unsigned int numRows) +

+ + +

ovoid setHeight(unsigned int c, unsigned int r, float value) +

+ + +

ovirtual float getHeight(unsigned int c, unsigned int r) const +

+ + +

o ~Grid() +

+ + +

otypedef std::vector<float> HeightList +

+ + +

oHeightList _heights +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Group.html b/doc/doc++/osg/Group.html new file mode 100644 index 000000000..c3d9a31fd --- /dev/null +++ b/doc/doc++/osg/Group.html @@ -0,0 +1,427 @@ + + + + + class SG_EXPORT osg::Group + + + + +

class SG_EXPORT osg::Group

General group node which maintains a list of children.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Group() +
+[more] Group(const Group&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Group) +
+[more]virtual Group* asGroup() +
+[more]virtual const Group* asGroup() const +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]virtual bool addChild( Node* child ) +
Add Node to Group. +
+[more]virtual bool removeChild( Node* child ) +
Remove Node from Group. +
+[more]virtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+[more]virtual bool replaceChild( Node* origChild, Node* newChild ) +
Replace specified Node with another Node. +
+[more]inline unsigned int getNumChildren() const +
return the number of chilren nodes +
+[more]virtual bool setChild( unsigned int i, Node* node ) +
set child node at position i. +
+[more]inline Node* getChild( unsigned int i ) +
return child node at position i +
+[more]inline const Node* getChild( unsigned int i ) const +
return child node at position i +
+[more]inline bool containsNode( const Node* node ) const +
return true if node is contained within Group +
+[more]inline unsigned int getChildIndex( const Node* node ) const +
Get the index number of child, return a value between 0 and _childrensize()-1 if found, if not found then return _childrensize() +

+ +

+

Public Members

+[more]typedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+[more]ChildList _children +

+ +

+

Protected Methods

+[more]virtual ~Group() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
General group node which maintains a list of children. +Children are reference counted. This allows children to be shared +with memory management handled automatically via osg::Referenced.
+
+ + + +
otypedef std::vector<ref_ptr<Node> > ChildList +

+ + +

o Group() +

+ + +

o Group(const Group&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Group) +

+ + +

ovirtual Group* asGroup() +

+ + +

ovirtual const Group* asGroup() const +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovirtual bool addChild( Node* child ) +
Add Node to Group. +If node is not NULL and is not contained in Group then increment its +reference count, add it to the child list and dirty the bounding +sphere to force it to recompute on next getBound() and return true for success. +Otherwise return false. Scene nodes can't be added as child nodes. +

+ + +

ovirtual bool removeChild( Node* child ) +
Remove Node from Group. +If Node is contained in Group then remove it from the child +list, decrement its reference count, and dirty the +bounding sphere to force it to recompute on next getBound() and +return true for success. If Node is not found then return false +and do not change the reference count of the Node. +

+ + +

ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +

+ + +

ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
Replace specified Node with another Node. +Equivalent to setChild(getChildIndex(orignChild),node), +see docs for setChild for futher details on implementation. +

+ + +

oinline unsigned int getNumChildren() const +
return the number of chilren nodes +

+ + +

ovirtual bool setChild( unsigned int i, Node* node ) +
set child node at position i. +return true if set correctly, false on failure (if node==NULL || i is out of range). +When set can be successful applied, the algorithm is : decrement the reference count origNode and increments the +reference count of newNode, and dirty the bounding sphere +to force it to recompute on next getBound() and returns true. +If origNode is not found then return false and do not +add newNode. If newNode is NULL then return false and do +not remove origNode. Also returns false if newChild is a Scene node. +

+ + +

oinline Node* getChild( unsigned int i ) +
return child node at position i +

+ + +

oinline const Node* getChild( unsigned int i ) const +
return child node at position i +

+ + +

oinline bool containsNode( const Node* node ) const +
return true if node is contained within Group +

+ + +

oinline unsigned int getChildIndex( const Node* node ) const +
Get the index number of child, return a value between +0 and _childrensize()-1 if found, if not found then +return _childrensize() +

+ + +

ovirtual ~Group() +

+ + +

ovirtual bool computeBound() const +

+ + +

oChildList _children +

+
+
Direct child classes: +
Transform
+Switch
+Sequence
+Projection
+OccluderNode
+LightSource
+LOD
+ClipNode
+ClearNode
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/HIER.html b/doc/doc++/osg/HIER.html new file mode 100644 index 000000000..5b7aab0bd --- /dev/null +++ b/doc/doc++/osg/HIER.html @@ -0,0 +1,232 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/HIERjava.html b/doc/doc++/osg/HIERjava.html new file mode 100644 index 000000000..c3cc5a8bd --- /dev/null +++ b/doc/doc++/osg/HIERjava.html @@ -0,0 +1,331 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/HeightField.html b/doc/doc++/osg/HeightField.html new file mode 100644 index 000000000..88697b432 --- /dev/null +++ b/doc/doc++/osg/HeightField.html @@ -0,0 +1,279 @@ + + + + + class SG_EXPORT osg::HeightField + + + + +

class SG_EXPORT osg::HeightField

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] HeightField() +
+[more] HeightField(const HeightField& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void accept(osg::ShapeVisitor& sv) +
+[more]virtual void accept(osg::ConstShapeVisitor& csv) const +
+[more]inline unsigned int getNumColumns() const +
+[more]inline unsigned int getNumRows() const +
+[more]inline void setOrigin(const osg::Vec3& origin) +
+[more]inline const osg::Vec3& getOrigin() const +
+[more]inline void setXInterval(float dx) +
+[more]inline float getXInterval() const +
+[more]inline void setYInterval(float dy) +
+[more]inline float getYInterval() const +
+[more]virtual float getHeight(unsigned int c, unsigned int r) const = 0 +
+[more]virtual Vec3 getNormal(unsigned int c, unsigned int r) const +
+[more]inline void setRotation(const Quat& quat) +
+[more]inline const Quat& getRotation() const +
+[more]inline Matrix getRotationMatrix() const +
+[more]inline bool zeroRotation() const +

+ +

+

Protected Fields

+[more]unsigned int _columns +
+[more]unsigned int _rows +
+[more]osg::Vec3 _origin +
+[more]float _dx +
+[more]float _dy +
+[more]Quat _rotation +

+ +

+

Protected Methods

+[more] ~HeightField() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o HeightField() +

+ + +

o HeightField(const HeightField& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void accept(osg::ShapeVisitor& sv) +

+ + +

ovirtual void accept(osg::ConstShapeVisitor& csv) const +

+ + +

oinline unsigned int getNumColumns() const +

+ + +

oinline unsigned int getNumRows() const +

+ + +

oinline void setOrigin(const osg::Vec3& origin) +

+ + +

oinline const osg::Vec3& getOrigin() const +

+ + +

oinline void setXInterval(float dx) +

+ + +

oinline float getXInterval() const +

+ + +

oinline void setYInterval(float dy) +

+ + +

oinline float getYInterval() const +

+ + +

ovirtual float getHeight(unsigned int c, unsigned int r) const = 0 +

+ + +

ovirtual Vec3 getNormal(unsigned int c, unsigned int r) const +

+ + +

oinline void setRotation(const Quat& quat) +

+ + +

oinline const Quat& getRotation() const +

+ + +

oinline Matrix getRotationMatrix() const +

+ + +

oinline bool zeroRotation() const +

+ + +

o ~HeightField() +

+ + +

ounsigned int _columns +

+ + +

ounsigned int _rows +

+ + +

oosg::Vec3 _origin +

+ + +

ofloat _dx +

+ + +

ofloat _dy +

+ + +

oQuat _rotation +

+
+
Direct child classes: +
Grid
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Image.html b/doc/doc++/osg/Image.html new file mode 100644 index 000000000..08ff79b10 --- /dev/null +++ b/doc/doc++/osg/Image.html @@ -0,0 +1,596 @@ + + + + + class SG_EXPORT osg::Image + + + + +

class SG_EXPORT osg::Image

Image class for encapsulating the storage texture image data
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Image() +
+[more] Image(const Image& image, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual int compare(const Image& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setFileName(const std::string& fileName) +
+[more]inline const std::string& getFileName() const +
+[more]void setAllocationMode(AllocationMode mode) +
Set the method used for deleting data once it goes out of scope +
+[more]AllocationMode setAllocationMode() const +
Get the method used for deleting data once it goes out of scope +
+[more]void allocateImage(int s, int t, int r, GLenum format, GLenum type, int packing=1) +
+[more]void setImage(int s, int t, int r, GLint internalTextureformat, GLenum format, GLenum type, unsigned char* data, AllocationMode mode, int packing=1) +
set the image data and format. +
+[more]void readPixels(int x, int y, int width, int height, GLenum format, GLenum type) +
readPixels from screen at specified position and size, using glReadPixels. +
+[more]void readImageFromCurrentTexture(unsigned int contextID=0) +
read the contents of the current bound texture, handling compressed formats if present. +
+[more]void scaleImage(int s, int t, int r) +
Scale image to specified size. +
+[more]void copySubImage(int s_offset, int t_offset, int r_offset, osg::Image* source) +
Copy a source Image into a subpart of this Image at specified position. +
+[more]inline int s() const +
Width of image +
+[more]inline int t() const +
Height of image +
+[more]inline int r() const +
Depth of image +
+[more]void setInternalTextureFormat(GLint internalFormat) +
+[more]inline GLint getInternalTextureFormat() const +
+[more]void setPixelFormat(GLenum format) +
+[more]inline GLenum getPixelFormat() const +
+[more]inline GLenum getDataType() const +
+[more]inline unsigned int getPacking() const +
+[more]inline unsigned int getPixelSizeInBits() const +
return the numbers of bits required for each pixel +
+[more]inline unsigned int getRowSizeInBytes() const +
return the numbers of bytes each row of pixels occupies once it has been packed +
+[more]inline unsigned int getImageSizeInBytes() const +
return the numbers of bytes each image (_s*_t) of pixels occupies +
+[more]inline unsigned int getTotalSizeInBytes() const +
return the numbers of bytes the whole row/image/volume of pixels occupies +
+[more]inline unsigned char* data() +
raw image data +
+[more]inline const unsigned char* data() const +
raw const image data +
+[more]inline unsigned char* data(int column, int row=0, int image=0) const +
+[more]void flipHorizontal(int image=0) +
Flip the image horizontally +
+[more]void flipVertical(int image=0) +
Flip the image vertically +
+[more]void ensureValidSizeForTexturing(GLint maxTextureSize) +
Ensure image dimensions are a power of two. +
+[more]inline void dirty() +
Dirty the image, which increments the modified flag, to force osg::Texture to reload the image +
+[more]inline void setModifiedTag(unsigned int value) +
Set the modified tag value, only used by osg::Texture when using texture subloading. +
+[more]inline unsigned int getModifiedTag() const +
Get modified tag value, only used by osg::Texture when using texture subloading. +
+[more]static bool isPackedType(GLenum type) +
+[more]static unsigned int computeNumComponents(GLenum format) +
+[more]static unsigned int computePixelSizeInBits(GLenum format, GLenum type) +
+[more]static unsigned int computeRowWidthInBytes(int width, GLenum format, GLenum type, int packing) +
+[more]static int computeNearestPowerOfTwo(int s, float bias=0.5f) +
+[more]inline bool isMipmap() const +
+[more]unsigned int getNumMipmapLevels() const +
+[more]inline void setMipmapData(const MipmapDataType& mipmapDataVector) +
+[more]inline unsigned char* getMipmapData(unsigned int mipmapNumber) const +
+[more]void computeMipMaps() +
converts a single image into mip mapped version image +
+[more]bool isImageTranslucent() const +
return true of this image is translucent - ie. +

+ +

+

Public Members

+[more]enum AllocationMode +
+[more]typedef std::vector< unsigned int > MipmapDataType +

+ +

+

Protected Fields

+[more]std::string _fileName +
+[more]int _s +
+[more]int _t +
+[more]int _r +
+[more]GLint _internalTextureFormat +
+[more]GLenum _pixelFormat +
+[more]GLenum _dataType +
+[more]unsigned int _packing +
+[more]AllocationMode _allocationMode +
+[more]unsigned char* _data +
+[more]unsigned int _modifiedTag +
+[more]MipmapDataType _mipmapData +

+ +

+

Protected Methods

+[more]virtual ~Image() +
+[more]Image& operator = (const Image&) +
+[more]void deallocateData() +
+[more]void setData(unsigned char* data, AllocationMode allocationMode) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Image class for encapsulating the storage texture image data
+
+ + + +
o Image() +

+ + +

o Image(const Image& image, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual int compare(const Image& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovoid setFileName(const std::string& fileName) +

+ + +

oinline const std::string& getFileName() const +

+ + +

oenum AllocationMode +

+ + + +
o NO_DELETE +

+ + +

o USE_NEW_DELETE +

+ + +

o USE_MALLOC_FREE +

+ + + +
ovoid setAllocationMode(AllocationMode mode) +
Set the method used for deleting data once it goes out of scope +

+ + +

oAllocationMode setAllocationMode() const +
Get the method used for deleting data once it goes out of scope +

+ + +

ovoid allocateImage(int s, int t, int r, GLenum format, GLenum type, int packing=1) +

+ + +

ovoid setImage(int s, int t, int r, GLint internalTextureformat, GLenum format, GLenum type, unsigned char* data, AllocationMode mode, int packing=1) +
set the image data and format. +note, when the packing value is negative (the default is -1) this method assumes +a _packing width of 1 if the width is not a multiple of 4, +otherwise automatically sets to _packing to 4. If a positive +value of packing is supplied than _packing is simply set to that value. +

+ + +

ovoid readPixels(int x, int y, int width, int height, GLenum format, GLenum type) +
readPixels from screen at specified position and size, using glReadPixels. +Create memory for storage if required, reuse existing pixel coords if possible. +

+ + +

ovoid readImageFromCurrentTexture(unsigned int contextID=0) +
read the contents of the current bound texture, handling compressed formats if present. +Create memory for storage if required, reuse existing pixel coords if possible. +

+ + +

ovoid scaleImage(int s, int t, int r) +
Scale image to specified size. +

+ + +

ovoid copySubImage(int s_offset, int t_offset, int r_offset, osg::Image* source) +
Copy a source Image into a subpart of this Image at specified position. +Typically used to copy to an already allocated image, such as creating +a 3D image from a stack 2D images. +If the this Image is empty then image data is created to +accomodate the imaging image in its offset position. +If source is NULL then no operation happens, this Image is left unchanged. +

+ + +

oinline int s() const +
Width of image +

+ + +

oinline int t() const +
Height of image +

+ + +

oinline int r() const +
Depth of image +

+ + +

ovoid setInternalTextureFormat(GLint internalFormat) +

+ + +

oinline GLint getInternalTextureFormat() const +

+ + +

ovoid setPixelFormat(GLenum format) +

+ + +

oinline GLenum getPixelFormat() const +

+ + +

oinline GLenum getDataType() const +

+ + +

oinline unsigned int getPacking() const +

+ + +

oinline unsigned int getPixelSizeInBits() const +
return the numbers of bits required for each pixel +

+ + +

oinline unsigned int getRowSizeInBytes() const +
return the numbers of bytes each row of pixels occupies once it has been packed +

+ + +

oinline unsigned int getImageSizeInBytes() const +
return the numbers of bytes each image (_s*_t) of pixels occupies +

+ + +

oinline unsigned int getTotalSizeInBytes() const +
return the numbers of bytes the whole row/image/volume of pixels occupies +

+ + +

oinline unsigned char* data() +
raw image data +

+ + +

oinline const unsigned char* data() const +
raw const image data +

+ + +

oinline unsigned char* data(int column, int row=0, int image=0) const +

+ + +

ovoid flipHorizontal(int image=0) +
Flip the image horizontally +

+ + +

ovoid flipVertical(int image=0) +
Flip the image vertically +

+ + +

ovoid ensureValidSizeForTexturing(GLint maxTextureSize) +
Ensure image dimensions are a power of two. +Mip Mapped texture require the image dimensions to be +power of two and are within the maxiumum texture size for +the host machine. +

+ + +

oinline void dirty() +
Dirty the image, which increments the modified flag, to force osg::Texture to reload the image +

+ + +

oinline void setModifiedTag(unsigned int value) +
Set the modified tag value, only used by osg::Texture when using texture subloading. +

+ + +

oinline unsigned int getModifiedTag() const +
Get modified tag value, only used by osg::Texture when using texture subloading. +

+ + +

ostatic bool isPackedType(GLenum type) +

+ + +

ostatic unsigned int computeNumComponents(GLenum format) +

+ + +

ostatic unsigned int computePixelSizeInBits(GLenum format, GLenum type) +

+ + +

ostatic unsigned int computeRowWidthInBytes(int width, GLenum format, GLenum type, int packing) +

+ + +

ostatic int computeNearestPowerOfTwo(int s, float bias=0.5f) +

+ + +

otypedef std::vector< unsigned int > MipmapDataType +

+ + +

oinline bool isMipmap() const +

+ + +

ounsigned int getNumMipmapLevels() const +

+ + +

oinline void setMipmapData(const MipmapDataType& mipmapDataVector) +

+ + +

oinline unsigned char* getMipmapData(unsigned int mipmapNumber) const +

+ + +

ovoid computeMipMaps() +
converts a single image into mip mapped version image +

+ + +

obool isImageTranslucent() const +
return true of this image is translucent - ie. it has alpha values that are less 1.0 (when normalized). +

+ + +

ovirtual ~Image() +

+ + +

oImage& operator = (const Image&) +

+ + +

ostd::string _fileName +

+ + +

oint _s +

+ + +

oint _t +

+ + +

oint _r +

+ + +

oGLint _internalTextureFormat +

+ + +

oGLenum _pixelFormat +

+ + +

oGLenum _dataType +

+ + +

ounsigned int _packing +

+ + +

oAllocationMode _allocationMode +

+ + +

ounsigned char* _data +

+ + +

ovoid deallocateData() +

+ + +

ovoid setData(unsigned char* data, AllocationMode allocationMode) +

+ + +

ounsigned int _modifiedTag +

+ + +

oMipmapDataType _mipmapData +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Impostor.html b/doc/doc++/osg/Impostor.html new file mode 100644 index 000000000..810e4d85f --- /dev/null +++ b/doc/doc++/osg/Impostor.html @@ -0,0 +1,488 @@ + + + + + class SG_EXPORT osg::Impostor + + + + +

class SG_EXPORT osg::Impostor

Impostor - is a form of Level Of Detail group node which allows both switching between children depending on distance from eye point and image caching.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Impostor() +
+[more] Impostor(const Impostor& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, Impostor) +
+[more]inline void setImpostorThreshold(float distance) +
Set the Impostor threshold distance. +
+[more]inline void setImpostorThresholdToBound(float ratio=1.0f) +
Set the Impostor threshold distance relative to the node's bounding sphere's radius +
+[more]inline float getImpostorThreshold() const +
+[more]inline float getImpostorThreshold2() const +
+[more]ImpostorSprite* findBestImpostorSprite(unsigned int contextID, const osg::Vec3& currLocalEyePoint) const +
Find the ImposterSprite which fits the current eye point best +
+[more]void addImpostorSprite(unsigned int contextID, ImpostorSprite* is) +
Add an ImpostorSprite to the Impostor +
+[more]inline ImpostorSpriteList& getImpostorSpriteList(unsigned int contexID) +
Get the list of ImpostorSprites attached to this Impostor +
+[more]inline const ImpostorSpriteList& getImpostorSpriteList(unsigned int contexID) const +
Get a const list of ImpostorSprites attached to this const Impostor +

+ +

+

Public Members

+[more]typedef std::vector< ref_ptr<ImpostorSprite> > ImpostorSpriteList +

+ +

+

Protected Fields

+[more]mutable buffered_object<ImpostorSpriteList> _impostorSpriteListBuffer +
+[more]float _impostorThreshold +

+ +

+

Protected Methods

+[more]virtual ~Impostor() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from LOD:

+
+

+

Public Methods

+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild(Node* child) +
+ovirtual bool addChild(Node* child, float min, float max) +
+ovirtual bool removeChild(Node* child) +
+ovoid setCenterMode(CenterMode mode) +
+oCenterMode getCenterMode() const +
+oinline void setCenter(const Vec3& center) +
+oinline const Vec3& getCenter() const +
+ovoid setRange(unsigned int childNo, float min, float max) +
+oinline float getMinRange(unsigned int childNo) const +
+oinline float getMaxRange(unsigned int childNo) const +
+oinline unsigned int getNumRanges() const +
+oinline RangeList& getRangeList() +
+oinline const RangeList& getRangeList() const +

+ +

+

Public Members

+otypedef std::pair<float,float> MinMaxPair +
+otypedef std::vector<MinMaxPair> RangeList +
+oenum CenterMode +

+ +

+

Protected Fields

+oCenterMode _centerMode +
+oVec3 _userDefinedCenter +
+oRangeList _rangeList +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Impostor - is a form of Level Of Detail group node which allows both switching +between children depending on distance from eye point and image caching. + +

The principle behind Imposters is that they cache an image of real geometry and then the image is drawn +in subsequent frames instead of the real geometry. Its a bit like a +Billboard *but* is updated at runtime and w.r.t view point. By drawing +just the texture mapped quad you can cut down scene complexity and +improve performance. + +

For more details have a look at: + +

http://grail.cs.washington.edu/projects/hic/ + +

The OSG doesn't implement exactly the same technique as above, but its +should be a good starting place. The OSG's impostors are much less +intrusive since you don't need to restructure your whole scene to use +them. + +

All you need to do to use Impostors is to set up the visible +range values for each LOD child of the Impostor, as per osg::LOD, +and set an Impostor threshold to tell the renderer at what distance +the Impostor's image caching should cut in. The osg::CullVisitor +automatically handles all the setting of pre-rendering stages to +calculate the required ImpostorSprites (which encapsulates the image +cache and quad), and updates them as the view point changes. If you +use osg::SceneView/CullVisitor all the complexity of supporting +Impostor will be nicely hidden away. + +

TODO: +Various improvements are planned for the Impostor- +1) Estimation of how many frames an ImpostorSprite will be reused, if +it won't be used more often than a minimum threshold then do not create +ImpostorSprite - use the real geometry. +2) Sharing of texture memory between ImpostorSprites. +3) Simple 3D geometry for ImpostorSprite's rather than Billboarding. +4) Shrinking of the ImpostorSprite size to more closely fit the underlying +geometry.

+
+ + + +
o Impostor() +

+ + +

o Impostor(const Impostor& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, Impostor) +

+ + +

otypedef std::vector< ref_ptr<ImpostorSprite> > ImpostorSpriteList +

+ + +

oinline void setImpostorThreshold(float distance) +
Set the Impostor threshold distance. +For eye points further than this threshold the Imposter is used if appropriate, +otherwise the LOD children as chosen as per a standard LOD node. +

+ + +

oinline void setImpostorThresholdToBound(float ratio=1.0f) +
Set the Impostor threshold distance relative to the node's bounding +sphere's radius +

+ + +

oinline float getImpostorThreshold() const +

+ + +

oinline float getImpostorThreshold2() const +

+ + +

oImpostorSprite* findBestImpostorSprite(unsigned int contextID, const osg::Vec3& currLocalEyePoint) const +
Find the ImposterSprite which fits the current eye point best +

+ + +

ovoid addImpostorSprite(unsigned int contextID, ImpostorSprite* is) +
Add an ImpostorSprite to the Impostor +

+ + +

oinline ImpostorSpriteList& getImpostorSpriteList(unsigned int contexID) +
Get the list of ImpostorSprites attached to this Impostor +

+ + +

oinline const ImpostorSpriteList& getImpostorSpriteList(unsigned int contexID) const +
Get a const list of ImpostorSprites attached to this const Impostor +

+ + +

ovirtual ~Impostor() +

+ + +

ovirtual bool computeBound() const +

+ + +

omutable buffered_object<ImpostorSpriteList> _impostorSpriteListBuffer +

+ + +

ofloat _impostorThreshold +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ImpostorSprite.html b/doc/doc++/osg/ImpostorSprite.html new file mode 100644 index 000000000..11f972f80 --- /dev/null +++ b/doc/doc++/osg/ImpostorSprite.html @@ -0,0 +1,596 @@ + + + + + class SG_EXPORT osg::ImpostorSprite + + + + +

class SG_EXPORT osg::ImpostorSprite

An ImposterSprite is a textured quad which is rendered in place a 3D geometry.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]Vec4 _color +

+ +

+

Public Methods

+[more] ImpostorSprite() +
+[more]virtual Object* cloneType() const +
Clone an object of the same type as an ImpostorSprite +
+[more]virtual Object* clone(const CopyOp&) const +
Clone on ImpostorSprite just returns a clone of type, since it is not appropriate to share data of an ImpostorSprite +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]void setParent(Impostor* parent) +
Set the parent, which must be an Impostor. +
+[more]Impostor* getParent() +
Get the parent, which is an Impostor. +
+[more]const Impostor* getParent() const +
Get the const parent, which is an Impostor. +
+[more]inline void setStoredLocalEyePoint(const Vec3& v) +
Set the eye point for when the ImpsotorSprite was snapped +
+[more]inline const Vec3& getStoredLocalEyePoint() const +
Get the eye point for when the ImpsotorSprite was snapped +
+[more]inline void setLastFrameUsed(int frameNumber) +
Set the frame number for when the ImpostorSprite was last used in rendering +
+[more]inline int getLastFrameUsed() const +
Get the frame number for when the ImpostorSprite was last used in rendering +
+[more]inline Vec3* getCoords() +
Get the coordinates of the corners of the quad. +
+[more]inline const Vec3* getCoords() const +
Get the const coordinates of the corners of the quad +
+[more]inline Vec2* getTexCoords() +
Get the texture coordinates of the corners of the quad. +
+[more]inline const Vec2* getTexCoords() const +
Get the const texture coordinates of the corners of the quad +
+[more]inline Vec3* getControlCoords() +
Get the control coordinates of the corners of the quad. +
+[more]inline const Vec3* getControlCoords() const +
Get the const control coordinates of the corners of the quad +
+[more]float calcPixelError(const Matrix& MVPW) const +
calculate the pixel error value for passing in the ModelViewProjectionWindow transform, which transform local coords into screen space +
+[more]void setTexture(Texture2D* tex, int s, int t) +
+[more]Texture2D* getTexture() +
+[more]const Texture2D* getTexture() const +
+[more]int s() const +
+[more]int t() const +
+[more]virtual void drawImplementation(State& state) const +
draw ImpostorSprite directly. +
+[more]virtual bool supports(AttributeFunctor&) const +
return true, osg::ImpostorSprite does support accept(AttributeFunctor&) +
+[more]virtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(ConstAttributeFunctor&) const +
return true, osg::ImpostorSprite does support accept(ConstAttributeFunctor&) +
+[more]virtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(PrimitiveFunctor&) const +
return true, osg::ImpostorSprite does support accept(PrimitiveFunctor&) +
+[more]virtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ +

+

Protected Fields

+[more]Impostor* _parent +
+[more]ImpostorSpriteManager* _ism +
+[more]ImpostorSprite* _previous +
+[more]ImpostorSprite* _next +
+[more]int _lastFrameUsed +
+[more]Vec3 _storedLocalEyePoint +
+[more]Vec3 _coords[4] +
+[more]Vec2 _texcoords[4] +
+[more]Vec3 _controlcoords[4] +
+[more]Texture2D* _texture +
+[more]int _s +
+[more]int _t +

+ +

+

Protected Methods

+[more] ImpostorSprite(const ImpostorSprite&) +
+[more]ImpostorSprite& operator = (const ImpostorSprite&) +
+[more]virtual ~ImpostorSprite() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Drawable:

+
+

+

Public Methods

+ovirtual Geometry* asGeometry() +
+ovirtual const Geometry* asGeometry() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline unsigned int getNumParents() const +
+oinline void setStateSet(StateSet* state) +
+oinline StateSet* getStateSet() +
+oinline const StateSet* getStateSet() const +
+oStateSet* getOrCreateStateSet() +
+ovoid dirtyBound() +
+oinline const BoundingBox& getBound() const +
+oinline void setShape(Shape* shape) +
+oinline Shape* getShape() +
+oinline const Shape* getShape() const +
+ovoid setSupportsDisplayList(bool flag) +
+oinline bool getSupportsDisplayList() const +
+ovoid setUseDisplayList(bool flag) +
+oinline bool getUseDisplayList() const +
+ovoid dirtyDisplayList() +
+ovirtual void compile(State& state) const +
+ovoid setUpdateCallback(UpdateCallback* ac) +
+oUpdateCallback* getUpdateCallback() +
+ovoid setAppCallback(AppCallback* ac) +
+oAppCallback* getAppCallback() +
+oconst AppCallback* getAppCallback() const +
+ovoid setCullCallback(CullCallback* cc) +
+oCullCallback* getCullCallback() +
+oconst CullCallback* getCullCallback() const +
+ovoid setDrawCallback(DrawCallback* dc) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
+ostatic void flushDeletedDisplayLists(unsigned int contextID) +
+oinline void draw(State& state) const +

+ +

+

Public Members

+otypedef std::vector<Node*> ParentList +
+ostruct UpdateCallback: public virtual osg::Referenced +
+ostruct AppCallback: public UpdateCallback +
+ostruct CullCallback: public virtual osg::Referenced +
+ostruct DrawCallback: public virtual osg::Referenced +
+oenum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+oParentList _parents +
+oref_ptr<StateSet> _stateset +
+omutable BoundingBox _bbox +
+omutable bool _bbox_computed +
+oref_ptr<Shape> _shape +
+obool _supportsDisplayList +
+obool _useDisplayList +
+omutable GLObjectList _globjList +
+oref_ptr<UpdateCallback> _updateCallback +
+oref_ptr<DrawCallback> _drawCallback +
+oref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+ovoid setBound(const BoundingBox& bb) const +
+ovoid addParent(osg::Node* node) +
+ovoid removeParent(osg::Node* node) +

+ +

+

Protected Members

+otypedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
An ImposterSprite is a textured quad which is rendered in place a +3D geometry. The ImposterSprite is generated by rendering the original +3D geometry to a texture as an image cache. The ImpostorSprite is +automatically generated by the osgUtil::CullVisitor so it not +necessary to deal with it directly.
+
+ + + +
o ImpostorSprite() +

+ + +

ovirtual Object* cloneType() const +
Clone an object of the same type as an ImpostorSprite +

+ + +

ovirtual Object* clone(const CopyOp&) const +
Clone on ImpostorSprite just returns a clone of type, +since it is not appropriate to share data of an ImpostorSprite +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovoid setParent(Impostor* parent) +
Set the parent, which must be an Impostor. +Unlike conventional Drawables, ImpostorSprite's can only ever have +one parent. +

+ + +

oImpostor* getParent() +
Get the parent, which is an Impostor. +

+ + +

oconst Impostor* getParent() const +
Get the const parent, which is an Impostor. +

+ + +

oinline void setStoredLocalEyePoint(const Vec3& v) +
Set the eye point for when the ImpsotorSprite was snapped +

+ + +

oinline const Vec3& getStoredLocalEyePoint() const +
Get the eye point for when the ImpsotorSprite was snapped +

+ + +

oinline void setLastFrameUsed(int frameNumber) +
Set the frame number for when the ImpostorSprite was last used in rendering +

+ + +

oinline int getLastFrameUsed() const +
Get the frame number for when the ImpostorSprite was last used in rendering +

+ + +

oinline Vec3* getCoords() +
Get the coordinates of the corners of the quad. +Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left. +

+ + +

oinline const Vec3* getCoords() const +
Get the const coordinates of the corners of the quad +

+ + +

oinline Vec2* getTexCoords() +
Get the texture coordinates of the corners of the quad. +Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left. +

+ + +

oinline const Vec2* getTexCoords() const +
Get the const texture coordinates of the corners of the quad +

+ + +

oinline Vec3* getControlCoords() +
Get the control coordinates of the corners of the quad. +The control coordinates are the corners of the quad projected +out onto the front face of bounding box which enclosed the impostor +geometry when it was pre-rendered into the impostor sprite's texture. +At the point of creation/or update of the impostor sprite the control +coords will lie on top of the corners of the quad in screen space - with a pixel error +or zero. Once the camera moves relative to the impostor sprite the +control coords will no longer lie on top of the corners of the quad in +screen space - a pixel error will have accumulated. This pixel error +can then be used to determine whether the impostor needs to be updated. +Stored in the order, [0] - top_left, [1] - bottom_left, [2] - bottom_right, [3] - top_left. +

+ + +

oinline const Vec3* getControlCoords() const +
Get the const control coordinates of the corners of the quad +

+ + +

ofloat calcPixelError(const Matrix& MVPW) const +
calculate the pixel error value for passing in the ModelViewProjectionWindow transform, +which transform local coords into screen space +

+ + +

ovoid setTexture(Texture2D* tex, int s, int t) +

+ + +

oTexture2D* getTexture() +

+ + +

oconst Texture2D* getTexture() const +

+ + +

oint s() const +

+ + +

oint t() const +

+ + +

ovirtual void drawImplementation(State& state) const +
draw ImpostorSprite directly. +

+ + +

ovirtual bool supports(AttributeFunctor&) const +
return true, osg::ImpostorSprite does support accept(AttributeFunctor&) +

+ + +

ovirtual void accept(AttributeFunctor& af) +
accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(ConstAttributeFunctor&) const +
return true, osg::ImpostorSprite does support accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(PrimitiveFunctor&) const +
return true, osg::ImpostorSprite does support accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ + +

oVec4 _color +

+ + +

o ImpostorSprite(const ImpostorSprite&) +

+ + +

oImpostorSprite& operator = (const ImpostorSprite&) +

+ + +

ovirtual ~ImpostorSprite() +

+ + +

ovirtual bool computeBound() const +

+ + +

oImpostor* _parent +

+ + +

oImpostorSpriteManager* _ism +

+ + +

oImpostorSprite* _previous +

+ + +

oImpostorSprite* _next +

+ + +

oint _lastFrameUsed +

+ + +

oVec3 _storedLocalEyePoint +

+ + +

oVec3 _coords[4] +

+ + +

oVec2 _texcoords[4] +

+ + +

oVec3 _controlcoords[4] +

+ + +

oTexture2D* _texture +

+ + +

oint _s +

+ + +

oint _t +

+ +
This class has no child classes.
+ +
Friends:
class osg::ImpostorSpriteManager

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ImpostorSpriteManager.html b/doc/doc++/osg/ImpostorSpriteManager.html new file mode 100644 index 000000000..48fcc4bf8 --- /dev/null +++ b/doc/doc++/osg/ImpostorSpriteManager.html @@ -0,0 +1,178 @@ + + + + + class SG_EXPORT osg::ImpostorSpriteManager + + + + +

class SG_EXPORT osg::ImpostorSpriteManager

Helper class for managing the reuse of ImpostorSprite resources
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ImpostorSpriteManager() +
+[more]bool empty() const +
+[more]ImpostorSprite* first() +
+[more]ImpostorSprite* last() +
+[more]void push_back(ImpostorSprite* is) +
+[more]void remove(ImpostorSprite* is) +
+[more]ImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber) +
+[more]StateSet* createOrReuseStateSet() +
+[more]void reset() +

+ +

+

Protected Fields

+[more]ref_ptr<TexEnv> _texenv +
+[more]ref_ptr<AlphaFunc> _alphafunc +
+[more]ImpostorSprite* _first +
+[more]ImpostorSprite* _last +
+[more]StateSetList _stateSetList +
+[more]unsigned int _reuseStateSetIndex +

+ +

+

Protected Methods

+[more] ~ImpostorSpriteManager() +

+ +

+

Protected Members

+[more]typedef std::vector< ref_ptr<StateSet> > StateSetList +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Helper class for managing the reuse of ImpostorSprite resources
+
+ + + +
o ImpostorSpriteManager() +

+ + +

obool empty() const +

+ + +

oImpostorSprite* first() +

+ + +

oImpostorSprite* last() +

+ + +

ovoid push_back(ImpostorSprite* is) +

+ + +

ovoid remove(ImpostorSprite* is) +

+ + +

oImpostorSprite* createOrReuseImpostorSprite(int s, int t, int frameNumber) +

+ + +

oStateSet* createOrReuseStateSet() +

+ + +

ovoid reset() +

+ + +

o ~ImpostorSpriteManager() +

+ + +

oref_ptr<TexEnv> _texenv +

+ + +

oref_ptr<AlphaFunc> _alphafunc +

+ + +

oImpostorSprite* _first +

+ + +

oImpostorSprite* _last +

+ + +

otypedef std::vector< ref_ptr<StateSet> > StateSetList +

+ + +

oStateSetList _stateSetList +

+ + +

ounsigned int _reuseStateSetIndex +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/IndexArray.html b/doc/doc++/osg/IndexArray.html new file mode 100644 index 000000000..27fbc9d9f --- /dev/null +++ b/doc/doc++/osg/IndexArray.html @@ -0,0 +1,174 @@ + + + + + class SG_EXPORT osg::IndexArray + + + + +

class SG_EXPORT osg::IndexArray

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] IndexArray(Type arrayType=ArrayType, GLint dataSize=0, GLenum dataType=0) +
+[more] IndexArray(const Array& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual unsigned int index(unsigned int pos) const = 0 +

+ +

+

Protected Methods

+[more]virtual ~IndexArray() +

+ +
+

Inherited from Array:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ArrayVisitor&) +
+ovirtual void accept(ConstArrayVisitor&) const +
+ovirtual void accept(unsigned int index, ValueVisitor&) +
+ovirtual void accept(unsigned int index, ConstValueVisitor&) const +
+oType getType() const +
+oGLint getDataSize() const +
+oGLenum getDataType() const +
+ovirtual const GLvoid* getDataPointer() const +
+ovirtual unsigned int getNumElements() const +

+ +

+

Public Members

+oenum Type +

+ +

+

Protected Fields

+oType _arrayType +
+oGLint _dataSize +
+oGLenum _dataType +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o IndexArray(Type arrayType=ArrayType, GLint dataSize=0, GLenum dataType=0) +

+ + +

o IndexArray(const Array& array, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual unsigned int index(unsigned int pos) const = 0 +

+ + +

ovirtual ~IndexArray() +

+
+
Direct child classes: +
TemplateIndexArray
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/InfinitePlane.html b/doc/doc++/osg/InfinitePlane.html new file mode 100644 index 000000000..d11a4bb47 --- /dev/null +++ b/doc/doc++/osg/InfinitePlane.html @@ -0,0 +1,198 @@ + + + + + class osg::InfinitePlane + + + + +

class osg::InfinitePlane

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] InfinitePlane() +
+[more] InfinitePlane(const InfinitePlane& plane, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Shape(osg, InfinitePlane) +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+

Inherited from Plane:

+
+

+

Public Methods

+oinline void set(const Plane& pl) +
+oinline void set(float a, float b, float c, float d) +
+oinline void set(const Vec4& vec) +
+oinline void set(const Vec3& norm, float d) +
+oinline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3) +
+oinline void set(const Vec3& norm, const Vec3& point) +
+oinline void flip() +
+oinline void makeUnitLength() +
+oinline void calculateUpperLowerBBCorners() +
+oinline bool valid() const +
+oinline bool operator == (const Plane& plane) const +
+oinline bool operator != (const Plane& plane) const +
+oinline bool operator < (const Plane& plane) const +
+oinline float* ptr() +
+oinline const float* ptr() const +
+oinline Vec4& asVec4() +
+oinline const Vec4& asVec4() const +
+oinline float& operator [] (unsigned int i) +
+oinline float operator [] (unsigned int i) const +
+oinline osg::Vec3 getNormal() const +
+oinline float distance(const osg::Vec3& v) const +
+oinline int intersect(const std::vector<Vec3>& vertices) const +
+oinline int intersect(const BoundingSphere& bs) const +
+oinline int intersect(const BoundingBox& bb) const +
+oinline void transform(const osg::Matrix& matrix) +
+oinline void transformProvidingInverse(const osg::Matrix& matrix) +

+ +

+

Protected Fields

+oVec4 _fv +
+ounsigned int _upperBBCorner +
+ounsigned int _lowerBBCorner +

+ +
+ + +
+

Documentation

+
+ + + +
o InfinitePlane() +

+ + +

o InfinitePlane(const InfinitePlane& plane, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Shape(osg, InfinitePlane) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LOD.html b/doc/doc++/osg/LOD.html new file mode 100644 index 000000000..fc1fe4e1c --- /dev/null +++ b/doc/doc++/osg/LOD.html @@ -0,0 +1,483 @@ + + + + + class SG_EXPORT osg::LOD + + + + +

class SG_EXPORT osg::LOD

LOD - Level Of Detail group node which allows switching between children depending on distance from eye point.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LOD() +
+[more] LOD(const LOD&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, LOD) +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]virtual bool addChild(Node* child) +
+[more]virtual bool addChild(Node* child, float min, float max) +
+[more]virtual bool removeChild(Node* child) +
+[more]void setCenterMode(CenterMode mode) +
+[more]CenterMode getCenterMode() const +
+[more]inline void setCenter(const Vec3& center) +
Sets the object-space point which defines the center of the osg::LOD. +
+[more]inline const Vec3& getCenter() const +
return the LOD center point. +
+[more]void setRange(unsigned int childNo, float min, float max) +
Sets the min and max visible ranges of range of specifiec child. +
+[more]inline float getMinRange(unsigned int childNo) const +
returns the min visible range for specified child +
+[more]inline float getMaxRange(unsigned int childNo) const +
returns the max visible range for specified child +
+[more]inline unsigned int getNumRanges() const +
returns the number of ranges currently set. +
+[more]inline RangeList& getRangeList() +
return the list of MinMax ranges for each child +
+[more]inline const RangeList& getRangeList() const +
return the list of MinMax ranges for each child +

+ +

+

Public Members

+[more]typedef std::pair<float,float> MinMaxPair +
+[more]typedef std::vector<MinMaxPair> RangeList +
+[more]enum CenterMode +

+ +

+

Protected Fields

+[more]CenterMode _centerMode +
+[more]Vec3 _userDefinedCenter +
+[more]RangeList _rangeList +

+ +

+

Protected Methods

+[more]virtual ~LOD() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
LOD - Level Of Detail group node which allows switching between children +depending on distance from eye point. +Typical uses are for load balancing - objects further away from +the eye point are rendered at a lower level of detail, and at times +of high stress on the graphics pipeline lower levels of detail can +also be chosen. +The children are ordered from most detailed (for close up views) to the least +(see from a distance), and a set of ranges are used to decide which LOD is used +at different view distances, the criteria used is child 'i' is used when +range[i] +
+ + + +
o LOD() +

+ + +

o LOD(const LOD&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, LOD) +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovirtual bool addChild(Node* child) +

+ + +

ovirtual bool addChild(Node* child, float min, float max) +

+ + +

ovirtual bool removeChild(Node* child) +

+ + +

otypedef std::pair<float,float> MinMaxPair +

+ + +

otypedef std::vector<MinMaxPair> RangeList +

+ + +

oenum CenterMode +

+ + + +
o USE_BOUNDING_SPHERE_CENTER +

+ + +

o USER_DEFINED_CENTER +

+ + + +
ovoid setCenterMode(CenterMode mode) +

+ + +

oCenterMode getCenterMode() const +

+ + +

oinline void setCenter(const Vec3& center) +
Sets the object-space point which defines the center of the osg::LOD. +center is affected by any transforms in the hierarchy above the osg::LOD. +

+ + +

oinline const Vec3& getCenter() const +
return the LOD center point. +

+ + +

ovoid setRange(unsigned int childNo, float min, float max) +
Sets the min and max visible ranges of range of specifiec child. +Values are floating point distance specified in local objects coordinates. +

+ + +

oinline float getMinRange(unsigned int childNo) const +
returns the min visible range for specified child +

+ + +

oinline float getMaxRange(unsigned int childNo) const +
returns the max visible range for specified child +

+ + +

oinline unsigned int getNumRanges() const +
returns the number of ranges currently set. +An LOD which has been fully set up will have getNumChildren()==getNumRanges(). +

+ + +

oinline RangeList& getRangeList() +
return the list of MinMax ranges for each child +

+ + +

oinline const RangeList& getRangeList() const +
return the list of MinMax ranges for each child +

+ + +

ovirtual ~LOD() +

+ + +

oCenterMode _centerMode +

+ + +

oVec3 _userDefinedCenter +

+ + +

oRangeList _rangeList +

+
+
Direct child classes: +
Impostor
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Light.html b/doc/doc++/osg/Light.html new file mode 100644 index 000000000..96839ae09 --- /dev/null +++ b/doc/doc++/osg/Light.html @@ -0,0 +1,452 @@ + + + + + class SG_EXPORT osg::Light + + + + +

class SG_EXPORT osg::Light

Light state class which encapsulates OpenGL glLight() functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Light() +
+[more] Light(const Light& light, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Light, (Type)(LIGHT_0+_lightnum)) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setLightNum(int num) +
Set which OpenGL light to operate on +
+[more]int getLightNum() const +
Get which OpenGL light this osg::Light operates on +
+[more]inline void setAmbient( const Vec4& ambient ) +
Set the ambient component of the light. +
+[more]inline const Vec4& getAmbient() const +
Get the ambient component of the light. +
+[more]inline void setDiffuse( const Vec4& diffuse ) +
Set the diffuse component of the light. +
+[more]inline const Vec4& getDiffuse() const +
Get the diffuse component of the light. +
+[more]inline void setSpecular( const Vec4& specular ) +
Set the specular component of the light. +
+[more]inline const Vec4& getSpecular() const +
Get the specular component of the light. +
+[more]inline void setPosition( const Vec4& position ) +
Set the position of the light. +
+[more]inline const Vec4& getPosition() const +
Get the position of the light. +
+[more]inline void setDirection( const Vec3& direction ) +
Set the direction of the light. +
+[more]inline const Vec3& getDirection() const +
Get the direction of the light. +
+[more]inline void setConstantAttenuation( float constant_attenuation ) +
Set the constant attenuation of the light. +
+[more]inline float getConstantAttenuation() const +
Get the constant attenuation of the light. +
+[more]inline void setLinearAttenuation( float linear_attenuation ) +
Set the linear attenuation of the light. +
+[more]inline float getLinearAttenuation() const +
Get the linear attenuation of the light. +
+[more]inline void setQuadraticAttenuation( float quadratic_attenuation ) +
Set the quadratic attenuation of the light. +
+[more]inline float getQuadraticAttenuation() const +
Get the quadratic attenuation of the light. +
+[more]inline void setSpotExponent( float spot_exponent ) +
Set the spot exponent of the light. +
+[more]inline float getSpotExponent() const +
Get the spot exponent of the light. +
+[more]inline void setSpotCutoff( float spot_cutoff ) +
Set the spot cutoff of the light. +
+[more]inline float getSpotCutoff() const +
Get the spot cutoff of the light. +
+[more]void captureLightState() +
Capture the lighting settings of the current OpenGL state and store them in this object +
+[more]virtual void apply(State& state) const +
Apply the light's state to the OpenGL state machine. +

+ +

+

Protected Fields

+[more]int _lightnum +
+[more]Vec4 _ambient +
+[more]Vec4 _diffuse +
+[more]Vec4 _specular +
+[more]Vec4 _position +
+[more]Vec3 _direction +
+[more]float _constant_attenuation +
+[more]float _linear_attenuation +
+[more]float _quadratic_attenuation +
+[more]float _spot_exponent +
+[more]float _spot_cutoff +

+ +

+

Protected Methods

+[more]virtual ~Light() +
+[more]void init() +
Initialize the light's settings with some decent defaults. +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Light state class which encapsulates OpenGL glLight() functionality
+
+ + + +
o Light() +

+ + +

o Light(const Light& light, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Light, (Type)(LIGHT_0+_lightnum)) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setLightNum(int num) +
Set which OpenGL light to operate on +

+ + +

oint getLightNum() const +
Get which OpenGL light this osg::Light operates on +

+ + +

oinline void setAmbient( const Vec4& ambient ) +
Set the ambient component of the light. +

+ + +

oinline const Vec4& getAmbient() const +
Get the ambient component of the light. +

+ + +

oinline void setDiffuse( const Vec4& diffuse ) +
Set the diffuse component of the light. +

+ + +

oinline const Vec4& getDiffuse() const +
Get the diffuse component of the light. +

+ + +

oinline void setSpecular( const Vec4& specular ) +
Set the specular component of the light. +

+ + +

oinline const Vec4& getSpecular() const +
Get the specular component of the light. +

+ + +

oinline void setPosition( const Vec4& position ) +
Set the position of the light. +

+ + +

oinline const Vec4& getPosition() const +
Get the position of the light. +

+ + +

oinline void setDirection( const Vec3& direction ) +
Set the direction of the light. +

+ + +

oinline const Vec3& getDirection() const +
Get the direction of the light. +

+ + +

oinline void setConstantAttenuation( float constant_attenuation ) +
Set the constant attenuation of the light. +

+ + +

oinline float getConstantAttenuation() const +
Get the constant attenuation of the light. +

+ + +

oinline void setLinearAttenuation( float linear_attenuation ) +
Set the linear attenuation of the light. +

+ + +

oinline float getLinearAttenuation() const +
Get the linear attenuation of the light. +

+ + +

oinline void setQuadraticAttenuation( float quadratic_attenuation ) +
Set the quadratic attenuation of the light. +

+ + +

oinline float getQuadraticAttenuation() const +
Get the quadratic attenuation of the light. +

+ + +

oinline void setSpotExponent( float spot_exponent ) +
Set the spot exponent of the light. +

+ + +

oinline float getSpotExponent() const +
Get the spot exponent of the light. +

+ + +

oinline void setSpotCutoff( float spot_cutoff ) +
Set the spot cutoff of the light. +

+ + +

oinline float getSpotCutoff() const +
Get the spot cutoff of the light. +

+ + +

ovoid captureLightState() +
+Capture the lighting settings of the current OpenGL state +and store them in this object +

+ + +

ovirtual void apply(State& state) const +
Apply the light's state to the OpenGL state machine. +

+ + +

ovirtual ~Light() +

+ + +

ovoid init() +
Initialize the light's settings with some decent defaults. +

+ + +

oint _lightnum +

+ + +

oVec4 _ambient +

+ + +

oVec4 _diffuse +

+ + +

oVec4 _specular +

+ + +

oVec4 _position +

+ + +

oVec3 _direction +

+ + +

ofloat _constant_attenuation +

+ + +

ofloat _linear_attenuation +

+ + +

ofloat _quadratic_attenuation +

+ + +

ofloat _spot_exponent +

+ + +

ofloat _spot_cutoff +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LightModel.html b/doc/doc++/osg/LightModel.html new file mode 100644 index 000000000..2941b50a0 --- /dev/null +++ b/doc/doc++/osg/LightModel.html @@ -0,0 +1,275 @@ + + + + + class SG_EXPORT osg::LightModel + + + + +

class SG_EXPORT osg::LightModel

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LightModel() +
+[more] LightModel(const LightModel& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, LightModel, LIGHTMODEL) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setAmbientIntensity(const osg::Vec4& ambient) +
+[more]const osg::Vec4& getAmbientIntensity() const +
+[more]void setColorControl(ColorControl cc) +
+[more]inline ColorControl getColorControl() const +
+[more]void setLocalViewer(bool localViewer) +
+[more]inline bool getLocalViewer() const +
+[more]void setTwoSided(bool twoSided) +
+[more]inline bool getTwoSided() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum ColorControl +

+ +

+

Protected Fields

+[more]osg::Vec4 _ambient +
+[more]ColorControl _colorControl +
+[more]bool _localViewer +
+[more]bool _twoSided +

+ +

+

Protected Methods

+[more]virtual ~LightModel() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o LightModel() +

+ + +

o LightModel(const LightModel& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, LightModel, LIGHTMODEL) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovoid setAmbientIntensity(const osg::Vec4& ambient) +

+ + +

oconst osg::Vec4& getAmbientIntensity() const +

+ + +

oenum ColorControl +

+ + + +
o SEPARATE_SPECULAR_COLOR +

+ + +

o SINGLE_COLOR +

+ + + +
ovoid setColorControl(ColorControl cc) +

+ + +

oinline ColorControl getColorControl() const +

+ + +

ovoid setLocalViewer(bool localViewer) +

+ + +

oinline bool getLocalViewer() const +

+ + +

ovoid setTwoSided(bool twoSided) +

+ + +

oinline bool getTwoSided() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~LightModel() +

+ + +

oosg::Vec4 _ambient +

+ + +

oColorControl _colorControl +

+ + +

obool _localViewer +

+ + +

obool _twoSided +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LightSource.html b/doc/doc++/osg/LightSource.html new file mode 100644 index 000000000..28c63a19b --- /dev/null +++ b/doc/doc++/osg/LightSource.html @@ -0,0 +1,424 @@ + + + + + class SG_EXPORT osg::LightSource + + + + +

class SG_EXPORT osg::LightSource

Leaf Node for defining a light in the scene
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LightSource() +
+[more] LightSource(const LightSource& ls, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, LightSource) +
+[more]void setReferenceFrame(ReferenceFrame rf) +
Set the light sources's ReferenceFrame, either to be relative to its parent reference frame, or relative to an absolute coordinate frame. +
+[more]ReferenceFrame getReferenceFrame() const +
+[more]void setLight(StateAttribute* light) +
Set the attached light +
+[more]inline StateAttribute* getLight() +
Get the attached light +
+[more]inline const StateAttribute* getLight() const +
Get the const attached light +
+[more]void setStateSetModes(StateSet&, StateAttribute::GLModeValue) const +
Set the GLModes on StateSet associated with the LightSource +
+[more]void setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON) +
Set up the local StateSet +

+ +

+

Public Members

+[more]enum ReferenceFrame +

+ +

+

Protected Fields

+[more]StateAttribute::GLModeValue _value +
+[more]ref_ptr<StateAttribute> _light +
+[more]ReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+[more]virtual ~LightSource() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Leaf Node for defining a light in the scene
+
+ + + +
o LightSource() +

+ + +

o LightSource(const LightSource& ls, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, LightSource) +

+ + +

oenum ReferenceFrame +

+ + + +
o RELATIVE_TO_PARENTS +

+ + +

o RELATIVE_TO_ABSOLUTE +

+ + + +
ovoid setReferenceFrame(ReferenceFrame rf) +
Set the light sources's ReferenceFrame, either to be relative to its +parent reference frame, or relative to an absolute coordinate +frame. RELATIVE_TO_PARENTS is the default. +Note: setting the ReferenceFrame to be RELATIVE_TO_ABSOLUTE will +also set the CullingActive flag on the light source, and hence all +of its parents, to false, thereby disabling culling of it and +all its parents. This is neccessary to prevent inappropriate +culling, but may impact cull times if the absolute light source is +deep in the scene graph. It is therefore recommend to only use +absolute light source at the top of the scene. +

+ + +

oReferenceFrame getReferenceFrame() const +

+ + +

ovoid setLight(StateAttribute* light) +
Set the attached light +

+ + +

oinline StateAttribute* getLight() +
Get the attached light +

+ + +

oinline const StateAttribute* getLight() const +
Get the const attached light +

+ + +

ovoid setStateSetModes(StateSet&, StateAttribute::GLModeValue) const +
Set the GLModes on StateSet associated with the LightSource +

+ + +

ovoid setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON) +
Set up the local StateSet +

+ + +

ovirtual ~LightSource() +

+ + +

ovirtual bool computeBound() const +

+ + +

oStateAttribute::GLModeValue _value +

+ + +

oref_ptr<StateAttribute> _light +

+ + +

oReferenceFrame _referenceFrame +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LineSegment.html b/doc/doc++/osg/LineSegment.html new file mode 100644 index 000000000..53cfb7fba --- /dev/null +++ b/doc/doc++/osg/LineSegment.html @@ -0,0 +1,211 @@ + + + + + class SG_EXPORT osg::LineSegment + + + + +

class SG_EXPORT osg::LineSegment

LineSegment class for representing a line segment
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LineSegment() +
+[more] LineSegment(const LineSegment& seg) +
+[more] LineSegment(const Vec3& s, const Vec3& e) +
+[more]LineSegment& operator = (const LineSegment& seg) +
+[more]inline void set(const Vec3& s, const Vec3& e) +
+[more]inline Vec3& start() +
+[more]inline const Vec3& start() const +
+[more]inline Vec3& end() +
+[more]inline const Vec3& end() const +
+[more]inline bool valid() const +
+[more]bool intersect(const BoundingBox& bb) const +
return true if segment intersects BoundingBox +
+[more]bool intersect(const BoundingBox& bb, float& r1, float& r2) const +
return true if segment intersects BoundingBox and return the intersection ratio's +
+[more]bool intersect(const BoundingSphere& bs) const +
return true if segment intersects BoundingSphere +
+[more]bool intersect(const BoundingSphere& bs, float& r1, float& r2) const +
return true if segment intersects BoundingSphere and return the intersection ratio's +
+[more]bool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r) +
return true if segment intersects triangle and set ratio long segment. +
+[more]inline void mult(const LineSegment& seg, const Matrix& m) +
post multiply a segment by matrix +
+[more]inline void mult(const Matrix& m, const LineSegment& seg) +
pre multiply a segment by matrix +

+ +

+

Protected Fields

+[more]Vec3 _s +
+[more]Vec3 _e +

+ +

+

Protected Methods

+[more]virtual ~LineSegment() +
+[more]static bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb) +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
LineSegment class for representing a line segment
+
+ + + +
o LineSegment() +

+ + +

o LineSegment(const LineSegment& seg) +

+ + +

o LineSegment(const Vec3& s, const Vec3& e) +

+ + +

oLineSegment& operator = (const LineSegment& seg) +

+ + +

oinline void set(const Vec3& s, const Vec3& e) +

+ + +

oinline Vec3& start() +

+ + +

oinline const Vec3& start() const +

+ + +

oinline Vec3& end() +

+ + +

oinline const Vec3& end() const +

+ + +

oinline bool valid() const +

+ + +

obool intersect(const BoundingBox& bb) const +
return true if segment intersects BoundingBox +

+ + +

obool intersect(const BoundingBox& bb, float& r1, float& r2) const +
return true if segment intersects BoundingBox and return the intersection ratio's +

+ + +

obool intersect(const BoundingSphere& bs) const +
return true if segment intersects BoundingSphere +

+ + +

obool intersect(const BoundingSphere& bs, float& r1, float& r2) const +
return true if segment intersects BoundingSphere and return the intersection ratio's +

+ + +

obool intersect(const Vec3& v1, const Vec3& v2, const Vec3& v3, float& r) +
return true if segment intersects triangle and set ratio long segment. +

+ + +

oinline void mult(const LineSegment& seg, const Matrix& m) +
post multiply a segment by matrix +

+ + +

oinline void mult(const Matrix& m, const LineSegment& seg) +
pre multiply a segment by matrix +

+ + +

ovirtual ~LineSegment() +

+ + +

ostatic bool intersectAndClip(Vec3& s, Vec3& e, const BoundingBox& bb) +

+ + +

oVec3 _s +

+ + +

oVec3 _e +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LineStipple.html b/doc/doc++/osg/LineStipple.html new file mode 100644 index 000000000..0e73087eb --- /dev/null +++ b/doc/doc++/osg/LineStipple.html @@ -0,0 +1,224 @@ + + + + + class SG_EXPORT osg::LineStipple + + + + +

class SG_EXPORT osg::LineStipple

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LineStipple() +
+[more] LineStipple(const LineStipple& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, LineStipple, LINESTIPPLE) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setFactor(GLint factor) +
+[more]inline GLint getFactor() const +
+[more]void setPattern(GLushort pattern) +
+[more]inline GLushort getPattern() const +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]GLint _factor +
+[more]GLushort _pattern +

+ +

+

Protected Methods

+[more]virtual ~LineStipple() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o LineStipple() +

+ + +

o LineStipple(const LineStipple& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, LineStipple, LINESTIPPLE) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setFactor(GLint factor) +

+ + +

oinline GLint getFactor() const +

+ + +

ovoid setPattern(GLushort pattern) +

+ + +

oinline GLushort getPattern() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~LineStipple() +

+ + +

oGLint _factor +

+ + +

oGLushort _pattern +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/LineWidth.html b/doc/doc++/osg/LineWidth.html new file mode 100644 index 000000000..521168095 --- /dev/null +++ b/doc/doc++/osg/LineWidth.html @@ -0,0 +1,204 @@ + + + + + class SG_EXPORT osg::LineWidth + + + + +

class SG_EXPORT osg::LineWidth

LineWidth - encapsulates the OpenGL glLineWidth for setting the width of lines in pixels
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LineWidth() +
+[more] LineWidth(const LineWidth& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, LineWidth, LINEWIDTH) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setWidth(float width) +
+[more]inline float getWidth() const +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]float _width +

+ +

+

Protected Methods

+[more]virtual ~LineWidth() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
LineWidth - encapsulates the OpenGL glLineWidth for setting the width of lines in pixels
+
+ + + +
o LineWidth() +

+ + +

o LineWidth(const LineWidth& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, LineWidth, LINEWIDTH) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovoid setWidth(float width) +

+ + +

oinline float getWidth() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~LineWidth() +

+ + +

ofloat _width +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/META_Node.html b/doc/doc++/osg/META_Node.html new file mode 100644 index 000000000..e3b213b8c --- /dev/null +++ b/doc/doc++/osg/META_Node.html @@ -0,0 +1,22 @@ + + + + + #define osg::META_Node + + + + +

#define osg::META_Node

(library, name)

META_Node macro define the standard clone, isSameKindAs, className and accept methods.
+ + +
+

Documentation

+
META_Node macro define the standard clone, isSameKindAs, className +and accept methods. Use when subclassing from Node to make it +more convinient to define the required pure virtual methods.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/META_Object.html b/doc/doc++/osg/META_Object.html new file mode 100644 index 000000000..2e6cf7141 --- /dev/null +++ b/doc/doc++/osg/META_Object.html @@ -0,0 +1,23 @@ + + + + + #define osg::META_Object + + + + +

#define osg::META_Object

(library, name)

META_Object macro define the standard clone, isSameKindAs and className methods.
+ + +
+

Documentation

+
META_Object macro define the standard clone, isSameKindAs and className methods. +Use when subclassing from Object to make it more convinient to define +the standard pure virtual clone, isSameKindAs and className methods +which are required for all Object subclasses.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/META_Shape.html b/doc/doc++/osg/META_Shape.html new file mode 100644 index 000000000..4774a9b1d --- /dev/null +++ b/doc/doc++/osg/META_Shape.html @@ -0,0 +1,24 @@ + + + + + #define osg::META_Shape + + + + +

#define osg::META_Shape

(library, name)

META_StateAttribute macro define the standard clone, isSameKindAs, className and getType methods.
+ + +
+

Documentation

+
META_StateAttribute macro define the standard clone, isSameKindAs, +className and getType methods. +Use when subclassing from Object to make it more convinient to define +the standard pure virtual methods which are required for all Object +subclasses.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/META_StateAttribute.html b/doc/doc++/osg/META_StateAttribute.html new file mode 100644 index 000000000..72b575224 --- /dev/null +++ b/doc/doc++/osg/META_StateAttribute.html @@ -0,0 +1,24 @@ + + + + + #define osg::META_StateAttribute + + + + +

#define osg::META_StateAttribute

(library, name, type)

META_StateAttribute macro define the standard clone, isSameKindAs, className and getType methods.
+ + +
+

Documentation

+
META_StateAttribute macro define the standard clone, isSameKindAs, +className and getType methods. +Use when subclassing from Object to make it more convinient to define +the standard pure virtual methods which are required for all Object +subclasses.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Material.html b/doc/doc++/osg/Material.html new file mode 100644 index 000000000..bc1011412 --- /dev/null +++ b/doc/doc++/osg/Material.html @@ -0,0 +1,481 @@ + + + + + class SG_EXPORT osg::Material + + + + +

class SG_EXPORT osg::Material

Material - encapsulates OpenGL glMaterial state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Material() +
+[more] Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Material, MATERIAL) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]virtual void apply(State& state) const +
+[more]inline void setColorMode(ColorMode mode) +
+[more]inline ColorMode getColorMode() const +
+[more]void setAmbient( Face face, const Vec4& ambient ) +
+[more]const Vec4& getAmbient(Face face) const +
+[more]inline bool getAmbientFrontAndBack() const +
+[more]void setDiffuse( Face face, const Vec4& diffuse ) +
+[more]const Vec4& getDiffuse(Face face) const +
+[more]inline bool getDiffuseFrontAndBack() const +
+[more]void setSpecular( Face face, const Vec4& specular ) +
Set specular value of specified face(s) of the material, valid specular[03] range is 00 to 10 +
+[more]const Vec4& getSpecular(Face face) const +
Get the specular value for specified face +
+[more]inline bool getSpecularFrontAndBack() const +
Get the whether specular values are equal for front and back faces +
+[more]void setEmission( Face face, const Vec4& emission ) +
Set emission value of specified face(s) of the material, valid emmison[03] range is 00 to 10 +
+[more]const Vec4& getEmission(Face face) const +
Get the emmsion value for specified face +
+[more]inline bool getEmissionFrontAndBack() const +
Get the whether emission values are equal for front and back faces +
+[more]void setShininess(Face face, float shininess ) +
Set shininess of specified face(s) of the material, valid shininess range is 00 to 1280 +
+[more]float getShininess(Face face) const +
Get the shininess value for specified face +
+[more]inline bool getShininessFrontAndBack() const +
Get the whether shininess values are equal for front and back faces +
+[more]void setTransparency(Face face, float trans) +
Set the alpha value of ambient,diffuse,specular and emission colors, of specified face, to 1-transparency. +
+[more]void setAlpha(Face face, float alpha) +
Set the alpha value of ambient,diffuse,specular and emission colors. +

+ +

+

Public Members

+[more]enum Face +
+[more]enum ColorMode +

+ +

+

Protected Fields

+[more]ColorMode _colorMode +
+[more]bool _ambientFrontAndBack +
+[more]Vec4 _ambientFront +
+[more]Vec4 _ambientBack +
+[more]bool _diffuseFrontAndBack +
+[more]Vec4 _diffuseFront +
+[more]Vec4 _diffuseBack +
+[more]bool _specularFrontAndBack +
+[more]Vec4 _specularFront +
+[more]Vec4 _specularBack +
+[more]bool _emissionFrontAndBack +
+[more]Vec4 _emissionFront +
+[more]Vec4 _emissionBack +
+[more]bool _shininessFrontAndBack +
+[more]float _shininessFront +
+[more]float _shininessBack +

+ +

+

Protected Methods

+[more]virtual ~Material() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Material - encapsulates OpenGL glMaterial state
+
+ + + +
o Material() +

+ + +

o Material(const Material& mat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Material, MATERIAL) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovirtual void apply(State& state) const +

+ + +

oenum Face +

+ + + +
o FRONT +

+ + +

o BACK +

+ + +

o FRONT_AND_BACK +

+ + + +
oenum ColorMode +

+ + + +
o AMBIENT +

+ + +

o DIFFUSE +

+ + +

o SPECULAR +

+ + +

o EMISSION +

+ + +

o AMBIENT_AND_DIFFUSE +

+ + +

o OFF +

+ + + +
oinline void setColorMode(ColorMode mode) +

+ + +

oinline ColorMode getColorMode() const +

+ + +

ovoid setAmbient( Face face, const Vec4& ambient ) +

+ + +

oconst Vec4& getAmbient(Face face) const +

+ + +

oinline bool getAmbientFrontAndBack() const +

+ + +

ovoid setDiffuse( Face face, const Vec4& diffuse ) +

+ + +

oconst Vec4& getDiffuse(Face face) const +

+ + +

oinline bool getDiffuseFrontAndBack() const +

+ + +

ovoid setSpecular( Face face, const Vec4& specular ) +
Set specular value of specified face(s) of the material, +valid specular[03] range is 00 to 10 +

+ + +

oconst Vec4& getSpecular(Face face) const +
Get the specular value for specified face +

+ + +

oinline bool getSpecularFrontAndBack() const +
Get the whether specular values are equal for front and back faces +

+ + +

ovoid setEmission( Face face, const Vec4& emission ) +
Set emission value of specified face(s) of the material, +valid emmison[03] range is 00 to 10 +

+ + +

oconst Vec4& getEmission(Face face) const +
Get the emmsion value for specified face +

+ + +

oinline bool getEmissionFrontAndBack() const +
Get the whether emission values are equal for front and back faces +

+ + +

ovoid setShininess(Face face, float shininess ) +
Set shininess of specified face(s) of the material, valid shininess range is 00 to 1280 +

+ + +

ofloat getShininess(Face face) const +
Get the shininess value for specified face +

+ + +

oinline bool getShininessFrontAndBack() const +
Get the whether shininess values are equal for front and back faces +

+ + +

ovoid setTransparency(Face face, float trans) +
Set the alpha value of ambient,diffuse,specular and emission colors, +of specified face, to 1-transparency. Valid transparency range is 0.0 to 1.0. +

+ + +

ovoid setAlpha(Face face, float alpha) +
Set the alpha value of ambient,diffuse,specular and emission colors. +Valid transparency range is 0.0 to 1.0. +

+ + +

ovirtual ~Material() +

+ + +

oColorMode _colorMode +

+ + +

obool _ambientFrontAndBack +

+ + +

oVec4 _ambientFront +

+ + +

oVec4 _ambientBack +

+ + +

obool _diffuseFrontAndBack +

+ + +

oVec4 _diffuseFront +

+ + +

oVec4 _diffuseBack +

+ + +

obool _specularFrontAndBack +

+ + +

oVec4 _specularFront +

+ + +

oVec4 _specularBack +

+ + +

obool _emissionFrontAndBack +

+ + +

oVec4 _emissionFront +

+ + +

oVec4 _emissionBack +

+ + +

obool _shininessFrontAndBack +

+ + +

ofloat _shininessFront +

+ + +

ofloat _shininessBack +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Matrix.html b/doc/doc++/osg/Matrix.html new file mode 100644 index 000000000..f007c3077 --- /dev/null +++ b/doc/doc++/osg/Matrix.html @@ -0,0 +1,587 @@ + + + + + class SG_EXPORT osg::Matrix + + + + +

class SG_EXPORT osg::Matrix

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Matrix() +
+[more] Matrix( const Matrix& other) +
+[more]explicit Matrix( float const* const def ) +
+[more] Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +
+[more] ~Matrix() +
+[more]int compare(const Matrix& m) const +
+[more]bool operator < (const Matrix& m) const +
+[more]bool operator == (const Matrix& m) const +
+[more]bool operator != (const Matrix& m) const +
+[more]inline float& operator()(int row, int col) +
+[more]inline float operator()(int row, int col) const +
+[more]inline bool valid() const +
+[more]inline bool isNaN() const +
+[more]inline Matrix& operator = (const Matrix& other) +
+[more]inline void set(const Matrix& other) +
+[more]inline void set(float const* const ptr) +
+[more]void set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +
+[more]float* ptr() const +
+[more]void makeIdentity() +
+[more]void makeScale( const Vec3& ) +
+[more]void makeScale( float, float, float ) +
+[more]void makeTranslate( const Vec3& ) +
+[more]void makeTranslate( float, float, float ) +
+[more]void makeRotate( const Vec3& from, const Vec3& to ) +
+[more]void makeRotate( float angle, const Vec3& axis ) +
+[more]void makeRotate( float angle, float x, float y, float z ) +
+[more]void makeRotate( const Quat& ) +
+[more]void makeRotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+[more]void makeOrtho(double left, double right, double bottom, double top, double zNear, double zFar) +
Set to a orthographic projection. +
+[more]inline void makeOrtho2D(double left, double right, double bottom, double top) +
Set to a 2D orthographic projection. +
+[more]void makeFrustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Set to a perspective projection. +
+[more]void makePerspective(double fovy, double aspectRatio, double zNear, double zFar) +
Set to a symmetrical perspective projection, See gluPerspective for further details. +
+[more]void makeLookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
Set to the position and orientation as per a camera, using the same convention as gluLookAt. +
+[more]bool invert( const Matrix& ) +
+[more]inline static Matrix identity( void ) +
+[more]inline static Matrix scale( const Vec3& sv) +
+[more]inline static Matrix scale( float sx, float sy, float sz) +
+[more]inline static Matrix translate( const Vec3& dv) +
+[more]inline static Matrix translate( float x, float y, float z) +
+[more]inline static Matrix rotate( const Vec3& from, const Vec3& to) +
+[more]inline static Matrix rotate( float angle, float x, float y, float z) +
+[more]inline static Matrix rotate( float angle, const Vec3& axis) +
+[more]inline static Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+[more]inline static Matrix rotate( const Quat& quat) +
+[more]inline static Matrix inverse( const Matrix& matrix) +
+[more]inline static Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +
Create a orthographic projection. +
+[more]inline static Matrix ortho2D(double left, double right, double bottom, double top) +
Create a 2D orthographic projection. +
+[more]inline static Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Create a perspective projection. +
+[more]inline static Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +
Create a symmetrical perspective projection, See gluPerspective for further details. +
+[more]inline static Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
Create the position and orientation as per a camera, using the same convention as gluLookAt. +
+[more]void setTrans( float tx, float ty, float tz ) +
+[more]void setTrans( const Vec3& v ) +
+[more]inline Vec3 getTrans() const +
+[more]inline Vec3 getScale() const +
+[more]inline static Vec3 transform3x3(const Vec3& v, const Matrix& m) +
apply apply an 3x3 transform of v*M[02,02] +
+[more]inline static Vec3 transform3x3(const Matrix& m, const Vec3& v) +
apply apply an 3x3 transform of M[02,02]*v +
+[more]void mult( const Matrix&, const Matrix& ) +
+[more]void preMult( const Matrix& ) +
+[more]void postMult( const Matrix& ) +
+[more]inline void operator *= ( const Matrix& other ) +
+[more]inline Matrix operator * ( const Matrix &m ) const +
+[more]inline Matrix identity(void) +
+[more]inline Matrix scale(float sx, float sy, float sz) +
+[more]inline Matrix scale(const Vec3& v ) +
+[more]inline Matrix translate(float tx, float ty, float tz) +
+[more]inline Matrix translate(const Vec3& v ) +
+[more]inline Matrix rotate( const Quat& q ) +
+[more]inline Matrix rotate(float angle, float x, float y, float z ) +
+[more]inline Matrix rotate(float angle, const Vec3& axis ) +
+[more]inline Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+[more]inline Matrix rotate(const Vec3& from, const Vec3& to ) +
+[more]inline Matrix inverse( const Matrix& matrix) +
+[more]inline Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +
+[more]inline Matrix ortho2D(double left, double right, double bottom, double top) +
+[more]inline Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +
+[more]inline Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +
+[more]inline Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
+[more]inline Vec3 postMult( const Vec3& v ) const +
+[more]inline Vec3 preMult( const Vec3& v ) const +
+[more]inline Vec4 postMult( const Vec4& v ) const +
+[more]inline Vec4 preMult( const Vec4& v ) const +
+[more]inline Vec3 transform3x3(const Vec3& v, const Matrix& m) +
+[more]inline Vec3 transform3x3(const Matrix& m, const Vec3& v) +
+[more]inline Vec3 operator* (const Vec3& v) const +
+[more]inline Vec4 operator* (const Vec4& v) const +

+ +

+

Protected Fields

+[more]float _mat[4][4] +

+ +
+ + +
+

Documentation

+
+ + + +
o Matrix() +

+ + +

o Matrix( const Matrix& other) +

+ + +

oexplicit Matrix( float const* const def ) +

+ + +

o Matrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +

+ + +

o ~Matrix() +

+ + +

oint compare(const Matrix& m) const +

+ + +

obool operator < (const Matrix& m) const +

+ + +

obool operator == (const Matrix& m) const +

+ + +

obool operator != (const Matrix& m) const +

+ + +

oinline float& operator()(int row, int col) +

+ + +

oinline float operator()(int row, int col) const +

+ + +

oinline bool valid() const +

+ + +

oinline bool isNaN() const +

+ + +

oinline Matrix& operator = (const Matrix& other) +

+ + +

oinline void set(const Matrix& other) +

+ + +

oinline void set(float const* const ptr) +

+ + +

ovoid set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +

+ + +

ofloat* ptr() const +

+ + +

ovoid makeIdentity() +

+ + +

ovoid makeScale( const Vec3& ) +

+ + +

ovoid makeScale( float, float, float ) +

+ + +

ovoid makeTranslate( const Vec3& ) +

+ + +

ovoid makeTranslate( float, float, float ) +

+ + +

ovoid makeRotate( const Vec3& from, const Vec3& to ) +

+ + +

ovoid makeRotate( float angle, const Vec3& axis ) +

+ + +

ovoid makeRotate( float angle, float x, float y, float z ) +

+ + +

ovoid makeRotate( const Quat& ) +

+ + +

ovoid makeRotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +

+ + +

ovoid makeOrtho(double left, double right, double bottom, double top, double zNear, double zFar) +
Set to a orthographic projection. See glOrtho for further details. +

+ + +

oinline void makeOrtho2D(double left, double right, double bottom, double top) +
Set to a 2D orthographic projection. See glOrtho2D for further details. +

+ + +

ovoid makeFrustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Set to a perspective projection. See glFrustum for further details. +

+ + +

ovoid makePerspective(double fovy, double aspectRatio, double zNear, double zFar) +
Set to a symmetrical perspective projection, See gluPerspective for further details. +Aspect ratio is defined as width/height. +

+ + +

ovoid makeLookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
Set to the position and orientation as per a camera, using the same convention as gluLookAt. +

+ + +

obool invert( const Matrix& ) +

+ + +

oinline static Matrix identity( void ) +

+ + +

oinline static Matrix scale( const Vec3& sv) +

+ + +

oinline static Matrix scale( float sx, float sy, float sz) +

+ + +

oinline static Matrix translate( const Vec3& dv) +

+ + +

oinline static Matrix translate( float x, float y, float z) +

+ + +

oinline static Matrix rotate( const Vec3& from, const Vec3& to) +

+ + +

oinline static Matrix rotate( float angle, float x, float y, float z) +

+ + +

oinline static Matrix rotate( float angle, const Vec3& axis) +

+ + +

oinline static Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +

+ + +

oinline static Matrix rotate( const Quat& quat) +

+ + +

oinline static Matrix inverse( const Matrix& matrix) +

+ + +

oinline static Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +
Create a orthographic projection. See glOrtho for further details. +

+ + +

oinline static Matrix ortho2D(double left, double right, double bottom, double top) +
Create a 2D orthographic projection. See glOrtho for further details. +

+ + +

oinline static Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +
Create a perspective projection. See glFrustum for further details. +

+ + +

oinline static Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +
Create a symmetrical perspective projection, See gluPerspective for further details. +Aspect ratio is defined as width/height. +

+ + +

oinline static Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
Create the position and orientation as per a camera, using the same convention as gluLookAt. +

+ + +

ovoid setTrans( float tx, float ty, float tz ) +

+ + +

ovoid setTrans( const Vec3& v ) +

+ + +

oinline Vec3 getTrans() const +

+ + +

oinline Vec3 getScale() const +

+ + +

oinline static Vec3 transform3x3(const Vec3& v, const Matrix& m) +
apply apply an 3x3 transform of v*M[02,02] +

+ + +

oinline static Vec3 transform3x3(const Matrix& m, const Vec3& v) +
apply apply an 3x3 transform of M[02,02]*v +

+ + +

ovoid mult( const Matrix&, const Matrix& ) +

+ + +

ovoid preMult( const Matrix& ) +

+ + +

ovoid postMult( const Matrix& ) +

+ + +

oinline void operator *= ( const Matrix& other ) +

+ + +

oinline Matrix operator * ( const Matrix &m ) const +

+ + +

ofloat _mat[4][4] +

+ + +

oinline Matrix identity(void) +

+ + +

oinline Matrix scale(float sx, float sy, float sz) +

+ + +

oinline Matrix scale(const Vec3& v ) +

+ + +

oinline Matrix translate(float tx, float ty, float tz) +

+ + +

oinline Matrix translate(const Vec3& v ) +

+ + +

oinline Matrix rotate( const Quat& q ) +

+ + +

oinline Matrix rotate(float angle, float x, float y, float z ) +

+ + +

oinline Matrix rotate(float angle, const Vec3& axis ) +

+ + +

oinline Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +

+ + +

oinline Matrix rotate(const Vec3& from, const Vec3& to ) +

+ + +

oinline Matrix inverse( const Matrix& matrix) +

+ + +

oinline Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +

+ + +

oinline Matrix ortho2D(double left, double right, double bottom, double top) +

+ + +

oinline Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +

+ + +

oinline Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +

+ + +

oinline Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +

+ + +

oinline Vec3 postMult( const Vec3& v ) const +

+ + +

oinline Vec3 preMult( const Vec3& v ) const +

+ + +

oinline Vec4 postMult( const Vec4& v ) const +

+ + +

oinline Vec4 preMult( const Vec4& v ) const +

+ + +

oinline Vec3 transform3x3(const Vec3& v, const Matrix& m) +

+ + +

oinline Vec3 transform3x3(const Matrix& m, const Vec3& v) +

+ + +

oinline Vec3 operator* (const Vec3& v) const +

+ + +

oinline Vec4 operator* (const Vec4& v) const +

+
+
Direct child classes: +
RefMatrix
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/MatrixTransform.html b/doc/doc++/osg/MatrixTransform.html new file mode 100644 index 000000000..6000960a4 --- /dev/null +++ b/doc/doc++/osg/MatrixTransform.html @@ -0,0 +1,457 @@ + + + + + class SG_EXPORT osg::MatrixTransform + + + + +

class SG_EXPORT osg::MatrixTransform

MatrixTransform - is a subclass of Transform which has an osg::Matrix which represent a 4x4 transformation of its children from local cordinates into the Transform's parent coordinates
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] MatrixTransform() +
+[more] MatrixTransform(const MatrixTransform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] MatrixTransform(const Matrix& matix) +
+[more] META_Node(osg, MatrixTransform) +
+[more]virtual MatrixTransform* asMatrixTransform() +
+[more]virtual const MatrixTransform* asMatrixTransform() const +
+[more]void setMatrix(const Matrix& mat) +
Set the transform's matrix +
+[more]inline const Matrix& getMatrix() const +
Get the matrix. +
+[more]void preMult(const Matrix& mat) +
pre multiply the transforms matrix +
+[more]void postMult(const Matrix& mat) +
post multiply the transforms matrix +
+[more]inline const Matrix& getInverseMatrix() const +
Get the inverse matrix. +
+[more]virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const +
+[more]virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const +

+ +

+

Protected Fields

+[more]Matrix _matrix +
+[more]mutable Matrix _inverse +
+[more]mutable bool _inverseDirty +

+ +

+

Protected Methods

+[more]virtual ~MatrixTransform() +

+ +
+

Inherited from Transform:

+
+

+

Public Methods

+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual PositionAttitudeTransform* asPositionAttitudeTransform() +
+ovirtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +
+ovirtual DOFTransform* asDOFTransform() +
+ovirtual const DOFTransform* asDOFTransform() const +
+ovoid setReferenceFrame(ReferenceFrame rf) +
+oReferenceFrame getReferenceFrame() const +
+ovoid setComputeTransformCallback(ComputeTransformCallback* ctc) +
+oComputeTransformCallback* getComputeTransformCallback() +
+oconst ComputeTransformCallback* getComputeTransformCallback() const +
+oinline bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+oinline bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Public Members

+oenum ReferenceFrame +
+ostruct ComputeTransformCallback: public virtual osg::Referenced +

+ +

+

Protected Fields

+oref_ptr<ComputeTransformCallback> _computeTransformCallback +
+oReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
MatrixTransform - is a subclass of Transform which has an osg::Matrix +which represent a 4x4 transformation of its children from local cordinates +into the Transform's parent coordinates
+
+ + + +
o MatrixTransform() +

+ + +

o MatrixTransform(const MatrixTransform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o MatrixTransform(const Matrix& matix) +

+ + +

o META_Node(osg, MatrixTransform) +

+ + +

ovirtual MatrixTransform* asMatrixTransform() +

+ + +

ovirtual const MatrixTransform* asMatrixTransform() const +

+ + +

ovoid setMatrix(const Matrix& mat) +
Set the transform's matrix +

+ + +

oinline const Matrix& getMatrix() const +
Get the matrix. +

+ + +

ovoid preMult(const Matrix& mat) +
pre multiply the transforms matrix +

+ + +

ovoid postMult(const Matrix& mat) +
post multiply the transforms matrix +

+ + +

oinline const Matrix& getInverseMatrix() const +
Get the inverse matrix. +

+ + +

ovirtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const +

+ + +

ovirtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const +

+ + +

ovirtual ~MatrixTransform() +

+ + +

oMatrix _matrix +

+ + +

omutable Matrix _inverse +

+ + +

omutable bool _inverseDirty +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NavigatorButton.class b/doc/doc++/osg/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..5fa134ee0f22ae5659bc0091d4cc98b3e6a0532a GIT binary patch literal 1816 zcma)7S#ujj5dOxJHIlr(EguO9h9t&b+fld=C4tzn6A=-+FmbSpYrI~`YgW5rHIi-4 z-$D2RyyS%xl7Uq5NUHcz6g{)6i}C{x>hAfbr|)h3{m&nNB8FxBki?B7wvzaWqrh>W zV}s)pjxRY}jxvYG;d4|tzTyZtsvI(n6z0ROx-Zk(Yb`5-w z+YE!VPIWf#NjoSC%VrpzUnm@ky2y$nnO*linPZq}VXp8>*)173UWwq?{K7WF_%P`iZr@g7ia}n61-1WX4!P5UyT&Wd{c0d95 zs7FSkY`ZdRt7p2cx6~=TsWb3=UIo5##!VQvXUpt^4+~KhM5W>qa7(jQDzbenbGy5t zkxnX)xbAq4yvdMWbw#y$ClHkbhT+cPs_Iz}vMD^xc6Ni!s=rnV?kV}?S!m9YYROSs!2aKxT#Q&7YAMcpY0=?5z{DSeM(-tudK zWv@FfCBSHu62ej$D4|lZy?x4dPiGh3^IbY66;pvQa4W1iNhMo`Sh5uOM+Lh`*9phl zr;#NCs_Iljr`q*}q#Y?-#|mG~gx|^;HKCZ>-%%^(p*EsxMC0EDlqXx9{5MMeXCa13G`PhdY2@n-wGmD3uqX5UCrA@5ujCwKO;dq7Wm0rJjIxq>2KhIx!k~v zxzxa%nTa=W-pnK#xNK&41J9YiV)_}z&8IMS#$xdi;}jDOOcQ*u1NTSpMS?Hs!+@!*H1Ptl%a6k2G#!7@!807-y(s88 z#7P3qMHa{U$e!86xh689#nzk8u@b$xhCcdlgU(>?FHDk?8RhqPT~V#~za| R#{{M@M4Akr679nW{{js3#=-yq literal 0 HcmV?d00001 diff --git a/doc/doc++/osg/Node.html b/doc/doc++/osg/Node.html new file mode 100644 index 000000000..93edf1d70 --- /dev/null +++ b/doc/doc++/osg/Node.html @@ -0,0 +1,697 @@ + + + + + class SG_EXPORT osg::Node + + + + +

class SG_EXPORT osg::Node

Base class for all internal nodes in the scene graph.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Node() +
Construct a node. +
+[more] Node(const Node&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
clone the an object of the same type as the node +
+[more]virtual Object* clone(const CopyOp& copyop) const +
return a clone of a node, with Object* return type +
+[more]virtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +
+[more]virtual const char* libraryName() const +
return the name of the node's library +
+[more]virtual const char* className() const +
return the name of the node's class type +
+[more]virtual Group* asGroup() +
convert 'this' into a Group pointer if Node is a Group, otherwise return 0. +
+[more]virtual const Group* asGroup() const +
convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. +
+[more]virtual Transform* asTransform() +
convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. +
+[more]virtual const Transform* asTransform() const +
convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. +
+[more]virtual void accept(NodeVisitor& nv) +
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type +
+[more]virtual void ascend(NodeVisitor& nv) +
Traverse upwards : calls parents' accept method with NodeVisitor +
+[more]virtual void traverse(NodeVisitor& ) +
Traverse downwards : calls children's accept method with NodeVisitor +
+[more]inline void setName( const std::string& name ) +
Set the name of node using C++ style string +
+[more]inline void setName( const char* name ) +
Set the name of node using a C style string +
+[more]inline const std::string& getName() const +
Get the name of node +
+[more]inline const ParentList& getParents() const +
Get the parent list of node. +
+[more]inline ParentList getParents() +
Get the a copy of parent list of node. +
+[more]inline Group* getParent(unsigned int i) +
+[more]inline const Group* getParent(unsigned int i) const +
Get a single const parent of node. +
+[more]inline unsigned int getNumParents() const +
Get the number of parents of node. +
+[more]void setUpdateCallback(NodeCallback* nc) +
Set update node callback, called during update traversal. +
+[more]inline NodeCallback* getUpdateCallback() +
Get update node callback, called during update traversal. +
+[more]inline const NodeCallback* getUpdateCallback() const +
Get const update node callback, called during update traversal. +
+[more]void setAppCallback(NodeCallback* nc) +
deprecated. +
+[more]inline NodeCallback* getAppCallback() +
deprecated. +
+[more]inline const NodeCallback* getAppCallback() const +
deprecated. +
+[more]inline unsigned int getNumChildrenRequiringUpdateTraversal() const +
Get the number of Children of this node which require App traversal, since they have an AppCallback attached to them or their children +
+[more]void setCullCallback(NodeCallback* nc) +
Set cull node callback, called during cull traversal. +
+[more]inline NodeCallback* getCullCallback() +
Get cull node callback, called during cull traversal. +
+[more]inline const NodeCallback* getCullCallback() const +
Get const cull node callback, called during cull traversal. +
+[more]void setCullingActive(bool active) +
Set the view frustum/small feature culling of this node to be active or inactive. +
+[more]inline bool getCullingActive() const +
Get the view frustum/small feature _cullingActive flag for this node. +
+[more]inline unsigned int getNumChildrenWithCullingDisabled() const +
Get the number of Children of this node which have culling disabled +
+[more]inline bool isCullingActive() const +
Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. +
+[more]inline unsigned int getNumChildrenWithOccluderNodes() const +
Get the number of Children of this node which are or have OccluderNode's +
+[more]bool containsOccluderNodes() const +
return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes +
+[more]inline void setNodeMask(NodeMask nm) +
Set the node mask. +
+[more]inline NodeMask getNodeMask() const +
Get the node Mask. +
+[more]inline const DescriptionList& getDescriptions() const +
Get the description list of the const node +
+[more]inline DescriptionList& getDescriptions() +
Get the description list of the const node +
+[more]inline const std::string& getDescription(unsigned int i) const +
Get a single const description of the const node +
+[more]inline std::string& getDescription(unsigned int i) +
Get a single description of the node +
+[more]inline unsigned int getNumDescriptions() const +
Get the number of descriptions of the node +
+[more]void addDescription(const std::string& desc) +
Add a description string to the node +
+[more]inline void setStateSet(osg::StateSet* dstate) +
set the node's StateSet +
+[more]osg::StateSet* getOrCreateStateSet() +
return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. +
+[more]inline osg::StateSet* getStateSet() +
return the node's StateSet. +
+[more]inline const osg::StateSet* getStateSet() const +
return the node's const StateSet. +
+[more]inline const BoundingSphere& getBound() const +
get the bounding sphere of node. +
+[more]void dirtyBound() +
Mark this node's bounding sphere dirty. +

+ +

+

Public Members

+[more]typedef std::vector<Group*> ParentList +
A vector of osg::Group pointers which is used to store the parent(s) of node +
+[more]typedef unsigned int NodeMask +
+[more]typedef std::vector<std::string> DescriptionList +
A vector of std::string's which are used to describe the object +

+ +

+

Protected Fields

+[more]mutable BoundingSphere _bsphere +
+[more]mutable bool _bsphere_computed +
+[more]std::string _name +
+[more]ParentList _parents +
+[more]ref_ptr<NodeCallback> _updateCallback +
+[more]unsigned int _numChildrenRequiringUpdateTraversal +
+[more]ref_ptr<NodeCallback> _cullCallback +
+[more]bool _cullingActive +
+[more]unsigned int _numChildrenWithCullingDisabled +
+[more]unsigned int _numChildrenWithOccluderNodes +
+[more]NodeMask _nodeMask +
+[more]DescriptionList _descriptions +
+[more]ref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+[more]virtual ~Node() +
Node destructor. +
+[more]virtual bool computeBound() const +
Compute the bounding sphere around Node's geometry or children. +
+[more]void addParent(osg::Group* node) +
+[more]void removeParent(osg::Group* node) +
+[more]void setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+[more]void setNumChildrenWithCullingDisabled(unsigned int num) +
+[more]void setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Base class for all internal nodes in the scene graph. +Provides interface for most common node operations (Composite Pattern).
+
+ + + +
o Node() +
Construct a node. +Initialize the parent list to empty, node name to "" and +bounding sphere dirty flag to true. +

+ + +

o Node(const Node&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +
clone the an object of the same type as the node +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +
return a clone of a node, with Object* return type +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +

+ + +

ovirtual const char* libraryName() const +
return the name of the node's library +

+ + +

ovirtual const char* className() const +
return the name of the node's class type +

+ + +

ovirtual Group* asGroup() +
convert 'this' into a Group pointer if Node is a Group, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

ovirtual const Group* asGroup() const +
convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

ovirtual Transform* asTransform() +
convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

ovirtual const Transform* asTransform() const +
convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. +Equivalent to dynamic_cast(this). +

+ + +

ovirtual void accept(NodeVisitor& nv) +
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type +

+ + +

ovirtual void ascend(NodeVisitor& nv) +
Traverse upwards : calls parents' accept method with NodeVisitor +

+ + +

ovirtual void traverse(NodeVisitor& ) +
Traverse downwards : calls children's accept method with NodeVisitor +

+ + +

oinline void setName( const std::string& name ) +
Set the name of node using C++ style string +

+ + +

oinline void setName( const char* name ) +
Set the name of node using a C style string +

+ + +

oinline const std::string& getName() const +
Get the name of node +

+ + +

otypedef std::vector<Group*> ParentList +
A vector of osg::Group pointers which is used to store the parent(s) of node +

+ + +

oinline const ParentList& getParents() const +
Get the parent list of node. +

+ + +

oinline ParentList getParents() +
Get the a copy of parent list of node. A copy is returned to +prevent modification of the parent list. +

+ + +

oinline Group* getParent(unsigned int i) +

+ + +

oinline const Group* getParent(unsigned int i) const +
+Get a single const parent of node. + +
Parameters:
i - index of the parent to get. +
Returns:
the parent i.

+ + +

oinline unsigned int getNumParents() const +
+Get the number of parents of node. + +
Returns:
the number of parents of this node.

+ + +

ovoid setUpdateCallback(NodeCallback* nc) +
Set update node callback, called during update traversal. +

+ + +

oinline NodeCallback* getUpdateCallback() +
Get update node callback, called during update traversal. +

+ + +

oinline const NodeCallback* getUpdateCallback() const +
Get const update node callback, called during update traversal. +

+ + +

ovoid setAppCallback(NodeCallback* nc) +
deprecated. +

+ + +

oinline NodeCallback* getAppCallback() +
deprecated. +

+ + +

oinline const NodeCallback* getAppCallback() const +
deprecated. +

+ + +

oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
Get the number of Children of this node which require App traversal, +since they have an AppCallback attached to them or their children +

+ + +

ovoid setCullCallback(NodeCallback* nc) +
Set cull node callback, called during cull traversal. +

+ + +

oinline NodeCallback* getCullCallback() +
Get cull node callback, called during cull traversal. +

+ + +

oinline const NodeCallback* getCullCallback() const +
Get const cull node callback, called during cull traversal. +

+ + +

ovoid setCullingActive(bool active) +
Set the view frustum/small feature culling of this node to be active or inactive. +The default value to true for _cullingActive. Used a guide +to the cull traversal. +

+ + +

oinline bool getCullingActive() const +
Get the view frustum/small feature _cullingActive flag for this node. Used a guide +to the cull traversal. +

+ + +

oinline unsigned int getNumChildrenWithCullingDisabled() const +
Get the number of Children of this node which have culling disabled +

+ + +

oinline bool isCullingActive() const +
Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. +note, return true only if no children have culling disabled, and the local _cullingActive flag is true. +

+ + +

oinline unsigned int getNumChildrenWithOccluderNodes() const +
Get the number of Children of this node which are or have OccluderNode's +

+ + +

obool containsOccluderNodes() const +
return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes +

+ + +

otypedef unsigned int NodeMask +

+ + +

oinline void setNodeMask(NodeMask nm) +
Set the node mask. Note, node mask is will be replaced by TraversalMask. +

+ + +

oinline NodeMask getNodeMask() const +
Get the node Mask. Note, node mask is will be replaced by TraversalMask. +

+ + +

otypedef std::vector<std::string> DescriptionList +
A vector of std::string's which are used to describe the object +

+ + +

oinline const DescriptionList& getDescriptions() const +
Get the description list of the const node +

+ + +

oinline DescriptionList& getDescriptions() +
Get the description list of the const node +

+ + +

oinline const std::string& getDescription(unsigned int i) const +
Get a single const description of the const node +

+ + +

oinline std::string& getDescription(unsigned int i) +
Get a single description of the node +

+ + +

oinline unsigned int getNumDescriptions() const +
Get the number of descriptions of the node +

+ + +

ovoid addDescription(const std::string& desc) +
Add a description string to the node +

+ + +

oinline void setStateSet(osg::StateSet* dstate) +
set the node's StateSet +

+ + +

oosg::StateSet* getOrCreateStateSet() +
return the node's StateSet, if one does not already exist create it +set the node and return the newly created StateSet. This ensures +that a valid StateSet is always returned and can be used directly. +

+ + +

oinline osg::StateSet* getStateSet() +
return the node's StateSet. returns NULL if a stateset is not attached. +

+ + +

oinline const osg::StateSet* getStateSet() const +
return the node's const StateSet. returns NULL if a stateset is not attached. +

+ + +

oinline const BoundingSphere& getBound() const +
get the bounding sphere of node. +Using lazy evaluation computes the bounding sphere if it is 'dirty'. +

+ + +

ovoid dirtyBound() +
Mark this node's bounding sphere dirty. +Forcing it to be computed on the next call to getBound(). +

+ + +

ovirtual ~Node() +
Node destructor. Note, is protected so that Nodes cannot +be deleted other than by being dereferenced and the reference +count being zero (see osg::Referenced), preventing the deletion +of nodes which are still in use. This also means that +Node's cannot be created on stack i.e Node node will not compile, +forcing all nodes to be created on the heap i.e Node* node += new Node(). +

+ + +

ovirtual bool computeBound() const +
Compute the bounding sphere around Node's geometry or children. +This method is automatically called by getBound() when the bounding +sphere has been marked dirty via dirtyBound(). +

+ + +

omutable BoundingSphere _bsphere +

+ + +

omutable bool _bsphere_computed +

+ + +

ostd::string _name +

+ + +

ovoid addParent(osg::Group* node) +

+ + +

ovoid removeParent(osg::Group* node) +

+ + +

oParentList _parents +

+ + +

oref_ptr<NodeCallback> _updateCallback +

+ + +

ounsigned int _numChildrenRequiringUpdateTraversal +

+ + +

ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +

+ + +

oref_ptr<NodeCallback> _cullCallback +

+ + +

obool _cullingActive +

+ + +

ounsigned int _numChildrenWithCullingDisabled +

+ + +

ovoid setNumChildrenWithCullingDisabled(unsigned int num) +

+ + +

ounsigned int _numChildrenWithOccluderNodes +

+ + +

ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ + +

oNodeMask _nodeMask +

+ + +

oDescriptionList _descriptions +

+ + +

oref_ptr<StateSet> _stateset +

+
+
Direct child classes: +
Group
+Geode
+
+ +
Friends:
class osg::Group
class osg::Drawable

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NodeAcceptOp.html b/doc/doc++/osg/NodeAcceptOp.html new file mode 100644 index 000000000..370f33454 --- /dev/null +++ b/doc/doc++/osg/NodeAcceptOp.html @@ -0,0 +1,51 @@ + + + + + struct osg::NodeAcceptOp + + + + +

struct osg::NodeAcceptOp

Convenience functor for assisting visiting of arrays of osg::Node's
+ +
+

+
+[more]NodeVisitor& _nv +
+[more] NodeAcceptOp(NodeVisitor& nv) +
+[more]void operator () (Node* node) +
+[more]void operator () (ref_ptr<Node> node) +

+ + + +
+

Documentation

+
Convenience functor for assisting visiting of arrays of osg::Node's
+
+ + + +
oNodeVisitor& _nv +

+ + +

o NodeAcceptOp(NodeVisitor& nv) +

+ + +

ovoid operator () (Node* node) +

+ + +

ovoid operator () (ref_ptr<Node> node) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NodeCallback.html b/doc/doc++/osg/NodeCallback.html new file mode 100644 index 000000000..dfb37c10e --- /dev/null +++ b/doc/doc++/osg/NodeCallback.html @@ -0,0 +1,173 @@ + + + + + class SG_EXPORT osg::NodeCallback + + + + +

class SG_EXPORT osg::NodeCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]ref_ptr<NodeCallback> _nestedCallback +

+ +

+

Public Methods

+[more] NodeCallback() +
+[more] NodeCallback(const NodeCallback&, const CopyOp&) +
+[more]META_Object(osg, NodeCallback) ()(Node* node, NodeVisitor* nv) +
+[more]void traverse(Node* node, NodeVisitor* nv) +
Call any nested callbacks and then traverse the scene graph. +
+[more]void setNestedCallback(NodeCallback* nc) +
+[more]NodeCallback* getNestedCallback() +
+[more]inline void addNestedCallback(NodeCallback* nc) +
+[more]inline void removeNestedCallback(NodeCallback* nc) +

+ +

+

Protected Methods

+[more]virtual ~NodeCallback() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o NodeCallback() +

+ + +

o NodeCallback(const NodeCallback&, const CopyOp&) +

+ + +

oMETA_Object(osg, NodeCallback) ()(Node* node, NodeVisitor* nv) +

+ + +

ovoid traverse(Node* node, NodeVisitor* nv) +
Call any nested callbacks and then traverse the scene graph. +

+ + +

ovoid setNestedCallback(NodeCallback* nc) +

+ + +

oNodeCallback* getNestedCallback() +

+ + +

oinline void addNestedCallback(NodeCallback* nc) +

+ + +

oinline void removeNestedCallback(NodeCallback* nc) +

+ + +

oref_ptr<NodeCallback> _nestedCallback +

+ + +

ovirtual ~NodeCallback() +

+
+
Direct child classes: +
AnimationPathCallback
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NodePath.html b/doc/doc++/osg/NodePath.html new file mode 100644 index 000000000..43550096d --- /dev/null +++ b/doc/doc++/osg/NodePath.html @@ -0,0 +1,20 @@ + + + + + typedef std::vector<Node*> osg::NodePath + + + + +

typedef std::vector<Node*> osg::NodePath

A vector of Nodes pointers which is used to describe the path from a root node to a descendant
+ + +
+

Documentation

+
A vector of Nodes pointers which is used to describe the path from a root node to a descendant
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NodeVisitor.html b/doc/doc++/osg/NodeVisitor.html new file mode 100644 index 000000000..96e96814b --- /dev/null +++ b/doc/doc++/osg/NodeVisitor.html @@ -0,0 +1,535 @@ + + + + + class SG_EXPORT osg::NodeVisitor + + + + +

class SG_EXPORT osg::NodeVisitor

Visitor for type safe operations on osg::Node's.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] NodeVisitor(TraversalMode tm=TRAVERSE_NONE) +
+[more] NodeVisitor(VisitorType type, TraversalMode tm=TRAVERSE_NONE) +
+[more]virtual ~NodeVisitor() +
+[more]virtual void reset() +
Method to call to reset visitor. +
+[more]inline void setVisitorType(VisitorType type) +
Set the VisitorType, used to distingush different visitors during traversal of the scene, typically used in the Node::traverse() method to select which behaviour to use for different types of traversal/visitors +
+[more]inline VisitorType getVisitorType() const +
Get the VisitorType +
+[more]inline void setTraversalNumber(int fn) +
Set the traversal number. +
+[more]inline int getTraversalNumber() const +
Get the traversal number. +
+[more]inline void setFrameStamp(FrameStamp* fs) +
Set the FrameStamp that this traversal is assoicated with +
+[more]inline const FrameStamp* getFrameStamp() const +
Get the FrameStamp that this traversal is assoicated with +
+[more]inline void setTraversalMask(Node::NodeMask mask) +
Set the TraversalMask of this NodeVisitor. +
+[more]inline Node::NodeMask getTraversalMask() const +
Get the TraversalMask +
+[more]inline void setNodeMaskOverride(Node::NodeMask mask) +
Set the NodeMaskOverride mask. +
+[more]inline Node::NodeMask getNodeMaskOverride() const +
Get the NodeMaskOverride mask +
+[more]inline bool validNodeMask(const osg::Node& node) const +
Method to called by Node and its subclass' Node::accept() method, if the result is true to be used to cull operations of nodes and their subgraphs. +
+[more]inline void setTraversalMode(TraversalMode mode) +
Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse. +
+[more]inline TraversalMode getTraversalMode() const +
Get the traversal mode +
+[more]inline void traverse(Node& node) +
Method for handling traversal of a nodes. +
+[more]inline void pushOntoNodePath(Node* node) +
Method called by osg::Node::accept() method before a call the NodeVisitor::apply(). +
+[more]inline void popFromNodePath() +
Method callby osg::Node::accept() method after a call the NodeVisitor::apply(). +
+[more]NodePath& getNodePath() +
Get the non const NodePath from the top most node applied down to the current Node being visited +
+[more]const NodePath& getNodePath() const +
Get the const NodePath from the top most node applied down to the current Node being visited +
+[more]virtual bool getLocalToWorldMatrix(Matrix& matrix, Node* node) +
Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u +
+[more]virtual bool getWorldToLocalMatrix(Matrix& matrix, Node* node) +
Get the World To Local Matrix from the NodePath for specified Transform::Mode +
+[more]virtual osg::Vec3 getEyePoint() const +
Get the eye point in local coordinates. +
+[more]virtual float getDistanceToEyePoint(const Vec3& , bool ) const +
Get the distance from a point to the eye point, distance value in local coordinate system. +
+[more]virtual float getDistanceFromEyePoint(const Vec3& , bool ) const +
Get the distance of a point from the eye point, distance value in the eye coordinate system. +
+[more]virtual void apply(Node& node) +
+[more]virtual void apply(Geode& node) +
+[more]virtual void apply(Billboard& node) +
+[more]virtual void apply(Group& node) +
+[more]virtual void apply(Projection& node) +
+[more]virtual void apply(ClipNode& node) +
+[more]virtual void apply(LightSource& node) +
+[more]virtual void apply(Transform& node) +
+[more]virtual void apply(DOFTransform& node) +
+[more]virtual void apply(MatrixTransform& node) +
+[more]virtual void apply(PositionAttitudeTransform& node) +
+[more]virtual void apply(Switch& node) +
+[more]virtual void apply(Sequence& node) +
+[more]virtual void apply(LOD& node) +
+[more]virtual void apply(Impostor& node) +
+[more]virtual void apply(ClearNode& node) +
+[more]virtual void apply(OccluderNode& node) +

+ +

+

Public Members

+[more]enum TraversalMode +
+[more]enum VisitorType +

+ +

+

Protected Fields

+[more]VisitorType _visitorType +
+[more]int _traversalNumber +
+[more]ref_ptr<FrameStamp> _frameStamp +
+[more]TraversalMode _traversalMode +
+[more]Node::NodeMask _traversalMask +
+[more]Node::NodeMask _nodeMaskOverride +
+[more]NodePath _nodePath +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Visitor for type safe operations on osg::Node's. +Based on GOF's Visitor pattern. The NodeVisitor +is useful for developing type safe operations to nodes +in the scene graph (as per Visitor pattern), and adds to this +support for optional scene graph traversal to allow +operations to be applied to whole scenes at once. The Visitor +pattern uses a technique of double dispatch as a mechanism to +called the appropriate apply(..) method of the NodeVisitor. To +use this feature one must use the Node::accept(NodeVisitor) which +is extended in each Node subclass, rather than the NodeVisitor +apply directly. So use root->accept(myVisitor); instead of +myVisitor.apply(*root). The later method will bypass the double +dispatch and the appropriate NodeVisitor::apply(..) method will +not be called.
+
+ + + +
oenum TraversalMode +

+ + + +
o TRAVERSE_NONE +

+ + +

o TRAVERSE_PARENTS +

+ + +

o TRAVERSE_ALL_CHILDREN +

+ + +

o TRAVERSE_ACTIVE_CHILDREN +

+ + + +
oenum VisitorType +

+ + + +
o NODE_VISITOR +

+ + +

o UPDATE_VISITOR +

+ + +

o COLLECT_OCCLUDER_VISITOR +

+ + +

o CULL_VISITOR +

+ + + +
o NodeVisitor(TraversalMode tm=TRAVERSE_NONE) +

+ + +

o NodeVisitor(VisitorType type, TraversalMode tm=TRAVERSE_NONE) +

+ + +

ovirtual ~NodeVisitor() +

+ + +

ovirtual void reset() +
Method to call to reset visitor. Useful for your visitor accumulates +state during a traversal, and you plan to reuse the visitor. +To flush that state for the next traversal than call reset() prior +to each traversal. +

+ + +

oinline void setVisitorType(VisitorType type) +
Set the VisitorType, used to distingush different visitors during +traversal of the scene, typically used in the Node::traverse() method +to select which behaviour to use for different types of traversal/visitors +

+ + +

oinline VisitorType getVisitorType() const +
Get the VisitorType +

+ + +

oinline void setTraversalNumber(int fn) +
Set the traversal number. Typically used to denote the frame count. +

+ + +

oinline int getTraversalNumber() const +
Get the traversal number. Typically used to denote the frame count. +

+ + +

oinline void setFrameStamp(FrameStamp* fs) +
Set the FrameStamp that this traversal is assoicated with +

+ + +

oinline const FrameStamp* getFrameStamp() const +
Get the FrameStamp that this traversal is assoicated with +

+ + +

oinline void setTraversalMask(Node::NodeMask mask) +
Set the TraversalMask of this NodeVisitor. +The TraversalMask is used by the NodeVisitor::validNodeMask() method +to determine whether to operate on a node and its subgraph. +validNodeMask() is called automaticaly in the Node::accept() method before +any call to NodeVisitor::apply(), apply() is only ever called if validNodeMask +returns true. Note, if NodeVisitor::_traversalMask is 0 then all operations +will be swithced off for all nodes. Whereas setting both _traversalMask and +_nodeMaskOverride to 0xffffffff will allow a visitor to work on all nodes +regardless of their own Node::_nodeMask state. +

+ + +

oinline Node::NodeMask getTraversalMask() const +
Get the TraversalMask +

+ + +

oinline void setNodeMaskOverride(Node::NodeMask mask) +
Set the NodeMaskOverride mask. +Used in validNodeMask() to determine whether to operate on a node or its +subgraph, by OR'ing NodeVisitor::_nodeMaskOverride with the Node's own Node::_nodeMask. +Typically used to force on nodes which may have +been switched off by their own Node::_nodeMask. +

+ + +

oinline Node::NodeMask getNodeMaskOverride() const +
Get the NodeMaskOverride mask +

+ + +

oinline bool validNodeMask(const osg::Node& node) const +
Method to called by Node and its subclass' Node::accept() method, if the result is true +to be used to cull operations of nodes and their subgraphs. +Return true if the result of a bit wise and of the NodeVisitor::_traversalMask +with the bit or between NodeVistor::_nodeMaskOverride and the Node::_nodeMask. +default values for _traversalMask is 0xffffffff, _nodeMaskOverride is 0x0, +and osg::Node::_nodeMask is 0xffffffff. +

+ + +

oinline void setTraversalMode(TraversalMode mode) +
Set the traversal mode for Node::traverse() to use when +deciding which children of a node to traverse. If a +NodeVisitor has been attached via setTraverseVisitor() +and the new mode is not TRAVERSE_VISITOR then the attached +visitor is detached. Default mode is TRAVERSE_NONE. +

+ + +

oinline TraversalMode getTraversalMode() const +
Get the traversal mode +

+ + +

oinline void traverse(Node& node) +
Method for handling traversal of a nodes. +If you intend to use the visitor for actively traversing +the scene graph then make sure the accept() methods call +this method unless they handle traversal directly. +

+ + +

oinline void pushOntoNodePath(Node* node) +
Method called by osg::Node::accept() method before +a call the NodeVisitor::apply(). The back of the list will, +therefore, be the current node being visited inside the apply(..), +and the rest of the list will be the parental sequence of nodes +from the top most node applied down the graph to the current node. +Note, the user does not typically call pushNodeOnPath() as it +will be called automatically by the Node::accept() method. +

+ + +

oinline void popFromNodePath() +
Method callby osg::Node::accept() method after +a call the NodeVisitor::apply(). +Note, the user does not typically call pushNodeOnPath() as it +will be called automatically by the Node::accept() method. +

+ + +

oNodePath& getNodePath() +
Get the non const NodePath from the top most node applied down +to the current Node being visited +

+ + +

oconst NodePath& getNodePath() const +
Get the const NodePath from the top most node applied down +to the current Node being visited +

+ + +

ovirtual bool getLocalToWorldMatrix(Matrix& matrix, Node* node) +
Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u +

+ + +

ovirtual bool getWorldToLocalMatrix(Matrix& matrix, Node* node) +
Get the World To Local Matrix from the NodePath for specified Transform::Mode +

+ + +

ovirtual osg::Vec3 getEyePoint() const +
Get the eye point in local coordinates. +Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. +

+ + +

ovirtual float getDistanceToEyePoint(const Vec3& , bool ) const +
Get the distance from a point to the eye point, distance value in local coordinate system. +Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. +If the getDistianceFromEyePoint(pos) is not implmented than a default value of 0.0 is returned. +

+ + +

ovirtual float getDistanceFromEyePoint(const Vec3& , bool ) const +
Get the distance of a point from the eye point, distance value in the eye coordinate system. +Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. +If the getDistianceFromEyePoint(pos) is not implmented than a default value of 0.0 is returned. +

+ + +

ovirtual void apply(Node& node) +

+ + +

ovirtual void apply(Geode& node) +

+ + +

ovirtual void apply(Billboard& node) +

+ + +

ovirtual void apply(Group& node) +

+ + +

ovirtual void apply(Projection& node) +

+ + +

ovirtual void apply(ClipNode& node) +

+ + +

ovirtual void apply(LightSource& node) +

+ + +

ovirtual void apply(Transform& node) +

+ + +

ovirtual void apply(DOFTransform& node) +

+ + +

ovirtual void apply(MatrixTransform& node) +

+ + +

ovirtual void apply(PositionAttitudeTransform& node) +

+ + +

ovirtual void apply(Switch& node) +

+ + +

ovirtual void apply(Sequence& node) +

+ + +

ovirtual void apply(LOD& node) +

+ + +

ovirtual void apply(Impostor& node) +

+ + +

ovirtual void apply(ClearNode& node) +

+ + +

ovirtual void apply(OccluderNode& node) +

+ + +

oVisitorType _visitorType +

+ + +

oint _traversalNumber +

+ + +

oref_ptr<FrameStamp> _frameStamp +

+ + +

oTraversalMode _traversalMode +

+ + +

oNode::NodeMask _traversalMask +

+ + +

oNode::NodeMask _nodeMaskOverride +

+ + +

oNodePath _nodePath +

+
+
Direct child classes: +
CollectOccludersVisitor
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/NotifySeverity.html b/doc/doc++/osg/NotifySeverity.html new file mode 100644 index 000000000..2d5dbee66 --- /dev/null +++ b/doc/doc++/osg/NotifySeverity.html @@ -0,0 +1,73 @@ + + + + + enum osg::NotifySeverity + + + + +

enum osg::NotifySeverity

Range of notify levels from DEBUG_FP through to FATAL, ALWAYS is reserved for forcing the absorption of all messages.
+ +
+

+
+[more] ALWAYS +
+[more] FATAL +
+[more] WARN +
+[more] NOTICE +
+[more] INFO +
+[more] DEBUG_INFO +
+[more] DEBUG_FP +

+ + + +
+

Documentation

+
Range of notify levels from DEBUG_FP through to FATAL, ALWAYS +is reserved for forcing the absorption of all messages. The +keywords are also used verbatim when specified by the environmental +variable OSGNOTIFYLEVEL. See documentation on osg::notify() for +further details.
+
+ + + +
o ALWAYS +

+ + +

o FATAL +

+ + +

o WARN +

+ + +

o NOTICE +

+ + +

o INFO +

+ + +

o DEBUG_INFO +

+ + +

o DEBUG_FP +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html b/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html new file mode 100644 index 000000000..a24c1f305 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_ADD_TESTCASE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_ADD_TESTCASE + + + + +

#define OSGUTX_ADD_TESTCASE

( tfixture, tmethod )

Adds a test case to a suite object being created in a TestSuite singleton function.
+ + +
+

Documentation

+
+Adds a test case to a suite object being created in a TestSuite singleton function. +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html b/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html new file mode 100644 index 000000000..f9a129314 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_ADD_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_ADD_TESTSUITE + + + + +

#define OSGUTX_ADD_TESTSUITE

( childSuite )

Adds a suite to a suite - allows composition of test suites.
+ + +
+

Documentation

+
+Adds a suite to a suite - allows composition of test suites. +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html new file mode 100644 index 000000000..bf303f7ae --- /dev/null +++ b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_AUTOREGISTER_TESTSUITE + + + + +

#define OSGUTX_AUTOREGISTER_TESTSUITE

( tsuite )

Autoregister a testsuite with the root suite at startup
+ + +
+

Documentation

+
Autoregister a testsuite with the root suite at startup
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html new file mode 100644 index 000000000..33ff8d5cb --- /dev/null +++ b/doc/doc++/osg/OSGUTX_AUTOREGISTER_TESTSUITE_AT.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_AUTOREGISTER_TESTSUITE_AT + + + + +

#define OSGUTX_AUTOREGISTER_TESTSUITE_AT

( tsuite , path )

Auto register a testsuite with at designated point in the suite graph at startup
+ + +
+

Documentation

+
Auto register a testsuite with at designated point in the suite graph at startup
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html b/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html new file mode 100644 index 000000000..37499f0e9 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_BEGIN_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_BEGIN_TESTSUITE + + + + +

#define OSGUTX_BEGIN_TESTSUITE

( tsuite )

Starts a TestSuite singleton function
+ + +
+

Documentation

+
+Starts a TestSuite singleton function +
+
See Also:
OSGUTX_ADD_TESTCASE, OSGUTX_END_TESTSUITE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_END_TESTSUITE.html b/doc/doc++/osg/OSGUTX_END_TESTSUITE.html new file mode 100644 index 000000000..960b16ced --- /dev/null +++ b/doc/doc++/osg/OSGUTX_END_TESTSUITE.html @@ -0,0 +1,22 @@ + + + + + #define OSGUTX_END_TESTSUITE + + + + +

#define OSGUTX_END_TESTSUITE

()

Ends a TestSuite singleton function
+ + +
+

Documentation

+
+Ends a TestSuite singleton function +
+
See Also:
OSGUTX_BEGIN_TESTSUITE, OSGUTX_ADD_TESTCASE

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TESTSUITE.html b/doc/doc++/osg/OSGUTX_TESTSUITE.html new file mode 100644 index 000000000..5e8a3aa56 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TESTSUITE.html @@ -0,0 +1,20 @@ + + + + + #define OSGUTX_TESTSUITE + + + + +

#define OSGUTX_TESTSUITE

( tsuite )

Define a TestSuite accessor
+ + +
+

Documentation

+
Define a TestSuite accessor
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TEST_E.html b/doc/doc++/osg/OSGUTX_TEST_E.html new file mode 100644 index 000000000..b22dc3954 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TEST_E.html @@ -0,0 +1,27 @@ + + + + + #define OSGUTX_TEST_E + + + + +

#define OSGUTX_TEST_E

( expr )

OSGUTX_TEST_E is a convenience macro, analogous to assert(), which will throw an osgUtx::TestErrorX if \em expr evaluates to false; this should be used to test for an error in a given test, as opposed to a failure in the tested code.
+ + +
+

Documentation

+
+OSGUTX_TEST_E is a convenience macro, analogous to assert(), which will +throw an osgUtx::TestErrorX if \em expr evaluates to false; this should be +used to test for an error in a given test, as opposed to a failure +in the tested code. + +

The exception will indicate the file and line number of the failed expression, +along with expression itself.

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSGUTX_TEST_F.html b/doc/doc++/osg/OSGUTX_TEST_F.html new file mode 100644 index 000000000..c30f06bf7 --- /dev/null +++ b/doc/doc++/osg/OSGUTX_TEST_F.html @@ -0,0 +1,27 @@ + + + + + #define OSGUTX_TEST_F + + + + +

#define OSGUTX_TEST_F

( expr )

OSGUTX_TEST_F is a convenience macro, analogous to assert(), which will throw an osgUtx::TestFailureX if \em expr evaluates to false; this should be used to test for failure in a given test, as opposed to an actual error in the test owing to some other reason than the tested code being faulty.
+ + +
+

Documentation

+
+OSGUTX_TEST_F is a convenience macro, analogous to assert(), which will +throw an osgUtx::TestFailureX if \em expr evaluates to false; this should be +used to test for failure in a given test, as opposed to an actual error +in the test owing to some other reason than the tested code being faulty. + +

The exception will indicate the file and line number of the failed expression, +along with expression itself.

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OSG_GL_DEBUG.html b/doc/doc++/osg/OSG_GL_DEBUG.html new file mode 100644 index 000000000..4ff76344f --- /dev/null +++ b/doc/doc++/osg/OSG_GL_DEBUG.html @@ -0,0 +1,21 @@ + + + + + #define osg::OSG_GL_DEBUG + + + + +

#define osg::OSG_GL_DEBUG

(message)

macro for use with osg::StateAttrbiute::apply methods for detected and reporting OpenGL error messages
+ + +
+

Documentation

+
macro for use with osg::StateAttrbiute::apply methods for detected and +reporting OpenGL error messages
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Object.html b/doc/doc++/osg/Object.html new file mode 100644 index 000000000..56d9160ee --- /dev/null +++ b/doc/doc++/osg/Object.html @@ -0,0 +1,244 @@ + + + + + class SG_EXPORT osg::Object + + + + +

class SG_EXPORT osg::Object

Base class/standard interface for objects which require IO support, cloning and reference counting.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]inline Object() +
Construct an object. +
+[more] 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 +
+[more]virtual Object* cloneType() const = 0 +
Clone the type of an object, with Object* return type. +
+[more]virtual Object* clone(const CopyOp&) const = 0 +
Clone the an object, with Object* return type. +
+[more]virtual bool isSameKindAs(const Object*) const +
+[more]virtual const char* libraryName() const = 0 +
return the name of the object's library. +
+[more]virtual const char* className() const = 0 +
return the name of the object's class type. +
+[more]inline void setDataVariance(DataVariance dv) +
Set the data variance of this object. +
+[more]inline DataVariance getDataVariance() const +
Get the data variance of this object +
+[more]inline void setUserData(Referenced* obj) +
Set user data, data must be subclased from Referenced to allow automatic memory handling. +
+[more]inline Referenced* getUserData() +
Get user data +
+[more]inline const Referenced* getUserData() const +
Get const user data +

+ +

+

Public Members

+[more]enum DataVariance +

+ +

+

Protected Fields

+[more]DataVariance _dataVariance +
+[more]ref_ptr<Referenced> _userData +

+ +

+

Protected Methods

+[more]virtual ~Object() +
Object destructor. +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Base class/standard interface for objects which require IO support, +cloning and reference counting. +Based on GOF Composite, Prototype and Template Method patterns.
+
+ + + +
oinline Object() +
Construct an object. Note Object is a pure virtual base class +and therefore cannot be constructed on its own, only derived +classes which override the clone and className methods are +concrete classes and can be constructed. +

+ + +

o 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 +

+ + +

ovirtual Object* cloneType() const = 0 +
Clone the type of an object, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual Object* clone(const CopyOp&) const = 0 +
Clone the an object, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual bool isSameKindAs(const Object*) const +

+ + +

ovirtual const char* libraryName() const = 0 +
return the name of the object's library. Must be defined +by derived classes. The OpenSceneGraph convention the is +that the namspace of a library is the same as the library name. +

+ + +

ovirtual const char* className() const = 0 +
return the name of the object's class type. Must be defined +by derived classes. +

+ + +

oenum DataVariance +

+ + + +
o DYNAMIC +

+ + +

o STATIC +

+ + + +
oinline void setDataVariance(DataVariance dv) +
Set the data variance of this object. +Can be set to either STATIC for values that do not change over the lifetime of the object, +or DYNAMIC for values that vary over the lifetime of the object. The DataVariance value +can be used be routines such as optimzation codes that wish to share static data. +

+ + +

oinline DataVariance getDataVariance() const +
Get the data variance of this object +

+ + +

oinline void setUserData(Referenced* obj) +
+Set user data, data must be subclased from Referenced to allow +automatic memory handling. If you own data isn't directly +subclassed from Referenced then create and adapter object +which points to your own objects and handles the memory addressing. +

+ + +

oinline Referenced* getUserData() +
Get user data +

+ + +

oinline const Referenced* getUserData() const +
Get const user data +

+ + +

ovirtual ~Object() +
Object destructor. Note, is protected so that Objects cannot +be deleted other than by being dereferenced and the reference +count being zero (see osg::Referenced), preventing the deletion +of nodes which are still in use. This also means that +Node's cannot be created on stack i.e Node node will not compile, +forcing all nodes to be created on the heap i.e Node* node += new Node(). +

+ + +

oDataVariance _dataVariance +

+ + +

oref_ptr<Referenced> _userData +

+
+
Direct child classes: +
TessellationHints
+StateSet
+StateAttribute
+Shape
+RefMatrix
+PrimitiveSet
+NodeCallback
+Node
+Image
+Drawable
+ConvexPlanarOccluder
+Array
+AnimationPath
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/OccluderNode.html b/doc/doc++/osg/OccluderNode.html new file mode 100644 index 000000000..1acbbfd41 --- /dev/null +++ b/doc/doc++/osg/OccluderNode.html @@ -0,0 +1,361 @@ + + + + + class SG_EXPORT osg::OccluderNode + + + + +

class SG_EXPORT osg::OccluderNode

OccluderNode is a Group node which allows OccluderNodeing between children.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] OccluderNode() +
+[more] OccluderNode(const OccluderNode&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, OccluderNode) +
+[more]void setOccluder(ConvexPlanarOccluder* occluder) +
Attach a ConvexPlanarOccluder to an OccluderNode +
+[more]ConvexPlanarOccluder* getOccluder() +
Get the ConvexPlanarOccluder* attached to a OccluderNode. +
+[more]const ConvexPlanarOccluder* getOccluder() const +
Get the const ConvexPlanarOccluder* attached to a OccluderNode +

+ +

+

Protected Fields

+[more]ref_ptr<ConvexPlanarOccluder> _occluder +

+ +

+

Protected Methods

+[more]virtual ~OccluderNode() +
+[more]virtual bool computeBound() const +
Override's Group's computeBound +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
OccluderNode is a Group node which allows OccluderNodeing between children. +Typical uses would be for objects which might need to be rendered +differently at different times, for instance a OccluderNode could be used +to represent the different states of a traffic light.
+
+ + + +
o OccluderNode() +

+ + +

o OccluderNode(const OccluderNode&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, OccluderNode) +

+ + +

ovoid setOccluder(ConvexPlanarOccluder* occluder) +
Attach a ConvexPlanarOccluder to an OccluderNode +

+ + +

oConvexPlanarOccluder* getOccluder() +
Get the ConvexPlanarOccluder* attached to a OccluderNode. +

+ + +

oconst ConvexPlanarOccluder* getOccluder() const +
Get the const ConvexPlanarOccluder* attached to a OccluderNode +

+ + +

ovirtual ~OccluderNode() +

+ + +

ovirtual bool computeBound() const +
Override's Group's computeBound +

+ + +

oref_ptr<ConvexPlanarOccluder> _occluder +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Plane.html b/doc/doc++/osg/Plane.html new file mode 100644 index 000000000..724466ff7 --- /dev/null +++ b/doc/doc++/osg/Plane.html @@ -0,0 +1,295 @@ + + + + + class SG_EXPORT osg::Plane + + + + +

class SG_EXPORT osg::Plane

A plane class.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]inline Plane() +
+[more]inline Plane(const Plane& pl) +
+[more]inline Plane(float a, float b, float c, float d) +
+[more]inline Plane(const Vec4& vec) +
+[more]inline Plane(const Vec3& norm, float d) +
+[more]inline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3) +
+[more]inline Plane& operator = (const Plane& pl) +
+[more]inline void set(const Plane& pl) +
+[more]inline void set(float a, float b, float c, float d) +
+[more]inline void set(const Vec4& vec) +
+[more]inline void set(const Vec3& norm, float d) +
+[more]inline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3) +
+[more]inline void set(const Vec3& norm, const Vec3& point) +
+[more]inline void flip() +
flip/reverse the orientation of the plane +
+[more]inline void makeUnitLength() +
+[more]inline void calculateUpperLowerBBCorners() +
calculate the upper and lower bounding box corners to be used in the intersect(BoundingBox&) method for speeding calculations +
+[more]inline bool valid() const +
+[more]inline bool operator == (const Plane& plane) const +
+[more]inline bool operator != (const Plane& plane) const +
+[more]inline bool operator < (const Plane& plane) const +
+[more]inline float* ptr() +
+[more]inline const float* ptr() const +
+[more]inline Vec4& asVec4() +
+[more]inline const Vec4& asVec4() const +
+[more]inline float& operator [] (unsigned int i) +
+[more]inline float operator [] (unsigned int i) const +
+[more]inline osg::Vec3 getNormal() const +
+[more]inline float distance(const osg::Vec3& v) const +
calculate the distance between a point and the plane +
+[more]inline int intersect(const std::vector<Vec3>& vertices) const +
intersection test between plane and vertex list return 1 if the bs is completely above plane, return 0 if the bs intersects the plane, return -1 if the bs is completely below the plane +
+[more]inline int intersect(const BoundingSphere& bs) const +
intersection test between plane and bounding sphere. +
+[more]inline int intersect(const BoundingBox& bb) const +
intersection test between plane and bounding sphere. +
+[more]inline void transform(const osg::Matrix& matrix) +
Transform the plane by matrix. +
+[more]inline void transformProvidingInverse(const osg::Matrix& matrix) +
Transform the plane by provide a pre inverted matrix. +

+ +

+

Protected Fields

+[more]Vec4 _fv +
+[more]unsigned int _upperBBCorner +
+[more]unsigned int _lowerBBCorner +

+ +
+ + +
+

Documentation

+
A plane class. It can be used to represent an infinite plane.
+
+ + + +
oinline Plane() +

+ + +

oinline Plane(const Plane& pl) +

+ + +

oinline Plane(float a, float b, float c, float d) +

+ + +

oinline Plane(const Vec4& vec) +

+ + +

oinline Plane(const Vec3& norm, float d) +

+ + +

oinline Plane(const Vec3& v1, const Vec3& v2, const Vec3& v3) +

+ + +

oinline Plane& operator = (const Plane& pl) +

+ + +

oinline void set(const Plane& pl) +

+ + +

oinline void set(float a, float b, float c, float d) +

+ + +

oinline void set(const Vec4& vec) +

+ + +

oinline void set(const Vec3& norm, float d) +

+ + +

oinline void set(const Vec3& v1, const Vec3& v2, const Vec3& v3) +

+ + +

oinline void set(const Vec3& norm, const Vec3& point) +

+ + +

oinline void flip() +
flip/reverse the orientation of the plane +

+ + +

oinline void makeUnitLength() +

+ + +

oinline void calculateUpperLowerBBCorners() +
calculate the upper and lower bounding box corners to be used +in the intersect(BoundingBox&) method for speeding calculations +

+ + +

oinline bool valid() const +

+ + +

oinline bool operator == (const Plane& plane) const +

+ + +

oinline bool operator != (const Plane& plane) const +

+ + +

oinline bool operator < (const Plane& plane) const +

+ + +

oinline float* ptr() +

+ + +

oinline const float* ptr() const +

+ + +

oinline Vec4& asVec4() +

+ + +

oinline const Vec4& asVec4() const +

+ + +

oinline float& operator [] (unsigned int i) +

+ + +

oinline float operator [] (unsigned int i) const +

+ + +

oinline osg::Vec3 getNormal() const +

+ + +

oinline float distance(const osg::Vec3& v) const +
calculate the distance between a point and the plane +

+ + +

oinline int intersect(const std::vector<Vec3>& vertices) const +
intersection test between plane and vertex list +return 1 if the bs is completely above plane, +return 0 if the bs intersects the plane, +return -1 if the bs is completely below the plane +

+ + +

oinline int intersect(const BoundingSphere& bs) const +
intersection test between plane and bounding sphere. +return 1 if the bs is completely above plane, +return 0 if the bs intersects the plane, +return -1 if the bs is completely below the plane. +

+ + +

oinline int intersect(const BoundingBox& bb) const +
intersection test between plane and bounding sphere. +return 1 if the bs is completely above plane, +return 0 if the bs intersects the plane, +return -1 if the bs is completely below the plane. +

+ + +

oinline void transform(const osg::Matrix& matrix) +
Transform the plane by matrix. Note, this operations carries out +the calculation of the inverse of the matrix since to transforms +planes must be multiplied my the inverse transposed. This +make this operation expensive. If the inverse has been already +calculated elsewhere then use transformProvidingInverse() instead. +See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf +

+ + +

oinline void transformProvidingInverse(const osg::Matrix& matrix) +
Transform the plane by provide a pre inverted matrix. +see transform for details. +

+ + +

oVec4 _fv +

+ + +

ounsigned int _upperBBCorner +

+ + +

ounsigned int _lowerBBCorner +

+
+
Direct child classes: +
InfinitePlane
+
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const Plane& pl)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Point.html b/doc/doc++/osg/Point.html new file mode 100644 index 000000000..2b8cb362f --- /dev/null +++ b/doc/doc++/osg/Point.html @@ -0,0 +1,250 @@ + + + + + class SG_EXPORT osg::Point + + + + +

class SG_EXPORT osg::Point

Point - encapsulates the OpenGL point smoothing and size state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Point() +
+[more] Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Point, POINT) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setSize(float size) +
+[more]inline float getSize() const +
+[more]void setFadeThresholdSize(float fadeThresholdSize) +
+[more]inline float getFadeThresholdSize() const +
+[more]void setDistanceAttenuation(const Vec3& distanceAttenuation) +
+[more]inline const Vec3& getDistanceAttenuation() const +
+[more]virtual void apply(State& state) const +
+[more]static void init_GL_EXT() +

+ +

+

Protected Fields

+[more]float _size +
+[more]float _fadeThresholdSize +
+[more]Vec3 _distanceAttenuation +

+ +

+

Protected Methods

+[more]virtual ~Point() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Point - encapsulates the OpenGL point smoothing and size state
+
+ + + +
o Point() +

+ + +

o Point(const Point& point, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Point, POINT) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setSize(float size) +

+ + +

oinline float getSize() const +

+ + +

ovoid setFadeThresholdSize(float fadeThresholdSize) +

+ + +

oinline float getFadeThresholdSize() const +

+ + +

ovoid setDistanceAttenuation(const Vec3& distanceAttenuation) +

+ + +

oinline const Vec3& getDistanceAttenuation() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ostatic void init_GL_EXT() +

+ + +

ovirtual ~Point() +

+ + +

ofloat _size +

+ + +

ofloat _fadeThresholdSize +

+ + +

oVec3 _distanceAttenuation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PolygonMode.html b/doc/doc++/osg/PolygonMode.html new file mode 100644 index 000000000..d3b282400 --- /dev/null +++ b/doc/doc++/osg/PolygonMode.html @@ -0,0 +1,265 @@ + + + + + class SG_EXPORT osg::PolygonMode + + + + +

class SG_EXPORT osg::PolygonMode

Class to for setting OpenGL's polygon culling mode
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PolygonMode() +
+[more] PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, PolygonMode, POLYGONMODE) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setMode(Face face, Mode mode) +
+[more]Mode getMode(Face face) const +
+[more]inline bool getFrontAndBack() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Face +
+[more]enum Mode +

+ +

+

Protected Fields

+[more]bool _frontAndBack +
+[more]Mode _modeFront +
+[more]Mode _modeBack +

+ +

+

Protected Methods

+[more]virtual ~PolygonMode() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Class to for setting OpenGL's polygon culling mode
+
+ + + +
o PolygonMode() +

+ + +

o PolygonMode(const PolygonMode& pm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, PolygonMode, POLYGONMODE) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum Face +

+ + + +
o FRONT +

+ + +

o BACK +

+ + +

o FRONT_AND_BACK +

+ + + +
oenum Mode +

+ + + +
o POINT +

+ + +

o LINE +

+ + +

o FILL +

+ + + +
ovoid setMode(Face face, Mode mode) +

+ + +

oMode getMode(Face face) const +

+ + +

oinline bool getFrontAndBack() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~PolygonMode() +

+ + +

obool _frontAndBack +

+ + +

oMode _modeFront +

+ + +

oMode _modeBack +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PolygonOffset.html b/doc/doc++/osg/PolygonOffset.html new file mode 100644 index 000000000..7204aee9e --- /dev/null +++ b/doc/doc++/osg/PolygonOffset.html @@ -0,0 +1,232 @@ + + + + + class SG_EXPORT osg::PolygonOffset + + + + +

class SG_EXPORT osg::PolygonOffset

PolygonOffset - encapsulates the OpenGL glPolygonOffset state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PolygonOffset() +
+[more] PolygonOffset(float factor, float units) +
+[more] PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, PolygonOffset, POLYGONOFFSET) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setFactor(float factor) +
+[more]inline float getFactor() const +
+[more]inline void setUnits(float units) +
+[more]inline float getUnits() const +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]float _factor +
+[more]float _units +

+ +

+

Protected Methods

+[more]virtual ~PolygonOffset() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
PolygonOffset - encapsulates the OpenGL glPolygonOffset state
+
+ + + +
o PolygonOffset() +

+ + +

o PolygonOffset(float factor, float units) +

+ + +

o PolygonOffset(const PolygonOffset& po, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, PolygonOffset, POLYGONOFFSET) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oinline void setFactor(float factor) +

+ + +

oinline float getFactor() const +

+ + +

oinline void setUnits(float units) +

+ + +

oinline float getUnits() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~PolygonOffset() +

+ + +

ofloat _factor +

+ + +

ofloat _units +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PolygonStipple.html b/doc/doc++/osg/PolygonStipple.html new file mode 100644 index 000000000..61dc9e9e8 --- /dev/null +++ b/doc/doc++/osg/PolygonStipple.html @@ -0,0 +1,210 @@ + + + + + class SG_EXPORT osg::PolygonStipple + + + + +

class SG_EXPORT osg::PolygonStipple

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PolygonStipple() +
+[more] PolygonStipple(const PolygonStipple& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, PolygonStipple, POLYGONSTIPPLE) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setMask(const GLubyte* mask) +
set the mask up, copying 128 bytes (32x32 bitfield) from mask into the local _mask +
+[more]inline const GLubyte* getMask() const +
get a pointer to the mask +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]GLubyte _mask[128] +

+ +

+

Protected Methods

+[more]virtual ~PolygonStipple() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o PolygonStipple() +

+ + +

o PolygonStipple(const PolygonStipple& lw, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, PolygonStipple, POLYGONSTIPPLE) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setMask(const GLubyte* mask) +
set the mask up, copying 128 bytes (32x32 bitfield) from mask into the local _mask +

+ + +

oinline const GLubyte* getMask() const +
get a pointer to the mask +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~PolygonStipple() +

+ + +

oGLubyte _mask[128] +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Polytope.html b/doc/doc++/osg/Polytope.html new file mode 100644 index 000000000..74da36179 --- /dev/null +++ b/doc/doc++/osg/Polytope.html @@ -0,0 +1,321 @@ + + + + + class SG_EXPORT osg::Polytope + + + + +

class SG_EXPORT osg::Polytope

A Polytope class for representing convex clipping volumes made up.
+
+ +
+

+

Public Methods

+[more]inline Polytope() +
+[more]inline Polytope(const Polytope& cv) +
+[more]inline Polytope(const PlaneList& pl) +
+[more]inline ~Polytope() +
+[more]inline void clear() +
+[more]inline Polytope& operator = (const Polytope& cv) +
+[more]void setToUnitFrustum(bool withNear=true, bool withFar=true) +
Create a Polytope with is cube, centered at 0,0,0, with sides of 2 units +
+[more]inline void set(const PlaneList& pl) +
+[more]inline void add(const osg::Plane& pl) +
+[more]inline void flip() +
flip/reverse the orientation of all the planes +
+[more]inline PlaneList& getPlaneList() +
+[more]inline const PlaneList& getPlaneList() const +
+[more]inline void setReferenceVertexList(VertexList& vertices) +
+[more]inline VertexList& getReferenceVertexList() +
+[more]inline const VertexList& getReferenceVertexList() const +
+[more]inline void setupMask() +
+[more]inline ClippingMask& getCurrentMask() +
+[more]inline ClippingMask getCurrentMask() const +
+[more]inline void setResultMask(ClippingMask mask) +
+[more]inline ClippingMask getResultMask() const +
+[more]MaskStack& getMaskStack() +
+[more]const MaskStack& getMaskStack() const +
+[more]inline void pushCurrentMask() +
+[more]inline void popCurrentMask() +
+[more]inline bool contains(const osg::Vec3& v) const +
Check whether a vertex is contained with clipping set +
+[more]inline bool contains(const std::vector<Vec3>& vertices) +
Check whether any part of vertex list is contained with clipping set +
+[more]inline bool contains(const osg::BoundingSphere& bs) +
Check whether any part of a bounding sphere is contained within clipping set. +
+[more]inline bool contains(const osg::BoundingBox& bb) +
Check whether any part of a bounding box is contained within clipping set. +
+[more]inline bool containsAllOf(const std::vector<Vec3>& vertices) +
Check whether all of vertex list is contained with clipping set +
+[more]inline bool containsAllOf(const osg::BoundingSphere& bs) +
Check whether the entire bounding sphere is contained within clipping set +
+[more]inline bool containsAllOf(const osg::BoundingBox& bb) +
Check whether the entire bounding box is contained within clipping set +
+[more]inline void transform(const osg::Matrix& matrix) +
Transform the clipping set by matrix. +
+[more]inline void transformProvidingInverse(const osg::Matrix& matrix) +
Transform the clipping set by provide a pre inverted matrix. +

+ +

+

Public Members

+[more]typedef unsigned int ClippingMask +
+[more]typedef std::vector<Plane> PlaneList +
+[more]typedef std::vector<Vec3> VertexList +
+[more]typedef fast_back_stack<ClippingMask> MaskStack +

+ +

+

Protected Fields

+[more]MaskStack _maskStack +
+[more]ClippingMask _resultMask +
+[more]PlaneList _planeList +
+[more]VertexList _referenceVertexList +

+ +
+ + +
+

Documentation

+
A Polytope class for representing convex clipping volumes made up. +When adding planes, their normals should point inwards (into the volume)
+
+ + + +
otypedef unsigned int ClippingMask +

+ + +

otypedef std::vector<Plane> PlaneList +

+ + +

otypedef std::vector<Vec3> VertexList +

+ + +

otypedef fast_back_stack<ClippingMask> MaskStack +

+ + +

oinline Polytope() +

+ + +

oinline Polytope(const Polytope& cv) +

+ + +

oinline Polytope(const PlaneList& pl) +

+ + +

oinline ~Polytope() +

+ + +

oinline void clear() +

+ + +

oinline Polytope& operator = (const Polytope& cv) +

+ + +

ovoid setToUnitFrustum(bool withNear=true, bool withFar=true) +
Create a Polytope with is cube, centered at 0,0,0, with sides of 2 units +

+ + +

oinline void set(const PlaneList& pl) +

+ + +

oinline void add(const osg::Plane& pl) +

+ + +

oinline void flip() +
flip/reverse the orientation of all the planes +

+ + +

oinline PlaneList& getPlaneList() +

+ + +

oinline const PlaneList& getPlaneList() const +

+ + +

oinline void setReferenceVertexList(VertexList& vertices) +

+ + +

oinline VertexList& getReferenceVertexList() +

+ + +

oinline const VertexList& getReferenceVertexList() const +

+ + +

oinline void setupMask() +

+ + +

oinline ClippingMask& getCurrentMask() +

+ + +

oinline ClippingMask getCurrentMask() const +

+ + +

oinline void setResultMask(ClippingMask mask) +

+ + +

oinline ClippingMask getResultMask() const +

+ + +

oMaskStack& getMaskStack() +

+ + +

oconst MaskStack& getMaskStack() const +

+ + +

oinline void pushCurrentMask() +

+ + +

oinline void popCurrentMask() +

+ + +

oinline bool contains(const osg::Vec3& v) const +
Check whether a vertex is contained with clipping set +

+ + +

oinline bool contains(const std::vector<Vec3>& vertices) +
Check whether any part of vertex list is contained with clipping set +

+ + +

oinline bool contains(const osg::BoundingSphere& bs) +
Check whether any part of a bounding sphere is contained within clipping set. +Using a mask to determine which planes should be used for the check, and +modifying the mask to turn off planes which wouldn't contribute to clipping +of any internal objects. This feature is used in osgUtil::CullVisitor +to prevent redundant plane checking. +

+ + +

oinline bool contains(const osg::BoundingBox& bb) +
Check whether any part of a bounding box is contained within clipping set. +Using a mask to determine which planes should be used for the check, and +modifying the mask to turn off planes which wouldn't contribute to clipping +of any internal objects. This feature is used in osgUtil::CullVisitor +to prevent redundant plane checking. +

+ + +

oinline bool containsAllOf(const std::vector<Vec3>& vertices) +
Check whether all of vertex list is contained with clipping set +

+ + +

oinline bool containsAllOf(const osg::BoundingSphere& bs) +
Check whether the entire bounding sphere is contained within clipping set +

+ + +

oinline bool containsAllOf(const osg::BoundingBox& bb) +
Check whether the entire bounding box is contained within clipping set +

+ + +

oinline void transform(const osg::Matrix& matrix) +
Transform the clipping set by matrix. Note, this operations carries out +the calculation of the inverse of the matrix since to transforms +planes must be multiplied my the inverse transposed. This +make this operation expensive. If the inverse has been already +calculated elsewhere then use transformProvidingInverse() instead. +See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf +

+ + +

oinline void transformProvidingInverse(const osg::Matrix& matrix) +
Transform the clipping set by provide a pre inverted matrix. +see transform for details. +

+ + +

oMaskStack _maskStack +

+ + +

oClippingMask _resultMask +

+ + +

oPlaneList _planeList +

+ + +

oVertexList _referenceVertexList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PositionAttitudeTransform.html b/doc/doc++/osg/PositionAttitudeTransform.html new file mode 100644 index 000000000..b800e5af2 --- /dev/null +++ b/doc/doc++/osg/PositionAttitudeTransform.html @@ -0,0 +1,444 @@ + + + + + class SG_EXPORT osg::PositionAttitudeTransform + + + + +

class SG_EXPORT osg::PositionAttitudeTransform

PositionAttitideTransform - is Transform the set the coordinates transform up via a Vec3 position and Quat attitude
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PositionAttitudeTransform() +
+[more] PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Node(osg, PositionAttitudeTransform) +
+[more]virtual PositionAttitudeTransform* asPositionAttitudeTransform() +
+[more]virtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +
+[more]inline void setPosition(const Vec3& pos) +
+[more]inline const Vec3& getPosition() const +
+[more]inline void setAttitude(const Quat& quat) +
+[more]inline const Quat& getAttitude() const +
+[more]inline void setPivotPoint(const Vec3& pivot) +
+[more]inline const Vec3& getPivotPoint() const +
+[more]virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+[more]virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Protected Fields

+[more]Vec3 _position +
+[more]Quat _attitude +
+[more]Vec3 _pivotPoint +

+ +

+

Protected Methods

+[more]virtual ~PositionAttitudeTransform() +

+ +
+

Inherited from Transform:

+
+

+

Public Methods

+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual MatrixTransform* asMatrixTransform() +
+ovirtual const MatrixTransform* asMatrixTransform() const +
+ovirtual DOFTransform* asDOFTransform() +
+ovirtual const DOFTransform* asDOFTransform() const +
+ovoid setReferenceFrame(ReferenceFrame rf) +
+oReferenceFrame getReferenceFrame() const +
+ovoid setComputeTransformCallback(ComputeTransformCallback* ctc) +
+oComputeTransformCallback* getComputeTransformCallback() +
+oconst ComputeTransformCallback* getComputeTransformCallback() const +
+oinline bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
+oinline bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ +

+

Public Members

+oenum ReferenceFrame +
+ostruct ComputeTransformCallback: public virtual osg::Referenced +

+ +

+

Protected Fields

+oref_ptr<ComputeTransformCallback> _computeTransformCallback +
+oReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
PositionAttitideTransform - is Transform the set the coordinates transform +up via a Vec3 position and Quat attitude
+
+ + + +
o PositionAttitudeTransform() +

+ + +

o PositionAttitudeTransform(const PositionAttitudeTransform& pat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osg, PositionAttitudeTransform) +

+ + +

ovirtual PositionAttitudeTransform* asPositionAttitudeTransform() +

+ + +

ovirtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +

+ + +

oinline void setPosition(const Vec3& pos) +

+ + +

oinline const Vec3& getPosition() const +

+ + +

oinline void setAttitude(const Quat& quat) +

+ + +

oinline const Quat& getAttitude() const +

+ + +

oinline void setPivotPoint(const Vec3& pivot) +

+ + +

oinline const Vec3& getPivotPoint() const +

+ + +

ovirtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +

+ + +

ovirtual ~PositionAttitudeTransform() +

+ + +

oVec3 _position +

+ + +

oQuat _attitude +

+ + +

oVec3 _pivotPoint +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PrimitiveFunctor.html b/doc/doc++/osg/PrimitiveFunctor.html new file mode 100644 index 000000000..b682cad95 --- /dev/null +++ b/doc/doc++/osg/PrimitiveFunctor.html @@ -0,0 +1,102 @@ + + + + + class osg::Drawable::PrimitiveFunctor + + + + +

class PrimitiveFunctor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual ~PrimitiveFunctor() +
+[more]virtual void setVertexArray(unsigned int count, const Vec3* vertices) = 0 +
+[more]virtual void drawArrays(GLenum mode, GLint first, GLsizei count) = 0 +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLubyte* indices) = 0 +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLushort* indices) = 0 +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLuint* indices) = 0 +
+[more]virtual void begin(GLenum mode) = 0 +
+[more]virtual void vertex(const Vec3& vert) = 0 +
+[more]virtual void vertex(float x, float y, float z) = 0 +
+[more]virtual void end() = 0 +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual ~PrimitiveFunctor() +

+ + +

ovirtual void setVertexArray(unsigned int count, const Vec3* vertices) = 0 +

+ + +

ovirtual void drawArrays(GLenum mode, GLint first, GLsizei count) = 0 +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLubyte* indices) = 0 +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLushort* indices) = 0 +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLuint* indices) = 0 +

+ + +

ovirtual void begin(GLenum mode) = 0 +

+ + +

ovirtual void vertex(const Vec3& vert) = 0 +

+ + +

ovirtual void vertex(float x, float y, float z) = 0 +

+ + +

ovirtual void end() = 0 +

+
+
Direct child classes: +
Statistics
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/PrimitiveSet.html b/doc/doc++/osg/PrimitiveSet.html new file mode 100644 index 000000000..47b7d982e --- /dev/null +++ b/doc/doc++/osg/PrimitiveSet.html @@ -0,0 +1,294 @@ + + + + + class osg::PrimitiveSet + + + + +

class osg::PrimitiveSet

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PrimitiveSet(Type primType=PrimitiveType, GLenum mode=0) +
+[more] PrimitiveSet(const PrimitiveSet& prim, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]Type getType() const +
+[more]void setMode(GLenum mode) +
+[more]GLenum getMode() const +
+[more]virtual void draw() const = 0 +
+[more]virtual void accept(Drawable::PrimitiveFunctor& functor) const = 0 +
+[more]virtual unsigned int index(unsigned int pos) const = 0 +
+[more]virtual unsigned int getNumIndices() const = 0 +
+[more]virtual void offsetIndices(int offset) = 0 +
+[more]virtual unsigned int getNumPrimitives() const +

+ +

+

Public Members

+[more]enum Type +
+[more]enum Mode +

+ +

+

Protected Fields

+[more]Type _primitiveType +
+[more]GLenum _mode +

+ +

+

Protected Methods

+[more]virtual ~PrimitiveSet() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
oenum Type +

+ + + +
o PrimitiveType +

+ + +

o DrawArraysPrimitiveType +

+ + +

o DrawArrayLengthsPrimitiveType +

+ + +

o DrawElementsUBytePrimitiveType +

+ + +

o DrawElementsUShortPrimitiveType +

+ + +

o DrawElementsUIntPrimitiveType +

+ + + +
oenum Mode +

+ + + +
o POINTS +

+ + +

o LINES +

+ + +

o LINE_STRIP +

+ + +

o LINE_LOOP +

+ + +

o TRIANGLES +

+ + +

o TRIANGLE_STRIP +

+ + +

o TRIANGLE_FAN +

+ + +

o QUADS +

+ + +

o QUAD_STRIP +

+ + +

o POLYGON +

+ + + +
o PrimitiveSet(Type primType=PrimitiveType, GLenum mode=0) +

+ + +

o PrimitiveSet(const PrimitiveSet& prim, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

oType getType() const +

+ + +

ovoid setMode(GLenum mode) +

+ + +

oGLenum getMode() const +

+ + +

ovirtual void draw() const = 0 +

+ + +

ovirtual void accept(Drawable::PrimitiveFunctor& functor) const = 0 +

+ + +

ovirtual unsigned int index(unsigned int pos) const = 0 +

+ + +

ovirtual unsigned int getNumIndices() const = 0 +

+ + +

ovirtual void offsetIndices(int offset) = 0 +

+ + +

ovirtual unsigned int getNumPrimitives() const +

+ + +

ovirtual ~PrimitiveSet() +

+ + +

oType _primitiveType +

+ + +

oGLenum _mode +

+
+
Direct child classes: +
DrawElementsUShort
+DrawElementsUInt
+DrawElementsUByte
+DrawArrays
+DrawArrayLengths
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Projection.html b/doc/doc++/osg/Projection.html new file mode 100644 index 000000000..951474e59 --- /dev/null +++ b/doc/doc++/osg/Projection.html @@ -0,0 +1,369 @@ + + + + + class SG_EXPORT osg::Projection + + + + +

class SG_EXPORT osg::Projection

Projection nodes set up the frustum/orthographic projection used when rendering the scene
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Projection() +
+[more] Projection(const Projection&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] Projection(const Matrix& matix) +
+[more] META_Node(osg, Projection) +
+[more]void setMatrix(const Matrix& mat) +
Set the transform's matrix +
+[more]inline const Matrix& getMatrix() const +
Get the transform's matrix. +
+[more]void preMult(const Matrix& mat) +
preMult transform +
+[more]void postMult(const Matrix& mat) +
postMult transform +

+ +

+

Protected Fields

+[more]Matrix _matrix +

+ +

+

Protected Methods

+[more]virtual ~Projection() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Projection nodes set up the frustum/orthographic projection used when rendering the scene
+
+ + + +
o Projection() +

+ + +

o Projection(const Projection&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o Projection(const Matrix& matix) +

+ + +

o META_Node(osg, Projection) +

+ + +

ovoid setMatrix(const Matrix& mat) +
Set the transform's matrix +

+ + +

oinline const Matrix& getMatrix() const +
Get the transform's matrix. +

+ + +

ovoid preMult(const Matrix& mat) +
preMult transform +

+ + +

ovoid postMult(const Matrix& mat) +
postMult transform +

+ + +

ovirtual ~Projection() +

+ + +

oMatrix _matrix +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/QualifiedTestPrinter.html b/doc/doc++/osg/QualifiedTestPrinter.html new file mode 100644 index 000000000..4dc4a94be --- /dev/null +++ b/doc/doc++/osg/QualifiedTestPrinter.html @@ -0,0 +1,65 @@ + + + + + class SG_EXPORT osgUtx::QualifiedTestPrinter + + + + +

class SG_EXPORT osgUtx::QualifiedTestPrinter

QualifiedTestPrinter prints to standard output a list of fully qualified tests
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visit( TestCase* pTest ) +

+ +
+

Inherited from TestQualifier:

+
+

+

Public Methods

+ovirtual bool visitEnter( TestSuite* pSuite ) +
+ovirtual bool visitLeave( TestSuite* pSuite ) +
+oconst std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+
+ + +
+

Documentation

+
+QualifiedTestPrinter prints to standard output a list of fully +qualified tests
+
+ + + +
ovirtual bool visit( TestCase* pTest ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Quat.html b/doc/doc++/osg/Quat.html new file mode 100644 index 000000000..3ef3dcfbe --- /dev/null +++ b/doc/doc++/osg/Quat.html @@ -0,0 +1,385 @@ + + + + + class SG_EXPORT osg::Quat + + + + +

class SG_EXPORT osg::Quat

A quaternion class.
+
+ +
+

+

Public Fields

+[more]Vec4 _fv +

+ +

+

Public Methods

+[more]inline Quat() +
+[more]inline Quat( float x, float y, float z, float w ) +
+[more]inline Quat( const Vec4& v ) +
+[more]inline Quat( float angle, const Vec3& axis) +
+[more]inline Quat( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+[more]inline Vec4& asVec4() +
+[more]inline const Vec4& asVec4() const +
+[more]inline const Vec3 asVec3() const +
+[more]inline void set(float x, float y, float z, float w) +
+[more]inline void set(const osg::Vec4& v) +
+[more]inline float& operator [] (int i) +
+[more]inline float operator [] (int i) const +
+[more]inline float& x() +
+[more]inline float& y() +
+[more]inline float& z() +
+[more]inline float& w() +
+[more]inline float x() const +
+[more]inline float y() const +
+[more]inline float z() const +
+[more]inline float w() const +
+[more]bool zeroRotation() const +
return true if the Quat represents a zero rotation, and therefore can be ignored in computations +
+[more]inline const Quat operator * (float rhs) const +
Multiply by scalar +
+[more]inline Quat& operator *= (float rhs) +
Unary multiply by scalar +
+[more]inline const Quat operator*(const Quat& rhs) const +
Binary multiply +
+[more]inline Quat& operator*=(const Quat& rhs) +
Unary multiply +
+[more]inline const Quat operator / (float rhs) const +
Divide by scalar +
+[more]inline Quat& operator /= (float rhs) +
Unary divide by scalar +
+[more]inline const Quat operator/(const Quat& denom) const +
Binary divide +
+[more]inline Quat& operator/=(const Quat& denom) +
Unary divide +
+[more]inline const Quat operator + (const Quat& rhs) const +
Binary addition +
+[more]inline Quat& operator += (const Quat& rhs) +
Unary addition +
+[more]inline const Quat operator - (const Quat& rhs) const +
Binary subtraction +
+[more]inline Quat& operator -= (const Quat& rhs) +
Unary subtraction +
+[more]inline const Quat operator - () const +
Negation operator - returns the negative of the quaternion. +
+[more]float length() const +
Length of the quaternion = sqrt( vec . +
+[more]float length2() const +
Length of the quaternion = vec . +
+[more]inline Quat conj() const +
Conjugate +
+[more]inline const Quat inverse() const +
Multiplicative inverse method: q^(-1) = q^*/(qq^*) +
+[more]void makeRotate( float angle, float x, float y, float z ) +
+[more]void makeRotate( float angle, const Vec3& vec ) +
+[more]void makeRotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+[more]void makeRotate( const Vec3& vec1, const Vec3& vec2 ) +
Make a rotation Quat which will rotate vec1 to vec2. +
+[more]void getRotate( float& angle, float& x, float& y, float& z ) const +
Return the angle and vector components represented by the quaternion +
+[more]void getRotate( float& angle, Vec3& vec ) const +
Return the angle and vector represented by the quaternion +
+[more]void slerp( float t, const Quat& from, const Quat& to) +
Spherical Linear Interpolation. +
+[more]void set( const Matrix& m ) +
Set quaternion to be equivalent to specified matrix +
+[more]void get( Matrix& m ) const +
Get the equivalent matrix for this quaternion +
+[more]Matrix getMatrix() const +
Get the equivalent matrix for this quaternion +

+ +
+ + +
+

Documentation

+
A quaternion class. It can be used to represent an orientation in 3D space.
+
+ + + +
oVec4 _fv +

+ + +

oinline Quat() +

+ + +

oinline Quat( float x, float y, float z, float w ) +

+ + +

oinline Quat( const Vec4& v ) +

+ + +

oinline Quat( float angle, const Vec3& axis) +

+ + +

oinline Quat( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +

+ + +

oinline Vec4& asVec4() +

+ + +

oinline const Vec4& asVec4() const +

+ + +

oinline const Vec3 asVec3() const +

+ + +

oinline void set(float x, float y, float z, float w) +

+ + +

oinline void set(const osg::Vec4& v) +

+ + +

oinline float& operator [] (int i) +

+ + +

oinline float operator [] (int i) const +

+ + +

oinline float& x() +

+ + +

oinline float& y() +

+ + +

oinline float& z() +

+ + +

oinline float& w() +

+ + +

oinline float x() const +

+ + +

oinline float y() const +

+ + +

oinline float z() const +

+ + +

oinline float w() const +

+ + +

obool zeroRotation() const +
return true if the Quat represents a zero rotation, and therefore can be ignored in computations +

+ + +

oinline const Quat operator * (float rhs) const +
Multiply by scalar +

+ + +

oinline Quat& operator *= (float rhs) +
Unary multiply by scalar +

+ + +

oinline const Quat operator*(const Quat& rhs) const +
Binary multiply +

+ + +

oinline Quat& operator*=(const Quat& rhs) +
Unary multiply +

+ + +

oinline const Quat operator / (float rhs) const +
Divide by scalar +

+ + +

oinline Quat& operator /= (float rhs) +
Unary divide by scalar +

+ + +

oinline const Quat operator/(const Quat& denom) const +
Binary divide +

+ + +

oinline Quat& operator/=(const Quat& denom) +
Unary divide +

+ + +

oinline const Quat operator + (const Quat& rhs) const +
Binary addition +

+ + +

oinline Quat& operator += (const Quat& rhs) +
Unary addition +

+ + +

oinline const Quat operator - (const Quat& rhs) const +
Binary subtraction +

+ + +

oinline Quat& operator -= (const Quat& rhs) +
Unary subtraction +

+ + +

oinline const Quat operator - () const +
Negation operator - returns the negative of the quaternion. +Basically just calls operator - () on the Vec4 +

+ + +

ofloat length() const +
Length of the quaternion = sqrt( vec . vec ) +

+ + +

ofloat length2() const +
Length of the quaternion = vec . vec +

+ + +

oinline Quat conj() const +
Conjugate +

+ + +

oinline const Quat inverse() const +
Multiplicative inverse method: q^(-1) = q^*/(qq^*) +

+ + +

ovoid makeRotate( float angle, float x, float y, float z ) +

+ + +

ovoid makeRotate( float angle, const Vec3& vec ) +

+ + +

ovoid makeRotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +

+ + +

ovoid makeRotate( const Vec3& vec1, const Vec3& vec2 ) +
Make a rotation Quat which will rotate vec1 to vec2. +Generally take adot product to get the angle between these +and then use a cross product to get the rotation axis +Watch out for the two special cases of when the vectors +are co-incident or opposite in direction. +

+ + +

ovoid getRotate( float& angle, float& x, float& y, float& z ) const +
Return the angle and vector components represented by the quaternion +

+ + +

ovoid getRotate( float& angle, Vec3& vec ) const +
Return the angle and vector represented by the quaternion +

+ + +

ovoid slerp( float t, const Quat& from, const Quat& to) +
Spherical Linear Interpolation. +As t goes from 0 to 1, the Quat object goes from "from" to "to". +

+ + +

ovoid set( const Matrix& m ) +
Set quaternion to be equivalent to specified matrix +

+ + +

ovoid get( Matrix& m ) const +
Get the equivalent matrix for this quaternion +

+ + +

oMatrix getMatrix() const +
Get the equivalent matrix for this quaternion +

+ +
This class has no child classes.
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const Quat& vec)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/RefMatrix.html b/doc/doc++/osg/RefMatrix.html new file mode 100644 index 000000000..84f524b2d --- /dev/null +++ b/doc/doc++/osg/RefMatrix.html @@ -0,0 +1,331 @@ + + + + + class osg::RefMatrix + + + + +

class osg::RefMatrix

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] RefMatrix() +
+[more] RefMatrix( const Matrix& other) +
+[more] RefMatrix( const RefMatrix& other) +
+[more]explicit RefMatrix( float const* const def ) +
+[more] RefMatrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp&) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +

+ +

+

Protected Methods

+[more]virtual ~RefMatrix() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+

Inherited from Matrix:

+
+

+

Public Methods

+oint compare(const Matrix& m) const +
+obool operator < (const Matrix& m) const +
+obool operator == (const Matrix& m) const +
+obool operator != (const Matrix& m) const +
+oinline float& operator()(int row, int col) +
+oinline float operator()(int row, int col) const +
+oinline bool valid() const +
+oinline bool isNaN() const +
+oinline void set(const Matrix& other) +
+oinline void set(float const* const ptr) +
+ovoid set( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +
+ofloat* ptr() const +
+ovoid makeIdentity() +
+ovoid makeScale( const Vec3& ) +
+ovoid makeScale( float, float, float ) +
+ovoid makeTranslate( const Vec3& ) +
+ovoid makeTranslate( float, float, float ) +
+ovoid makeRotate( const Vec3& from, const Vec3& to ) +
+ovoid makeRotate( float angle, const Vec3& axis ) +
+ovoid makeRotate( float angle, float x, float y, float z ) +
+ovoid makeRotate( const Quat& ) +
+ovoid makeRotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+ovoid makeOrtho(double left, double right, double bottom, double top, double zNear, double zFar) +
+oinline void makeOrtho2D(double left, double right, double bottom, double top) +
+ovoid makeFrustum(double left, double right, double bottom, double top, double zNear, double zFar) +
+ovoid makePerspective(double fovy, double aspectRatio, double zNear, double zFar) +
+ovoid makeLookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
+obool invert( const Matrix& ) +
+oinline static Matrix identity( void ) +
+oinline static Matrix scale( const Vec3& sv) +
+oinline static Matrix scale( float sx, float sy, float sz) +
+oinline static Matrix translate( const Vec3& dv) +
+oinline static Matrix translate( float x, float y, float z) +
+oinline static Matrix rotate( const Vec3& from, const Vec3& to) +
+oinline static Matrix rotate( float angle, float x, float y, float z) +
+oinline static Matrix rotate( float angle, const Vec3& axis) +
+oinline static Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+oinline static Matrix rotate( const Quat& quat) +
+oinline static Matrix inverse( const Matrix& matrix) +
+oinline static Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +
+oinline static Matrix ortho2D(double left, double right, double bottom, double top) +
+oinline static Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +
+oinline static Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +
+oinline static Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
+ovoid setTrans( float tx, float ty, float tz ) +
+ovoid setTrans( const Vec3& v ) +
+oinline Vec3 getTrans() const +
+oinline Vec3 getScale() const +
+oinline static Vec3 transform3x3(const Vec3& v, const Matrix& m) +
+oinline static Vec3 transform3x3(const Matrix& m, const Vec3& v) +
+ovoid mult( const Matrix&, const Matrix& ) +
+ovoid preMult( const Matrix& ) +
+ovoid postMult( const Matrix& ) +
+oinline void operator *= ( const Matrix& other ) +
+oinline Matrix operator * ( const Matrix &m ) const +
+oinline Matrix identity(void) +
+oinline Matrix scale(float sx, float sy, float sz) +
+oinline Matrix scale(const Vec3& v ) +
+oinline Matrix translate(float tx, float ty, float tz) +
+oinline Matrix translate(const Vec3& v ) +
+oinline Matrix rotate( const Quat& q ) +
+oinline Matrix rotate(float angle, float x, float y, float z ) +
+oinline Matrix rotate(float angle, const Vec3& axis ) +
+oinline Matrix rotate( float angle1, const Vec3& axis1, float angle2, const Vec3& axis2, float angle3, const Vec3& axis3) +
+oinline Matrix rotate(const Vec3& from, const Vec3& to ) +
+oinline Matrix inverse( const Matrix& matrix) +
+oinline Matrix ortho(double left, double right, double bottom, double top, double zNear, double zFar) +
+oinline Matrix ortho2D(double left, double right, double bottom, double top) +
+oinline Matrix frustum(double left, double right, double bottom, double top, double zNear, double zFar) +
+oinline Matrix perspective(double fovy, double aspectRatio, double zNear, double zFar) +
+oinline Matrix lookAt(const Vec3& eye, const Vec3& center, const Vec3& up) +
+oinline Vec3 postMult( const Vec3& v ) const +
+oinline Vec3 preMult( const Vec3& v ) const +
+oinline Vec4 postMult( const Vec4& v ) const +
+oinline Vec4 preMult( const Vec4& v ) const +
+oinline Vec3 transform3x3(const Vec3& v, const Matrix& m) +
+oinline Vec3 transform3x3(const Matrix& m, const Vec3& v) +
+oinline Vec3 operator* (const Vec3& v) const +
+oinline Vec4 operator* (const Vec4& v) const +

+ +

+

Protected Fields

+ofloat _mat[4][4] +

+ +
+ + +
+

Documentation

+
+ + + +
o RefMatrix() +

+ + +

o RefMatrix( const Matrix& other) +

+ + +

o RefMatrix( const RefMatrix& other) +

+ + +

oexplicit RefMatrix( float const* const def ) +

+ + +

o RefMatrix( float a00, float a01, float a02, float a03, float a10, float a11, float a12, float a13, float a20, float a21, float a22, float a23, float a30, float a31, float a32, float a33) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp&) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual ~RefMatrix() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Referenced.html b/doc/doc++/osg/Referenced.html new file mode 100644 index 000000000..89e5a0a01 --- /dev/null +++ b/doc/doc++/osg/Referenced.html @@ -0,0 +1,156 @@ + + + + + class SG_EXPORT osg::Referenced + + + + +

class SG_EXPORT osg::Referenced

Base class from providing referencing counted objects
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Referenced() +
+[more] Referenced(const Referenced&) +
+[more]inline Referenced& operator = (Referenced&) +
+[more]static void setDeleteHandler(DeleteHandler* handler) +
Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to +
+[more]static DeleteHandler* getDeleteHandler() +
Get a DeleteHandler +
+[more]inline void ref() const +
increment the reference count by one, indicating that this object has another pointer which is referencing it +
+[more]inline void unref_nodelete() const +
decrement the reference count by one, indicating that a pointer to this object is referencing it. +
+[more]inline int referenceCount() const +
return the number pointers currently referencing this object. +
+[more]inline void unref() const +
decrement the reference count by one, indicating that a pointer to this object is referencing it. +

+ +

+

Protected Fields

+[more]mutable int _refCount +

+ +

+

Protected Methods

+[more]virtual ~Referenced() +

+ +
+ + +
+

Documentation

+
Base class from providing referencing counted objects
+
+ + + +
o Referenced() +

+ + +

o Referenced(const Referenced&) +

+ + +

oinline Referenced& operator = (Referenced&) +

+ + +

ostatic void setDeleteHandler(DeleteHandler* handler) +
Set a DeleteHandler to which deletion of all referenced counted objects +will be delegated to +

+ + +

ostatic DeleteHandler* getDeleteHandler() +
Get a DeleteHandler +

+ + +

oinline void ref() const +
increment the reference count by one, indicating that +this object has another pointer which is referencing it +

+ + +

oinline void unref_nodelete() const +
decrement the reference count by one, indicating that +a pointer to this object is referencing it. However, do +not delete it, even if ref count goes to 0. Warning, unref_nodelete() +should only be called if the user knows exactly who will +be resonsible for, one should prefer unref() over unref_nodelete() +as the later can lead to memory leaks. +

+ + +

oinline int referenceCount() const +
return the number pointers currently referencing this object. +

+ + +

ovirtual ~Referenced() +

+ + +

omutable int _refCount +

+ + +

oinline void unref() const +
decrement the reference count by one, indicating that +a pointer to this object is referencing it. If the +reference count goes to zero, it is assumed that this object +is no longer referenced and is automatically deleted. +

+
+
Direct child classes: +
Test
+Extensions
+SubloadCallback
+SubloadCallback
+Extensions
+SubloadCallback
+Extensions
+SubloadCallback
+SubloadCallback
+Extensions
+State
+Object
+NodeVisitor
+LineSegment
+ImpostorSpriteManager
+FrameStamp
+DisplaySettings
+CullingSet
+Camera
+
+ +
Friends:
class DeleteHandler

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Sequence.html b/doc/doc++/osg/Sequence.html new file mode 100644 index 000000000..d13ab7a06 --- /dev/null +++ b/doc/doc++/osg/Sequence.html @@ -0,0 +1,519 @@ + + + + + class SG_EXPORT osg::Sequence + + + + +

class SG_EXPORT osg::Sequence

Sequence is a Group node which allows automatic, time based switching between children
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Sequence() +
+[more] Sequence(const Sequence&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Sequence) +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]void setValue(int value) +
+[more]int getValue() const +
+[more]void setTime(int frame, float t) +
Set time in seconds for child +
+[more]float getTime(int frame) const +
Get time for child +
+[more]void setInterval(LoopMode mode, int begin, int end) +
Set sequence mode & interval. +
+[more]inline void getInterval(LoopMode& mode, int& begin, int& end) const +
Get sequence mode & interval. +
+[more]void setDuration(float speed, int nreps = -1) +
Set duration: speed-up & number of repeats +
+[more]inline void getDuration(float& speed, int& nreps) const +
Get duration +
+[more]void setMode(SequenceMode mode) +
Set sequence mode. +
+[more]inline SequenceMode getMode() const +
Get sequence mode. +

+ +

+

Public Members

+[more]enum LoopMode +
Interval modes +
+[more]enum SequenceMode +
Sequence modes +

+ +

+

Protected Fields

+[more]int _value +
+[more]float _last +
+[more]std::vector<float> _frameTime +
+[more]int _step +
+[more]LoopMode _loopMode +
+[more]int _begin +
+[more]int _end +
+[more]float _speed +
+[more]int _nreps +
+[more]int _nrepsremain +
+[more]SequenceMode _mode +

+ +

+

Protected Methods

+[more]virtual ~Sequence() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Sequence is a Group node which allows automatic, time based +switching between children
+
+ + + +
o Sequence() +

+ + +

o Sequence(const Sequence&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Sequence) +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovoid setValue(int value) +

+ + +

oint getValue() const +

+ + +

ovoid setTime(int frame, float t) +
Set time in seconds for child +

+ + +

ofloat getTime(int frame) const +
Get time for child +

+ + +

oenum LoopMode +
Interval modes +

+ + + +
o LOOP +

+ + +

o SWING +

+ + + +
ovoid setInterval(LoopMode mode, int begin, int end) +
Set sequence mode & interval. +

+ + +

oinline void getInterval(LoopMode& mode, int& begin, int& end) const +
Get sequence mode & interval. +

+ + +

ovoid setDuration(float speed, int nreps = -1) +
Set duration: speed-up & number of repeats +

+ + +

oinline void getDuration(float& speed, int& nreps) const +
Get duration +

+ + +

oenum SequenceMode +
Sequence modes +

+ + + +
o START +

+ + +

o STOP +

+ + +

o PAUSE +

+ + +

o RESUME +

+ + + +
ovoid setMode(SequenceMode mode) +
Set sequence mode. Start/stop & pause/resume. +

+ + +

oinline SequenceMode getMode() const +
Get sequence mode. +

+ + +

ovirtual ~Sequence() +

+ + +

oint _value +

+ + +

ofloat _last +

+ + +

ostd::vector<float> _frameTime +

+ + +

oint _step +

+ + +

oLoopMode _loopMode +

+ + +

oint _begin +

+ + +

oint _end +

+ + +

ofloat _speed +

+ + +

oint _nreps +

+ + +

oint _nrepsremain +

+ + +

oSequenceMode _mode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ShadeModel.html b/doc/doc++/osg/ShadeModel.html new file mode 100644 index 000000000..fb0d22d45 --- /dev/null +++ b/doc/doc++/osg/ShadeModel.html @@ -0,0 +1,223 @@ + + + + + class SG_EXPORT osg::ShadeModel + + + + +

class SG_EXPORT osg::ShadeModel

Class which encapsulates glShadeModel()
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ShadeModel() +
+[more] ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, ShadeModel, SHADEMODEL) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setMode(Mode mode) +
+[more]inline Mode getMode() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Mode +

+ +

+

Protected Fields

+[more]Mode _mode +

+ +

+

Protected Methods

+[more]virtual ~ShadeModel() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Class which encapsulates glShadeModel()
+
+ + + +
o ShadeModel() +

+ + +

o ShadeModel(const ShadeModel& sm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, ShadeModel, SHADEMODEL) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum Mode +

+ + + +
o FLAT +

+ + +

o SMOOTH +

+ + + +
oinline void setMode(Mode mode) +

+ + +

oinline Mode getMode() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~ShadeModel() +

+ + +

oMode _mode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ShadowVolumeOccluder.html b/doc/doc++/osg/ShadowVolumeOccluder.html new file mode 100644 index 000000000..4e175b488 --- /dev/null +++ b/doc/doc++/osg/ShadowVolumeOccluder.html @@ -0,0 +1,222 @@ + + + + + class SG_EXPORT osg::ShadowVolumeOccluder + + + + +

class SG_EXPORT osg::ShadowVolumeOccluder

ShadowVolumeOccluder is a helper class for implementating shadow occlusion culling.
+
+ +
+

+

Public Methods

+[more] ShadowVolumeOccluder(const ShadowVolumeOccluder& svo) +
+[more] ShadowVolumeOccluder() +
+[more]bool operator < (const ShadowVolumeOccluder& svo) const +
+[more]bool computeOccluder(const NodePath& nodePath, const ConvexPlanarOccluder& occluder, CullStack& cullStack, bool createDrawables=false) +
compute the shadow volume occluder. +
+[more]bool matchProjectionMatrix(const osg::Matrix& matrix) const +
return true if the matrix passed in matches the projection matrix that this ShaowVolumeOccluder is associated with +
+[more]inline void setNodePath(NodePath& nodePath) +
Set the NodePath which describes the which node in the scene graph that this occluder was attached to +
+[more]inline NodePath& getNodePath() +
+[more]inline const NodePath& getNodePath() const +
+[more]float getVolume() const +
get the volume of the occluder minus its holes, in eye coords, the volume is normalized by dividing by the volume of the view frustum in eye coords +
+[more]Polytope& getOccluder() +
return the occluder polytope +
+[more]const Polytope& getOccluder() const +
return the const occluder polytope +
+[more]HoleList& getHoleList() +
return the list of holes +
+[more]const HoleList& getHoleList() const +
return the const list of holes +
+[more]bool contains(const std::vector<Vec3>& vertices) +
return true if the specified vertex list is contaned entirely within this shadow occluder volume +
+[more]bool contains(const BoundingSphere& bound) +
return true if the specified bounding sphere is contaned entirely within this shadow occluder volume +
+[more]bool contains(const BoundingBox& bound) +
return true if the specified bounding box is contained entirely within this shadow occluder volume +
+[more]inline void transformProvidingInverse(const osg::Matrix& matrix) +
+[more]inline void disableResultMasks() +
+[more]inline void pushCurrentMask() +
+[more]inline void popCurrentMask() +

+ +

+

Public Members

+[more]typedef std::vector<Polytope> HoleList +

+ +

+

Protected Fields

+[more]float _volume +
+[more]NodePath _nodePath +
+[more]ref_ptr<const RefMatrix> _projectionMatrix +
+[more]Polytope _occluderVolume +
+[more]HoleList _holeList +

+ +
+ + +
+

Documentation

+
ShadowVolumeOccluder is a helper class for implementating shadow occlusion culling.
+
+ + + +
otypedef std::vector<Polytope> HoleList +

+ + +

o ShadowVolumeOccluder(const ShadowVolumeOccluder& svo) +

+ + +

o ShadowVolumeOccluder() +

+ + +

obool operator < (const ShadowVolumeOccluder& svo) const +

+ + +

obool computeOccluder(const NodePath& nodePath, const ConvexPlanarOccluder& occluder, CullStack& cullStack, bool createDrawables=false) +
compute the shadow volume occluder. +

+ + +

obool matchProjectionMatrix(const osg::Matrix& matrix) const +
return true if the matrix passed in matches the projection matrix that this ShaowVolumeOccluder is +associated with +

+ + +

oinline void setNodePath(NodePath& nodePath) +
Set the NodePath which describes the which node in the scene graph +that this occluder was attached to +

+ + +

oinline NodePath& getNodePath() +

+ + +

oinline const NodePath& getNodePath() const +

+ + +

ofloat getVolume() const +
get the volume of the occluder minus its holes, in eye coords, the volume is normalized by dividing by +the volume of the view frustum in eye coords +

+ + +

oPolytope& getOccluder() +
return the occluder polytope +

+ + +

oconst Polytope& getOccluder() const +
return the const occluder polytope +

+ + +

oHoleList& getHoleList() +
return the list of holes +

+ + +

oconst HoleList& getHoleList() const +
return the const list of holes +

+ + +

obool contains(const std::vector<Vec3>& vertices) +
return true if the specified vertex list is contaned entirely +within this shadow occluder volume +

+ + +

obool contains(const BoundingSphere& bound) +
return true if the specified bounding sphere is contaned entirely +within this shadow occluder volume +

+ + +

obool contains(const BoundingBox& bound) +
return true if the specified bounding box is contained entirely +within this shadow occluder volume +

+ + +

oinline void transformProvidingInverse(const osg::Matrix& matrix) +

+ + +

ofloat _volume +

+ + +

oNodePath _nodePath +

+ + +

oref_ptr<const RefMatrix> _projectionMatrix +

+ + +

oPolytope _occluderVolume +

+ + +

oHoleList _holeList +

+ + +

oinline void disableResultMasks() +

+ + +

oinline void pushCurrentMask() +

+ + +

oinline void popCurrentMask() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ShadowVolumeOccluderList.html b/doc/doc++/osg/ShadowVolumeOccluderList.html new file mode 100644 index 000000000..09f0f755d --- /dev/null +++ b/doc/doc++/osg/ShadowVolumeOccluderList.html @@ -0,0 +1,20 @@ + + + + + typedef std::vector<ShadowVolumeOccluder> osg::ShadowVolumeOccluderList + + + + +

typedef std::vector<ShadowVolumeOccluder> osg::ShadowVolumeOccluderList

A list of ShadowVolumeOccluder, used by CollectOccluderVisitor and CullVistor's
+ + +
+

Documentation

+
A list of ShadowVolumeOccluder, used by CollectOccluderVisitor and CullVistor's
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Shape.html b/doc/doc++/osg/Shape.html new file mode 100644 index 000000000..1ed6254ca --- /dev/null +++ b/doc/doc++/osg/Shape.html @@ -0,0 +1,187 @@ + + + + + class SG_EXPORT osg::Shape + + + + +

class SG_EXPORT osg::Shape

Base class for all shape types.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Shape() +
+[more] Shape(const Shape& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual Object* cloneType() const = 0 +
Clone the type of an attribute, with Object* return type. +
+[more]virtual Object* clone(const CopyOp&) const = 0 +
Clone an attribute, with Object* return type. +
+[more]virtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +
+[more]virtual const char* libraryName() const +
return the name of the attribute's library +
+[more]virtual const char* className() const +
return the name of the attribute's class type +
+[more]virtual void accept(ShapeVisitor&) = 0 +
accept a non const shape visitor which can be used on non const shape objects. +
+[more]virtual void accept(ConstShapeVisitor&) const = 0 +
accept a const shape visitor which can be used on const shape objects. +

+ +

+

Protected Methods

+[more]virtual ~Shape() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Base class for all shape types. +Shapes are used to either for culling and collision detection or +to define the geometric shape of procedurally generate Geometry.
+
+ + + +
o Shape() +

+ + +

o Shape(const Shape& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual Object* cloneType() const = 0 +
Clone the type of an attribute, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual Object* clone(const CopyOp&) const = 0 +
Clone an attribute, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +

+ + +

ovirtual const char* libraryName() const +
return the name of the attribute's library +

+ + +

ovirtual const char* className() const +
return the name of the attribute's class type +

+ + +

ovirtual void accept(ShapeVisitor&) = 0 +
accept a non const shape visitor which can be used on non const shape objects. +Must be defined by derived classes. +

+ + +

ovirtual void accept(ConstShapeVisitor&) const = 0 +
accept a const shape visitor which can be used on const shape objects. +Must be defined by derived classes. +

+ + +

ovirtual ~Shape() +

+
+
Direct child classes: +
TriangleMesh
+Sphere
+InfinitePlane
+HeightField
+Cylinder
+Cone
+CompositeShape
+Box
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ShapeDrawable.html b/doc/doc++/osg/ShapeDrawable.html new file mode 100644 index 000000000..a816c2088 --- /dev/null +++ b/doc/doc++/osg/ShapeDrawable.html @@ -0,0 +1,399 @@ + + + + + class SG_EXPORT osg::ShapeDrawable + + + + +

class SG_EXPORT osg::ShapeDrawable

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ShapeDrawable() +
+[more] ShapeDrawable(Shape* shape) +
+[more] ShapeDrawable(const ShapeDrawable& pg, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]void setColor(const Vec4& color) +
set the color of the shape +
+[more]const Vec4& getColor() const +
get the color of the shape +
+[more]void setTessellationHints(TessellationHints* hints) +
+[more]TessellationHints* getTessellationHints() +
+[more]const TessellationHints* getTessellationHints() const +
+[more]virtual void drawImplementation(State& state) const +
draw ShapeDrawable directly ignoring an OpenGL display list which could be attached. +
+[more]virtual bool supports(AttributeFunctor&) const +
return false, osg::ShapeDrawable does not support accept(AttributeFunctor&) +
+[more]virtual bool supports(ConstAttributeFunctor&) const +
return true, osg::ShapeDrawable does support accept(ConstAttributeFunctor&) +
+[more]virtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(PrimitiveFunctor&) const +
return true, osg::ShapeDrawable does support accept(PrimitiveFunctor&) +
+[more]virtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ +

+

Protected Fields

+[more]Vec4 _color +
+[more]ref_ptr<TessellationHints> _tessellationHints +

+ +

+

Protected Methods

+[more]ShapeDrawable& operator = (const ShapeDrawable&) +
+[more]virtual ~ShapeDrawable() +
+[more]virtual bool computeBound() const +

+ +
+

Inherited from Drawable:

+
+

+

Public Methods

+ovirtual Geometry* asGeometry() +
+ovirtual const Geometry* asGeometry() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Node* getParent(unsigned int i) +
+oinline const Node* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+oinline void setStateSet(StateSet* state) +
+oinline StateSet* getStateSet() +
+oinline const StateSet* getStateSet() const +
+oStateSet* getOrCreateStateSet() +
+ovoid dirtyBound() +
+oinline const BoundingBox& getBound() const +
+oinline void setShape(Shape* shape) +
+oinline Shape* getShape() +
+oinline const Shape* getShape() const +
+ovoid setSupportsDisplayList(bool flag) +
+oinline bool getSupportsDisplayList() const +
+ovoid setUseDisplayList(bool flag) +
+oinline bool getUseDisplayList() const +
+ovoid dirtyDisplayList() +
+ovirtual void compile(State& state) const +
+ovoid setUpdateCallback(UpdateCallback* ac) +
+oUpdateCallback* getUpdateCallback() +
+ovoid setAppCallback(AppCallback* ac) +
+oAppCallback* getAppCallback() +
+oconst AppCallback* getAppCallback() const +
+ovoid setCullCallback(CullCallback* cc) +
+oCullCallback* getCullCallback() +
+oconst CullCallback* getCullCallback() const +
+ovoid setDrawCallback(DrawCallback* dc) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ostatic void deleteDisplayList(unsigned int contextID, GLuint globj) +
+ostatic void flushDeletedDisplayLists(unsigned int contextID) +
+oinline void draw(State& state) const +

+ +

+

Public Members

+otypedef std::vector<Node*> ParentList +
+ostruct UpdateCallback: public virtual osg::Referenced +
+ostruct AppCallback: public UpdateCallback +
+ostruct CullCallback: public virtual osg::Referenced +
+ostruct DrawCallback: public virtual osg::Referenced +
+oenum AttributeType +
+class AttributeFunctor +
+class ConstAttributeFunctor +
+class PrimitiveFunctor +

+ +

+

Protected Fields

+oParentList _parents +
+oref_ptr<StateSet> _stateset +
+omutable BoundingBox _bbox +
+omutable bool _bbox_computed +
+oref_ptr<Shape> _shape +
+obool _supportsDisplayList +
+obool _useDisplayList +
+omutable GLObjectList _globjList +
+oref_ptr<UpdateCallback> _updateCallback +
+oref_ptr<DrawCallback> _drawCallback +
+oref_ptr<CullCallback> _cullCallback +

+ +

+

Protected Methods

+ovoid setBound(const BoundingBox& bb) const +
+ovoid addParent(osg::Node* node) +
+ovoid removeParent(osg::Node* node) +

+ +

+

Protected Members

+otypedef osg::buffered_value<GLuint> GLObjectList +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o ShapeDrawable() +

+ + +

o ShapeDrawable(Shape* shape) +

+ + +

o ShapeDrawable(const ShapeDrawable& pg, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovoid setColor(const Vec4& color) +
set the color of the shape +

+ + +

oconst Vec4& getColor() const +
get the color of the shape +

+ + +

ovoid setTessellationHints(TessellationHints* hints) +

+ + +

oTessellationHints* getTessellationHints() +

+ + +

oconst TessellationHints* getTessellationHints() const +

+ + +

ovirtual void drawImplementation(State& state) const +
draw ShapeDrawable directly ignoring an OpenGL display list which could be attached. +This is the internal draw method which does the drawing itself, +and is the method to override when deriving from ShapeDrawable for user-drawn objects. +

+ + +

ovirtual bool supports(AttributeFunctor&) const +
return false, osg::ShapeDrawable does not support accept(AttributeFunctor&) +

+ + +

ovirtual bool supports(ConstAttributeFunctor&) const +
return true, osg::ShapeDrawable does support accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(PrimitiveFunctor&) const +
return true, osg::ShapeDrawable does support accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ + +

oShapeDrawable& operator = (const ShapeDrawable&) +

+ + +

ovirtual ~ShapeDrawable() +

+ + +

ovirtual bool computeBound() const +

+ + +

oVec4 _color +

+ + +

oref_ptr<TessellationHints> _tessellationHints +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ShapeVisitor.html b/doc/doc++/osg/ShapeVisitor.html new file mode 100644 index 000000000..a8e385114 --- /dev/null +++ b/doc/doc++/osg/ShapeVisitor.html @@ -0,0 +1,90 @@ + + + + + class osg::ShapeVisitor + + + + +

class osg::ShapeVisitor

+ +
+

+

Public Methods

+[more] ShapeVisitor() +
+[more]virtual void apply(Sphere&) +
+[more]virtual void apply(Box&) +
+[more]virtual void apply(Cone&) +
+[more]virtual void apply(Cylinder&) +
+[more]virtual void apply(InfinitePlane&) +
+[more]virtual void apply(TriangleMesh&) +
+[more]virtual void apply(ConvexHull&) +
+[more]virtual void apply(HeightField&) +
+[more]virtual void apply(CompositeShape&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ShapeVisitor() +

+ + +

ovirtual void apply(Sphere&) +

+ + +

ovirtual void apply(Box&) +

+ + +

ovirtual void apply(Cone&) +

+ + +

ovirtual void apply(Cylinder&) +

+ + +

ovirtual void apply(InfinitePlane&) +

+ + +

ovirtual void apply(TriangleMesh&) +

+ + +

ovirtual void apply(ConvexHull&) +

+ + +

ovirtual void apply(HeightField&) +

+ + +

ovirtual void apply(CompositeShape&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Sphere.html b/doc/doc++/osg/Sphere.html new file mode 100644 index 000000000..6ee73e62e --- /dev/null +++ b/doc/doc++/osg/Sphere.html @@ -0,0 +1,191 @@ + + + + + class osg::Sphere + + + + +

class osg::Sphere

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Sphere() +
+[more] Sphere(const osg::Vec3& center, float radius) +
+[more] Sphere(const Sphere& sphere, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, Sphere)() const +
+[more]inline void set(const Vec3& center, float radius) +
+[more]inline void setCenter(const Vec3& center) +
+[more]inline const Vec3& getCenter() const +
+[more]inline void setRadius(float radius) +
+[more]inline float getRadius() const +

+ +

+

Protected Fields

+[more]Vec3 _center +
+[more]float _radius +

+ +

+

Protected Methods

+[more]virtual ~Sphere() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o Sphere() +

+ + +

o Sphere(const osg::Vec3& center, float radius) +

+ + +

o Sphere(const Sphere& sphere, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, Sphere)() const +

+ + +

oinline void set(const Vec3& center, float radius) +

+ + +

oinline void setCenter(const Vec3& center) +

+ + +

oinline const Vec3& getCenter() const +

+ + +

oinline void setRadius(float radius) +

+ + +

oinline float getRadius() const +

+ + +

ovirtual ~Sphere() +

+ + +

oVec3 _center +

+ + +

ofloat _radius +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/State.html b/doc/doc++/osg/State.html new file mode 100644 index 000000000..2636bbdf8 --- /dev/null +++ b/doc/doc++/osg/State.html @@ -0,0 +1,1101 @@ + + + + + class SG_EXPORT osg::State + + + + +

class SG_EXPORT osg::State

State class for managing a state stack.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] State() +
+[more]void pushStateSet(const StateSet* dstate) +
push stateset onto state stack +
+[more]void popStateSet() +
pop drawstate off state stack +
+[more]void captureCurrentState(StateSet& stateset) const +
copy the modes and attributes which captures the current state +
+[more]void reset() +
reset the state object to an empty stack +
+[more]inline void applyProjectionMatrix(const osg::RefMatrix* matrix) +
+[more]const osg::Matrix& getProjectionMatrix() const +
+[more]inline void applyModelViewMatrix(const osg::RefMatrix* matrix) +
+[more]const osg::Matrix& getModelViewMatrix() const +
+[more]Polytope getViewFrustum() const +
+[more]void apply(const StateSet* dstate) +
Apply stateset +
+[more]void apply() +
Apply the state +
+[more]inline bool applyMode(StateAttribute::GLMode mode, bool enabled) +
Apply an OpenGL mode if required. +
+[more]inline bool applyTextureMode(unsigned int unit, StateAttribute::GLMode mode, bool enabled) +
+[more]inline bool applyAttribute(const StateAttribute* attribute) +
Apply an attribute if required. +
+[more]inline bool applyTextureAttribute(unsigned int unit, const StateAttribute* attribute) +
+[more]void haveAppliedMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
Mode has been set externally, update state to reflect this setting +
+[more]void haveAppliedMode(StateAttribute::GLMode mode) +
Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply() +
+[more]void haveAppliedAttribute(const StateAttribute* attribute) +
Attribute has been applied externally, update state to reflect this setting +
+[more]void haveAppliedAttribute(StateAttribute::Type type) +
Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-appplied on next osg::Stateapply(). +
+[more]bool getLastAppliedMode(StateAttribute::GLMode mode) const +
Get whether the current specified mode is enabled (true) or disabled (false) +
+[more]const StateAttribute* getLastAppliedAttribute(StateAttribute::Type type) const +
Get the current specified attribute, return NULL is one has not yet been applied +
+[more]void haveAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
texture Mode has been set externally, update state to reflect this setting +
+[more]void haveAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode) +
texture Mode has been set externally, therefore dirty the associated mode in osg::State so it is applied on next call to osg::State::apply() +
+[more]void haveAppliedTextureAttribute(unsigned int unit, const StateAttribute* attribute) +
texture Attribute has been applied externally, update state to reflect this setting +
+[more]void haveAppliedTextureAttribute(unsigned int unit, StateAttribute::Type type) +
texture Attribute has been applied externally, and therefore this attribute type has been dirtied and will need to be re-appplied on next osg::Stateapply(). +
+[more]bool getLastAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode) const +
Get whether the current specified texture mode is enabled (true) or disabled (false) +
+[more]const StateAttribute* getLastAppliedTextureAttribute(unsigned int unit, StateAttribute::Type type) const +
Get the current specified texture attribute, return NULL is one has not yet been applied +
+[more]void dirtyAllModes() +
Dirty the modes previously applied in osg::State +
+[more]void dirtyAllAttributes() +
Dirty the modes attributes previously applied in osg::State +
+[more]void disableAllVertexArrays() +
disable the vertex, normal, color, tex coords, secenday color, fog coord and index arrays +
+[more]void dirtyAllVertexArrays() +
dirty the vertex, normal, color, tex coords, secenday color, fog coord and index arrays +
+[more]void setInterleavedArrays( GLenum format, GLsizei stride, const GLvoid* pointer) +
Wrapper around glInterleavedArrays(). +
+[more]inline void setVertexPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_VERTEX_ARRAY);glVertexPointer(); note, only updates values that change +
+[more]inline void disableVertexPointer() +
wrapper glDisableClientState(GL_VERTEX_ARRAY). +
+[more]inline void dirtyVertexPointer() +
+[more]inline void setNormalPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_NORMAL_ARRAY);glNormalPointer(); note, only updates values that change +
+[more]inline void disableNormalPointer() +
wrapper around glDisableClientState(GL_NORMAL_ARRAY); note, only updates values that change +
+[more]inline void dirtyNormalPointer() +
+[more]inline void setColorPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_COLOR_ARRAY);glColorPointer(); note, only updates values that change +
+[more]inline void disableColorPointer() +
wrapper around glDisableClientState(GL_COLOR_ARRAY); note, only updates values that change +
+[more]inline void dirtyColorPointer() +
+[more]inline bool isSecondaryColorSupported() const +
+[more]void setSecondaryColorPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_SECONDARY_COLOR_ARRAY);glSecondayColorPointer(); note, only updates values that change +
+[more]inline void disableSecondaryColorPointer() +
wrapper around glDisableClientState(GL_SECONDARY_COLOR_ARRAY); note, only updates values that change +
+[more]inline void dirtySecondaryColorPointer() +
+[more]inline void setIndexPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_INDEX_ARRAY);glIndexPointer(); note, only updates values that change +
+[more]inline void disableIndexPointer() +
wrapper around glDisableClientState(GL_INDEX_ARRAY); note, only updates values that change +
+[more]inline void dirtyIndexPointer() +
+[more]inline bool isFogCoordSupported() const +
+[more]void setFogCoordPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_FOG_COORDINATE_ARRAY);glFogCoordPointer(); note, only updates values that change +
+[more]inline void disableFogCoordPointer() +
wrapper around glDisableClientState(GL_FOG_COORDINATE_ARRAY); note, only updates values that change +
+[more]inline void dirtyFogCoordPointer() +
+[more]inline void setTexCoordPointer( unsigned int unit, GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_TEXTURE_COORD_ARRAY);glTexCoordPointer(); note, only updates values that change +
+[more]inline void disableTexCoordPointer( unsigned int unit ) +
wrapper around glDisableClientState(GL_TEXTURE_COORD_ARRAY); note, only updates values that change +
+[more]inline void dirtyTexCoordPointer( unsigned int unit ) +
+[more]inline void disableTexCoordPointersAboveAndIncluding( unsigned int unit ) +
+[more]inline void dirtyTexCoordPointersAboveAndIncluding( unsigned int unit ) +
+[more]bool setClientActiveTextureUnit( unsigned int unit ) +
set the current tex coord array texture unit, return true if selected, false if selection failed such as when multitexturing is not supported. +
+[more]bool setActiveTextureUnit( unsigned int unit ) +
set the current texture unit, return true if selected, false if selection failed such as when multitexturing is not supported. +
+[more]inline void setContextID(unsigned int contextID) +
Set the current OpenGL context uniqueID. +
+[more]inline unsigned int getContextID() const +
Get the current OpenGL context unique ID +
+[more]inline void setFrameStamp(FrameStamp* fs) +
Set the frame stamp for the current frame +
+[more]inline const FrameStamp* getFrameStamp() const +
Set the frame stamp for the current frame +
+[more]inline void setDisplaySettings(DisplaySettings* vs) +
Set the DisplaySettings. +
+[more]inline const DisplaySettings* getDisplaySettings() const +
Get the DisplaySettings +
+[more]void setAbortRenderingPtr(bool* abortPtr) +
Set flag for early termination of the draw traversal +
+[more]bool getAbortRendering() const +
Get flag for early termination of the draw traversal, if true steps should be taken to complete rendering early +
+[more]void setReportGLErrors(bool flag) +
+[more]bool getReportGLErrors() const +
+[more]bool checkGLErrors(const char* str) const +
+[more]bool checkGLErrors(StateAttribute::GLMode mode) const +
+[more]bool checkGLErrors(const StateAttribute* attribute) const +
+[more]inline void pushModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +
+[more]inline void pushAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +
+[more]inline void popModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +
+[more]inline void popAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +
+[more]inline void applyModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +
+[more]inline void applyAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +
+[more]inline void applyModeMap(ModeMap& modeMap) +
+[more]inline void applyAttributeMap(AttributeMap& attributeMap) +

+ +

+

Public Members

+[more]typedef std::pair<const StateAttribute*,StateAttribute::OverrideValue> AttributePair +
+[more]typedef std::vector<AttributePair> AttributeVec +
+[more]typedef std::vector<StateAttribute::GLModeValue> ValueVec +

+ +

+

Protected Fields

+[more]unsigned int _contextID +
+[more]ref_ptr<FrameStamp> _frameStamp +
+[more]ref_ptr<const RefMatrix> _identity +
+[more]ref_ptr<const RefMatrix> _projection +
+[more]ref_ptr<const RefMatrix> _modelView +
+[more]ref_ptr<DisplaySettings> _displaySettings +
+[more]bool* _abortRenderingPtr +
+[more]bool _reportGLErrors +
+[more]ModeMap _modeMap +
+[more]AttributeMap _attributeMap +
+[more]TextureModeMapList _textureModeMapList +
+[more]TextureAttributeMapList _textureAttributeMapList +
+[more]StateSetStack _drawStateStack +
+[more]EnabledArrayPair _vertexArray +
+[more]EnabledArrayPair _normalArray +
+[more]EnabledArrayPair _colorArray +
+[more]EnabledArrayPair _secondaryColorArray +
+[more]EnabledArrayPair _indexArray +
+[more]EnabledArrayPair _fogArray +
+[more]EnabledTexCoordArrayList _texCoordArrayList +
+[more]unsigned int _currentActiveTextureUnit +
+[more]unsigned int _currentClientActiveTextureUnit +
+[more]mutable bool _isSecondColorSupportResolved +
+[more]mutable bool _isSecondColorSupported +
+[more]mutable bool _isFogCoordSupportResolved +
+[more]mutable bool _isFogCoordSupported +

+ +

+

Protected Methods

+[more]virtual ~State() +
+[more]inline bool applyMode(StateAttribute::GLMode mode, bool enabled, ModeStack& ms) +
apply an OpenGL mode if required, passing in mode, enable flag and appropriate mode stack +
+[more]inline bool applyAttribute(const StateAttribute* attribute, AttributeStack& as) +
apply an attribute if required, passing in attribute and appropriate attribute stack +
+[more]inline bool applyGlobalDefaultAttribute(AttributeStack& as) +
+[more]inline ModeMap& getOrCreateTextureModeMap(unsigned int unit) +
+[more]inline AttributeMap& getOrCreateTextureAttributeMap(unsigned int unit) +
+[more]void haveAppliedMode(ModeMap& modeMap, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
+[more]void haveAppliedMode(ModeMap& modeMap, StateAttribute::GLMode mode) +
+[more]void haveAppliedAttribute(AttributeMap& attributeMap, const StateAttribute* attribute) +
+[more]void haveAppliedAttribute(AttributeMap& attributeMap, StateAttribute::Type type) +
+[more]bool getLastAppliedMode(const ModeMap& modeMap, StateAttribute::GLMode mode) const +
+[more]const StateAttribute* getLastAppliedAttribute(const AttributeMap& attributeMap, StateAttribute::Type type) const +
+[more]bool computeSecondaryColorSupported() const +
+[more]bool computeFogCoordSupported() const +

+ +

+

Protected Members

+[more]struct ModeStack +
+[more]struct AttributeStack +
+[more]typedef std::map<StateAttribute::GLMode,ModeStack> ModeMap +
+[more]typedef std::vector<ModeMap> TextureModeMapList +
+[more]typedef std::map<StateAttribute::Type,AttributeStack> AttributeMap +
+[more]typedef std::vector<AttributeMap> TextureAttributeMapList +
+[more]typedef std::vector<const StateSet*> StateSetStack +
+[more]typedef std::vector<ref_ptr<const Matrix> > MatrixStack +
+[more]struct EnabledArrayPair +
+[more]typedef std::vector<EnabledArrayPair> EnabledTexCoordArrayList +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
State class for managing a state stack. +Lazy state updating is used to minimize state changes.
+
+ + + +
o State() +

+ + +

ovoid pushStateSet(const StateSet* dstate) +
push stateset onto state stack +

+ + +

ovoid popStateSet() +
pop drawstate off state stack +

+ + +

ovoid captureCurrentState(StateSet& stateset) const +
copy the modes and attributes which captures the current state +

+ + +

ovoid reset() +
reset the state object to an empty stack +

+ + +

oinline void applyProjectionMatrix(const osg::RefMatrix* matrix) +

+ + +

oconst osg::Matrix& getProjectionMatrix() const +

+ + +

oinline void applyModelViewMatrix(const osg::RefMatrix* matrix) +

+ + +

oconst osg::Matrix& getModelViewMatrix() const +

+ + +

oPolytope getViewFrustum() const +

+ + +

ovoid apply(const StateSet* dstate) +
Apply stateset +

+ + +

ovoid apply() +
Apply the state +

+ + +

oinline bool applyMode(StateAttribute::GLMode mode, bool enabled) +
Apply an OpenGL mode if required. +

+ + +

oinline bool applyTextureMode(unsigned int unit, StateAttribute::GLMode mode, bool enabled) +

+ + +

oinline bool applyAttribute(const StateAttribute* attribute) +
Apply an attribute if required. +

+ + +

oinline bool applyTextureAttribute(unsigned int unit, const StateAttribute* attribute) +

+ + +

ovoid haveAppliedMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
Mode has been set externally, update state to reflect this setting +

+ + +

ovoid haveAppliedMode(StateAttribute::GLMode mode) +
Mode has been set externally, therefore dirty the associated mode in osg::State +so it is applied on next call to osg::State::apply() +

+ + +

ovoid haveAppliedAttribute(const StateAttribute* attribute) +
Attribute has been applied externally, update state to reflect this setting +

+ + +

ovoid haveAppliedAttribute(StateAttribute::Type type) +
Attribute has been applied externally, +and therefore this attribute type has been dirtied +and will need to be re-appplied on next osg::Stateapply(). +note, if you have an osg::StateAttribute which you have applied externally +then use the have_applied(attribute) method as this will the osg::State to +track the current state more accuratly and enable lazy state updating such +that only changed state will be applied. +

+ + +

obool getLastAppliedMode(StateAttribute::GLMode mode) const +
Get whether the current specified mode is enabled (true) or disabled (false) +

+ + +

oconst StateAttribute* getLastAppliedAttribute(StateAttribute::Type type) const +
Get the current specified attribute, return NULL is one has not yet been applied +

+ + +

ovoid haveAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
texture Mode has been set externally, update state to reflect this setting +

+ + +

ovoid haveAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode) +
texture Mode has been set externally, therefore dirty the associated mode in osg::State +so it is applied on next call to osg::State::apply() +

+ + +

ovoid haveAppliedTextureAttribute(unsigned int unit, const StateAttribute* attribute) +
texture Attribute has been applied externally, update state to reflect this setting +

+ + +

ovoid haveAppliedTextureAttribute(unsigned int unit, StateAttribute::Type type) +
texture Attribute has been applied externally, +and therefore this attribute type has been dirtied +and will need to be re-appplied on next osg::Stateapply(). +note, if you have an osg::StateAttribute which you have applied externally +then use the have_applied(attribute) method as this will the osg::State to +track the current state more accuratly and enable lazy state updating such +that only changed state will be applied. +

+ + +

obool getLastAppliedTextureMode(unsigned int unit, StateAttribute::GLMode mode) const +
Get whether the current specified texture mode is enabled (true) or disabled (false) +

+ + +

oconst StateAttribute* getLastAppliedTextureAttribute(unsigned int unit, StateAttribute::Type type) const +
Get the current specified texture attribute, return NULL is one has not yet been applied +

+ + +

ovoid dirtyAllModes() +
Dirty the modes previously applied in osg::State +

+ + +

ovoid dirtyAllAttributes() +
Dirty the modes attributes previously applied in osg::State +

+ + +

ovoid disableAllVertexArrays() +
disable the vertex, normal, color, tex coords, secenday color, fog coord and index arrays +

+ + +

ovoid dirtyAllVertexArrays() +
dirty the vertex, normal, color, tex coords, secenday color, fog coord and index arrays +

+ + +

ovoid setInterleavedArrays( GLenum format, GLsizei stride, const GLvoid* pointer) +
Wrapper around glInterleavedArrays(). +also resets the internal array points and modes within osg::State to keep the other +vertex array operations consistent. +

+ + +

oinline void setVertexPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_VERTEX_ARRAY);glVertexPointer(); +note, only updates values that change +

+ + +

oinline void disableVertexPointer() +
wrapper glDisableClientState(GL_VERTEX_ARRAY). +note, only updates values that change. +

+ + +

oinline void dirtyVertexPointer() +

+ + +

oinline void setNormalPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_NORMAL_ARRAY);glNormalPointer(); +note, only updates values that change +

+ + +

oinline void disableNormalPointer() +
wrapper around glDisableClientState(GL_NORMAL_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtyNormalPointer() +

+ + +

oinline void setColorPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_COLOR_ARRAY);glColorPointer(); +note, only updates values that change +

+ + +

oinline void disableColorPointer() +
wrapper around glDisableClientState(GL_COLOR_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtyColorPointer() +

+ + +

oinline bool isSecondaryColorSupported() const +

+ + +

ovoid setSecondaryColorPointer( GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_SECONDARY_COLOR_ARRAY);glSecondayColorPointer(); +note, only updates values that change +

+ + +

oinline void disableSecondaryColorPointer() +
wrapper around glDisableClientState(GL_SECONDARY_COLOR_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtySecondaryColorPointer() +

+ + +

oinline void setIndexPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_INDEX_ARRAY);glIndexPointer(); +note, only updates values that change +

+ + +

oinline void disableIndexPointer() +
wrapper around glDisableClientState(GL_INDEX_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtyIndexPointer() +

+ + +

oinline bool isFogCoordSupported() const +

+ + +

ovoid setFogCoordPointer( GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_FOG_COORDINATE_ARRAY);glFogCoordPointer(); +note, only updates values that change +

+ + +

oinline void disableFogCoordPointer() +
wrapper around glDisableClientState(GL_FOG_COORDINATE_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtyFogCoordPointer() +

+ + +

oinline void setTexCoordPointer( unsigned int unit, GLint size, GLenum type, GLsizei stride, const GLvoid* ptr ) +
wrapper around glEnableClientState(GL_TEXTURE_COORD_ARRAY);glTexCoordPointer(); +note, only updates values that change +

+ + +

oinline void disableTexCoordPointer( unsigned int unit ) +
wrapper around glDisableClientState(GL_TEXTURE_COORD_ARRAY); +note, only updates values that change +

+ + +

oinline void dirtyTexCoordPointer( unsigned int unit ) +

+ + +

oinline void disableTexCoordPointersAboveAndIncluding( unsigned int unit ) +

+ + +

oinline void dirtyTexCoordPointersAboveAndIncluding( unsigned int unit ) +

+ + +

obool setClientActiveTextureUnit( unsigned int unit ) +
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. +

+ + +

obool setActiveTextureUnit( unsigned int unit ) +
set the current texture unit, return true if selected, false if selection failed such as when multitexturing is not supported. +note, only updates values that change. +

+ + +

oinline void setContextID(unsigned int contextID) +
Set the current OpenGL context uniqueID. +Note, it is the application developers responsibility to +set up unique ID for each OpenGL context. This value is +then used by osg::StateAttribure's and osg::Drawable's to +help manage OpenGL display list and texture binds appropriate +for each context, the contextID simply acts as an index 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. +By default contextID is 0. +

+ + +

oinline unsigned int getContextID() const +
Get the current OpenGL context unique ID +

+ + +

oinline void setFrameStamp(FrameStamp* fs) +
Set the frame stamp for the current frame +

+ + +

oinline const FrameStamp* getFrameStamp() const +
Set the frame stamp for the current frame +

+ + +

oinline void setDisplaySettings(DisplaySettings* vs) +
Set the DisplaySettings. Note, nothing is applied, the visual settings are just used +used in the State object to pass the current visual settings to Drawables +during rendering. +

+ + +

oinline const DisplaySettings* getDisplaySettings() const +
Get the DisplaySettings +

+ + +

otypedef std::pair<const StateAttribute*,StateAttribute::OverrideValue> AttributePair +

+ + +

otypedef std::vector<AttributePair> AttributeVec +

+ + +

otypedef std::vector<StateAttribute::GLModeValue> ValueVec +

+ + +

ovoid setAbortRenderingPtr(bool* abortPtr) +
Set flag for early termination of the draw traversal +

+ + +

obool getAbortRendering() const +
Get flag for early termination of the draw traversal, +if true steps should be taken to complete rendering early +

+ + +

ovoid setReportGLErrors(bool flag) +

+ + +

obool getReportGLErrors() const +

+ + +

obool checkGLErrors(const char* str) const +

+ + +

obool checkGLErrors(StateAttribute::GLMode mode) const +

+ + +

obool checkGLErrors(const StateAttribute* attribute) const +

+ + +

ovirtual ~State() +

+ + +

ounsigned int _contextID +

+ + +

oref_ptr<FrameStamp> _frameStamp +

+ + +

oref_ptr<const RefMatrix> _identity +

+ + +

oref_ptr<const RefMatrix> _projection +

+ + +

oref_ptr<const RefMatrix> _modelView +

+ + +

oref_ptr<DisplaySettings> _displaySettings +

+ + +

obool* _abortRenderingPtr +

+ + +

obool _reportGLErrors +

+ + +

ostruct ModeStack +

+ + + +
o ModeStack() +

+ + +

obool changed +

+ + +

obool last_applied_value +

+ + +

obool global_default_value +

+ + +

oValueVec valueVec +

+ + + +
ostruct AttributeStack +

+ + + +
o AttributeStack() +

+ + +

obool changed +
apply an attribute if required, passing in attribute and appropriate attribute stack +

+ + +

oconst StateAttribute* last_applied_attribute +

+ + +

oref_ptr<StateAttribute> global_default_attribute +

+ + +

oAttributeVec attributeVec +

+ + + +
oinline bool applyMode(StateAttribute::GLMode mode, bool enabled, ModeStack& ms) +
apply an OpenGL mode if required, passing in mode, enable flag and appropriate mode stack +

+ + +

oinline bool applyAttribute(const StateAttribute* attribute, AttributeStack& as) +
apply an attribute if required, passing in attribute and appropriate attribute stack +

+ + +

oinline bool applyGlobalDefaultAttribute(AttributeStack& as) +

+ + +

otypedef std::map<StateAttribute::GLMode,ModeStack> ModeMap +

+ + +

otypedef std::vector<ModeMap> TextureModeMapList +

+ + +

otypedef std::map<StateAttribute::Type,AttributeStack> AttributeMap +

+ + +

otypedef std::vector<AttributeMap> TextureAttributeMapList +

+ + +

otypedef std::vector<const StateSet*> StateSetStack +

+ + +

otypedef std::vector<ref_ptr<const Matrix> > MatrixStack +

+ + +

oModeMap _modeMap +

+ + +

oAttributeMap _attributeMap +

+ + +

oTextureModeMapList _textureModeMapList +

+ + +

oTextureAttributeMapList _textureAttributeMapList +

+ + +

oStateSetStack _drawStateStack +

+ + +

ostruct EnabledArrayPair +

+ + + +
o EnabledArrayPair() +

+ + +

o EnabledArrayPair(const EnabledArrayPair& eap) +

+ + +

oEnabledArrayPair& operator = (const EnabledArrayPair& eap) +

+ + +

obool _dirty +

+ + +

obool _enabled +

+ + +

oconst GLvoid* _pointer +

+ + + +
otypedef std::vector<EnabledArrayPair> EnabledTexCoordArrayList +

+ + +

oEnabledArrayPair _vertexArray +

+ + +

oEnabledArrayPair _normalArray +

+ + +

oEnabledArrayPair _colorArray +

+ + +

oEnabledArrayPair _secondaryColorArray +

+ + +

oEnabledArrayPair _indexArray +

+ + +

oEnabledArrayPair _fogArray +

+ + +

oEnabledTexCoordArrayList _texCoordArrayList +

+ + +

ounsigned int _currentActiveTextureUnit +

+ + +

ounsigned int _currentClientActiveTextureUnit +

+ + +

oinline ModeMap& getOrCreateTextureModeMap(unsigned int unit) +

+ + +

oinline AttributeMap& getOrCreateTextureAttributeMap(unsigned int unit) +

+ + +

ovoid haveAppliedMode(ModeMap& modeMap, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +

+ + +

ovoid haveAppliedMode(ModeMap& modeMap, StateAttribute::GLMode mode) +

+ + +

ovoid haveAppliedAttribute(AttributeMap& attributeMap, const StateAttribute* attribute) +

+ + +

ovoid haveAppliedAttribute(AttributeMap& attributeMap, StateAttribute::Type type) +

+ + +

obool getLastAppliedMode(const ModeMap& modeMap, StateAttribute::GLMode mode) const +

+ + +

oconst StateAttribute* getLastAppliedAttribute(const AttributeMap& attributeMap, StateAttribute::Type type) const +

+ + +

omutable bool _isSecondColorSupportResolved +

+ + +

omutable bool _isSecondColorSupported +

+ + +

obool computeSecondaryColorSupported() const +

+ + +

omutable bool _isFogCoordSupportResolved +

+ + +

omutable bool _isFogCoordSupported +

+ + +

obool computeFogCoordSupported() const +

+ + +

oinline void pushModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +

+ + +

oinline void pushAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +

+ + +

oinline void popModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +

+ + +

oinline void popAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +

+ + +

oinline void applyModeList(ModeMap& modeMap, const StateSet::ModeList& modeList) +

+ + +

oinline void applyAttributeList(AttributeMap& attributeMap, const StateSet::AttributeList& attributeList) +

+ + +

oinline void applyModeMap(ModeMap& modeMap) +

+ + +

oinline void applyAttributeMap(AttributeMap& attributeMap) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/StateAttribute.html b/doc/doc++/osg/StateAttribute.html new file mode 100644 index 000000000..e8530a762 --- /dev/null +++ b/doc/doc++/osg/StateAttribute.html @@ -0,0 +1,524 @@ + + + + + class SG_EXPORT osg::StateAttribute + + + + +

class SG_EXPORT osg::StateAttribute

Base class for state attribuets
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] StateAttribute() +
+[more] StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual Object* cloneType() const = 0 +
Clone the type of an attribute, with Object* return type. +
+[more]virtual Object* clone(const CopyOp&) const = 0 +
Clone an attribute, with Object* return type. +
+[more]virtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +
+[more]virtual const char* libraryName() const +
return the name of the attribute's library +
+[more]virtual const char* className() const +
return the name of the attribute's class type +
+[more]virtual Type getType() const = 0 +
return the Type identifier of the attribute's class type +
+[more]virtual bool isTextureAttribute() const +
return true if StateAttribute is a type which controls texturing and needs to be issued wrt to specific texture unit +
+[more]virtual int compare(const StateAttribute& sa) const = 0 +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]bool operator < (const StateAttribute& rhs) const +
+[more]bool operator == (const StateAttribute& rhs) const +
+[more]bool operator != (const StateAttribute& rhs) const +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& ) const +
return the modes associated with this StateSet +
+[more]virtual void apply(State&) const = 0 +
apply the OpenGL state attributes. +
+[more]virtual void compile(State&) const +
default to nothing to compile - all state is applied immediately. +

+ +

+

Public Members

+[more]typedef GLenum GLMode +
GLMode is the value used in glEnable/glDisable(mode) +
+[more]typedef unsigned int GLModeValue +
GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF). +
+[more]typedef unsigned int OverrideValue +
Override is used to specified the override behavior of StateAttributes from from parent to children. +
+[more]enum Values +
list values which can be used in to set either GLModeValues or OverrideValues. +
+[more]typedef unsigned int Type +
Type identifier to differentiate between different state types. +
+[more]enum Types +
Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses. +

+ +

+

Protected Methods

+[more]virtual ~StateAttribute() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Base class for state attribuets
+
+ + + +
otypedef GLenum GLMode +
GLMode is the value used in glEnable/glDisable(mode) +

+ + +

otypedef unsigned int GLModeValue +
GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF). +GLMoveValue is also used to specify the override behavior of modes from parent to children. +See enum Value description for more details. +

+ + +

otypedef unsigned int OverrideValue +
Override is used to specified the override behavior of StateAttributes +from from parent to children. +See enum Value description for more details. +

+ + +

oenum Values +
list values which can be used in to set either GLModeValues +or OverrideValues. When using in conjunction with GLModeValues +all Values have meaning. When using in conjection with +StateAttribute OverrideValue only OFF,OVERRIDE and INHERIT +are meaningful. However, they are useful when using GLModeValue +and OverrideValue in conjunction with each other as when using +StateSet::setAttributeAndModes(..). +

+ + + +
o OFF +
means that associated GLMode and Override is disabled +

+ + +

o ON +
means that associated GLMode is enabled and Override is disabled +

+ + +

o OVERRIDE +
Overriding of GLMode's or StateAttributes is enabled, so that state below it is overriden +

+ + +

o PROTECTED +
Protecting of GLMode's os StateAttributes is enabled, so that state from above connot override this and below state +

+ + +

o INHERIT +
means that GLMode or StateAttribute should in inherited from above +

+ + + +
otypedef unsigned int Type +
Type identifier to differentiate between different state types. +

+ + +

oenum Types +
Values of StateAttribute::Type used to aid identification +of different StateAttribute subclasses. Each subclass defines +it own value in the virtual Type getType() method. When +extending the osg's StateAttribute's simply define your +own Type value which is unique, using the StateAttribute::Type +enum as a guide of what values to use. If your new subclass +needs to override a standard StateAttriubte then simple use +that types value. +

+ + + +
o TEXTURE +

+ + +

o POLYGONMODE +

+ + +

o POLYGONOFFSET +

+ + +

o MATERIAL +

+ + +

o ALPHAFUNC +

+ + +

o ANTIALIAS +

+ + +

o COLORTABLE +

+ + +

o CULLFACE +

+ + +

o FOG +

+ + +

o FRONTFACE +

+ + +

o LIGHT +

+ + +

o LIGHT_0 +

+ + +

o LIGHT_1 +

+ + +

o LIGHT_2 +

+ + +

o LIGHT_3 +

+ + +

o LIGHT_4 +

+ + +

o LIGHT_5 +

+ + +

o LIGHT_6 +

+ + +

o LIGHT_7 +

+ + +

o POINT +

+ + +

o LINEWIDTH +

+ + +

o LINESTIPPLE +

+ + +

o POLYGONSTIPPLE +

+ + +

o SHADEMODEL +

+ + +

o TEXENV +

+ + +

o TEXGEN +

+ + +

o TEXMAT +

+ + +

o LIGHTMODEL +

+ + +

o BLENDFUNC +

+ + +

o STENCIL +

+ + +

o COLORMASK +

+ + +

o DEPTH +

+ + +

o VIEWPORT +

+ + +

o CLIPPLANE +

+ + +

o CLIPPLANE_0 +

+ + +

o CLIPPLANE_1 +

+ + +

o CLIPPLANE_2 +

+ + +

o CLIPPLANE_3 +

+ + +

o CLIPPLANE_4 +

+ + +

o CLIPPLANE_5 +

+ + +

o COLORMATRIX +

+ + +

o VERTEXPROGRAM +

+ + +

o FRAGMENTPROGRAM +

+ + + +
o StateAttribute() +

+ + +

o StateAttribute(const StateAttribute& sa, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual Object* cloneType() const = 0 +
Clone the type of an attribute, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual Object* clone(const CopyOp&) const = 0 +
Clone an attribute, with Object* return type. +Must be defined by derived classes. +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +
return true if this and obj are of the same kind of object +

+ + +

ovirtual const char* libraryName() const +
return the name of the attribute's library +

+ + +

ovirtual const char* className() const +
return the name of the attribute's class type +

+ + +

ovirtual Type getType() const = 0 +
return the Type identifier of the attribute's class type +

+ + +

ovirtual bool isTextureAttribute() const +
return true if StateAttribute is a type which controls texturing and needs to be issued wrt to specific texture unit +

+ + +

ovirtual int compare(const StateAttribute& sa) const = 0 +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

obool operator < (const StateAttribute& rhs) const +

+ + +

obool operator == (const StateAttribute& rhs) const +

+ + +

obool operator != (const StateAttribute& rhs) const +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
return the modes associated with this StateSet +

+ + +

ovirtual void apply(State&) const = 0 +
apply the OpenGL state attributes. +The global state for the current OpenGL context is passed +in to allow the StateAttribute to obtain details on the +the current context and state. +

+ + +

ovirtual void compile(State&) const +
default to nothing to compile - all state is applied immediately. +

+ + +

ovirtual ~StateAttribute() +

+
+
Direct child classes: +
Viewport
+VertexProgram
+Texture
+TexMat
+TexGen
+TexEnvCombine
+TexEnv
+Stencil
+ShadeModel
+PolygonStipple
+PolygonOffset
+PolygonMode
+Point
+Material
+LineWidth
+LineStipple
+LightModel
+Light
+FrontFace
+Fog
+Depth
+CullFace
+ColorMatrix
+ColorMask
+ClipPlane
+BlendFunc
+AlphaFunc
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/StateSet.html b/doc/doc++/osg/StateSet.html new file mode 100644 index 000000000..e8143d05e --- /dev/null +++ b/doc/doc++/osg/StateSet.html @@ -0,0 +1,728 @@ + + + + + class SG_EXPORT osg::StateSet + + + + +

class SG_EXPORT osg::StateSet

Encapsulates OpenGL state modes and attributes.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] StateSet() +
+[more] StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]int compare(const StateSet& rhs, bool compareAttributeContents=false) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]bool operator < (const StateSet& rhs) const +
+[more]bool operator == (const StateSet& rhs) const +
+[more]bool operator != (const StateSet& rhs) const +
+[more]void setGlobalDefaults() +
set all the modes to on or off so that it defines a complete state, typically used for a default global state +
+[more]void setAllToInherit() +
set all the modes to inherit, typically used to signify nodes which inherit all of their modes for the global state +
+[more]void merge(const StateSet& rhs) +
merge this stateset with stateset rhs, this overrides the rhs if OVERRIDE is specified, otherwise rhs takes precedence +
+[more]void setMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
set this StateSet to contain specified GLMode and value +
+[more]void setModeToInherit(StateAttribute::GLMode mode) +
set this StateSet to inherit specified GLMode type from parents. +
+[more]StateAttribute::GLModeValue getMode(StateAttribute::GLMode mode) const +
get specified GLModeValue for specified GLMode. +
+[more]inline ModeList& getModeList() +
return the list of all GLModes contained in this StateSet +
+[more]inline const ModeList& getModeList() const +
return the const list of all GLModes contained in this const StateSet +
+[more]void setAttribute(StateAttribute* attribute, StateAttribute::OverrideValue value=StateAttribute::OFF) +
set this StateSet to contain specified attribute and override flag +
+[more]void setAttributeAndModes(StateAttribute* attribute, StateAttribute::GLModeValue value=StateAttribute::ON) +
set this StateSet to contain specified attribute and set the associated GLMode's to specified value +
+[more]void setAttributeToInherit(StateAttribute::Type type) +
set this StateSet to inherit specified attribute type from parents. +
+[more]StateAttribute* getAttribute(StateAttribute::Type type) +
get specified StateAttribute for specified type. +
+[more]const StateAttribute* getAttribute(StateAttribute::Type type) const +
get specified const StateAttribute for specified type. +
+[more]const RefAttributePair* getAttributePair(StateAttribute::Type type) const +
get specified RefAttributePair for specified type. +
+[more]inline AttributeList& getAttributeList() +
return the list of all StateAttributes contained in this StateSet +
+[more]inline const AttributeList& getAttributeList() const +
return the const list of all StateAttributes contained in this const StateSet +
+[more]void setTextureMode(unsigned int unit, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
set this StateSet to contain specified GLMode and value +
+[more]void setTextureModeToInherit(unsigned int unit, StateAttribute::GLMode mode) +
set this StateSet to inherit specified GLMode type from parents. +
+[more]StateAttribute::GLModeValue getTextureMode(unsigned int unit, StateAttribute::GLMode mode) const +
get specified GLModeValue for specified GLMode. +
+[more]inline TextureModeList& getTextureModeList() +
return the list of all Texture related GLModes contained in this StateSet +
+[more]inline const TextureModeList& getTextureModeList() const +
return the const list of all Texture related GLModes contained in this const StateSet +
+[more]void setTextureAttribute(unsigned int unit, StateAttribute* attribute, StateAttribute::OverrideValue value=StateAttribute::OFF) +
set this StateSet to contain specified attribute and override flag +
+[more]void setTextureAttributeAndModes(unsigned int unit, StateAttribute* attribute, StateAttribute::GLModeValue value=StateAttribute::ON) +
set this StateSet to contain specified attribute and set the associated GLMode's to specified value +
+[more]void setTextureAttributeToInherit(unsigned int unit, StateAttribute::Type type) +
set this StateSet to inherit specified attribute type from parents. +
+[more]StateAttribute* getTextureAttribute(unsigned int unit, StateAttribute::Type type) +
get specified Texture related StateAttribute for specified type. +
+[more]const StateAttribute* getTextureAttribute(unsigned int unit, StateAttribute::Type type) const +
get specified Texture related const StateAttribute for specified type. +
+[more]const RefAttributePair* getTextureAttributePair(unsigned int unit, StateAttribute::Type type) const +
get specified Texture related RefAttributePair for specified type. +
+[more]inline TextureAttributeList& getTextureAttributeList() +
return the list of all Texture related StateAttributes contained in this StateSet +
+[more]inline const TextureAttributeList& getTextureAttributeList() const +
return the const list of all Texture related StateAttributes contained in this const StateSet +
+[more]void setAssociatedModes(const StateAttribute* attribute, StateAttribute::GLModeValue value) +
+[more]void setAssociatedTextureModes(unsigned int unit, const StateAttribute* attribute, StateAttribute::GLModeValue value) +
+[more]void setRenderingHint(int hint) +
set the RenderingHint of the StateSet. +
+[more]inline int getRenderingHint() const +
get the RenderingHint of the StateSet +
+[more]void setRenderBinDetails(int binNum, const std::string& binName, RenderBinMode mode=USE_RENDERBIN_DETAILS) +
set the render bin details +
+[more]void setRenderBinToInherit() +
set the render bin details to inherit +
+[more]inline RenderBinMode getRenderBinMode() const +
get the render bin mode +
+[more]inline bool useRenderBinDetails() const +
get whether the render bin details are set and should be used +
+[more]inline int getBinNumber() const +
get the render bin number +
+[more]inline const std::string& getBinName() const +
get the render bin name +
+[more]void compile(State& state) const +
call compile on all StateAttributes contained within this StateSet +

+ +

+

Public Members

+[more]typedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList +
a container to map GLModes to their respective GLModeValues +
+[more]typedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair +
simple pairing between an attribute and its override flag +
+[more]typedef std::map<StateAttribute::Type,RefAttributePair> AttributeList +
a container to map StateAttribyte::Types to their respective RefAttributePair +
+[more]typedef std::vector<ModeList> TextureModeList +
+[more]typedef std::vector<AttributeList> TextureAttributeList +
+[more]enum RenderingHint +
+[more]enum RenderBinMode +

+ +

+

Protected Fields

+[more]ModeList _modeList +
+[more]AttributeList _attributeList +
+[more]TextureModeList _textureModeList +
+[more]TextureAttributeList _textureAttributeList +
+[more]int _renderingHint +
+[more]RenderBinMode _binMode +
+[more]int _binNum +
+[more]std::string _binName +

+ +

+

Protected Methods

+[more]virtual ~StateSet() +
+[more]StateSet& operator = (const StateSet&) +
+[more]inline ModeList& getOrCreateTextureModeList(unsigned int unit) +
+[more]inline AttributeList& getOrCreateTextureAttributeList(unsigned int unit) +
+[more]int compareModes(const ModeList& lhs, const ModeList& rhs) +
+[more]int compareAttributePtrs(const AttributeList& lhs, const AttributeList& rhs) +
+[more]int compareAttributeContents(const AttributeList& lhs, const AttributeList& rhs) +
+[more]void setMode(ModeList& modeList, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
+[more]void setModeToInherit(ModeList& modeList, StateAttribute::GLMode mode) +
+[more]StateAttribute::GLModeValue getMode(const ModeList& modeList, StateAttribute::GLMode mode) const +
+[more]void setAssociatedModes(ModeList& modeList, const StateAttribute* attribute, StateAttribute::GLModeValue value) +
+[more]void setAttribute(AttributeList& attributeList, StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF) +
+[more]StateAttribute* getAttribute(AttributeList& attributeList, const StateAttribute::Type type) +
+[more]const StateAttribute* getAttribute(const AttributeList& attributeList, const StateAttribute::Type type) const +
+[more]const RefAttributePair* getAttributePair(const AttributeList& attributeList, const StateAttribute::Type type) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+Encapsulates OpenGL state modes and attributes. +Used to specific textures etc of osg::Drawable's which hold references +to a single osg::StateSet. StateSet can be shared between Drawable's +and is recommend if possible as it minimize expensive state changes +in the graphics pipeline.
+
+ + + +
o StateSet() +

+ + +

o StateSet(const StateSet&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

oint compare(const StateSet& rhs, bool compareAttributeContents=false) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

obool operator < (const StateSet& rhs) const +

+ + +

obool operator == (const StateSet& rhs) const +

+ + +

obool operator != (const StateSet& rhs) const +

+ + +

ovoid setGlobalDefaults() +
set all the modes to on or off so that it defines a +complete state, typically used for a default global state +

+ + +

ovoid setAllToInherit() +
set all the modes to inherit, typically used to signify +nodes which inherit all of their modes for the global state +

+ + +

ovoid merge(const StateSet& rhs) +
merge this stateset with stateset rhs, this overrides +the rhs if OVERRIDE is specified, otherwise rhs takes precedence +

+ + +

otypedef std::map<StateAttribute::GLMode,StateAttribute::GLModeValue> ModeList +
a container to map GLModes to their respective GLModeValues +

+ + +

ovoid setMode(StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
set this StateSet to contain specified GLMode and value +

+ + +

ovoid setModeToInherit(StateAttribute::GLMode mode) +
set this StateSet to inherit specified GLMode type from parents. +has the effect of deleting any GlMode of specified type from StateSet. +

+ + +

oStateAttribute::GLModeValue getMode(StateAttribute::GLMode mode) const +
get specified GLModeValue for specified GLMode. +returns INHERIT if no GLModeValue is contained within StateSet. +

+ + +

oinline ModeList& getModeList() +
return the list of all GLModes contained in this StateSet +

+ + +

oinline const ModeList& getModeList() const +
return the const list of all GLModes contained in this const StateSet +

+ + +

otypedef std::pair<ref_ptr<StateAttribute>,StateAttribute::OverrideValue> RefAttributePair +
simple pairing between an attribute and its override flag +

+ + +

otypedef std::map<StateAttribute::Type,RefAttributePair> AttributeList +
a container to map StateAttribyte::Types to their respective RefAttributePair +

+ + +

ovoid setAttribute(StateAttribute* attribute, StateAttribute::OverrideValue value=StateAttribute::OFF) +
set this StateSet to contain specified attribute and override flag +

+ + +

ovoid setAttributeAndModes(StateAttribute* attribute, StateAttribute::GLModeValue value=StateAttribute::ON) +
set this StateSet to contain specified attribute and set the associated GLMode's to specified value +

+ + +

ovoid setAttributeToInherit(StateAttribute::Type type) +
set this StateSet to inherit specified attribute type from parents. +has the effect of deleting any state attributes of specified type from StateSet. +

+ + +

oStateAttribute* getAttribute(StateAttribute::Type type) +
get specified StateAttribute for specified type. +returns NULL if no type is contained within StateSet. +

+ + +

oconst StateAttribute* getAttribute(StateAttribute::Type type) const +
get specified const StateAttribute for specified type. +returns NULL if no type is contained within const StateSet. +

+ + +

oconst RefAttributePair* getAttributePair(StateAttribute::Type type) const +
get specified RefAttributePair for specified type. +returns NULL if no type is contained within StateSet. +

+ + +

oinline AttributeList& getAttributeList() +
return the list of all StateAttributes contained in this StateSet +

+ + +

oinline const AttributeList& getAttributeList() const +
return the const list of all StateAttributes contained in this const StateSet +

+ + +

otypedef std::vector<ModeList> TextureModeList +

+ + +

ovoid setTextureMode(unsigned int unit, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +
set this StateSet to contain specified GLMode and value +

+ + +

ovoid setTextureModeToInherit(unsigned int unit, StateAttribute::GLMode mode) +
set this StateSet to inherit specified GLMode type from parents. +has the effect of deleting any GlMode of specified type from StateSet. +

+ + +

oStateAttribute::GLModeValue getTextureMode(unsigned int unit, StateAttribute::GLMode mode) const +
get specified GLModeValue for specified GLMode. +returns INHERIT if no GLModeValue is contained within StateSet. +

+ + +

oinline TextureModeList& getTextureModeList() +
return the list of all Texture related GLModes contained in this StateSet +

+ + +

oinline const TextureModeList& getTextureModeList() const +
return the const list of all Texture related GLModes contained in this const StateSet +

+ + +

otypedef std::vector<AttributeList> TextureAttributeList +

+ + +

ovoid setTextureAttribute(unsigned int unit, StateAttribute* attribute, StateAttribute::OverrideValue value=StateAttribute::OFF) +
set this StateSet to contain specified attribute and override flag +

+ + +

ovoid setTextureAttributeAndModes(unsigned int unit, StateAttribute* attribute, StateAttribute::GLModeValue value=StateAttribute::ON) +
set this StateSet to contain specified attribute and set the associated GLMode's to specified value +

+ + +

ovoid setTextureAttributeToInherit(unsigned int unit, StateAttribute::Type type) +
set this StateSet to inherit specified attribute type from parents. +has the effect of deleting any state attributes of specified type from StateSet. +

+ + +

oStateAttribute* getTextureAttribute(unsigned int unit, StateAttribute::Type type) +
get specified Texture related StateAttribute for specified type. +returns NULL if no type is contained within StateSet. +

+ + +

oconst StateAttribute* getTextureAttribute(unsigned int unit, StateAttribute::Type type) const +
get specified Texture related const StateAttribute for specified type. +returns NULL if no type is contained within const StateSet. +

+ + +

oconst RefAttributePair* getTextureAttributePair(unsigned int unit, StateAttribute::Type type) const +
get specified Texture related RefAttributePair for specified type. +returns NULL if no type is contained within StateSet. +

+ + +

oinline TextureAttributeList& getTextureAttributeList() +
return the list of all Texture related StateAttributes contained in this StateSet +

+ + +

oinline const TextureAttributeList& getTextureAttributeList() const +
return the const list of all Texture related StateAttributes contained in this const StateSet +

+ + +

ovoid setAssociatedModes(const StateAttribute* attribute, StateAttribute::GLModeValue value) +

+ + +

ovoid setAssociatedTextureModes(unsigned int unit, const StateAttribute* attribute, StateAttribute::GLModeValue value) +

+ + +

oenum RenderingHint +

+ + + +
o DEFAULT_BIN +

+ + +

o OPAQUE_BIN +

+ + +

o TRANSPARENT_BIN +

+ + + +
ovoid setRenderingHint(int hint) +
set the RenderingHint of the StateSet. +RenderingHint is used by osgUtil::Renderer to determine which +draw bin to drop associated osg::Drawables in. For opaque +objects OPAQUE_BIN would typical used, which TRANSPARENT_BIN +should be used for objects which need to be depth sorted. +

+ + +

oinline int getRenderingHint() const +
get the RenderingHint of the StateSet +

+ + +

oenum RenderBinMode +

+ + + +
o INHERIT_RENDERBIN_DETAILS +

+ + +

o USE_RENDERBIN_DETAILS +

+ + +

o OVERRIDE_RENDERBIN_DETAILS +

+ + +

o ENCLOSE_RENDERBIN_DETAILS +

+ + + +
ovoid setRenderBinDetails(int binNum, const std::string& binName, RenderBinMode mode=USE_RENDERBIN_DETAILS) +
set the render bin details +

+ + +

ovoid setRenderBinToInherit() +
set the render bin details to inherit +

+ + +

oinline RenderBinMode getRenderBinMode() const +
get the render bin mode +

+ + +

oinline bool useRenderBinDetails() const +
get whether the render bin details are set and should be used +

+ + +

oinline int getBinNumber() const +
get the render bin number +

+ + +

oinline const std::string& getBinName() const +
get the render bin name +

+ + +

ovoid compile(State& state) const +
call compile on all StateAttributes contained within this StateSet +

+ + +

ovirtual ~StateSet() +

+ + +

oStateSet& operator = (const StateSet&) +

+ + +

oModeList _modeList +

+ + +

oAttributeList _attributeList +

+ + +

oTextureModeList _textureModeList +

+ + +

oTextureAttributeList _textureAttributeList +

+ + +

oinline ModeList& getOrCreateTextureModeList(unsigned int unit) +

+ + +

oinline AttributeList& getOrCreateTextureAttributeList(unsigned int unit) +

+ + +

oint compareModes(const ModeList& lhs, const ModeList& rhs) +

+ + +

oint compareAttributePtrs(const AttributeList& lhs, const AttributeList& rhs) +

+ + +

oint compareAttributeContents(const AttributeList& lhs, const AttributeList& rhs) +

+ + +

ovoid setMode(ModeList& modeList, StateAttribute::GLMode mode, StateAttribute::GLModeValue value) +

+ + +

ovoid setModeToInherit(ModeList& modeList, StateAttribute::GLMode mode) +

+ + +

oStateAttribute::GLModeValue getMode(const ModeList& modeList, StateAttribute::GLMode mode) const +

+ + +

ovoid setAssociatedModes(ModeList& modeList, const StateAttribute* attribute, StateAttribute::GLModeValue value) +

+ + +

ovoid setAttribute(AttributeList& attributeList, StateAttribute* attribute, const StateAttribute::OverrideValue value=StateAttribute::OFF) +

+ + +

oStateAttribute* getAttribute(AttributeList& attributeList, const StateAttribute::Type type) +

+ + +

oconst StateAttribute* getAttribute(const AttributeList& attributeList, const StateAttribute::Type type) const +

+ + +

oconst RefAttributePair* getAttributePair(const AttributeList& attributeList, const StateAttribute::Type type) const +

+ + +

oint _renderingHint +

+ + +

oRenderBinMode _binMode +

+ + +

oint _binNum +

+ + +

ostd::string _binName +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Statistics.html b/doc/doc++/osg/Statistics.html new file mode 100644 index 000000000..1a5ee690e --- /dev/null +++ b/doc/doc++/osg/Statistics.html @@ -0,0 +1,287 @@ + + + + + class osg::Statistics + + + + +

class osg::Statistics

Statistics base class.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]int numDrawables +
+[more]int nummat +
+[more]int nbins +
+[more]int nlights +
+[more]int depth +
+[more]int _binNo +
+[more]statsType stattype +
+[more]int nimpostor +
+[more]unsigned int _vertexCount +
+[more]PrimtiveValueMap _primitiveCount +
+[more]GLenum _currentPrimtiveFunctorMode +

+ +

+

Public Methods

+[more] Statistics() +
+[more]void reset() +
+[more]void setType(statsType t) +
+[more]virtual void setVertexArray(unsigned int count, const Vec3*) +
+[more]virtual void drawArrays(GLenum mode, GLint, GLsizei count) +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLuint*) +
+[more]virtual void begin(GLenum mode) +
+[more]virtual void vertex(const Vec3&) +
+[more]virtual void vertex(float, float, float) +
+[more]virtual void end() +
+[more]void addDrawable() +
+[more]void addMatrix() +
+[more]void addLight(int np) +
+[more]void addImpostor(int np) +
+[more]inline int getBins() +
+[more]void setDepth(int d) +
+[more]void addBins(int np) +
+[more]void setBinNo(int n) +

+ +

+

Public Members

+[more]typedef std::pair<unsigned int,unsigned int> PrimitivePair +
+[more]typedef std::map<GLenum,PrimitivePair> PrimtiveValueMap +
+[more]enum statsType +

+ +
+

Inherited from PrimitiveFunctor:

+
+
+ + +
+

Documentation

+
+Statistics base class. Used to extract primitive information from +the renderBin(s). Add a case of getStats(osgUtil::Statistics *stat) +for any new drawable (or drawable derived class) that you generate +(eg see Geometry.cpp). There are 20 types of drawable counted - actually only +14 cases can occur in reality. these represent sets of GL_POINTS, GL_LINES +GL_LINESTRIPS, LOOPS, TRIANGLES, TRI-fans, tristrips, quads, quadstrips etc +The number of triangles rendered is inferred: +each triangle = 1 triangle (number of vertices/3) +each quad = 2 triangles (nverts/2) +each trifan or tristrip = (length-2) triangles and so on.
+
+ + + +
otypedef std::pair<unsigned int,unsigned int> PrimitivePair +

+ + +

otypedef std::map<GLenum,PrimitivePair> PrimtiveValueMap +

+ + +

o Statistics() +

+ + +

oenum statsType +

+ + + +
o STAT_NONE +

+ + +

o STAT_FRAMERATE +

+ + +

o STAT_GRAPHS +

+ + +

o STAT_PRIMS +

+ + +

o STAT_PRIMSPERVIEW +

+ + +

o STAT_PRIMSPERBIN +

+ + +

o STAT_DC +

+ + +

o STAT_RESTART +

+ + + +
ovoid reset() +

+ + +

ovoid setType(statsType t) +

+ + +

ovirtual void setVertexArray(unsigned int count, const Vec3*) +

+ + +

ovirtual void drawArrays(GLenum mode, GLint, GLsizei count) +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLuint*) +

+ + +

ovirtual void begin(GLenum mode) +

+ + +

ovirtual void vertex(const Vec3&) +

+ + +

ovirtual void vertex(float, float, float) +

+ + +

ovirtual void end() +

+ + +

ovoid addDrawable() +

+ + +

ovoid addMatrix() +

+ + +

ovoid addLight(int np) +

+ + +

ovoid addImpostor(int np) +

+ + +

oinline int getBins() +

+ + +

ovoid setDepth(int d) +

+ + +

ovoid addBins(int np) +

+ + +

ovoid setBinNo(int n) +

+ + +

oint numDrawables +

+ + +

oint nummat +

+ + +

oint nbins +

+ + +

oint nlights +

+ + +

oint depth +

+ + +

oint _binNo +

+ + +

ostatsType stattype +

+ + +

oint nimpostor +

+ + +

ounsigned int _vertexCount +

+ + +

oPrimtiveValueMap _primitiveCount +

+ + +

oGLenum _currentPrimtiveFunctorMode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Stencil.html b/doc/doc++/osg/Stencil.html new file mode 100644 index 000000000..44ea9bf65 --- /dev/null +++ b/doc/doc++/osg/Stencil.html @@ -0,0 +1,381 @@ + + + + + class SG_EXPORT osg::Stencil + + + + +

class SG_EXPORT osg::Stencil

Encapsulate OpenGL glStencilFunc/Op/Mask functions
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Stencil() +
+[more] Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Stencil, STENCIL) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline void setFunction(Function func, int ref, unsigned int mask) +
+[more]inline Function getFunction() const +
+[more]inline int getFunctionRef() const +
+[more]inline unsigned int getFunctionMask() const +
+[more]inline void setOperation(Operation sfail, Operation zfail, Operation zpass) +
set the operations to apply when the various stencil and depth tests fail or pass. +
+[more]inline Operation getStencilFailOperation() const +
get the operation when the stencil test fails +
+[more]inline Operation getStencilPassAndDepthFailOperation() const +
get the operation when the stencil test passes but the depth test fails +
+[more]inline Operation getStencilPassAndDepthPassOperation() const +
get the operation when both the stencil test and the depth test pass +
+[more]inline void setWriteMask(unsigned int mask) +
+[more]inline unsigned int getWriteMask() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Function +
+[more]enum Operation +

+ +

+

Protected Fields

+[more]Function _func +
+[more]int _funcRef +
+[more]unsigned int _funcMask +
+[more]Operation _sfail +
+[more]Operation _zfail +
+[more]Operation _zpass +
+[more]unsigned int _writeMask +

+ +

+

Protected Methods

+[more]virtual ~Stencil() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Encapsulate OpenGL glStencilFunc/Op/Mask functions
+
+ + + +
o Stencil() +

+ + +

o Stencil(const Stencil& stencil, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Stencil, STENCIL) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum Function +

+ + + +
o NEVER +

+ + +

o LESS +

+ + +

o EQUAL +

+ + +

o LEQUAL +

+ + +

o GREATER +

+ + +

o NOTEQUAL +

+ + +

o GEQUAL +

+ + +

o ALWAYS +

+ + + +
oinline void setFunction(Function func, int ref, unsigned int mask) +

+ + +

oinline Function getFunction() const +

+ + +

oinline int getFunctionRef() const +

+ + +

oinline unsigned int getFunctionMask() const +

+ + +

oenum Operation +

+ + + +
o KEEP +

+ + +

o ZERO +

+ + +

o REPLACE +

+ + +

o INCR +

+ + +

o DECR +

+ + +

o INVERT +

+ + + +
oinline void setOperation(Operation sfail, Operation zfail, Operation zpass) +
set the operations to apply when the various stencil and depth +tests fail or pass. First parameter is to control the operation +when the stencil test fails. The second parameter is to control the +operation when the stencil test passes, but depth test fails. The +third parameter controls the operation when both the stencil test +and depth pass. Ordering of parameter is the same as if using +glStencilOp(,,). +

+ + +

oinline Operation getStencilFailOperation() const +
get the operation when the stencil test fails +

+ + +

oinline Operation getStencilPassAndDepthFailOperation() const +
get the operation when the stencil test passes but the depth test fails +

+ + +

oinline Operation getStencilPassAndDepthPassOperation() const +
get the operation when both the stencil test and the depth test pass +

+ + +

oinline void setWriteMask(unsigned int mask) +

+ + +

oinline unsigned int getWriteMask() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~Stencil() +

+ + +

oFunction _func +

+ + +

oint _funcRef +

+ + +

ounsigned int _funcMask +

+ + +

oOperation _sfail +

+ + +

oOperation _zfail +

+ + +

oOperation _zpass +

+ + +

ounsigned int _writeMask +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.2.html b/doc/doc++/osg/SubloadCallback.2.html new file mode 100644 index 000000000..440d219a7 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.2.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osg::Texture2D::SubloadCallback + + + + +

class SG_EXPORT SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture2D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture2D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture2D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture2D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.3.html b/doc/doc++/osg/SubloadCallback.3.html new file mode 100644 index 000000000..292ad5c7a --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.3.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osg::Texture3D::SubloadCallback + + + + +

class SG_EXPORT SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture3D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture3D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture3D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture3D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.4.html b/doc/doc++/osg/SubloadCallback.4.html new file mode 100644 index 000000000..3302b2982 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.4.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osg::TextureCubeMap::SubloadCallback + + + + +

class SG_EXPORT SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const TextureCubeMap& texture, State& state) const = 0 +
+[more]virtual void subload(const TextureCubeMap& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const TextureCubeMap& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const TextureCubeMap& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.5.html b/doc/doc++/osg/SubloadCallback.5.html new file mode 100644 index 000000000..aa3aa5a93 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.5.html @@ -0,0 +1,77 @@ + + + + + class osg::TextureRectangle::SubloadCallback + + + + +

class SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const TextureRectangle&, State&) const = 0 +
+[more]virtual void subload(const TextureRectangle&, State&) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const TextureRectangle&, State&) const = 0 +

+ + +

ovirtual void subload(const TextureRectangle&, State&) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/SubloadCallback.html b/doc/doc++/osg/SubloadCallback.html new file mode 100644 index 000000000..aa592f5c5 --- /dev/null +++ b/doc/doc++/osg/SubloadCallback.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osg::Texture1D::SubloadCallback + + + + +

class SG_EXPORT SubloadCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void load(const Texture1D& texture, State& state) const = 0 +
+[more]virtual void subload(const Texture1D& texture, State& state) const = 0 +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual void load(const Texture1D& texture, State& state) const = 0 +

+ + +

ovirtual void subload(const Texture1D& texture, State& state) const = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Switch.html b/doc/doc++/osg/Switch.html new file mode 100644 index 000000000..aaf3e0769 --- /dev/null +++ b/doc/doc++/osg/Switch.html @@ -0,0 +1,477 @@ + + + + + class SG_EXPORT osg::Switch + + + + +

class SG_EXPORT osg::Switch

Switch is a Group node which allows switching between children.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Switch() +
+[more] Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Switch) +
+[more]virtual void traverse(NodeVisitor& nv) +
+[more]void setNewChildDefaultValue(bool value) +
+[more]bool getNewChildDefaultValue() const +
+[more]virtual bool addChild( Node* child ) +
+[more]virtual bool addChild( Node* child, bool value ) +
+[more]virtual bool removeChild( Node* child ) +
+[more]void setValue(unsigned int pos, bool value) +
+[more]bool getValue(unsigned int pos) const +
+[more]void setChildValue(const Node* child, bool value) +
+[more]bool getChildValue(const Node* child) const +
+[more]bool setAllChildrenOff() +
Set all the children off (false), and set the new default child value to off (false) +
+[more]bool setAllChildrenOn() +
Set all the children on (true), and set the new default child value to on (true) +
+[more]bool setSingleChildOn(unsigned int pos) +
Set a single child to be on, switch off all other children +
+[more]void setValue(int value) +
Selects the active child Node or enables a special SwitchType mode. +
+[more]int getValue() const +
+[more]const ValueList& getValueList() const +

+ +

+

Public Members

+[more]enum Values +
Special values for the Switch. +
+[more]typedef std::vector<bool> ValueList +

+ +

+

Protected Fields

+[more]bool _newChildDefaultValue +
+[more]ValueList _values +

+ +

+

Protected Methods

+[more]virtual ~Switch() +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +

+

Protected Methods

+ovirtual bool computeBound() const +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Transform* asTransform() +
+ovirtual const Transform* asTransform() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Switch is a Group node which allows switching between children. +Typical uses would be for objects which might need to be rendered +differently at different times, for instance a switch could be used +to represent the different states of a traffic light.
+
+ + + +
o Switch() +

+ + +

o Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Switch) +

+ + +

ovirtual void traverse(NodeVisitor& nv) +

+ + +

ovoid setNewChildDefaultValue(bool value) +

+ + +

obool getNewChildDefaultValue() const +

+ + +

ovirtual bool addChild( Node* child ) +

+ + +

ovirtual bool addChild( Node* child, bool value ) +

+ + +

ovirtual bool removeChild( Node* child ) +

+ + +

ovoid setValue(unsigned int pos, bool value) +

+ + +

obool getValue(unsigned int pos) const +

+ + +

ovoid setChildValue(const Node* child, bool value) +

+ + +

obool getChildValue(const Node* child) const +

+ + +

obool setAllChildrenOff() +
Set all the children off (false), and set the new default child value to off (false) +

+ + +

obool setAllChildrenOn() +
Set all the children on (true), and set the new default child value to on (true) +

+ + +

obool setSingleChildOn(unsigned int pos) +
Set a single child to be on, switch off all other children +

+ + +

oenum Values +
+Special values for the Switch. Use these if you want to +turn on/off all child nodes. +

+ + + +
o ALL_CHILDREN_ON +
All children turned on. +

+ + +

o ALL_CHILDREN_OFF +
All children off. +

+ + +

o MULTIPLE_CHILDREN_ON +
Multiple children turned on +

+ + + +
ovoid setValue(int value) +
+Selects the active child Node or enables a special +SwitchType mode. + +
Parameters:
value - the number of the active child +(first child == number 0) or SwitchType. Invalid values +will be ignored.

+ + +

oint getValue() const +

+ + +

otypedef std::vector<bool> ValueList +

+ + +

oconst ValueList& getValueList() const +

+ + +

ovirtual ~Switch() +

+ + +

obool _newChildDefaultValue +

+ + +

oValueList _values +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TemplateArray.html b/doc/doc++/osg/TemplateArray.html new file mode 100644 index 000000000..aaf0da7ac --- /dev/null +++ b/doc/doc++/osg/TemplateArray.html @@ -0,0 +1,212 @@ + + + + + template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class osg::TemplateArray + + + + +

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class osg::TemplateArray

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TemplateArray() +
+[more] TemplateArray(const TemplateArray& ta, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] TemplateArray(unsigned int no) +
+[more] TemplateArray(unsigned int no, T* ptr) +
+[more]template<class InputIterator> TemplateArray(InputIterator first, InputIterator last) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual void accept(ArrayVisitor& av) +
+[more]virtual void accept(ConstArrayVisitor& av) const +
+[more]virtual void accept(unsigned int index, ValueVisitor& vv) +
+[more]virtual void accept(unsigned int index, ConstValueVisitor& vv) const +
+[more]virtual const GLvoid* getDataPointer() const +
+[more]virtual unsigned int getNumElements() const +

+ +

+

Protected Methods

+[more]virtual ~TemplateArray() +

+ +
+

Inherited from Array:

+
+

+

Public Methods

+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oType getType() const +
+oGLint getDataSize() const +
+oGLenum getDataType() const +

+ +

+

Public Members

+oenum Type +

+ +

+

Protected Fields

+oType _arrayType +
+oGLint _dataSize +
+oGLenum _dataType +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o TemplateArray() +

+ + +

o TemplateArray(const TemplateArray& ta, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o TemplateArray(unsigned int no) +

+ + +

o TemplateArray(unsigned int no, T* ptr) +

+ + +

otemplate<class InputIterator> TemplateArray(InputIterator first, InputIterator last) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual void accept(ArrayVisitor& av) +

+ + +

ovirtual void accept(ConstArrayVisitor& av) const +

+ + +

ovirtual void accept(unsigned int index, ValueVisitor& vv) +

+ + +

ovirtual void accept(unsigned int index, ConstValueVisitor& vv) const +

+ + +

ovirtual const GLvoid* getDataPointer() const +

+ + +

ovirtual unsigned int getNumElements() const +

+ + +

ovirtual ~TemplateArray() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TemplateIndexArray.html b/doc/doc++/osg/TemplateIndexArray.html new file mode 100644 index 000000000..ca9f5f966 --- /dev/null +++ b/doc/doc++/osg/TemplateIndexArray.html @@ -0,0 +1,224 @@ + + + + + template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class osg::TemplateIndexArray + + + + +

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class osg::TemplateIndexArray

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TemplateIndexArray() +
+[more] TemplateIndexArray(const TemplateIndexArray& ta, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] TemplateIndexArray(unsigned int no) +
+[more] TemplateIndexArray(unsigned int no, T* ptr) +
+[more]template<class InputIterator> TemplateIndexArray(InputIterator first, InputIterator last) +
+[more]virtual Object* cloneType() const +
+[more]virtual Object* clone(const CopyOp& copyop) const +
+[more]virtual void accept(ArrayVisitor& av) +
+[more]virtual void accept(ConstArrayVisitor& av) const +
+[more]virtual void accept(unsigned int index, ValueVisitor& vv) +
+[more]virtual void accept(unsigned int index, ConstValueVisitor& vv) const +
+[more]virtual const GLvoid* getDataPointer() const +
+[more]virtual unsigned int getNumElements() const +
+[more]virtual unsigned int index(unsigned int pos) const +

+ +

+

Protected Methods

+[more]virtual ~TemplateIndexArray() +

+ +
+

Inherited from IndexArray:

+
+

+

Public Methods

+ovirtual bool isSameKindAs(const Object* obj) const +

+ +
+

Inherited from Array:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oType getType() const +
+oGLint getDataSize() const +
+oGLenum getDataType() const +

+ +

+

Public Members

+oenum Type +

+ +

+

Protected Fields

+oType _arrayType +
+oGLint _dataSize +
+oGLenum _dataType +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o TemplateIndexArray() +

+ + +

o TemplateIndexArray(const TemplateIndexArray& ta, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o TemplateIndexArray(unsigned int no) +

+ + +

o TemplateIndexArray(unsigned int no, T* ptr) +

+ + +

otemplate<class InputIterator> TemplateIndexArray(InputIterator first, InputIterator last) +

+ + +

ovirtual Object* cloneType() const +

+ + +

ovirtual Object* clone(const CopyOp& copyop) const +

+ + +

ovirtual void accept(ArrayVisitor& av) +

+ + +

ovirtual void accept(ConstArrayVisitor& av) const +

+ + +

ovirtual void accept(unsigned int index, ValueVisitor& vv) +

+ + +

ovirtual void accept(unsigned int index, ConstValueVisitor& vv) const +

+ + +

ovirtual const GLvoid* getDataPointer() const +

+ + +

ovirtual unsigned int getNumElements() const +

+ + +

ovirtual unsigned int index(unsigned int pos) const +

+ + +

ovirtual ~TemplateIndexArray() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TessellationHints.html b/doc/doc++/osg/TessellationHints.html new file mode 100644 index 000000000..88b785533 --- /dev/null +++ b/doc/doc++/osg/TessellationHints.html @@ -0,0 +1,295 @@ + + + + + class osg::TessellationHints + + + + +

class osg::TessellationHints

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TessellationHints() +
+[more] TessellationHints(const TessellationHints& tess, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more] META_Object(osg, TessellationHints) +
+[more]inline void setTessellationMode(TessellationMode mode) +
+[more]inline TessellationMode getTessellationMode() const +
+[more]inline void setTargetNumFaces(unsigned int target) +
+[more]inline unsigned int getTargetNumFaces() const +
+[more]inline void setCreateFrontFace(bool on) +
+[more]inline bool getCreateFrontFace() const +
+[more]inline void setCreateBackFace(bool on) +
+[more]inline bool getCreateBackFace() const +
+[more]inline void setCreateNormals(bool on) +
+[more]inline bool getCreateNormals() const +
+[more]inline void setCreateTextureCoords(bool on) +
+[more]inline bool getCreateTextureCoords() const +
+[more]inline void setCreateTop(bool on) +
+[more]inline bool getCreateTop() const +
+[more]inline void setCreateBody(bool on) +
+[more]inline bool getCreateBody() const +
+[more]inline void setCreateBottom(bool on) +
+[more]inline bool getCreateBottom() const +

+ +

+

Protected Fields

+[more]TessellationMode _TessellationMode +
+[more]unsigned int _targetNumFaces +
+[more]bool _createFrontFace +
+[more]bool _createBackFace +
+[more]bool _createNormals +
+[more]bool _createTextureCoords +
+[more]bool _createTop +
+[more]bool _createBody +
+[more]bool _createBottom +

+ +

+

Protected Methods

+[more] ~TessellationHints() +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object*) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o TessellationHints() +

+ + +

o TessellationHints(const TessellationHints& tess, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osg, TessellationHints) +

+ + +

oinline void setTessellationMode(TessellationMode mode) +

+ + +

oinline TessellationMode getTessellationMode() const +

+ + +

oinline void setTargetNumFaces(unsigned int target) +

+ + +

oinline unsigned int getTargetNumFaces() const +

+ + +

oinline void setCreateFrontFace(bool on) +

+ + +

oinline bool getCreateFrontFace() const +

+ + +

oinline void setCreateBackFace(bool on) +

+ + +

oinline bool getCreateBackFace() const +

+ + +

oinline void setCreateNormals(bool on) +

+ + +

oinline bool getCreateNormals() const +

+ + +

oinline void setCreateTextureCoords(bool on) +

+ + +

oinline bool getCreateTextureCoords() const +

+ + +

oinline void setCreateTop(bool on) +

+ + +

oinline bool getCreateTop() const +

+ + +

oinline void setCreateBody(bool on) +

+ + +

oinline bool getCreateBody() const +

+ + +

oinline void setCreateBottom(bool on) +

+ + +

oinline bool getCreateBottom() const +

+ + +

o ~TessellationHints() +

+ + +

oTessellationMode _TessellationMode +

+ + +

ounsigned int _targetNumFaces +

+ + +

obool _createFrontFace +

+ + +

obool _createBackFace +

+ + +

obool _createNormals +

+ + +

obool _createTextureCoords +

+ + +

obool _createTop +

+ + +

obool _createBody +

+ + +

obool _createBottom +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Test.html b/doc/doc++/osg/Test.html new file mode 100644 index 000000000..cdf372645 --- /dev/null +++ b/doc/doc++/osg/Test.html @@ -0,0 +1,119 @@ + + + + + class SG_EXPORT osgUtx::Test + + + + +

class SG_EXPORT osgUtx::Test

Test, an abstract base class, is the Composite pattern's \em component class for our graph of test cases, and defines the basic interface for all Test components.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Test( const std::string& sName ) +
+[more]const std::string& name() const +
+[more]virtual bool accept( Visitor& ) = 0 +

+ +

+

Public Members

+[more]typedef TestVisitor Visitor +

+ +

+

Protected Fields

+[more]std::string _name +

+ +

+

Protected Methods

+[more]virtual ~Test() +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+Test, an abstract base class, is the Composite pattern's \em component +class for our graph of test cases, and defines the basic interface +for all Test components. It is a referent, and may be pointed +to by an osg::ref_ptr.
+
+ + + +
otypedef TestVisitor Visitor +

+ + +

o Test( const std::string& sName ) +

+ + +

oconst std::string& name() const +

+ + +

ovirtual bool accept( Visitor& ) = 0 +

+ + +

ovirtual ~Test() +

+ + +

ostd::string _name +

+
+
Direct child classes: +
TestSuite
+TestCase
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestCase.html b/doc/doc++/osg/TestCase.html new file mode 100644 index 000000000..1d2d479c8 --- /dev/null +++ b/doc/doc++/osg/TestCase.html @@ -0,0 +1,125 @@ + + + + + class osgUtx::TestCase + + + + +

class osgUtx::TestCase

TestCase, is the supplies the interface for a Composite pattern's \em leaf class, though it is not a leaf in itself
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestCase( const std::string& sName ) +
+[more]virtual bool accept( Visitor& v ) +
+[more]virtual void run( const Context& ) = 0 +

+ +

+

Public Members

+[more]typedef TestContext Context +

+ +

+

Protected Methods

+[more]virtual ~TestCase() +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +

+

Public Members

+otypedef TestVisitor Visitor +

+ +

+

Protected Fields

+ostd::string _name +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+TestCase, is the supplies the interface for a Composite pattern's +\em leaf class, though it is not a leaf in itself
+
+ + + +
otypedef TestContext Context +

+ + +

o TestCase( const std::string& sName ) +

+ + +

ovirtual bool accept( Visitor& v ) +

+ + +

ovirtual void run( const Context& ) = 0 +

+ + +

ovirtual ~TestCase() +

+
+
Direct child classes: +
TestCase_
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestCase_.html b/doc/doc++/osg/TestCase_.html new file mode 100644 index 000000000..e5d08bd3f --- /dev/null +++ b/doc/doc++/osg/TestCase_.html @@ -0,0 +1,134 @@ + + + + + template< typename FixtureT > class osgUtx::TestCase_ + + + + +

template< typename FixtureT > class osgUtx::TestCase_

TestCase_ is a class template for a leaf TestCase, which allows TestFixture classes to be easily collected into the tree of tests, and have their public test methods called.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestCase_( const std::string& sName, TestMethodPtr pTestMethod ) +
+[more]virtual void run( const Context& ctx ) +

+ +

+

Protected Fields

+[more]TestMethodPtr _pTestMethod +

+ +

+

Protected Methods

+[more]virtual ~TestCase_() +

+ +
+

Inherited from TestCase:

+
+

+

Public Methods

+ovirtual bool accept( Visitor& v ) +

+ +

+

Public Members

+otypedef TestContext Context +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +

+

Public Members

+otypedef TestVisitor Visitor +

+ +

+

Protected Fields

+ostd::string _name +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+TestCase_ is a class template for a leaf TestCase, which allows TestFixture +classes to be easily collected into the tree of tests, and have their public +test methods called. It is worth noting that, for a given TestCase_, an +instance of the test fixture class will be constructed pior to the +test method being called, and destructed afterwards. This prevents 'leakage' +of information from one test case to the next.
+
+ + + +
o TestCase_( const std::string& sName, TestMethodPtr pTestMethod ) +

+ + +

ovirtual void run( const Context& ctx ) +

+ + +

ovirtual ~TestCase_() +

+ + +

oTestMethodPtr _pTestMethod +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestContext.html b/doc/doc++/osg/TestContext.html new file mode 100644 index 000000000..c089796dd --- /dev/null +++ b/doc/doc++/osg/TestContext.html @@ -0,0 +1,98 @@ + + + + + class SG_EXPORT osgUtx::TestContext + + + + +

class SG_EXPORT osgUtx::TestContext

TestContext wraps up information which is passed to tests as they are run, and may contain test-specific information or 'global' test objects, such as an output stream for verbose output during the running of tests.
+
+ +
+

+

Public Methods

+[more] TestContext() +
+[more]bool shouldStop() +
+[more]bool isVerbose() +
+[more]void setTraceLevel(TraceLevel tl) +
+[more]TraceLevel getTraceLevel() const +
+[more]std::ostream& tout(TraceLevel tl=Full) const +

+ +

+

Public Members

+[more]enum TraceLevel +

+ +
+ + +
+

Documentation

+
+TestContext wraps up information which is passed to tests as they are run, +and may contain test-specific information or 'global' test objects, such +as an output stream for verbose output during the running of tests. + +

\todo Improve the output stream code by providing a filtering stream.

+
+ + + +
o TestContext() +

+ + +

obool shouldStop() +

+ + +

obool isVerbose() +

+ + +

oenum TraceLevel +

+ + + +
o Off +

+ + +

o Results +
< All tracing turned off +

+ + +

o Full +
< Output results only +

+ + + +
ovoid setTraceLevel(TraceLevel tl) +

+ + +

oTraceLevel getTraceLevel() const +

+ + +

ostd::ostream& tout(TraceLevel tl=Full) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestErrorX.html b/doc/doc++/osg/TestErrorX.html new file mode 100644 index 000000000..512ccfa21 --- /dev/null +++ b/doc/doc++/osg/TestErrorX.html @@ -0,0 +1,60 @@ + + + + + class osgUtx::TestErrorX + + + + +

class osgUtx::TestErrorX

A TestErrorX indicates an error while testing a component, which prevents the test from being run; it does not indicate a problem with the component, but rather a problem during the run which prevents the component from being tested
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestErrorX(const std::string& s) +

+ +
+

Inherited from TestX:

+
+

+

Public Methods

+oconst std::string& what() const +

+ +
+ + +
+

Documentation

+
+A TestErrorX indicates an error while testing a component, +which prevents the test from being run; it does not indicate +a problem with the component, but rather a problem during the +run which prevents the component from being tested
+
+ + + +
o TestErrorX(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestFailureX.html b/doc/doc++/osg/TestFailureX.html new file mode 100644 index 000000000..aa579ecd6 --- /dev/null +++ b/doc/doc++/osg/TestFailureX.html @@ -0,0 +1,57 @@ + + + + + class osgUtx::TestFailureX + + + + +

class osgUtx::TestFailureX

A TestFailureX indicates a failure in the tested component
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestFailureX(const std::string& s) +

+ +
+

Inherited from TestX:

+
+

+

Public Methods

+oconst std::string& what() const +

+ +
+ + +
+

Documentation

+
+A TestFailureX indicates a failure in the tested component
+
+ + + +
o TestFailureX(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestGraph.html b/doc/doc++/osg/TestGraph.html new file mode 100644 index 000000000..9f8a5193e --- /dev/null +++ b/doc/doc++/osg/TestGraph.html @@ -0,0 +1,77 @@ + + + + + class SG_EXPORT osgUtx::TestGraph + + + + +

class SG_EXPORT osgUtx::TestGraph

TestGraph is a singleton providing central access to the tree of tests; primarily, it provides access to the root suite
+
+ +
+

+

Public Methods

+[more]static TestGraph& instance() +
+[more]TestSuite* root() +
+
+[more]TestSuite* suite(const std::string& path, TestSuite* tsuite = 0, bool createIfNecessary = false) +
A utility function for accessing an arbitrary quite by pathname, relative to the suite 'tsuite' (defaults to root if null), and with the option of creating the \em TestSuite designated by \em path, if it does not already exist. +

+ +
+ + +
+

Documentation

+
+TestGraph is a singleton providing central access to the tree of tests; +primarily, it provides access to the root suite
+
+ + + +
ostatic TestGraph& instance() +

+ + +

oTestSuite* root() +
+ +
Returns:
a pointer to the root TestSuite.

+ + +

oTestSuite* suite(const std::string& path, TestSuite* tsuite = 0, bool createIfNecessary = false) +
+A utility function for accessing an arbitrary quite by pathname, relative to +the suite 'tsuite' (defaults to root if null), and with the option of creating +the \em TestSuite designated by \em path, if it does not already exist. + +

This method may return 0 if the suite either cannot be found (and createIfNecssary +is 0), or the first component of \em path is not the same as the name of the +TestSuite \em tsuite. + +

This was written to aid the auto-registration of tests at specific points in +the test tree, where the tests' AutoRegistrationAgents may be distributed across +several files, and cannot be guaranteed to run in a given order. E.g. You cannot +register a test "root.osg.MyTest" unless you know that the the suite "root.osg" +already exists. + +

+ +

Parameters:
path - The name of the TestSuite to return. +
tsuite - The suite to 'start from'. Path is relative to this +suite (defaults to root suite). +
createIfNecessary - Optionally create the TestSuite(s) denoted by path if +they do not exist.

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestQualifier.html b/doc/doc++/osg/TestQualifier.html new file mode 100644 index 000000000..4dddc82be --- /dev/null +++ b/doc/doc++/osg/TestQualifier.html @@ -0,0 +1,79 @@ + + + + + class SG_EXPORT osgUtx::TestQualifier + + + + +

class SG_EXPORT osgUtx::TestQualifier

Maintains a string that when accessed in the "visit" member, returns the current qualified TestSuite path
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visitEnter( TestSuite* pSuite ) +
+[more]virtual bool visitLeave( TestSuite* pSuite ) +
+[more]const std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+

+

Public Methods

+ovirtual bool visit( TestCase* ) +

+ +
+ + +
+

Documentation

+
+Maintains a string that when accessed in the "visit" member, returns the +current qualified TestSuite path
+
+
+ + + +
o SEPCHAR +

+ + + +
ovirtual bool visitEnter( TestSuite* pSuite ) +

+ + +

ovirtual bool visitLeave( TestSuite* pSuite ) +

+ + +

oconst std::string& currentPath() const +

+
+
Direct child classes: +
TestRunner
+QualifiedTestPrinter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestRecord.html b/doc/doc++/osg/TestRecord.html new file mode 100644 index 000000000..ad835c069 --- /dev/null +++ b/doc/doc++/osg/TestRecord.html @@ -0,0 +1,87 @@ + + + + + class SG_EXPORT osgUtx::TestRecord + + + + +

class SG_EXPORT osgUtx::TestRecord

A TestRecord records the output of a given test case, ie.
+
+ +
+

+

Public Methods

+[more]void start() +
+[more]void stop() +
+[more]void log(const TestFailureX& e) +
+[more]void log(const TestErrorX& e) +
+[more]void log(const std::exception& e) +
+[more]void log(const std::string& s) +

+ +
+ + +
+

Documentation

+
+A TestRecord records the output of a given test case, ie. its start/stop time, +its result, and a textual description of any problems. + +

\todo Consider adding accessor methods if necessary, to get the details +stored in the TestRecord.

+
+ + + +
ovoid start() +

+ + +

ovoid stop() +

+ + +

ovoid log(const TestFailureX& e) +

+ + +

ovoid log(const TestErrorX& e) +

+ + +

ovoid log(const std::exception& e) +

+ + +

ovoid log(const std::string& s) +

+ + + +
o Success +

+ + +

o Failure +

+ + +

o Error +

+
+ +
This class has no child classes.
+ +
Friends:
class TestReport
std::ostream& operator<<(std::ostream& o,const TestRecord& tr)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestReport.html b/doc/doc++/osg/TestReport.html new file mode 100644 index 000000000..773a2af29 --- /dev/null +++ b/doc/doc++/osg/TestReport.html @@ -0,0 +1,43 @@ + + + + + class SG_EXPORT osgUtx::TestReport + + + + +

class SG_EXPORT osgUtx::TestReport

A TestReport represents the complete set of results (TestRecords) for a given test run.
+
+ +
+

+

Public Methods

+[more]TestRecord& createRecord(const std::string& s) +

+ +
+ + +
+

Documentation

+
+A TestReport represents the complete set of results (TestRecords) for a +given test run. + +

\todo Add support for printing the test report in various formats: +e.g. text, XML, CSV

+
+ + + +
oTestRecord& createRecord(const std::string& s) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestRunner.html b/doc/doc++/osg/TestRunner.html new file mode 100644 index 000000000..ad7a4dfed --- /dev/null +++ b/doc/doc++/osg/TestRunner.html @@ -0,0 +1,103 @@ + + + + + class SG_EXPORT osgUtx::TestRunner + + + + +

class SG_EXPORT osgUtx::TestRunner

A TestRunner is a visitor which will run specified tests as it traverses the test graph.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestRunner( TestContext& ctx ) +
+[more]void specify( const std::string& sQualifiedName ) +
Tests may be specified by partial names. +
+[more]bool visitEnter( TestSuite* pSuite ) +
+[more]bool visit( TestCase* pTest ) +
+[more]bool visitLeave( TestSuite* pSuite ) +

+ +

+

Protected Methods

+[more]void perform( TestCase* pTest ) +

+ +
+

Inherited from TestQualifier:

+
+

+

Public Methods

+oconst std::string& currentPath() const +

+ +
+

Inherited from TestVisitor:

+
+
+ + +
+

Documentation

+
+A TestRunner is a visitor which will run specified tests as it traverses the +test graph. + +

\todo Consider an accessor method to get at the TestReport if necessary.

+
+ + + +
o TestRunner( TestContext& ctx ) +

+ + +

ovoid specify( const std::string& sQualifiedName ) +
+Tests may be specified by partial names. E.g. specifiying "root" +will run all tests below root, i.e. all tests. +Specifiying "root.osg" will run all tests below \em root.osg. +Specifying "root.osg.de" will run all tests (and suites) below +\em root.osg with names beginning with the \em de. +

+ + +

obool visitEnter( TestSuite* pSuite ) +

+ + +

obool visit( TestCase* pTest ) +

+ + +

obool visitLeave( TestSuite* pSuite ) +

+ + +

ovoid perform( TestCase* pTest ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestSuite.html b/doc/doc++/osg/TestSuite.html new file mode 100644 index 000000000..c8e1b7246 --- /dev/null +++ b/doc/doc++/osg/TestSuite.html @@ -0,0 +1,143 @@ + + + + + class SG_EXPORT osgUtx::TestSuite + + + + +

class SG_EXPORT osgUtx::TestSuite

A TestSuite is the \em composite component of the Composite pattern, and allows aggregation of Tests into hierarchies
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestSuite( const std::string& name ) +
+[more]void add( Test* pTest ) +
Adds a Test to the suite. +
+[more]Test* findChild(const std::string& name) +
+
+[more]virtual bool accept( Test::Visitor& v ) +

+ +

+

Protected Fields

+[more]Tests _tests +

+ +

+

Protected Methods

+[more]virtual ~TestSuite() +

+ +

+

Protected Members

+[more]typedef std::vector< osg::ref_ptr<Test> > Tests +

+ +
+

Inherited from Test:

+
+

+

Public Methods

+oconst std::string& name() const +

+ +

+

Public Members

+otypedef TestVisitor Visitor +

+ +

+

Protected Fields

+ostd::string _name +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+A TestSuite is the \em composite component of the Composite pattern, +and allows aggregation of Tests into hierarchies
+
+ + + +
o TestSuite( const std::string& name ) +

+ + +

ovoid add( Test* pTest ) +
Adds a Test to the suite. +

+ + +

oTest* findChild(const std::string& name) +
+ +
Returns:
s The immediate child denoted by name, or 0 if not found.

+ + +

ovirtual bool accept( Test::Visitor& v ) +

+ + +

ovirtual ~TestSuite() +

+ + +

otypedef std::vector< osg::ref_ptr<Test> > Tests +

+ + +

oTests _tests +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html b/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html new file mode 100644 index 000000000..46db77a83 --- /dev/null +++ b/doc/doc++/osg/TestSuiteAutoRegistrationAgent.html @@ -0,0 +1,37 @@ + + + + + struct osgUtx::TestSuiteAutoRegistrationAgent + + + + +

struct osgUtx::TestSuiteAutoRegistrationAgent

A helper struct to perform automatic registration at program startup; not for direct use, it should be used via the following macros.
+ +
+

+
+[more] TestSuiteAutoRegistrationAgent(TestSuite* tsuite, const char* path = 0) +

+ + + +
+

Documentation

+
+A helper struct to perform automatic registration at program startup; not for +direct use, it should be used via the following macros. (It's a secret agent :-) + +

+
+ + + +
o TestSuiteAutoRegistrationAgent(TestSuite* tsuite, const char* path = 0) +

+
See Also:
OSGUTX_AUTOREGISTER_TESTSUITE, OSGUTX_AUTOREGISTER_TESTSUITE_AT

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestVisitor.html b/doc/doc++/osg/TestVisitor.html new file mode 100644 index 000000000..7ad0a02c2 --- /dev/null +++ b/doc/doc++/osg/TestVisitor.html @@ -0,0 +1,85 @@ + + + + + class osgUtx::TestVisitor + + + + +

class osgUtx::TestVisitor

Visits while maintaining the current hierarchical context.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual bool visitEnter( TestSuite* ) +
+[more]virtual bool visit( TestCase* ) = 0 +
+[more]virtual bool visitLeave( TestSuite* ) +

+ +

+

Protected Methods

+[more] TestVisitor() +
+[more] TestVisitor( const TestVisitor& ) +
+[more]virtual ~TestVisitor() +

+ +
+ + +
+

Documentation

+
+Visits while maintaining the current hierarchical context. Also allows +the traversal to be short-cicuited at any point during the visitation.
+
+ + + +
ovirtual bool visitEnter( TestSuite* ) +

+ + +

ovirtual bool visit( TestCase* ) = 0 +

+ + +

ovirtual bool visitLeave( TestSuite* ) +

+ + +

o TestVisitor() +

+ + +

o TestVisitor( const TestVisitor& ) +

+ + +

ovirtual ~TestVisitor() +

+
+
Direct child classes: +
TestQualifier
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TestX.html b/doc/doc++/osg/TestX.html new file mode 100644 index 000000000..277a6da3c --- /dev/null +++ b/doc/doc++/osg/TestX.html @@ -0,0 +1,65 @@ + + + + + class osgUtx::TestX + + + + +

class osgUtx::TestX

Base class catchable for the exception's which may be thrown to indicate problems during the run of a TestCase
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TestX(const std::string& s) +
+[more]virtual ~TestX() +
+[more]const std::string& what() const +

+ +
+ + +
+

Documentation

+
+Base class catchable for the exception's which may be thrown to +indicate problems during the run of a TestCase
+
+ + + +
o TestX(const std::string& s) +

+ + +

ovirtual ~TestX() +

+ + +

oconst std::string& what() const +

+
+
Direct child classes: +
TestFailureX
+TestErrorX
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TexEnv.html b/doc/doc++/osg/TexEnv.html new file mode 100644 index 000000000..d50b8077e --- /dev/null +++ b/doc/doc++/osg/TexEnv.html @@ -0,0 +1,263 @@ + + + + + class SG_EXPORT osg::TexEnv + + + + +

class SG_EXPORT osg::TexEnv

TexEnv - encapsulates the OpenGL glTexEnv (texture environment) state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TexEnv() +
+[more] TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TexEnv, TEXENV) +
+[more]virtual bool isTextureAttribute() const +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setMode( Mode mode ) +
+[more]Mode getMode() const +
+[more]void setColor( const Vec4& color ) +
+[more]Vec4& getColor() +
+[more]const Vec4& getColor() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum Mode +

+ +

+

Protected Fields

+[more]Mode _mode +
+[more]osg::Vec4 _color +

+ +

+

Protected Methods

+[more]virtual ~TexEnv( void ) +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
TexEnv - encapsulates the OpenGL glTexEnv (texture environment) state
+
+ + + +
o TexEnv() +

+ + +

o TexEnv(const TexEnv& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TexEnv, TEXENV) +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum Mode +

+ + + +
o DECAL +

+ + +

o MODULATE +

+ + +

o BLEND +

+ + +

o REPLACE +

+ + +

o ADD +

+ + + +
ovoid setMode( Mode mode ) +

+ + +

oMode getMode() const +

+ + +

ovoid setColor( const Vec4& color ) +

+ + +

oVec4& getColor() +

+ + +

oconst Vec4& getColor() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~TexEnv( void ) +

+ + +

oMode _mode +

+ + +

oosg::Vec4 _color +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TexEnvCombine.html b/doc/doc++/osg/TexEnvCombine.html new file mode 100644 index 000000000..c05a3c46f --- /dev/null +++ b/doc/doc++/osg/TexEnvCombine.html @@ -0,0 +1,637 @@ + + + + + class SG_EXPORT osg::TexEnvCombine + + + + +

class SG_EXPORT osg::TexEnvCombine

TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TexEnvCombine() +
+[more] TexEnvCombine(const TexEnvCombine& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TexEnvCombine, TEXENV) +
+[more]virtual bool isTextureAttribute() const +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setCombine_RGB(GLint cm) +
+[more]void setCombine_Alpha(GLint cm) +
+[more]GLint getCombine_RGB() const +
+[more]GLint getCombine_Alpha() const +
+[more]void setSource0_RGB(GLint sp) +
+[more]void setSource1_RGB(GLint sp) +
+[more]void setSource2_RGB(GLint sp) +
+[more]void setSource0_Alpha(GLint sp) +
+[more]void setSource1_Alpha(GLint sp) +
+[more]void setSource2_Alpha(GLint sp) +
+[more]GLint getSource0_RGB() const +
+[more]GLint getSource1_RGB() const +
+[more]GLint getSource2_RGB() const +
+[more]GLint getSource0_Alpha() const +
+[more]GLint getSource1_Alpha() const +
+[more]GLint getSource2_Alpha() const +
+[more]void setOperand0_RGB(GLint op) +
+[more]void setOperand1_RGB(GLint op) +
+[more]void setOperand2_RGB(GLint op) +
+[more]void setOperand0_Alpha(GLint op) +
+[more]void setOperand1_Alpha(GLint op) +
+[more]void setOperand2_Alpha(GLint op) +
+[more]GLint getOperand0_RGB() const +
+[more]GLint getOperand1_RGB() const +
+[more]GLint getOperand2_RGB() const +
+[more]GLint getOperand0_Alpha() const +
+[more]GLint getOperand1_Alpha() const +
+[more]GLint getOperand2_Alpha() const +
+[more]void setScale_RGB(float scale) +
+[more]void setScale_Alpha(float scale) +
+[more]float getScale_RGB() const +
+[more]float getScale_Alpha() const +
+[more]void setConstantColor( const Vec4& color ) +
+[more]const Vec4& getConstantColor() const +
+[more]virtual void apply(State& state) const +

+ +

+

Public Members

+[more]enum CombineParam +
+[more]enum SourceParam +
+[more]enum OperandParam +

+ +

+

Protected Fields

+[more]bool _needsTexEnvCrossbar +
+[more]GLint _combine_RGB +
+[more]GLint _combine_Alpha +
+[more]GLint _source0_RGB +
+[more]GLint _source1_RGB +
+[more]GLint _source2_RGB +
+[more]GLint _source0_Alpha +
+[more]GLint _source1_Alpha +
+[more]GLint _source2_Alpha +
+[more]GLint _operand0_RGB +
+[more]GLint _operand1_RGB +
+[more]GLint _operand2_RGB +
+[more]GLint _operand0_Alpha +
+[more]GLint _operand1_Alpha +
+[more]GLint _operand2_Alpha +
+[more]float _scale_RGB +
+[more]float _scale_Alpha +
+[more]osg::Vec4 _constantColor +

+ +

+

Protected Methods

+[more]virtual ~TexEnvCombine() +
+[more]inline bool needsTexEnvCombiner(GLint value) const +
+[more]void computeNeedoForTexEnvCombiners() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state
+
+ + + +
o TexEnvCombine() +

+ + +

o TexEnvCombine(const TexEnvCombine& texenv, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TexEnvCombine, TEXENV) +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oenum CombineParam +

+ + + +
o REPLACE +

+ + +

o MODULATE +

+ + +

o ADD +

+ + +

o ADD_SIGNED +

+ + +

o INTERPOLATE +

+ + +

o SUBTRACT +

+ + +

o DOT3_RGB +

+ + +

o DOT3_RGBA +

+ + + +
ovoid setCombine_RGB(GLint cm) +

+ + +

ovoid setCombine_Alpha(GLint cm) +

+ + +

oGLint getCombine_RGB() const +

+ + +

oGLint getCombine_Alpha() const +

+ + +

oenum SourceParam +

+ + + +
o CONSTANT +

+ + +

o PRIMARY_COLOR +

+ + +

o PREVIOUS +

+ + +

o TEXTURE +

+ + +

o TEXTURE0 +

+ + +

o TEXTURE1 +

+ + +

o TEXTURE2 +

+ + +

o TEXTURE3 +

+ + +

o TEXTURE4 +

+ + +

o TEXTURE5 +

+ + +

o TEXTURE6 +

+ + +

o TEXTURE7 +

+ + + +
ovoid setSource0_RGB(GLint sp) +

+ + +

ovoid setSource1_RGB(GLint sp) +

+ + +

ovoid setSource2_RGB(GLint sp) +

+ + +

ovoid setSource0_Alpha(GLint sp) +

+ + +

ovoid setSource1_Alpha(GLint sp) +

+ + +

ovoid setSource2_Alpha(GLint sp) +

+ + +

oGLint getSource0_RGB() const +

+ + +

oGLint getSource1_RGB() const +

+ + +

oGLint getSource2_RGB() const +

+ + +

oGLint getSource0_Alpha() const +

+ + +

oGLint getSource1_Alpha() const +

+ + +

oGLint getSource2_Alpha() const +

+ + +

oenum OperandParam +

+ + + +
o SRC_COLOR +

+ + +

o ONE_MINUS_SRC_COLOR +

+ + +

o SRC_ALPHA +

+ + +

o ONE_MINUS_SRC_ALPHA +

+ + + +
ovoid setOperand0_RGB(GLint op) +

+ + +

ovoid setOperand1_RGB(GLint op) +

+ + +

ovoid setOperand2_RGB(GLint op) +

+ + +

ovoid setOperand0_Alpha(GLint op) +

+ + +

ovoid setOperand1_Alpha(GLint op) +

+ + +

ovoid setOperand2_Alpha(GLint op) +

+ + +

oGLint getOperand0_RGB() const +

+ + +

oGLint getOperand1_RGB() const +

+ + +

oGLint getOperand2_RGB() const +

+ + +

oGLint getOperand0_Alpha() const +

+ + +

oGLint getOperand1_Alpha() const +

+ + +

oGLint getOperand2_Alpha() const +

+ + +

ovoid setScale_RGB(float scale) +

+ + +

ovoid setScale_Alpha(float scale) +

+ + +

ofloat getScale_RGB() const +

+ + +

ofloat getScale_Alpha() const +

+ + +

ovoid setConstantColor( const Vec4& color ) +

+ + +

oconst Vec4& getConstantColor() const +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~TexEnvCombine() +

+ + +

oinline bool needsTexEnvCombiner(GLint value) const +

+ + +

ovoid computeNeedoForTexEnvCombiners() +

+ + +

obool _needsTexEnvCrossbar +

+ + +

oGLint _combine_RGB +

+ + +

oGLint _combine_Alpha +

+ + +

oGLint _source0_RGB +

+ + +

oGLint _source1_RGB +

+ + +

oGLint _source2_RGB +

+ + +

oGLint _source0_Alpha +

+ + +

oGLint _source1_Alpha +

+ + +

oGLint _source2_Alpha +

+ + +

oGLint _operand0_RGB +

+ + +

oGLint _operand1_RGB +

+ + +

oGLint _operand2_RGB +

+ + +

oGLint _operand0_Alpha +

+ + +

oGLint _operand1_Alpha +

+ + +

oGLint _operand2_Alpha +

+ + +

ofloat _scale_RGB +

+ + +

ofloat _scale_Alpha +

+ + +

oosg::Vec4 _constantColor +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TexGen.html b/doc/doc++/osg/TexGen.html new file mode 100644 index 000000000..1a8b55804 --- /dev/null +++ b/doc/doc++/osg/TexGen.html @@ -0,0 +1,311 @@ + + + + + class SG_EXPORT osg::TexGen + + + + +

class SG_EXPORT osg::TexGen

TexGen - encapsulates the OpenGL glTexGen (texture coordinate generation) state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TexGen() +
+[more] TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TexGen, TEXGEN) +
+[more]virtual bool isTextureAttribute() const +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]virtual void apply(State& state) const +
+[more]inline void setMode( Mode mode ) +
+[more]Mode getMode() const +
+[more]void setPlane(Coord which, const Plane& plane) +
+[more]Plane& getPlane(Coord which) +
+[more]const Plane& getPlane(Coord which) const +

+ +

+

Public Members

+[more]enum Mode +
+[more]enum Coord +

+ +

+

Protected Fields

+[more]Mode _mode +
+[more]Plane _plane_s +
additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE, +
+[more]Plane _plane_t +
+[more]Plane _plane_r +
+[more]Plane _plane_q +

+ +

+

Protected Methods

+[more]virtual ~TexGen( void ) +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
TexGen - encapsulates the OpenGL glTexGen (texture coordinate generation) state
+
+ + + +
o TexGen() +

+ + +

o TexGen(const TexGen& texgen, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TexGen, TEXGEN) +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovirtual void apply(State& state) const +

+ + +

oenum Mode +

+ + + +
o OBJECT_LINEAR +

+ + +

o EYE_LINEAR +

+ + +

o SPHERE_MAP +

+ + +

o NORMAL_MAP +

+ + +

o REFLECTION_MAP +

+ + + +
oinline void setMode( Mode mode ) +

+ + +

oMode getMode() const +

+ + +

oenum Coord +

+ + + +
o S +

+ + +

o T +

+ + +

o R +

+ + +

o Q +

+ + + +
ovoid setPlane(Coord which, const Plane& plane) +

+ + +

oPlane& getPlane(Coord which) +

+ + +

oconst Plane& getPlane(Coord which) const +

+ + +

ovirtual ~TexGen( void ) +

+ + +

oMode _mode +

+ + +

oPlane _plane_s +
additional texgen coefficents for GL_OBJECT_PLANE or GL_EYE_PLANE, +

+ + +

oPlane _plane_t +

+ + +

oPlane _plane_r +

+ + +

oPlane _plane_q +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TexMat.html b/doc/doc++/osg/TexMat.html new file mode 100644 index 000000000..3297180fd --- /dev/null +++ b/doc/doc++/osg/TexMat.html @@ -0,0 +1,222 @@ + + + + + class SG_EXPORT osg::TexMat + + + + +

class SG_EXPORT osg::TexMat

Texture Matrix state class for encapsulating OpenGL texture matrix functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TexMat() +
+[more] TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TexMat, TEXMAT) +
+[more]virtual bool isTextureAttribute() const +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setMatrix(const Matrix& matrix) +
Set the texture matrix +
+[more]inline Matrix& getMatrix() +
Get the texture matrix +
+[more]inline const Matrix& getMatrix() const +
Get the const texture matrix +
+[more]virtual void apply(State& state) const +
apply as OpenGL texture matrix +

+ +

+

Protected Fields

+[more]Matrix _matrix +

+ +

+

Protected Methods

+[more]virtual ~TexMat( void ) +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture Matrix state class for encapsulating OpenGL texture matrix functionality
+
+ + + +
o TexMat() +

+ + +

o TexMat(const TexMat& texmat, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TexMat, TEXMAT) +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oinline void setMatrix(const Matrix& matrix) +
Set the texture matrix +

+ + +

oinline Matrix& getMatrix() +
Get the texture matrix +

+ + +

oinline const Matrix& getMatrix() const +
Get the const texture matrix +

+ + +

ovirtual void apply(State& state) const +
apply as OpenGL texture matrix +

+ + +

ovirtual ~TexMat( void ) +

+ + +

oMatrix _matrix +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture.html b/doc/doc++/osg/Texture.html new file mode 100644 index 000000000..775ca30ee --- /dev/null +++ b/doc/doc++/osg/Texture.html @@ -0,0 +1,712 @@ + + + + + class SG_EXPORT osg::Texture + + + + +

class SG_EXPORT osg::Texture

Texture base class which encapsulates OpenGl texture functionality which common betweent the various types of OpenGL textures
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture() +
+[more] Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual osg::Object* cloneType() const = 0 +
+[more]virtual osg::Object* clone(const CopyOp& copyop) const = 0 +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual Type getType() const +
+[more]virtual bool isTextureAttribute() const +
+[more]void setWrap(WrapParameter which, WrapMode wrap) +
Set the texture wrap mode +
+[more]WrapMode getWrap(WrapParameter which) const +
Get the texture wrap mode +
+[more]void setBorderColor(const Vec4& color) +
Sets the border color for this texture. +
+[more]const Vec4& getBorderColor() const +
+[more]void setFilter(FilterParameter which, FilterMode filter) +
Set the texture filter mode +
+[more]FilterMode getFilter(FilterParameter which) const +
Get the texture filter mode +
+[more]void setMaxAnisotropy(float anis) +
Set the maximum anisotropy value, default value is 10 for no anisotropic filtering. +
+[more]inline float getMaxAnisotropy() const +
Get the maximum anisotropy value +
+[more]inline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
Set the hint of whether to use hardware mip map generation where available +
+[more]inline bool getUseHardwareMipMapGeneration() const +
Get the hint of whether to use hardware mip map generation where available +
+[more]inline void setUnRefImageDataAfterApply(bool flag) +
Set the automatic unreference of image data after the texture has been set up in apply, on (true) or off (false). +
+[more]inline bool getUnRefImageDataAfterApply() const +
Get the automatic unreference of image data after the texture has been set up in apply +
+[more]inline void setInternalFormatMode(InternalFormatMode mode) +
Set the internal format mode. +
+[more]inline InternalFormatMode getInternalFormatMode() const +
Get the internal format mode +
+[more]inline void setInternalFormat(GLint internalFormat) +
Set the internal format to use when creating OpenGL textures. +
+[more]inline GLint getInternalFormat() const +
Get the internal format to use when creating OpenGL textures +
+[more]bool isCompressedInternalFormat() const +
+[more]inline GLuint& getTextureObject(unsigned int contextID) const +
Get the handle to the texture object for the current context +
+[more]inline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
get the dirty flag for the current contextID +
+[more]void dirtyTextureObject() +
Force a recompile on next apply() of associated OpenGL texture objects +
+[more]void dirtyTextureParameters() +
Force a resetting on next apply() of associated OpenGL texture parameters +
+[more]static void deleteTextureObject(unsigned int contextID, GLuint handle) +
use deleteTextureObject instead of glDeleteTextures to allow OpenGL texture objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID +
+[more]static void flushDeletedTextureObjects(unsigned int contextID) +
flush all the cached display list which need to be deleted in the OpenGL context related to contextID +
+[more]virtual void apply(State& state) const = 0 +
Texture is pure virtual base class, apply must be overriden. +
+[more]virtual void compile(State& state) const +
Calls apply(state) to compile the texture. +
+[more]static Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +
+[more]static void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +
+[more]void applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, but does not set or use texture binding. +
+[more]void applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
Helper method which subloads images to the texture itself, but does not set or use texture binding. +

+ +

+

Public Members

+[more]enum WrapParameter +
+[more]enum WrapMode +
+[more]enum FilterParameter +
+[more]enum FilterMode +
+[more]enum InternalFormatMode +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+[more]mutable TextureNameList _handleList +
+[more]mutable TexParameterDirtyList _texParametersDirtyList +
+[more]WrapMode _wrap_s +
+[more]WrapMode _wrap_t +
+[more]WrapMode _wrap_r +
+[more]FilterMode _min_filter +
+[more]FilterMode _mag_filter +
+[more]float _maxAnisotropy +
+[more]bool _useHardwareMipMapGeneration +
+[more]bool _unrefImageDataAfterApply +
+[more]Vec4 _borderColor +
+[more]InternalFormatMode _internalFormatMode +
+[more]mutable GLint _internalFormat +

+ +

+

Protected Methods

+[more]virtual ~Texture() +
+[more]virtual void computeInternalFormat() const = 0 +
+[more]void computeInternalFormatWithImage(const osg::Image& image) const +
+[more]bool isCompressedInternalFormat(GLint internalFormat) const +
+[more]void applyTexParameters(GLenum target, State& state) const +
Helper method which does setting of texture paramters. +
+[more]int compareTexture(const Texture& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ +

+

Protected Members

+[more]typedef buffered_value<GLuint> TextureNameList +
+[more]typedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual int compare(const StateAttribute& sa) const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture base class which encapsulates OpenGl texture functionality which common betweent the various types of OpenGL textures
+
+ + + +
o Texture() +

+ + +

o Texture(const Texture& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual osg::Object* cloneType() const = 0 +

+ + +

ovirtual osg::Object* clone(const CopyOp& copyop) const = 0 +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual Type getType() const +

+ + +

ovirtual bool isTextureAttribute() const +

+ + +

oenum WrapParameter +

+ + + +
o WRAP_S +

+ + +

o WRAP_T +

+ + +

o WRAP_R +

+ + + +
oenum WrapMode +

+ + + +
o CLAMP +

+ + +

o CLAMP_TO_EDGE +

+ + +

o CLAMP_TO_BORDER +

+ + +

o REPEAT +

+ + +

o MIRROR +

+ + + +
ovoid setWrap(WrapParameter which, WrapMode wrap) +
Set the texture wrap mode +

+ + +

oWrapMode getWrap(WrapParameter which) const +
Get the texture wrap mode +

+ + +

ovoid setBorderColor(const Vec4& color) +
Sets the border color for this texture. Makes difference only if +wrap mode is CLAMP_TO_BORDER +

+ + +

oconst Vec4& getBorderColor() const +

+ + +

oenum FilterParameter +

+ + + +
o MIN_FILTER +

+ + +

o MAG_FILTER +

+ + + +
oenum FilterMode +

+ + + +
o LINEAR +

+ + +

o LINEAR_MIPMAP_LINEAR +

+ + +

o LINEAR_MIPMAP_NEAREST +

+ + +

o NEAREST +

+ + +

o NEAREST_MIPMAP_LINEAR +

+ + +

o NEAREST_MIPMAP_NEAREST +

+ + + +
ovoid setFilter(FilterParameter which, FilterMode filter) +
Set the texture filter mode +

+ + +

oFilterMode getFilter(FilterParameter which) const +
Get the texture filter mode +

+ + +

ovoid setMaxAnisotropy(float anis) +
Set the maximum anisotropy value, default value is 10 for +no anisotropic filtering. If hardware does not support anisotropic +filtering then normal filtering is used, equivilant to a max anisotropy value of 1.0. +valid range is 1.0f upwards. The maximum value depends on the graphics +system being used. +

+ + +

oinline float getMaxAnisotropy() const +
Get the maximum anisotropy value +

+ + +

oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
Set the hint of whether to use hardware mip map generation where available +

+ + +

oinline bool getUseHardwareMipMapGeneration() const +
Get the hint of whether to use hardware mip map generation where available +

+ + +

oinline void setUnRefImageDataAfterApply(bool flag) +
Set the automatic unreference of image data after the texture has been set up in apply, on (true) or off (false). +If the image data is only referened by this Texture then the image data will be autoamtically deleted. +

+ + +

oinline bool getUnRefImageDataAfterApply() const +
Get the automatic unreference of image data after the texture has been set up in apply +

+ + +

oenum InternalFormatMode +

+ + + +
o USE_IMAGE_DATA_FORMAT +

+ + +

o USE_USER_DEFINED_FORMAT +

+ + +

o USE_ARB_COMPRESSION +

+ + +

o USE_S3TC_DXT1_COMPRESSION +

+ + +

o USE_S3TC_DXT3_COMPRESSION +

+ + +

o USE_S3TC_DXT5_COMPRESSION +

+ + + +
oinline void setInternalFormatMode(InternalFormatMode mode) +
Set the internal format mode. +Note, If the mode is set USE_IMAGE_DATA_FORMAT, USE_ARB_COMPRESSION, +USE_S3TC_COMPRESSION the internalFormat is automatically selected, +and will overwrite the previous _internalFormat. +

+ + +

oinline InternalFormatMode getInternalFormatMode() const +
Get the internal format mode +

+ + +

oinline void setInternalFormat(GLint internalFormat) +
Set the internal format to use when creating OpenGL textures. +Also sets the internalFormatMode to USE_USER_DEFINED_FORMAT. +

+ + +

oinline GLint getInternalFormat() const +
Get the internal format to use when creating OpenGL textures +

+ + +

obool isCompressedInternalFormat() const +

+ + +

oinline GLuint& getTextureObject(unsigned int contextID) const +
Get the handle to the texture object for the current context +

+ + +

oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
get the dirty flag for the current contextID +

+ + +

ovoid dirtyTextureObject() +
Force a recompile on next apply() of associated OpenGL texture objects +

+ + +

ovoid dirtyTextureParameters() +
Force a resetting on next apply() of associated OpenGL texture parameters +

+ + +

ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
use deleteTextureObject instead of glDeleteTextures to allow +OpenGL texture objects to cached until they can be deleted +by the OpenGL context in which they were created, specified +by contextID +

+ + +

ostatic void flushDeletedTextureObjects(unsigned int contextID) +
flush all the cached display list which need to be deleted +in the OpenGL context related to contextID +

+ + +

ovirtual void apply(State& state) const = 0 +
Texture is pure virtual base class, apply must be overriden. +

+ + +

ovirtual void compile(State& state) const +
Calls apply(state) to compile the texture. +

+ + +

ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +If the Exentsion object for that context has not yet been created then +and the 'createIfNotInitalized' flag been set to false then returns NULL. +If 'createIfNotInitalized' is true then the Extensions object is +automatically created. However, in this case the extension object +only be created with the graphics context associated with ContextID.. +

+ + +

ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +typically used when you have different extensions supported across graphics pipes +but need to ensure that they all use the same low common denominator extensions. +

+ + +

ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, but does not set or use texture binding. +Note, do not call this method directly unless you are implementing your own Subload callback +

+ + +

ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
Helper method which subloads images to the texture itself, but does not set or use texture binding. +Note, do not call this method directly unless you are implementing your own Subload callback +

+ + +

ovirtual ~Texture() +

+ + +

ovirtual void computeInternalFormat() const = 0 +

+ + +

ovoid computeInternalFormatWithImage(const osg::Image& image) const +

+ + +

obool isCompressedInternalFormat(GLint internalFormat) const +

+ + +

ovoid applyTexParameters(GLenum target, State& state) const +
Helper method which does setting of texture paramters. +

+ + +

oint compareTexture(const Texture& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

otypedef buffered_value<GLuint> TextureNameList +

+ + +

omutable TextureNameList _handleList +

+ + +

otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ + +

omutable TexParameterDirtyList _texParametersDirtyList +

+ + +

oWrapMode _wrap_s +

+ + +

oWrapMode _wrap_t +

+ + +

oWrapMode _wrap_r +

+ + +

oFilterMode _min_filter +

+ + +

oFilterMode _mag_filter +

+ + +

ofloat _maxAnisotropy +

+ + +

obool _useHardwareMipMapGeneration +

+ + +

obool _unrefImageDataAfterApply +

+ + +

oVec4 _borderColor +

+ + +

oInternalFormatMode _internalFormatMode +

+ + +

omutable GLint _internalFormat +

+
+
Direct child classes: +
TextureRectangle
+TextureCubeMap
+Texture3D
+Texture2D
+Texture1D
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture1D.html b/doc/doc++/osg/Texture1D.html new file mode 100644 index 000000000..ba9124f4a --- /dev/null +++ b/doc/doc++/osg/Texture1D.html @@ -0,0 +1,477 @@ + + + + + class SG_EXPORT osg::Texture1D + + + + +

class SG_EXPORT osg::Texture1D

Texture state class which encapsulates OpenGl 1D texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture1D() +
+[more] Texture1D(const Texture1D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture1D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline unsigned int& getModifiedTag(unsigned int contextID) const +
+[more]inline void setTextureSize(int width) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexImage1D(State& state, int x, int y, int width) +
Copy pixels into a 1D texture imageAs per glCopyTexImage1D. +
+[more]void copyTexSubImage1D(State& state, int xoffset, int x, int y, int width) +
Copy a one-dimensional texture subimage. +
+[more]virtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture +

+ +

+

Public Members

+class SG_EXPORT SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +
+[more]mutable ImageModifiedTag _modifiedTag +

+ +

+

Protected Methods

+[more]virtual ~Texture1D() +
+[more]virtual void computeInternalFormat() const +
+[more]void applyTexImage1D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, and does not set or use texture binding. +

+ +

+

Protected Members

+[more]typedef buffered_value<unsigned int> ImageModifiedTag +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(WrapParameter which, WrapMode wrap) +
+oWrapMode getWrap(WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& getBorderColor() const +
+ovoid setFilter(FilterParameter which, FilterMode filter) +
+oFilterMode getFilter(FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
+oinline bool getUseHardwareMipMapGeneration() const +
+oinline void setUnRefImageDataAfterApply(bool flag) +
+oinline bool getUnRefImageDataAfterApply() const +
+oinline void setInternalFormatMode(InternalFormatMode mode) +
+oinline InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(GLint internalFormat) +
+oinline GLint getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(unsigned int contextID) const +
+oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
+ovoid dirtyTextureObject() +
+ovoid dirtyTextureParameters() +
+ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(unsigned int contextID) +
+ovirtual void compile(State& state) const +
+ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
+ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
+ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+omutable TextureNameList _handleList +
+omutable TexParameterDirtyList _texParametersDirtyList +
+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+obool _useHardwareMipMapGeneration +
+obool _unrefImageDataAfterApply +
+oVec4 _borderColor +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(const osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef buffered_value<GLuint> TextureNameList +
+otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl 1D texture functionality
+
+ + + +
o Texture1D() +

+ + +

o Texture1D(const Texture1D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture1D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline unsigned int& getModifiedTag(unsigned int contextID) const +

+ + +

oinline void setTextureSize(int width) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid copyTexImage1D(State& state, int x, int y, int width) +
Copy pixels into a 1D texture imageAs per glCopyTexImage1D. +Creates an OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width. \a width must be a power of two. +

+ + +

ovoid copyTexSubImage1D(State& state, int xoffset, int x, int y, int width) +
Copy a one-dimensional texture subimage. As per glCopyTexSubImage1D. +Updates portion of an existing OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width. +

+ + +

ovirtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped +texture and bind it, subsequent apply will simple bind to texture +

+ + +

ovirtual ~Texture1D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

ovoid applyTexImage1D(GLenum target, Image* image, State& state, GLsizei& width, GLsizei& numMimpmapLevels) const +
Helper method which does the creation of the texture itself, and +does not set or use texture binding. +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ + +

otypedef buffered_value<unsigned int> ImageModifiedTag +

+ + +

omutable ImageModifiedTag _modifiedTag +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture2D.html b/doc/doc++/osg/Texture2D.html new file mode 100644 index 000000000..6ed944e8d --- /dev/null +++ b/doc/doc++/osg/Texture2D.html @@ -0,0 +1,487 @@ + + + + + class SG_EXPORT osg::Texture2D + + + + +

class SG_EXPORT osg::Texture2D

Texture state class which encapsulates OpenGl texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture2D() +
+[more] Texture2D(const Texture2D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture2D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline unsigned int& getModifiedTag(unsigned int contextID) const +
+[more]inline void setTextureSize(int width, int height) const +
Set the texture width and height. +
+[more]int getTextureWidth() const +
+[more]int getTextureHeight() const +
+[more]inline void getTextureSize(int& width, int& height) const +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexImage2D(State& state, int x, int y, int width, int height ) +
Copy pixels into a 2D texture imageAs per glCopyTexImage2D. +
+[more]void copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height ) +
Copy a two-dimensional texture subimage. +
+[more]virtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture +

+ +

+

Public Members

+class SG_EXPORT SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +
+[more]mutable ImageModifiedTag _modifiedTag +

+ +

+

Protected Methods

+[more]virtual ~Texture2D() +
+[more]virtual void computeInternalFormat() const +

+ +

+

Protected Members

+[more]typedef buffered_value<unsigned int> ImageModifiedTag +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(WrapParameter which, WrapMode wrap) +
+oWrapMode getWrap(WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& getBorderColor() const +
+ovoid setFilter(FilterParameter which, FilterMode filter) +
+oFilterMode getFilter(FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
+oinline bool getUseHardwareMipMapGeneration() const +
+oinline void setUnRefImageDataAfterApply(bool flag) +
+oinline bool getUnRefImageDataAfterApply() const +
+oinline void setInternalFormatMode(InternalFormatMode mode) +
+oinline InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(GLint internalFormat) +
+oinline GLint getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(unsigned int contextID) const +
+oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
+ovoid dirtyTextureObject() +
+ovoid dirtyTextureParameters() +
+ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(unsigned int contextID) +
+ovirtual void compile(State& state) const +
+ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
+ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
+ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+omutable TextureNameList _handleList +
+omutable TexParameterDirtyList _texParametersDirtyList +
+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+obool _useHardwareMipMapGeneration +
+obool _unrefImageDataAfterApply +
+oVec4 _borderColor +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(const osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef buffered_value<GLuint> TextureNameList +
+otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl texture functionality
+
+ + + +
o Texture2D() +

+ + +

o Texture2D(const Texture2D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture2D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline unsigned int& getModifiedTag(unsigned int contextID) const +

+ + +

oinline void setTextureSize(int width, int height) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oint getTextureWidth() const +

+ + +

oint getTextureHeight() const +

+ + +

oinline void getTextureSize(int& width, int& height) const +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid copyTexImage2D(State& state, int x, int y, int width, int height ) +
Copy pixels into a 2D texture imageAs per glCopyTexImage2D. +Creates an OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width and +height \a height. \a width and \a height must be a power of two. +

+ + +

ovoid copyTexSubImage2D(State& state, int xoffset, int yoffset, int x, int y, int width, int height ) +
Copy a two-dimensional texture subimage. As per glCopyTexSubImage2D. +Updates portion of an existing OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width and +height \a height. \a width and \a height must be a power of two, +and writing into the texture with offset \a xoffset and \a yoffset. +

+ + +

ovirtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped +texture and bind it, subsequent apply will simple bind to texture +

+ + +

ovirtual ~Texture2D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

oref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ + +

otypedef buffered_value<unsigned int> ImageModifiedTag +

+ + +

omutable ImageModifiedTag _modifiedTag +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Texture3D.html b/doc/doc++/osg/Texture3D.html new file mode 100644 index 000000000..db3538187 --- /dev/null +++ b/doc/doc++/osg/Texture3D.html @@ -0,0 +1,496 @@ + + + + + class SG_EXPORT osg::Texture3D + + + + +

class SG_EXPORT osg::Texture3D

Texture state class which encapsulates OpenGl 3D texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Texture3D() +
+[more] Texture3D(const Texture3D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Texture3D, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline unsigned int& getModifiedTag(unsigned int contextID) const +
+[more]inline void setTextureSize(int width, int height, int depth) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width, int& height, int& depth) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]void copyTexSubImage3D(State& state, int xoffset, int yoffset, int zoffset, int x, int y, int width, int height) +
Copy a two-dimensional texture subimage. +
+[more]virtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture +
+[more]static Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +
+[more]static void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +

+ +

+

Public Members

+class SG_EXPORT SubloadCallback: public Referenced +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]mutable GLsizei _textureDepth +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +
+[more]mutable ImageModifiedTag _modifiedTag +

+ +

+

Protected Methods

+[more]virtual ~Texture3D() +
+[more]virtual void computeInternalFormat() const +
+[more]void applyTexImage3D(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight, GLsizei& indepth, GLsizei& numMimpmapLevels) const +

+ +

+

Protected Members

+[more]typedef buffered_value<unsigned int> ImageModifiedTag +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(WrapParameter which, WrapMode wrap) +
+oWrapMode getWrap(WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& getBorderColor() const +
+ovoid setFilter(FilterParameter which, FilterMode filter) +
+oFilterMode getFilter(FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
+oinline bool getUseHardwareMipMapGeneration() const +
+oinline void setUnRefImageDataAfterApply(bool flag) +
+oinline bool getUnRefImageDataAfterApply() const +
+oinline void setInternalFormatMode(InternalFormatMode mode) +
+oinline InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(GLint internalFormat) +
+oinline GLint getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(unsigned int contextID) const +
+oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
+ovoid dirtyTextureObject() +
+ovoid dirtyTextureParameters() +
+ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(unsigned int contextID) +
+ovirtual void compile(State& state) const +
+ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +

+ +

+

Protected Fields

+omutable TextureNameList _handleList +
+omutable TexParameterDirtyList _texParametersDirtyList +
+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+obool _useHardwareMipMapGeneration +
+obool _unrefImageDataAfterApply +
+oVec4 _borderColor +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(const osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef buffered_value<GLuint> TextureNameList +
+otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGl 3D texture functionality
+
+ + + +
o Texture3D() +

+ + +

o Texture3D(const Texture3D& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Texture3D, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline unsigned int& getModifiedTag(unsigned int contextID) const +

+ + +

oinline void setTextureSize(int width, int height, int depth) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width, int& height, int& depth) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovoid copyTexSubImage3D(State& state, int xoffset, int yoffset, int zoffset, int x, int y, int width, int height) +
Copy a two-dimensional texture subimage. As per glCopyTexSubImage2D. +Updates portion of an existing OpenGL texture object from the current OpenGL background +framebuffer contents at pos \a x, \a y with width \a width and +height \a height. +

+ + +

ovirtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped +texture and bind it, subsequent apply will simple bind to texture +

+ + +

ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +If the Exentsion object for that context has not yet been created then +and the 'createIfNotInitalized' flag been set to false then returns NULL. +If 'createIfNotInitalized' is true then the Extensions object is +automatically created. However, in this case the extension object +only be created with the graphics context associated with ContextID.. +

+ + +

ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +typically used when you have different extensions supported across graphics pipes +but need to ensure that they all use the same low common denominator extensions. +

+ + +

ovirtual ~Texture3D() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

ovoid applyTexImage3D(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight, GLsizei& indepth, GLsizei& numMimpmapLevels) const +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

omutable GLsizei _textureDepth +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ + +

otypedef buffered_value<unsigned int> ImageModifiedTag +

+ + +

omutable ImageModifiedTag _modifiedTag +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TextureCubeMap.html b/doc/doc++/osg/TextureCubeMap.html new file mode 100644 index 000000000..60952dbcd --- /dev/null +++ b/doc/doc++/osg/TextureCubeMap.html @@ -0,0 +1,511 @@ + + + + + class SG_EXPORT osg::TextureCubeMap + + + + +

class SG_EXPORT osg::TextureCubeMap

TextureCubeMap state class which encapsulates OpenGl texture cubemap functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TextureCubeMap() +
+[more] TextureCubeMap(const TextureCubeMap& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TextureCubeMap, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Face, Image* image) +
Set the texture image for specified face. +
+[more]Image* getImage(Face) +
Get the texture image for specified face. +
+[more]const Image* getImage(Face) const +
Get the const texture image for specified face. +
+[more]inline unsigned int& getModifiedTag(Face face, unsigned int contextID) const +
+[more]inline void setTextureSize(int width, int height) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]void setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, should only be called within an osg::Texuture::apply() and custom OpenGL texture load +
+[more]unsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +
+[more]virtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture +
+[more]static Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +
+[more]static void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +

+ +

+

Public Members

+[more]enum Face +
+class SG_EXPORT SubloadCallback: public Referenced +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+[more]ref_ptr<Image> _images[6] +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]mutable GLsizei _numMimpmapLevels +
+[more]ref_ptr<SubloadCallback> _subloadCallback +
+[more]mutable ImageModifiedTag _modifiedTag[6] +

+ +

+

Protected Methods

+[more]virtual ~TextureCubeMap() +
+[more]bool imagesValid() const +
+[more]virtual void computeInternalFormat() const +

+ +

+

Protected Members

+[more]typedef buffered_value<unsigned int> ImageModifiedTag +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(WrapParameter which, WrapMode wrap) +
+oWrapMode getWrap(WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& getBorderColor() const +
+ovoid setFilter(FilterParameter which, FilterMode filter) +
+oFilterMode getFilter(FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
+oinline bool getUseHardwareMipMapGeneration() const +
+oinline void setUnRefImageDataAfterApply(bool flag) +
+oinline bool getUnRefImageDataAfterApply() const +
+oinline void setInternalFormatMode(InternalFormatMode mode) +
+oinline InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(GLint internalFormat) +
+oinline GLint getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(unsigned int contextID) const +
+oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
+ovoid dirtyTextureObject() +
+ovoid dirtyTextureParameters() +
+ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(unsigned int contextID) +
+ovirtual void compile(State& state) const +
+ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +

+ +

+

Protected Fields

+omutable TextureNameList _handleList +
+omutable TexParameterDirtyList _texParametersDirtyList +
+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+obool _useHardwareMipMapGeneration +
+obool _unrefImageDataAfterApply +
+oVec4 _borderColor +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(const osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef buffered_value<GLuint> TextureNameList +
+otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
TextureCubeMap state class which encapsulates OpenGl texture cubemap functionality
+
+ + + +
o TextureCubeMap() +

+ + +

o TextureCubeMap(const TextureCubeMap& cm, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TextureCubeMap, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oenum Face +

+ + + +
o POSITIVE_X +

+ + +

o NEGATIVE_X +

+ + +

o POSITIVE_Y +

+ + +

o NEGATIVE_Y +

+ + +

o POSITIVE_Z +

+ + +

o NEGATIVE_Z +

+ + + +
ovoid setImage(Face, Image* image) +
Set the texture image for specified face. +

+ + +

oImage* getImage(Face) +
Get the texture image for specified face. +

+ + +

oconst Image* getImage(Face) const +
Get the const texture image for specified face. +

+ + +

oinline unsigned int& getModifiedTag(Face face, unsigned int contextID) const +

+ + +

oinline void setTextureSize(int width, int height) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovoid setNumMipmapLevels(unsigned int num) const +
Set the number of mip map levels the the texture has been created with, +should only be called within an osg::Texuture::apply() and custom OpenGL texture load +

+ + +

ounsigned int getNumMipmapLevels() const +
Get the number of mip map levels the the texture has been created with +

+ + +

ovirtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped +texture and bind it, subsequent apply will simple bind to texture +

+ + +

ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +If the Exentsion object for that context has not yet been created then +and the 'createIfNotInitalized' flag been set to false then returns NULL. +If 'createIfNotInitalized' is true then the Extensions object is +automatically created. However, in this case the extension object +only be created with the graphics context associated with ContextID.. +

+ + +

ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +typically used when you have different extensions supported across graphics pipes +but need to ensure that they all use the same low common denominator extensions. +

+ + +

ovirtual ~TextureCubeMap() +

+ + +

obool imagesValid() const +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

oref_ptr<Image> _images[6] +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

omutable GLsizei _numMimpmapLevels +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ + +

otypedef buffered_value<unsigned int> ImageModifiedTag +

+ + +

omutable ImageModifiedTag _modifiedTag[6] +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TextureRectangle.html b/doc/doc++/osg/TextureRectangle.html new file mode 100644 index 000000000..340980e06 --- /dev/null +++ b/doc/doc++/osg/TextureRectangle.html @@ -0,0 +1,437 @@ + + + + + class SG_EXPORT osg::TextureRectangle + + + + +

class SG_EXPORT osg::TextureRectangle

Texture state class which encapsulates OpenGL texture functionality
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TextureRectangle() +
+[more] TextureRectangle(const TextureRectangle& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, TextureRectangle, TEXTURE) +
+[more]virtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]void setImage(Image* image) +
Set the texture image. +
+[more]Image* getImage() +
Get the texture image. +
+[more]inline const Image* getImage() const +
Get the const texture image. +
+[more]inline unsigned int& getModifiedTag(unsigned int contextID) const +
+[more]inline void setTextureSize(int width, int height) const +
Set the texture width and height. +
+[more]inline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +
+[more]void setSubloadCallback(SubloadCallback* cb) +
+[more]SubloadCallback* getSubloadCallback() +
+[more]const SubloadCallback* getSubloadCallback() const +
+[more]virtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped texture and bind it, subsequent apply will simple bind to texture +

+ +

+

Public Members

+class SubloadCallback: public Referenced +

+ +

+

Protected Fields

+[more]mutable ref_ptr<Image> _image +
+[more]mutable GLsizei _textureWidth +
+[more]mutable GLsizei _textureHeight +
+[more]ref_ptr<SubloadCallback> _subloadCallback +
+[more]mutable ImageModifiedTag _modifiedTag +

+ +

+

Protected Methods

+[more]virtual ~TextureRectangle() +
+[more]virtual void computeInternalFormat() const +
+[more]void applyTexImageRectangle(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight) const +

+ +

+

Protected Members

+[more]typedef buffered_value<unsigned int> ImageModifiedTag +

+ +
+

Inherited from Texture:

+
+

+

Public Methods

+ovirtual osg::Object* cloneType() const +
+ovirtual osg::Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+ovoid setWrap(WrapParameter which, WrapMode wrap) +
+oWrapMode getWrap(WrapParameter which) const +
+ovoid setBorderColor(const Vec4& color) +
+oconst Vec4& getBorderColor() const +
+ovoid setFilter(FilterParameter which, FilterMode filter) +
+oFilterMode getFilter(FilterParameter which) const +
+ovoid setMaxAnisotropy(float anis) +
+oinline float getMaxAnisotropy() const +
+oinline void setUseHardwareMipMapGeneration(bool useHardwareMipMapGeneration) +
+oinline bool getUseHardwareMipMapGeneration() const +
+oinline void setUnRefImageDataAfterApply(bool flag) +
+oinline bool getUnRefImageDataAfterApply() const +
+oinline void setInternalFormatMode(InternalFormatMode mode) +
+oinline InternalFormatMode getInternalFormatMode() const +
+oinline void setInternalFormat(GLint internalFormat) +
+oinline GLint getInternalFormat() const +
+obool isCompressedInternalFormat() const +
+oinline GLuint& getTextureObject(unsigned int contextID) const +
+oinline unsigned int& getTextureParameterDirty(unsigned int contextID) const +
+ovoid dirtyTextureObject() +
+ovoid dirtyTextureParameters() +
+ostatic void deleteTextureObject(unsigned int contextID, GLuint handle) +
+ostatic void flushDeletedTextureObjects(unsigned int contextID) +
+ovirtual void compile(State& state) const +
+ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
+ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
+ovoid applyTexImage2D_load(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +
+ovoid applyTexImage2D_subload(GLenum target, const Image* image, State& state, GLsizei& width, GLsizei& height, GLsizei& numMimpmapLevels) const +

+ +

+

Public Members

+oenum WrapParameter +
+oenum WrapMode +
+oenum FilterParameter +
+oenum FilterMode +
+oenum InternalFormatMode +
+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+omutable TextureNameList _handleList +
+omutable TexParameterDirtyList _texParametersDirtyList +
+oWrapMode _wrap_s +
+oWrapMode _wrap_t +
+oWrapMode _wrap_r +
+oFilterMode _min_filter +
+oFilterMode _mag_filter +
+ofloat _maxAnisotropy +
+obool _useHardwareMipMapGeneration +
+obool _unrefImageDataAfterApply +
+oVec4 _borderColor +
+oInternalFormatMode _internalFormatMode +
+omutable GLint _internalFormat +

+ +

+

Protected Methods

+ovoid computeInternalFormatWithImage(const osg::Image& image) const +
+obool isCompressedInternalFormat(GLint internalFormat) const +
+ovoid applyTexParameters(GLenum target, State& state) const +
+oint compareTexture(const Texture& rhs) const +

+ +

+

Protected Members

+otypedef buffered_value<GLuint> TextureNameList +
+otypedef buffered_value<unsigned int> TexParameterDirtyList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Texture state class which encapsulates OpenGL texture functionality
+
+ + + +
o TextureRectangle() +

+ + +

o TextureRectangle(const TextureRectangle& text, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, TextureRectangle, TEXTURE) +

+ + +

ovirtual int compare(const StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

ovoid setImage(Image* image) +
Set the texture image. +

+ + +

oImage* getImage() +
Get the texture image. +

+ + +

oinline const Image* getImage() const +
Get the const texture image. +

+ + +

oinline unsigned int& getModifiedTag(unsigned int contextID) const +

+ + +

oinline void setTextureSize(int width, int height) const +
Set the texture width and height. If width or height are zero then +the repsective size value is calculated from the source image sizes. +

+ + +

oinline void getTextureSize(int& width, int& height) const +
Get the texture subload width. +

+ + +

ovoid setSubloadCallback(SubloadCallback* cb) +

+ + +

oSubloadCallback* getSubloadCallback() +

+ + +

oconst SubloadCallback* getSubloadCallback() const +

+ + +

ovirtual void apply(State& state) const +
On first apply (unless already compiled), create the minmapped +texture and bind it, subsequent apply will simple bind to texture +

+ + +

ovirtual ~TextureRectangle() +

+ + +

ovirtual void computeInternalFormat() const +

+ + +

ovoid applyTexImageRectangle(GLenum target, Image* image, State& state, GLsizei& inwidth, GLsizei& inheight) const +

+ + +

omutable ref_ptr<Image> _image +

+ + +

omutable GLsizei _textureWidth +

+ + +

omutable GLsizei _textureHeight +

+ + +

oref_ptr<SubloadCallback> _subloadCallback +

+ + +

otypedef buffered_value<unsigned int> ImageModifiedTag +

+ + +

omutable ImageModifiedTag _modifiedTag +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Timer.html b/doc/doc++/osg/Timer.html new file mode 100644 index 000000000..377fa9766 --- /dev/null +++ b/doc/doc++/osg/Timer.html @@ -0,0 +1,80 @@ + + + + + class SG_EXPORT osg::Timer + + + + +

class SG_EXPORT osg::Timer

A high resolution, low latency time stamper
+
+ +
+

+

Public Methods

+[more] Timer() +
+[more] ~Timer() +
+[more]inline double delta_s( Timer_t t1, Timer_t t2 ) const +
+[more]inline double delta_m( Timer_t t1, Timer_t t2 ) const +
+[more]inline double delta_u( Timer_t t1, Timer_t t2 ) const +
+[more]inline double delta_n( Timer_t t1, Timer_t t2 ) const +
+[more]inline Timer_t tick() const +
+[more]inline Timer_t tick( void ) const +

+ +
+ + +
+

Documentation

+
A high resolution, low latency time stamper
+
+ + + +
o Timer() +

+ + +

o ~Timer() +

+ + +

oinline double delta_s( Timer_t t1, Timer_t t2 ) const +

+ + +

oinline double delta_m( Timer_t t1, Timer_t t2 ) const +

+ + +

oinline double delta_u( Timer_t t1, Timer_t t2 ) const +

+ + +

oinline double delta_n( Timer_t t1, Timer_t t2 ) const +

+ + +

oinline Timer_t tick() const +

+ + +

oinline Timer_t tick( void ) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TraceStream.html b/doc/doc++/osg/TraceStream.html new file mode 100644 index 000000000..06b2fb977 --- /dev/null +++ b/doc/doc++/osg/TraceStream.html @@ -0,0 +1,60 @@ + + + + + class SG_EXPORT osgUtx::TestContext::TraceStream + + + + +

class SG_EXPORT TraceStream

+ +
+

+

Public Methods

+[more] TraceStream(std::ostream& o=std::cout, TraceLevel tl=Results) +
+[more] ~TraceStream() +
+[more]void setTraceLevel(TraceLevel tl) +
+[more]TraceLevel getTraceLevel() const +
+[more]std::ostream& stream(TraceLevel tl) +

+ +
+ + +
+

Documentation

+
+ + + +
o TraceStream(std::ostream& o=std::cout, TraceLevel tl=Results) +

+ + +

o ~TraceStream() +

+ + +

ovoid setTraceLevel(TraceLevel tl) +

+ + +

oTraceLevel getTraceLevel() const +

+ + +

ostd::ostream& stream(TraceLevel tl) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Transform.html b/doc/doc++/osg/Transform.html new file mode 100644 index 000000000..7d9efe790 --- /dev/null +++ b/doc/doc++/osg/Transform.html @@ -0,0 +1,538 @@ + + + + + class SG_EXPORT osg::Transform + + + + +

class SG_EXPORT osg::Transform

A Transform is a group node for which all children are transformed by a 4x4 matrix.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Transform() +
+[more] Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osg, Transform) +
+[more]virtual Transform* asTransform() +
+[more]virtual const Transform* asTransform() const +
+[more]virtual MatrixTransform* asMatrixTransform() +
+[more]virtual const MatrixTransform* asMatrixTransform() const +
+[more]virtual PositionAttitudeTransform* asPositionAttitudeTransform() +
+[more]virtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +
+[more]virtual DOFTransform* asDOFTransform() +
+[more]virtual const DOFTransform* asDOFTransform() const +
+[more]void setReferenceFrame(ReferenceFrame rf) +
Set the transform's ReferenceFrame, either to be relative to its parent reference frame, or relative to an absolute coordinate frame. +
+[more]ReferenceFrame getReferenceFrame() const +
+[more]void setComputeTransformCallback(ComputeTransformCallback* ctc) +
Set the ComputerTransfromCallback which allows users to attach custom computation of the local transformation as seen by cull traversers and the like. +
+[more]ComputeTransformCallback* getComputeTransformCallback() +
Get the non const ComputerTransfromCallback +
+[more]const ComputeTransformCallback* getComputeTransformCallback() const +
Get the const ComputerTransfromCallback +
+[more]inline bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
Get the transformation matrix which moves from local coords to world coords. +
+[more]inline bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +
Get the transformation matrix which moves from world coords to local coords. +
+[more]virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const +
+[more]virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const +

+ +

+

Public Members

+[more]enum ReferenceFrame +
+[more]struct ComputeTransformCallback: public virtual osg::Referenced +
Callback attached to an Transform to specify how to compute the modelview transformation for the transform below the Transform node. +

+ +

+

Protected Fields

+[more]ref_ptr<ComputeTransformCallback> _computeTransformCallback +
+[more]ReferenceFrame _referenceFrame +

+ +

+

Protected Methods

+[more]virtual ~Transform() +
+[more]virtual bool computeBound() const +
Overrides Group's computeBound. +

+ +
+

Inherited from Group:

+
+

+

Public Methods

+ovirtual Group* asGroup() +
+ovirtual const Group* asGroup() const +
+ovirtual void traverse(NodeVisitor& nv) +
+ovirtual bool addChild( Node* child ) +
+ovirtual bool removeChild( Node* child ) +
+ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1) +
+ovirtual bool replaceChild( Node* origChild, Node* newChild ) +
+oinline unsigned int getNumChildren() const +
+ovirtual bool setChild( unsigned int i, Node* node ) +
+oinline Node* getChild( unsigned int i ) +
+oinline const Node* getChild( unsigned int i ) const +
+oinline bool containsNode( const Node* node ) const +
+oinline unsigned int getChildIndex( const Node* node ) const +

+ +

+

Public Members

+otypedef std::vector<ref_ptr<Node> > ChildList +

+ +

+

Protected Fields

+oChildList _children +

+ +
+

Inherited from Node:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp& copyop) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(NodeVisitor& nv) +
+ovirtual void ascend(NodeVisitor& nv) +
+oinline void setName( const std::string& name ) +
+oinline void setName( const char* name ) +
+oinline const std::string& getName() const +
+oinline const ParentList& getParents() const +
+oinline ParentList getParents() +
+oinline Group* getParent(unsigned int i) +
+oinline const Group* getParent(unsigned int i) const +
+oinline unsigned int getNumParents() const +
+ovoid setUpdateCallback(NodeCallback* nc) +
+oinline NodeCallback* getUpdateCallback() +
+oinline const NodeCallback* getUpdateCallback() const +
+ovoid setAppCallback(NodeCallback* nc) +
+oinline NodeCallback* getAppCallback() +
+oinline const NodeCallback* getAppCallback() const +
+oinline unsigned int getNumChildrenRequiringUpdateTraversal() const +
+ovoid setCullCallback(NodeCallback* nc) +
+oinline NodeCallback* getCullCallback() +
+oinline const NodeCallback* getCullCallback() const +
+ovoid setCullingActive(bool active) +
+oinline bool getCullingActive() const +
+oinline unsigned int getNumChildrenWithCullingDisabled() const +
+oinline bool isCullingActive() const +
+oinline unsigned int getNumChildrenWithOccluderNodes() const +
+obool containsOccluderNodes() const +
+oinline void setNodeMask(NodeMask nm) +
+oinline NodeMask getNodeMask() const +
+oinline const DescriptionList& getDescriptions() const +
+oinline DescriptionList& getDescriptions() +
+oinline const std::string& getDescription(unsigned int i) const +
+oinline std::string& getDescription(unsigned int i) +
+oinline unsigned int getNumDescriptions() const +
+ovoid addDescription(const std::string& desc) +
+oinline void setStateSet(osg::StateSet* dstate) +
+oosg::StateSet* getOrCreateStateSet() +
+oinline osg::StateSet* getStateSet() +
+oinline const osg::StateSet* getStateSet() const +
+oinline const BoundingSphere& getBound() const +
+ovoid dirtyBound() +

+ +

+

Public Members

+otypedef std::vector<Group*> ParentList +
+otypedef unsigned int NodeMask +
+otypedef std::vector<std::string> DescriptionList +

+ +

+

Protected Fields

+omutable BoundingSphere _bsphere +
+omutable bool _bsphere_computed +
+ostd::string _name +
+oParentList _parents +
+oref_ptr<NodeCallback> _updateCallback +
+ounsigned int _numChildrenRequiringUpdateTraversal +
+oref_ptr<NodeCallback> _cullCallback +
+obool _cullingActive +
+ounsigned int _numChildrenWithCullingDisabled +
+ounsigned int _numChildrenWithOccluderNodes +
+oNodeMask _nodeMask +
+oDescriptionList _descriptions +
+oref_ptr<StateSet> _stateset +

+ +

+

Protected Methods

+ovoid addParent(osg::Group* node) +
+ovoid removeParent(osg::Group* node) +
+ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num) +
+ovoid setNumChildrenWithCullingDisabled(unsigned int num) +
+ovoid setNumChildrenWithOccluderNodes(unsigned int num) +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
A Transform is a group node for which all children are transformed by +a 4x4 matrix. It is often used for positioning objects within a scene, +producing trackball functionality or for animation. + +

Transform itself does not provide set/get functions, only the interface +for defining what the 4x4 transformation is. Subclasses, such as +MatrixTransform and PositionAttitudeTransform support the use of an +osg::Matrix or a osg::Vec3/osg::Quat resprectively. +The Transform node can be customized via the ComputeTransfromCallback +which can be attached to the node. This might be used to convert from +internal representations of the transformation into generic osg::Matrix +objects which are used during scene grpah traversal, such as +CullTraversal and IntersectionTraversal. + +

Note: if the transformation matrix scales the subgraph then the normals +of the underlying geometry will need to be renormalized to be unit +vectors once more. This can be done transparently through OpenGL's +use of either GL_NORMALIZE and GL_SCALE_NORMALIZE modes. For further +background reading see the glNormalize documentation in the OpenGL +Reference Guide (the blue book). To enable it in the OSG, you simply +need to attach a local osg::StateSet to the osg::Transform, and set +the appropriate mode to ON via +stateset->setMode(GL_NORMALIZE, osg::StateAttribute::ON);

+
+ + + +
o Transform() +

+ + +

o Transform(const Transform&, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osg, Transform) +

+ + +

ovirtual Transform* asTransform() +

+ + +

ovirtual const Transform* asTransform() const +

+ + +

ovirtual MatrixTransform* asMatrixTransform() +

+ + +

ovirtual const MatrixTransform* asMatrixTransform() const +

+ + +

ovirtual PositionAttitudeTransform* asPositionAttitudeTransform() +

+ + +

ovirtual const PositionAttitudeTransform* asPositionAttitudeTransform() const +

+ + +

ovirtual DOFTransform* asDOFTransform() +

+ + +

ovirtual const DOFTransform* asDOFTransform() const +

+ + +

oenum ReferenceFrame +

+ + + +
o RELATIVE_TO_PARENTS +

+ + +

o RELATIVE_TO_ABSOLUTE +

+ + + +
ovoid setReferenceFrame(ReferenceFrame rf) +
Set the transform's ReferenceFrame, either to be relative to its +parent reference frame, or relative to an absolute coordinate +frame. RELATIVE_TO_PARENTS is the default. +Note: setting the ReferenceFrame to be RELATIVE_TO_ABSOLUTE will +also set the CullingActive flag on the transform, and hence all +of its parents, to false, thereby disabling culling of it and +all its parents. This is neccessary to prevent inappropriate +culling, but may impact cull times if the absolute transform is +deep in the scene graph. It is therefore recommend to only use +absolute Transforms at the top of the scene, for such things as +heads up displays. +

+ + +

oReferenceFrame getReferenceFrame() const +

+ + +

ostruct ComputeTransformCallback: public virtual osg::Referenced +
Callback attached to an Transform to specify how to compute the +modelview transformation for the transform below the Transform +node. +

+ + + +
ovirtual bool computeLocalToWorldMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0 +
Get the transformation matrix which moves from local coords +to world coords +

+ + +

ovirtual bool computeWorldToLocalMatrix(Matrix& matrix, const Transform* transform, NodeVisitor* nv) const = 0 +
Get the transformation matrix which moves from world coords +to local coords +

+ + + +
ovoid setComputeTransformCallback(ComputeTransformCallback* ctc) +
Set the ComputerTransfromCallback which allows users to attach +custom computation of the local transformation as seen by cull +traversers and the like. +

+ + +

oComputeTransformCallback* getComputeTransformCallback() +
Get the non const ComputerTransfromCallback +

+ + +

oconst ComputeTransformCallback* getComputeTransformCallback() const +
Get the const ComputerTransfromCallback +

+ + +

oinline bool getLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const +
Get the transformation matrix which moves from local coords to +world coords. +Returns true if the Matrix passed in has been updated. +

+ + +

oinline bool getWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const +
Get the transformation matrix which moves from world coords to +local coords. +Return true if the Matrix passed in has been updated. +

+ + +

ovirtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor*) const +

+ + +

ovirtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor*) const +

+ + +

ovirtual ~Transform() +

+ + +

ovirtual bool computeBound() const +
Overrides Group's computeBound. +There is no need to override in subclasses from osg::Transform +since this computeBound() uses the underlying matrix (calling +computeMatrix if required.) +

+ + +

oref_ptr<ComputeTransformCallback> _computeTransformCallback +

+ + +

oReferenceFrame _referenceFrame +

+
+
Direct child classes: +
PositionAttitudeTransform
+MatrixTransform
+DOFTransform
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TriangleFunctor.html b/doc/doc++/osg/TriangleFunctor.html new file mode 100644 index 000000000..7eb6a9166 --- /dev/null +++ b/doc/doc++/osg/TriangleFunctor.html @@ -0,0 +1,138 @@ + + + + + template<class T> class osg::TriangleFunctor + + + + +

template<class T> class osg::TriangleFunctor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TriangleFunctor() +
+[more]virtual ~TriangleFunctor() +
+[more]virtual void setVertexArray(unsigned int count, const Vec3* vertices) +
+[more]virtual void drawArrays(GLenum mode, GLint first, GLsizei count) +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLubyte* indices) +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLushort* indices) +
+[more]virtual void drawElements(GLenum mode, GLsizei count, const GLuint* indices) +
+[more]inline void begin(GLenum mode) +
begin(),vertex() & end() are convinience methods for adapting non vertex array primitives to vertex array based primitives. +
+[more]inline void vertex(const Vec3& vert) +
+[more]inline void vertex(float x, float y, float z) +
+[more]inline void end() +

+ +

+

Protected Fields

+[more]unsigned int _vertexArraySize +
+[more]const Vec3* _vertexArrayPtr +
+[more]GLenum _modeCache +
+[more]std::vector<Vec3> _vertexCache +

+ +
+ + +
+

Documentation

+
+ + + +
o TriangleFunctor() +

+ + +

ovirtual ~TriangleFunctor() +

+ + +

ovirtual void setVertexArray(unsigned int count, const Vec3* vertices) +

+ + +

ovirtual void drawArrays(GLenum mode, GLint first, GLsizei count) +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLubyte* indices) +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLushort* indices) +

+ + +

ovirtual void drawElements(GLenum mode, GLsizei count, const GLuint* indices) +

+ + +

oinline void begin(GLenum mode) +
begin(),vertex() & end() are convinience methods for adapting +non vertex array primitives to vertex array based primitives. +this is done to simplify the implementation of primtive functor +subclasses - users only need override drawArray and drawElements. +

+ + +

oinline void vertex(const Vec3& vert) +

+ + +

oinline void vertex(float x, float y, float z) +

+ + +

oinline void end() +

+ + +

ounsigned int _vertexArraySize +

+ + +

oconst Vec3* _vertexArrayPtr +

+ + +

oGLenum _modeCache +

+ + +

ostd::vector<Vec3> _vertexCache +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/TriangleMesh.html b/doc/doc++/osg/TriangleMesh.html new file mode 100644 index 000000000..1f1d15d28 --- /dev/null +++ b/doc/doc++/osg/TriangleMesh.html @@ -0,0 +1,187 @@ + + + + + class osg::TriangleMesh + + + + +

class osg::TriangleMesh

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TriangleMesh() +
+[more] TriangleMesh(const TriangleMesh& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
+[more]META_Shape (osg, TriangleMesh)(Vec3Array* vertices) +
+[more]Vec3Array* getVertices() +
+[more]const Vec3Array* getVertices() const +
+[more]void setIndices(IndexArray* indices) +
+[more]IndexArray* getIndices() +
+[more]const IndexArray* getIndices() const +

+ +

+

Protected Fields

+[more]ref_ptr<Vec3Array> _vertices +
+[more]ref_ptr<IndexArray> _indices +

+ +

+

Protected Methods

+[more] ~TriangleMesh() +

+ +
+

Inherited from Shape:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual void accept(ShapeVisitor&) +
+ovirtual void accept(ConstShapeVisitor&) const +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
+ + + +
o TriangleMesh() +

+ + +

o TriangleMesh(const TriangleMesh& mesh, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +

+ + +

oMETA_Shape (osg, TriangleMesh)(Vec3Array* vertices) +

+ + +

oVec3Array* getVertices() +

+ + +

oconst Vec3Array* getVertices() const +

+ + +

ovoid setIndices(IndexArray* indices) +

+ + +

oIndexArray* getIndices() +

+ + +

oconst IndexArray* getIndices() const +

+ + +

o ~TriangleMesh() +

+ + +

oref_ptr<Vec3Array> _vertices +

+ + +

oref_ptr<IndexArray> _indices +

+
+
Direct child classes: +
ConvexHull
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/UByte4.html b/doc/doc++/osg/UByte4.html new file mode 100644 index 000000000..05fcbabb1 --- /dev/null +++ b/doc/doc++/osg/UByte4.html @@ -0,0 +1,218 @@ + + + + + class osg::UByte4 + + + + +

class osg::UByte4

General purpose float quad, uses include representation of colour coordinates.
+
+ +
+

+

Public Fields

+[more]unsigned char _v[4] +

+ +

+

Public Methods

+[more] UByte4() +
+[more] UByte4(unsigned char r, unsigned char g, unsigned char b, unsigned char a) +
+[more]inline bool operator == (const UByte4& v) const +
+[more]inline bool operator != (const UByte4& v) const +
+[more]inline bool operator < (const UByte4& v) const +
+[more]inline unsigned char* ptr() +
+[more]inline const unsigned char* ptr() const +
+[more]inline void set(unsigned char r, unsigned char g, unsigned char b, unsigned char a) +
+[more]inline unsigned char& operator [] (unsigned int i) +
+[more]inline unsigned char operator [] (unsigned int i) const +
+[more]inline unsigned char& r() +
+[more]inline unsigned char& g() +
+[more]inline unsigned char& b() +
+[more]inline unsigned char& a() +
+[more]inline unsigned char r() const +
+[more]inline unsigned char g() const +
+[more]inline unsigned char b() const +
+[more]inline unsigned char a() const +
+[more]inline UByte4 operator * (float rhs) const +
multiply by scalar +
+[more]inline UByte4& operator *= (float rhs) +
unary multiply by scalar +
+[more]inline UByte4 operator / (float rhs) const +
divide by scalar +
+[more]inline UByte4& operator /= (float rhs) +
unary divide by scalar +
+[more]inline UByte4 operator + (const UByte4& rhs) const +
binary vector add +
+[more]inline UByte4& operator += (const UByte4& rhs) +
unary vector add. +
+[more]inline UByte4 operator - (const UByte4& rhs) const +
binary vector subtract +
+[more]inline UByte4& operator -= (const UByte4& rhs) +
unary vector subtract +

+ +
+ + +
+

Documentation

+
General purpose float quad, uses include representation +of colour coordinates. +No support yet added for float * UByte4 - is it necessary? +Need to define a non-member non-friend operator* etc. +UByte4 * float is okay
+
+ + + +
o UByte4() +

+ + +

o UByte4(unsigned char r, unsigned char g, unsigned char b, unsigned char a) +

+ + +

ounsigned char _v[4] +

+ + +

oinline bool operator == (const UByte4& v) const +

+ + +

oinline bool operator != (const UByte4& v) const +

+ + +

oinline bool operator < (const UByte4& v) const +

+ + +

oinline unsigned char* ptr() +

+ + +

oinline const unsigned char* ptr() const +

+ + +

oinline void set(unsigned char r, unsigned char g, unsigned char b, unsigned char a) +

+ + +

oinline unsigned char& operator [] (unsigned int i) +

+ + +

oinline unsigned char operator [] (unsigned int i) const +

+ + +

oinline unsigned char& r() +

+ + +

oinline unsigned char& g() +

+ + +

oinline unsigned char& b() +

+ + +

oinline unsigned char& a() +

+ + +

oinline unsigned char r() const +

+ + +

oinline unsigned char g() const +

+ + +

oinline unsigned char b() const +

+ + +

oinline unsigned char a() const +

+ + +

oinline UByte4 operator * (float rhs) const +
multiply by scalar +

+ + +

oinline UByte4& operator *= (float rhs) +
unary multiply by scalar +

+ + +

oinline UByte4 operator / (float rhs) const +
divide by scalar +

+ + +

oinline UByte4& operator /= (float rhs) +
unary divide by scalar +

+ + +

oinline UByte4 operator + (const UByte4& rhs) const +
binary vector add +

+ + +

oinline UByte4& operator += (const UByte4& rhs) +
unary vector add. Slightly more efficient because no temporary +intermediate object +

+ + +

oinline UByte4 operator - (const UByte4& rhs) const +
binary vector subtract +

+ + +

oinline UByte4& operator -= (const UByte4& rhs) +
unary vector subtract +

+ +
This class has no child classes.
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const UByte4& vec)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ValueVisitor.html b/doc/doc++/osg/ValueVisitor.html new file mode 100644 index 000000000..4d7d2e27d --- /dev/null +++ b/doc/doc++/osg/ValueVisitor.html @@ -0,0 +1,102 @@ + + + + + class osg::ValueVisitor + + + + +

class osg::ValueVisitor

+ +
+

+

Public Methods

+[more] ValueVisitor() +
+[more]virtual void apply(GLbyte&) +
+[more]virtual void apply(GLshort&) +
+[more]virtual void apply(GLint&) +
+[more]virtual void apply(GLushort&) +
+[more]virtual void apply(GLubyte&) +
+[more]virtual void apply(GLuint&) +
+[more]virtual void apply(GLfloat&) +
+[more]virtual void apply(UByte4&) +
+[more]virtual void apply(Vec2&) +
+[more]virtual void apply(Vec3&) +
+[more]virtual void apply(Vec4&) +

+ +
+ + +
+

Documentation

+
+ + + +
o ValueVisitor() +

+ + +

ovirtual void apply(GLbyte&) +

+ + +

ovirtual void apply(GLshort&) +

+ + +

ovirtual void apply(GLint&) +

+ + +

ovirtual void apply(GLushort&) +

+ + +

ovirtual void apply(GLubyte&) +

+ + +

ovirtual void apply(GLuint&) +

+ + +

ovirtual void apply(GLfloat&) +

+ + +

ovirtual void apply(UByte4&) +

+ + +

ovirtual void apply(Vec2&) +

+ + +

ovirtual void apply(Vec3&) +

+ + +

ovirtual void apply(Vec4&) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Vec2.html b/doc/doc++/osg/Vec2.html new file mode 100644 index 000000000..8cc53ef2e --- /dev/null +++ b/doc/doc++/osg/Vec2.html @@ -0,0 +1,247 @@ + + + + + class osg::Vec2 + + + + +

class osg::Vec2

General purpose float pair, uses include representation of texture coordinates.
+
+ +
+

+

Public Fields

+[more]float _v[2] +

+ +

+

Public Methods

+[more] Vec2() +
+[more] Vec2(float x, float y) +
+[more]inline bool operator == (const Vec2& v) const +
+[more]inline bool operator != (const Vec2& v) const +
+[more]inline bool operator < (const Vec2& v) const +
+[more]inline float* ptr() +
+[more]inline const float* ptr() const +
+[more]inline void set( float x, float y ) +
+[more]inline float& operator [] (int i) +
+[more]inline float operator [] (int i) const +
+[more]inline float& x() +
+[more]inline float& y() +
+[more]inline float x() const +
+[more]inline float y() const +
+[more]inline bool valid() const +
+[more]inline bool isNaN() const +
+[more]inline float operator * (const Vec2& rhs) const +
dot product +
+[more]inline const Vec2 operator * (float rhs) const +
multiply by scalar +
+[more]inline Vec2& operator *= (float rhs) +
unary multiply by scalar +
+[more]inline const Vec2 operator / (float rhs) const +
divide by scalar +
+[more]inline Vec2& operator /= (float rhs) +
unary divide by scalar +
+[more]inline const Vec2 operator + (const Vec2& rhs) const +
binary vector add +
+[more]inline Vec2& operator += (const Vec2& rhs) +
unary vector add. +
+[more]inline const Vec2 operator - (const Vec2& rhs) const +
binary vector subtract +
+[more]inline Vec2& operator -= (const Vec2& rhs) +
unary vector subtract +
+[more]inline const Vec2 operator - () const +
negation operator. +
+[more]inline float length() const +
Length of the vector = sqrt( vec . +
+[more]inline float length2( void ) const +
Length squared of the vector = vec . +
+[more]inline float normalize() +
normalize the vector so that it has length unity returns the previous length of the vector +

+ +
+ + +
+

Documentation

+
General purpose float pair, uses include representation of +texture coordinates. +No support yet added for float * Vec2 - is it necessary? +Need to define a non-member non-friend operator* etc. +BTW: Vec2 * float is okay
+
+ + + +
o Vec2() +

+ + +

o Vec2(float x, float y) +

+ + +

ofloat _v[2] +

+ + +

oinline bool operator == (const Vec2& v) const +

+ + +

oinline bool operator != (const Vec2& v) const +

+ + +

oinline bool operator < (const Vec2& v) const +

+ + +

oinline float* ptr() +

+ + +

oinline const float* ptr() const +

+ + +

oinline void set( float x, float y ) +

+ + +

oinline float& operator [] (int i) +

+ + +

oinline float operator [] (int i) const +

+ + +

oinline float& x() +

+ + +

oinline float& y() +

+ + +

oinline float x() const +

+ + +

oinline float y() const +

+ + +

oinline bool valid() const +

+ + +

oinline bool isNaN() const +

+ + +

oinline float operator * (const Vec2& rhs) const +
dot product +

+ + +

oinline const Vec2 operator * (float rhs) const +
multiply by scalar +

+ + +

oinline Vec2& operator *= (float rhs) +
unary multiply by scalar +

+ + +

oinline const Vec2 operator / (float rhs) const +
divide by scalar +

+ + +

oinline Vec2& operator /= (float rhs) +
unary divide by scalar +

+ + +

oinline const Vec2 operator + (const Vec2& rhs) const +
binary vector add +

+ + +

oinline Vec2& operator += (const Vec2& rhs) +
unary vector add. Slightly more efficient because no temporary +intermediate object. +

+ + +

oinline const Vec2 operator - (const Vec2& rhs) const +
binary vector subtract +

+ + +

oinline Vec2& operator -= (const Vec2& rhs) +
unary vector subtract +

+ + +

oinline const Vec2 operator - () const +
negation operator. Returns the negative of the Vec2 +

+ + +

oinline float length() const +
Length of the vector = sqrt( vec . vec ) +

+ + +

oinline float length2( void ) const +
Length squared of the vector = vec . vec +

+ + +

oinline float normalize() +
normalize the vector so that it has length unity +returns the previous length of the vector +

+ +
This class has no child classes.
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const Vec2& vec)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Vec3.html b/doc/doc++/osg/Vec3.html new file mode 100644 index 000000000..be10fcc7d --- /dev/null +++ b/doc/doc++/osg/Vec3.html @@ -0,0 +1,267 @@ + + + + + class osg::Vec3 + + + + +

class osg::Vec3

General purpose float triple for use as vertices, vectors and normals.
+
+ +
+

+

Public Fields

+[more]float _v[3] +

+ +

+

Public Methods

+[more] Vec3() +
+[more] Vec3(float x, float y, float z) +
+[more]inline bool operator == (const Vec3& v) const +
+[more]inline bool operator != (const Vec3& v) const +
+[more]inline bool operator < (const Vec3& v) const +
+[more]inline float* ptr() +
+[more]inline const float* ptr() const +
+[more]inline void set( float x, float y, float z) +
+[more]inline float& operator [] (int i) +
+[more]inline float operator [] (int i) const +
+[more]inline float& x() +
+[more]inline float& y() +
+[more]inline float& z() +
+[more]inline float x() const +
+[more]inline float y() const +
+[more]inline float z() const +
+[more]inline bool valid() const +
+[more]inline bool isNaN() const +
+[more]inline float operator * (const Vec3& rhs) const +
dot product +
+[more]inline const Vec3 operator ^ (const Vec3& rhs) const +
cross product +
+[more]inline const Vec3 operator * (float rhs) const +
multiply by scalar +
+[more]inline Vec3& operator *= (float rhs) +
unary multiply by scalar +
+[more]inline const Vec3 operator / (float rhs) const +
divide by scalar +
+[more]inline Vec3& operator /= (float rhs) +
unary divide by scalar +
+[more]inline const Vec3 operator + (const Vec3& rhs) const +
binary vector add +
+[more]inline Vec3& operator += (const Vec3& rhs) +
unary vector add. +
+[more]inline const Vec3 operator - (const Vec3& rhs) const +
binary vector subtract +
+[more]inline Vec3& operator -= (const Vec3& rhs) +
unary vector subtract +
+[more]inline const Vec3 operator - () const +
negation operator. +
+[more]inline float length() const +
Length of the vector = sqrt( vec . +
+[more]inline float length2() const +
Length squared of the vector = vec . +
+[more]inline float normalize() +
normalize the vector so that it has length unity returns the previous length of the vector +

+ +
+ + +
+

Documentation

+
General purpose float triple for use as vertices, vectors and normals. +Provides general maths operations from addition through to cross products. +No support yet added for float * Vec3 - is it necessary? +Need to define a non-member non-friend operator* etc. +Vec3 * float is okay
+
+ + + +
o Vec3() +

+ + +

o Vec3(float x, float y, float z) +

+ + +

ofloat _v[3] +

+ + +

oinline bool operator == (const Vec3& v) const +

+ + +

oinline bool operator != (const Vec3& v) const +

+ + +

oinline bool operator < (const Vec3& v) const +

+ + +

oinline float* ptr() +

+ + +

oinline const float* ptr() const +

+ + +

oinline void set( float x, float y, float z) +

+ + +

oinline float& operator [] (int i) +

+ + +

oinline float operator [] (int i) const +

+ + +

oinline float& x() +

+ + +

oinline float& y() +

+ + +

oinline float& z() +

+ + +

oinline float x() const +

+ + +

oinline float y() const +

+ + +

oinline float z() const +

+ + +

oinline bool valid() const +

+ + +

oinline bool isNaN() const +

+ + +

oinline float operator * (const Vec3& rhs) const +
dot product +

+ + +

oinline const Vec3 operator ^ (const Vec3& rhs) const +
cross product +

+ + +

oinline const Vec3 operator * (float rhs) const +
multiply by scalar +

+ + +

oinline Vec3& operator *= (float rhs) +
unary multiply by scalar +

+ + +

oinline const Vec3 operator / (float rhs) const +
divide by scalar +

+ + +

oinline Vec3& operator /= (float rhs) +
unary divide by scalar +

+ + +

oinline const Vec3 operator + (const Vec3& rhs) const +
binary vector add +

+ + +

oinline Vec3& operator += (const Vec3& rhs) +
unary vector add. Slightly more efficient because no temporary +intermediate object +

+ + +

oinline const Vec3 operator - (const Vec3& rhs) const +
binary vector subtract +

+ + +

oinline Vec3& operator -= (const Vec3& rhs) +
unary vector subtract +

+ + +

oinline const Vec3 operator - () const +
negation operator. Returns the negative of the Vec3 +

+ + +

oinline float length() const +
Length of the vector = sqrt( vec . vec ) +

+ + +

oinline float length2() const +
Length squared of the vector = vec . vec +

+ + +

oinline float normalize() +
normalize the vector so that it has length unity +returns the previous length of the vector +

+ +
This class has no child classes.
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const Vec3& vec)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Vec4.html b/doc/doc++/osg/Vec4.html new file mode 100644 index 000000000..061f20925 --- /dev/null +++ b/doc/doc++/osg/Vec4.html @@ -0,0 +1,289 @@ + + + + + class osg::Vec4 + + + + +

class osg::Vec4

General purpose float quad, uses include representation of colour coordinates.
+
+ +
+

+

Public Fields

+[more]float _v[4] +

+ +

+

Public Methods

+[more] Vec4() +
+[more] Vec4(float x, float y, float z, float w) +
+[more] Vec4(const Vec3& v3, float w) +
+[more]inline bool operator == (const Vec4& v) const +
+[more]inline bool operator != (const Vec4& v) const +
+[more]inline bool operator < (const Vec4& v) const +
+[more]inline float* ptr() +
+[more]inline const float* ptr() const +
+[more]inline void set( float x, float y, float z, float w) +
+[more]inline float& operator [] (unsigned int i) +
+[more]inline float operator [] (unsigned int i) const +
+[more]inline float& x() +
+[more]inline float& y() +
+[more]inline float& z() +
+[more]inline float& w() +
+[more]inline float x() const +
+[more]inline float y() const +
+[more]inline float z() const +
+[more]inline float w() const +
+[more]inline unsigned long asABGR() const +
+[more]inline unsigned long asRGBA() const +
+[more]inline bool valid() const +
+[more]inline bool isNaN() const +
+[more]inline float operator * (const Vec4& rhs) const +
dot product +
+[more]inline Vec4 operator * (float rhs) const +
multiply by scalar +
+[more]inline Vec4& operator *= (float rhs) +
unary multiply by scalar +
+[more]inline Vec4 operator / (float rhs) const +
divide by scalar +
+[more]inline Vec4& operator /= (float rhs) +
unary divide by scalar +
+[more]inline Vec4 operator + (const Vec4& rhs) const +
binary vector add +
+[more]inline Vec4& operator += (const Vec4& rhs) +
unary vector add. +
+[more]inline Vec4 operator - (const Vec4& rhs) const +
binary vector subtract +
+[more]inline Vec4& operator -= (const Vec4& rhs) +
unary vector subtract +
+[more]inline const Vec4 operator - () const +
negation operator. +
+[more]inline float length() const +
Length of the vector = sqrt( vec . +
+[more]inline float length2() const +
Length squared of the vector = vec . +
+[more]inline float normalize() +
normalize the vector so that it has length unity returns the previous length of the vector +

+ +
+ + +
+

Documentation

+
General purpose float quad, uses include representation +of colour coordinates. +No support yet added for float * Vec4 - is it necessary? +Need to define a non-member non-friend operator* etc. +Vec4 * float is okay
+
+ + + +
o Vec4() +

+ + +

o Vec4(float x, float y, float z, float w) +

+ + +

o Vec4(const Vec3& v3, float w) +

+ + +

ofloat _v[4] +

+ + +

oinline bool operator == (const Vec4& v) const +

+ + +

oinline bool operator != (const Vec4& v) const +

+ + +

oinline bool operator < (const Vec4& v) const +

+ + +

oinline float* ptr() +

+ + +

oinline const float* ptr() const +

+ + +

oinline void set( float x, float y, float z, float w) +

+ + +

oinline float& operator [] (unsigned int i) +

+ + +

oinline float operator [] (unsigned int i) const +

+ + +

oinline float& x() +

+ + +

oinline float& y() +

+ + +

oinline float& z() +

+ + +

oinline float& w() +

+ + +

oinline float x() const +

+ + +

oinline float y() const +

+ + +

oinline float z() const +

+ + +

oinline float w() const +

+ + +

oinline unsigned long asABGR() const +

+ + +

oinline unsigned long asRGBA() const +

+ + +

oinline bool valid() const +

+ + +

oinline bool isNaN() const +

+ + +

oinline float operator * (const Vec4& rhs) const +
dot product +

+ + +

oinline Vec4 operator * (float rhs) const +
multiply by scalar +

+ + +

oinline Vec4& operator *= (float rhs) +
unary multiply by scalar +

+ + +

oinline Vec4 operator / (float rhs) const +
divide by scalar +

+ + +

oinline Vec4& operator /= (float rhs) +
unary divide by scalar +

+ + +

oinline Vec4 operator + (const Vec4& rhs) const +
binary vector add +

+ + +

oinline Vec4& operator += (const Vec4& rhs) +
unary vector add. Slightly more efficient because no temporary +intermediate object +

+ + +

oinline Vec4 operator - (const Vec4& rhs) const +
binary vector subtract +

+ + +

oinline Vec4& operator -= (const Vec4& rhs) +
unary vector subtract +

+ + +

oinline const Vec4 operator - () const +
negation operator. Returns the negative of the Vec4 +

+ + +

oinline float length() const +
Length of the vector = sqrt( vec . vec ) +

+ + +

oinline float length2() const +
Length squared of the vector = vec . vec +

+ + +

oinline float normalize() +
normalize the vector so that it has length unity +returns the previous length of the vector +

+ +
This class has no child classes.
+ +
Friends:
inline std::ostream& operator << (std::ostream& output, const Vec4& vec)

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorSizei.2.html b/doc/doc++/osg/VectorSizei.2.html new file mode 100644 index 000000000..7a6010bba --- /dev/null +++ b/doc/doc++/osg/VectorSizei.2.html @@ -0,0 +1,31 @@ + + + + + class osg::VectorSizei + + + + +

class osg::VectorSizei

+ +

Inheritance:

+ + + + + + + + + +
+

Documentation

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorSizei.html b/doc/doc++/osg/VectorSizei.html new file mode 100644 index 000000000..acad4b0e1 --- /dev/null +++ b/doc/doc++/osg/VectorSizei.html @@ -0,0 +1,54 @@ + + + + + typedef std::vector<GLsizei> osg::VectorSizei + + + + +

typedef std::vector<GLsizei> osg::VectorSizei

+
+

+ + + +
+otypedef std::vector<value_type> inherited +
+[more] VectorSizei() +
+[more]explicit VectorSizei(size_type n) +
+[more] VectorSizei(const VectorSizei &copy) +
+[more]template<class InputIterator> VectorSizei(InputIterator beg_, InputIterator end_) +

+ + + +
+

Documentation

+
+ + + +
o VectorSizei() +

+ + +

oexplicit VectorSizei(size_type n) +

+ + +

o VectorSizei(const VectorSizei &copy) +

+ + +

otemplate<class InputIterator> VectorSizei(InputIterator beg_, InputIterator end_) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUByte.2.html b/doc/doc++/osg/VectorUByte.2.html new file mode 100644 index 000000000..6ca601f3b --- /dev/null +++ b/doc/doc++/osg/VectorUByte.2.html @@ -0,0 +1,31 @@ + + + + + class osg::VectorUByte + + + + +

class osg::VectorUByte

+ +

Inheritance:

+ + + + + + + + + +
+

Documentation

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUByte.html b/doc/doc++/osg/VectorUByte.html new file mode 100644 index 000000000..67a2684f0 --- /dev/null +++ b/doc/doc++/osg/VectorUByte.html @@ -0,0 +1,54 @@ + + + + + typedef std::vector<GLubyte> osg::VectorUByte + + + + +

typedef std::vector<GLubyte> osg::VectorUByte

+
+

+ + + +
+otypedef std::vector<value_type> inherited +
+[more] VectorUByte() +
+[more]explicit VectorUByte(size_type n) +
+[more] VectorUByte(const VectorUByte &copy) +
+[more]template<class InputIterator> VectorUByte(InputIterator beg_, InputIterator end_) +

+ + + +
+

Documentation

+
+ + + +
o VectorUByte() +

+ + +

oexplicit VectorUByte(size_type n) +

+ + +

o VectorUByte(const VectorUByte &copy) +

+ + +

otemplate<class InputIterator> VectorUByte(InputIterator beg_, InputIterator end_) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUInt.2.html b/doc/doc++/osg/VectorUInt.2.html new file mode 100644 index 000000000..7da1b8a22 --- /dev/null +++ b/doc/doc++/osg/VectorUInt.2.html @@ -0,0 +1,31 @@ + + + + + class osg::VectorUInt + + + + +

class osg::VectorUInt

+ +

Inheritance:

+ + + + + + + + + +
+

Documentation

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUInt.html b/doc/doc++/osg/VectorUInt.html new file mode 100644 index 000000000..4aea2cfcf --- /dev/null +++ b/doc/doc++/osg/VectorUInt.html @@ -0,0 +1,54 @@ + + + + + typedef std::vector<GLuint> osg::VectorUInt + + + + +

typedef std::vector<GLuint> osg::VectorUInt

+
+

+ + + +
+otypedef std::vector<value_type> inherited +
+[more] VectorUInt() +
+[more]explicit VectorUInt(size_type n) +
+[more] VectorUInt(const VectorUInt &copy) +
+[more]template<class InputIterator> VectorUInt(InputIterator beg_, InputIterator end_) +

+ + + +
+

Documentation

+
+ + + +
o VectorUInt() +

+ + +

oexplicit VectorUInt(size_type n) +

+ + +

o VectorUInt(const VectorUInt &copy) +

+ + +

otemplate<class InputIterator> VectorUInt(InputIterator beg_, InputIterator end_) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUShort.2.html b/doc/doc++/osg/VectorUShort.2.html new file mode 100644 index 000000000..851a29743 --- /dev/null +++ b/doc/doc++/osg/VectorUShort.2.html @@ -0,0 +1,31 @@ + + + + + class osg::VectorUShort + + + + +

class osg::VectorUShort

+ +

Inheritance:

+ + + + + + + + + +
+

Documentation

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VectorUShort.html b/doc/doc++/osg/VectorUShort.html new file mode 100644 index 000000000..9411417ef --- /dev/null +++ b/doc/doc++/osg/VectorUShort.html @@ -0,0 +1,54 @@ + + + + + typedef std::vector<GLushort> osg::VectorUShort + + + + +

typedef std::vector<GLushort> osg::VectorUShort

+
+

+ + + +
+otypedef std::vector<value_type> inherited +
+[more] VectorUShort() +
+[more]explicit VectorUShort(size_type n) +
+[more] VectorUShort(const VectorUShort &copy) +
+[more]template<class InputIterator> VectorUShort(InputIterator beg_, InputIterator end_) +

+ + + +
+

Documentation

+
+ + + +
o VectorUShort() +

+ + +

oexplicit VectorUShort(size_type n) +

+ + +

o VectorUShort(const VectorUShort &copy) +

+ + +

otemplate<class InputIterator> VectorUShort(InputIterator beg_, InputIterator end_) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/VertexProgram.html b/doc/doc++/osg/VertexProgram.html new file mode 100644 index 000000000..56f094c34 --- /dev/null +++ b/doc/doc++/osg/VertexProgram.html @@ -0,0 +1,344 @@ + + + + + class SG_EXPORT osg::VertexProgram + + + + +

class SG_EXPORT osg::VertexProgram

VertexProgram - encapsulates the OpenGL ARB vertex program state
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] VertexProgram() +
+[more] VertexProgram(const VertexProgram& vp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, VertexProgram, VERTEXPROGRAM) +
+[more]virtual int compare(const osg::StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]virtual void getAssociatedModes(std::vector<GLMode>& modes) const +
+[more]inline GLuint& getVertexProgramID(unsigned int contextID) const +
Get the handle to the vertex program id for the current context +
+[more]inline void setVertexProgram( const std::string& program ) +
Set the vertex program using C++ style string +
+[more]inline void setVertexProgram( const char* program ) +
Set the vertex program using a C style string +
+[more]inline const std::string& getVertexProgram() const +
Get the vertex program +
+[more]inline void setProgramLocalParameter(const GLuint index, const Vec4& p) +
Program Parameters +
+[more]inline void setMatrix(const GLenum mode, const Matrix& matrix) +
Matrix +
+[more]void dirtyVertexProgramObject() +
Force a recompile on next apply() of associated OpenGL vertex program objects +
+[more]static void deleteVertexProgramObject(unsigned int contextID, GLuint handle) +
use deleteVertexProgramObject instead of glDeletePrograms to allow OpenGL Vertex Program objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID +
+[more]static void flushDeletedVertexProgramObjects(unsigned int contextID) +
flush all the cached vertex programs which need to be deleted in the OpenGL context related to contextID +
+[more]virtual void apply(State& state) const +
+[more]virtual void compile(State& state) const +
+[more]static Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +
+[more]static void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +

+ +

+

Public Members

+class SG_EXPORT Extensions: public osg::Referenced +
Extensions class which encapsulates the querring of extensions and associated function pointers, and provide convinience wrappers to check for the extensions or use the associated functions +

+ +

+

Protected Fields

+[more]mutable VertexProgramIDList _vertexProgramIDList +
+[more]std::string _vertexProgram +
+[more]LocalParamList _programLocalParameters +
+[more]MatrixList _matrixList +

+ +

+

Protected Methods

+[more]virtual ~VertexProgram() +

+ +

+

Protected Members

+[more]typedef buffered_value<GLuint> VertexProgramIDList +
+[more]typedef std::map<GLuint,Vec4> LocalParamList +
+[more]typedef std::map<GLenum,Matrix> MatrixList +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
VertexProgram - encapsulates the OpenGL ARB vertex program state
+
+ + + +
o VertexProgram() +

+ + +

o VertexProgram(const VertexProgram& vp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, VertexProgram, VERTEXPROGRAM) +

+ + +

ovirtual int compare(const osg::StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovirtual void getAssociatedModes(std::vector<GLMode>& modes) const +

+ + +

oinline GLuint& getVertexProgramID(unsigned int contextID) const +
Get the handle to the vertex program id for the current context +

+ + +

oinline void setVertexProgram( const std::string& program ) +
Set the vertex program using C++ style string +

+ + +

oinline void setVertexProgram( const char* program ) +
Set the vertex program using a C style string +

+ + +

oinline const std::string& getVertexProgram() const +
Get the vertex program +

+ + +

oinline void setProgramLocalParameter(const GLuint index, const Vec4& p) +
Program Parameters +

+ + +

oinline void setMatrix(const GLenum mode, const Matrix& matrix) +
Matrix +

+ + +

ovoid dirtyVertexProgramObject() +
Force a recompile on next apply() of associated OpenGL vertex program objects +

+ + +

ostatic void deleteVertexProgramObject(unsigned int contextID, GLuint handle) +
use deleteVertexProgramObject instead of glDeletePrograms to allow +OpenGL Vertex Program objects to cached until they can be deleted +by the OpenGL context in which they were created, specified +by contextID +

+ + +

ostatic void flushDeletedVertexProgramObjects(unsigned int contextID) +
flush all the cached vertex programs which need to be deleted +in the OpenGL context related to contextID +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual void compile(State& state) const +

+ + +

ostatic Extensions* getExtensions(unsigned int contextID, bool createIfNotInitalized) +
Function to call to get the extension of a specified context. +If the Exentsion object for that context has not yet been created then +and the 'createIfNotInitalized' flag been set to false then returns NULL. +If 'createIfNotInitalized' is true then the Extensions object is +automatically created. However, in this case the extension object +only be created with the graphics context associated with ContextID.. +

+ + +

ostatic void setExtensions(unsigned int contextID, Extensions* extensions) +
setExtensions allows users to override the extensions across graphics contexts. +typically used when you have different extensions supported across graphics pipes +but need to ensure that they all use the same low common denominator extensions. +

+ + +

ovirtual ~VertexProgram() +

+ + +

otypedef buffered_value<GLuint> VertexProgramIDList +

+ + +

omutable VertexProgramIDList _vertexProgramIDList +

+ + +

ostd::string _vertexProgram +

+ + +

otypedef std::map<GLuint,Vec4> LocalParamList +

+ + +

oLocalParamList _programLocalParameters +

+ + +

otypedef std::map<GLenum,Matrix> MatrixList +

+ + +

oMatrixList _matrixList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/Viewport.html b/doc/doc++/osg/Viewport.html new file mode 100644 index 000000000..b22e1aff6 --- /dev/null +++ b/doc/doc++/osg/Viewport.html @@ -0,0 +1,279 @@ + + + + + class SG_EXPORT osg::Viewport + + + + +

class SG_EXPORT osg::Viewport

Encapsulte OpenGL glViewport
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Viewport() +
+[more] Viewport(int x, int y, int width, int height) +
+[more] Viewport(const Viewport& vp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_StateAttribute(osg, Viewport, VIEWPORT) +
+[more]virtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]inline void setViewport(int x, int y, int width, int height) +
+[more]void getViewport(int& x, int& y, int& width, int& height) const +
+[more]inline int x() const +
+[more]inline int y() const +
+[more]inline int width() const +
+[more]inline int height() const +
+[more]inline bool valid() const +
+[more]inline float aspectRatio() const +
Return the aspcetRatio of the viewport, which is equal to width/height. +
+[more]inline const osg::Matrix computeWindowMatrix() const +
Compute the Window Matrix which takes projected coords into Window coordinates. +
+[more]virtual void apply(State& state) const +

+ +

+

Protected Fields

+[more]int _x +
+[more]int _y +
+[more]int _width +
+[more]int _height +

+ +

+

Protected Methods

+[more]virtual ~Viewport() +

+ +
+

Inherited from StateAttribute:

+
+

+

Public Methods

+ovirtual Object* cloneType() const +
+ovirtual Object* clone(const CopyOp&) const +
+ovirtual bool isSameKindAs(const Object* obj) const +
+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual Type getType() const +
+ovirtual bool isTextureAttribute() const +
+obool operator < (const StateAttribute& rhs) const +
+obool operator == (const StateAttribute& rhs) const +
+obool operator != (const StateAttribute& rhs) const +
+ovirtual void getAssociatedModes(std::vector<GLMode>& ) const +
+ovirtual void compile(State&) const +

+ +

+

Public Members

+otypedef GLenum GLMode +
+otypedef unsigned int GLModeValue +
+otypedef unsigned int OverrideValue +
+oenum Values +
+otypedef unsigned int Type +
+oenum Types +

+ +
+

Inherited from Object:

+
+

+

Public Methods

+oinline void setDataVariance(DataVariance dv) +
+oinline DataVariance getDataVariance() const +
+oinline void setUserData(Referenced* obj) +
+oinline Referenced* getUserData() +
+oinline const Referenced* getUserData() const +

+ +

+

Public Members

+oenum DataVariance +

+ +

+

Protected Fields

+oDataVariance _dataVariance +
+oref_ptr<Referenced> _userData +

+ +
+

Inherited from Referenced:

+
+

+

Public Methods

+oinline Referenced& operator = (Referenced&) +
+ostatic void setDeleteHandler(DeleteHandler* handler) +
+ostatic DeleteHandler* getDeleteHandler() +
+oinline void ref() const +
+oinline void unref_nodelete() const +
+oinline int referenceCount() const +
+oinline void unref() const +

+ +

+

Protected Fields

+omutable int _refCount +

+ +
+ + +
+

Documentation

+
Encapsulte OpenGL glViewport
+
+ + + +
o Viewport() +

+ + +

o Viewport(int x, int y, int width, int height) +

+ + +

o Viewport(const Viewport& vp, const CopyOp& copyop=CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_StateAttribute(osg, Viewport, VIEWPORT) +

+ + +

ovirtual int compare(const StateAttribute& sa) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

oinline void setViewport(int x, int y, int width, int height) +

+ + +

ovoid getViewport(int& x, int& y, int& width, int& height) const +

+ + +

oinline int x() const +

+ + +

oinline int y() const +

+ + +

oinline int width() const +

+ + +

oinline int height() const +

+ + +

oinline bool valid() const +

+ + +

oinline float aspectRatio() const +
Return the aspcetRatio of the viewport, which is equal to width/height. +If height is zero, the potental division by zero is avoid by simply returning 1.0f. +

+ + +

oinline const osg::Matrix computeWindowMatrix() const +
Compute the Window Matrix which takes projected coords into Window coordinates. +To converted local coodinates into window coordinates use v_window = v_local * MVPW matrix, +where the MVPW matrix is ModelViewMatrix * ProjectionMatrix * WindowMatrix, the later supplied by +viewport::computeWindowMatrix(), the ModelView and Projection Matrix can either be sourced from the +current osg::State object, via osgUtil::SceneView or CullVisitor. +

+ + +

ovirtual void apply(State& state) const +

+ + +

ovirtual ~Viewport() +

+ + +

oint _x +

+ + +

oint _y +

+ + +

oint _width +

+ + +

oint _height +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/buffered_object.html b/doc/doc++/osg/buffered_object.html new file mode 100644 index 000000000..f4557647d --- /dev/null +++ b/doc/doc++/osg/buffered_object.html @@ -0,0 +1,81 @@ + + + + + template<class T> class osg::buffered_object + + + + +

template<class T> class osg::buffered_object

+ +
+

+

Public Methods

+[more]inline buffered_object() +
+[more]buffered_object& operator = (const buffered_object& rhs) +
+[more]inline void setAllElementsTo(const T& t) +
+[more]inline void clear() +
+[more]inline bool empty() const +
+[more]inline unsigned int size() const +
+[more]inline T& operator[] (unsigned int pos) +

+ +

+

Protected Fields

+[more]std::vector<T> _array +

+ +
+ + +
+

Documentation

+
+ + + +
oinline buffered_object() +

+ + +

obuffered_object& operator = (const buffered_object& rhs) +

+ + +

oinline void setAllElementsTo(const T& t) +

+ + +

oinline void clear() +

+ + +

oinline bool empty() const +

+ + +

oinline unsigned int size() const +

+ + +

oinline T& operator[] (unsigned int pos) +

+ + +

ostd::vector<T> _array +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/buffered_value.html b/doc/doc++/osg/buffered_value.html new file mode 100644 index 000000000..97f47f18c --- /dev/null +++ b/doc/doc++/osg/buffered_value.html @@ -0,0 +1,84 @@ + + + + + template<class T> class osg::buffered_value + + + + +

template<class T> class osg::buffered_value

Simple buffered value array which is used for values that need to multibuffered on one per graphics context basis
+
+ +
+

+

Public Methods

+[more]inline buffered_value() +
+[more]buffered_value& operator = (const buffered_value& rhs) +
+[more]inline void setAllElementsTo(const T& t) +
+[more]inline void clear() +
+[more]inline bool empty() const +
+[more]inline unsigned int size() const +
+[more]inline T& operator[] (unsigned int pos) +

+ +

+

Protected Fields

+[more]std::vector<T> _array +

+ +
+ + +
+

Documentation

+
Simple buffered value array which is used for values that need to multibuffered on +one per graphics context basis
+
+ + + +
oinline buffered_value() +

+ + +

obuffered_value& operator = (const buffered_value& rhs) +

+ + +

oinline void setAllElementsTo(const T& t) +

+ + +

oinline void clear() +

+ + +

oinline bool empty() const +

+ + +

oinline unsigned int size() const +

+ + +

oinline T& operator[] (unsigned int pos) +

+ + +

ostd::vector<T> _array +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray3BetweenRange.html b/doc/doc++/osg/clampArray3BetweenRange.html new file mode 100644 index 000000000..29eacfc3a --- /dev/null +++ b/doc/doc++/osg/clampArray3BetweenRange.html @@ -0,0 +1,23 @@ + + + + + template<class A, class T>inline void osg::clampArray3BetweenRange + + + + +

template<class A, class T>inline void osg::clampArray3BetweenRange

(A& value,
  const T minValue,
  const T maxValue,
  const char* valueName)

if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.
+ + +
+

Documentation

+
if array4 elements are between or equal to minValue and maxValue do nothing - legal value, +otherwise clamp value to specified to range and return warning +with valueName specifying which variable was clamped. Equivilant to +calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray3GEQUAL.html b/doc/doc++/osg/clampArray3GEQUAL.html new file mode 100644 index 000000000..9f0c40530 --- /dev/null +++ b/doc/doc++/osg/clampArray3GEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArray3GEQUAL + + + + +

template<class A, class T>inline void osg::clampArray3GEQUAL

(A& value,
  const T minValue,
  const char* valueName)

if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array4 elements are greater than or equal to minValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray3LEQUAL.html b/doc/doc++/osg/clampArray3LEQUAL.html new file mode 100644 index 000000000..02444dc7e --- /dev/null +++ b/doc/doc++/osg/clampArray3LEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArray3LEQUAL + + + + +

template<class A, class T>inline void osg::clampArray3LEQUAL

(A& value,
  const T maxValue,
  const char* valueName)

if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array4 elements are is less than or equal to maxValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray4BetweenRange.html b/doc/doc++/osg/clampArray4BetweenRange.html new file mode 100644 index 000000000..c7bd11f15 --- /dev/null +++ b/doc/doc++/osg/clampArray4BetweenRange.html @@ -0,0 +1,23 @@ + + + + + template<class A, class T>inline void osg::clampArray4BetweenRange + + + + +

template<class A, class T>inline void osg::clampArray4BetweenRange

(A& value,
  const T minValue,
  const T maxValue,
  const char* valueName)

if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.
+ + +
+

Documentation

+
if array4 elements are between or equal to minValue and maxValue do nothing - legal value, +otherwise clamp value to specified to range and return warning +with valueName specifying which variable was clamped. Equivilant to +calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray4GEQUAL.html b/doc/doc++/osg/clampArray4GEQUAL.html new file mode 100644 index 000000000..9aafb2a8b --- /dev/null +++ b/doc/doc++/osg/clampArray4GEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArray4GEQUAL + + + + +

template<class A, class T>inline void osg::clampArray4GEQUAL

(A& value,
  const T minValue,
  const char* valueName)

if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array4 elements are greater than or equal to minValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArray4LEQUAL.html b/doc/doc++/osg/clampArray4LEQUAL.html new file mode 100644 index 000000000..85bb89e2d --- /dev/null +++ b/doc/doc++/osg/clampArray4LEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArray4LEQUAL + + + + +

template<class A, class T>inline void osg::clampArray4LEQUAL

(A& value,
  unsigned int first,
  unsigned int last,
  const T maxValue,
  const char* valueName)

if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array4 elements are is less than or equal to maxValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementBetweenRange.html b/doc/doc++/osg/clampArrayElementBetweenRange.html new file mode 100644 index 000000000..c4ae3fa32 --- /dev/null +++ b/doc/doc++/osg/clampArrayElementBetweenRange.html @@ -0,0 +1,23 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementBetweenRange + + + + +

template<class A, class T>inline void osg::clampArrayElementBetweenRange

(A& value,
  unsigned int i,
  const T minValue,
  const T maxValue,
  const char* valueName)

if array element value[i] is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.
+ + +
+

Documentation

+
if array element value[i] is between or equal to minValue and maxValue do nothing - legal value, +otherwise clamp value to specified to range and return warning +with valueName specifying which variable was clamped. Equivilant to +calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementGEQUAL.html b/doc/doc++/osg/clampArrayElementGEQUAL.html new file mode 100644 index 000000000..f3ad4e5c3 --- /dev/null +++ b/doc/doc++/osg/clampArrayElementGEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementGEQUAL + + + + +

template<class A, class T>inline void osg::clampArrayElementGEQUAL

(A& value,
  unsigned int i,
  const T minValue,
  const char* valueName)

if array element value[i] is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array element value[i] is greater than or equal to minValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementLEQUAL.html b/doc/doc++/osg/clampArrayElementLEQUAL.html new file mode 100644 index 000000000..96f89e566 --- /dev/null +++ b/doc/doc++/osg/clampArrayElementLEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementLEQUAL + + + + +

template<class A, class T>inline void osg::clampArrayElementLEQUAL

(A& value,
  unsigned int i,
  const T maxValue,
  const char* valueName)

if array element value[i] is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array element value[i] is less than or equal to maxValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementsBetweenRange.html b/doc/doc++/osg/clampArrayElementsBetweenRange.html new file mode 100644 index 000000000..aca8a9b66 --- /dev/null +++ b/doc/doc++/osg/clampArrayElementsBetweenRange.html @@ -0,0 +1,23 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementsBetweenRange + + + + +

template<class A, class T>inline void osg::clampArrayElementsBetweenRange

(A& value,
  unsigned int first,
  unsigned int last,
  const T minValue,
  const T maxValue,
  const char* valueName)

if array elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped.
+ + +
+

Documentation

+
if array elements are between or equal to minValue and maxValue do nothing - legal value, +otherwise clamp value to specified to range and return warning +with valueName specifying which variable was clamped. Equivalent to +calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementsGEQUAL.html b/doc/doc++/osg/clampArrayElementsGEQUAL.html new file mode 100644 index 000000000..8bc9388cb --- /dev/null +++ b/doc/doc++/osg/clampArrayElementsGEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementsGEQUAL + + + + +

template<class A, class T>inline void osg::clampArrayElementsGEQUAL

(A& value,
  unsigned int first,
  unsigned int last,
  const T minValue,
  const char* valueName)

if array elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array elements are greater than or equal to minValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampArrayElementsLEQUAL.html b/doc/doc++/osg/clampArrayElementsLEQUAL.html new file mode 100644 index 000000000..075901ee0 --- /dev/null +++ b/doc/doc++/osg/clampArrayElementsLEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class A, class T>inline void osg::clampArrayElementsLEQUAL + + + + +

template<class A, class T>inline void osg::clampArrayElementsLEQUAL

(A& value,
  unsigned int first,
  unsigned int last,
  const T maxValue,
  const char* valueName)

if array elements are less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if array elements are less than or equal to maxValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampBetweenRange.html b/doc/doc++/osg/clampBetweenRange.html new file mode 100644 index 000000000..1d7ad6dc6 --- /dev/null +++ b/doc/doc++/osg/clampBetweenRange.html @@ -0,0 +1,23 @@ + + + + + template<class T>inline void osg::clampBetweenRange + + + + +

template<class T>inline void osg::clampBetweenRange

(T& value,
  const T minValue,
  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 to range and return warning with valueName specifying which variable was clamped.
+ + +
+

Documentation

+
if value is between or equal to minValue and maxValue do nothing - legal value, +otherwise clamp value to specified to range and return warning +with valueName specifying which variable was clamped. Equivilant to +calling clampGEQUAL(value,minValue,valueName); clampLEQUAL(value,maxValue,valueName);
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampGEQUAL.html b/doc/doc++/osg/clampGEQUAL.html new file mode 100644 index 000000000..c67340f4a --- /dev/null +++ b/doc/doc++/osg/clampGEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class T>inline void osg::clampGEQUAL + + + + +

template<class T>inline void osg::clampGEQUAL

(T& value,
  const T minValue,
  const char* valueName)

if value is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if value is greater than or equal to minValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/clampLEQUAL.html b/doc/doc++/osg/clampLEQUAL.html new file mode 100644 index 000000000..1efb1b478 --- /dev/null +++ b/doc/doc++/osg/clampLEQUAL.html @@ -0,0 +1,22 @@ + + + + + template<class T>inline void osg::clampLEQUAL + + + + +

template<class T>inline void osg::clampLEQUAL

(T& value,
  const T maxValue,
  const char* valueName)

if value is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped
+ + +
+

Documentation

+
if value is less than or equal to maxValue do nothing - legal value, +otherwise clamp value to specified maximum value and return warning +with valueName specifying which variable was clamped
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/computeEyeToLocal.html b/doc/doc++/osg/computeEyeToLocal.html new file mode 100644 index 000000000..4836c0236 --- /dev/null +++ b/doc/doc++/osg/computeEyeToLocal.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT Matrix osg::computeEyeToLocal + + + + +

extern SG_EXPORT Matrix osg::computeEyeToLocal

(const Matrix& modelview,
  NodePath& nodePath)

compute the matrix which transforms objects in world coords to local coords, by accumulating the Transform world to local matrices along the specified node path the inverse of the supplied initialial camera modelview
+ + +
+

Documentation

+
compute the matrix which transforms objects in world coords to local coords, +by accumulating the Transform world to local matrices along the specified node path +the inverse of the supplied initialial camera modelview
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/computeLocalToEye.html b/doc/doc++/osg/computeLocalToEye.html new file mode 100644 index 000000000..14856bece --- /dev/null +++ b/doc/doc++/osg/computeLocalToEye.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT Matrix osg::computeLocalToEye + + + + +

extern SG_EXPORT Matrix osg::computeLocalToEye

(const Matrix& modelview,
  NodePath& nodePath)

compute the matrix which transforms objects in local coords to world coords, by accumulating the Transform local to world matrices along the specified node path the supplied initialial camera modelview
+ + +
+

Documentation

+
compute the matrix which transforms objects in local coords to world coords, +by accumulating the Transform local to world matrices along the specified node path +the supplied initialial camera modelview
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/computeLocalToWorld.html b/doc/doc++/osg/computeLocalToWorld.html new file mode 100644 index 000000000..0ed1494c0 --- /dev/null +++ b/doc/doc++/osg/computeLocalToWorld.html @@ -0,0 +1,21 @@ + + + + + extern SG_EXPORT Matrix osg::computeLocalToWorld + + + + +

extern SG_EXPORT Matrix osg::computeLocalToWorld

(NodePath& nodePath)

compute the matrix which transforms objects in local coords to world coords, by accumulating the Transform local to world matrices along the specified node path
+ + +
+

Documentation

+
compute the matrix which transforms objects in local coords to world coords, +by accumulating the Transform local to world matrices along the specified node path
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/computeWorldToLocal.html b/doc/doc++/osg/computeWorldToLocal.html new file mode 100644 index 000000000..b2bdaae4d --- /dev/null +++ b/doc/doc++/osg/computeWorldToLocal.html @@ -0,0 +1,21 @@ + + + + + extern SG_EXPORT Matrix osg::computeWorldToLocal + + + + +

extern SG_EXPORT Matrix osg::computeWorldToLocal

(NodePath& nodePath)

compute the matrix which transforms objects in world coords to local coords, by accumulating the Transform world to local matrices along the specified node path
+ + +
+

Documentation

+
compute the matrix which transforms objects in world coords to local coords, +by accumulating the Transform world to local matrices along the specified node path
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/createGeodeForImage.2.html b/doc/doc++/osg/createGeodeForImage.2.html new file mode 100644 index 000000000..2e2f7eb8c --- /dev/null +++ b/doc/doc++/osg/createGeodeForImage.2.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT Geode* osg::createGeodeForImage + + + + +

extern SG_EXPORT Geode* osg::createGeodeForImage

(Image* image,
  float s,
  float t)

Convenience function to be used by images loaders to generate a valid geode to return for readNode().
+ + +
+

Documentation

+
Convenience function to be used by images loaders to generate a valid geode +to return for readNode(). +Use the specified s and t values scale the dimensions of the image.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/createGeodeForImage.html b/doc/doc++/osg/createGeodeForImage.html new file mode 100644 index 000000000..caadfeb75 --- /dev/null +++ b/doc/doc++/osg/createGeodeForImage.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT Geode* osg::createGeodeForImage + + + + +

extern SG_EXPORT Geode* osg::createGeodeForImage

(Image* image)

Convenience function to be used by images loaders to generate a valid geode to return for readNode().
+ + +
+

Documentation

+
Convenience function to be used by images loaders to generate a valid geode +to return for readNode(). +Use the images s and t values scale the dimensions of the image.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/fast_back_stack.html b/doc/doc++/osg/fast_back_stack.html new file mode 100644 index 000000000..a383a666c --- /dev/null +++ b/doc/doc++/osg/fast_back_stack.html @@ -0,0 +1,131 @@ + + + + + template<class T> class osg::fast_back_stack + + + + +

template<class T> class osg::fast_back_stack

Simple stack implementation that keeps the back() cached locally for fast access rather than at the back of the vector which is the traditional stack implementation.
+
+ +
+

+

Public Fields

+[more]T _value +
+[more]std::vector<T> _stack +
+[more]unsigned int _size +

+ +

+

Public Methods

+[more]inline fast_back_stack() +
+[more]inline fast_back_stack(const fast_back_stack& fbs) +
+[more]inline fast_back_stack(const T& value) +
+[more]fast_back_stack& operator = (const fast_back_stack& fbs) +
+[more]inline void clear() +
+[more]inline bool empty() const +
+[more]inline unsigned int size() const +
+[more]inline T& back() +
+[more]inline const T& back() const +
+[more]inline void push_back() +
+[more]inline void push_back(const T& value) +
+[more]inline void pop_back() +

+ +
+ + +
+

Documentation

+
Simple stack implementation that keeps the back() cached locally for fast access +rather than at the back of the vector which is the traditional stack implementation. +A conventional std::vector<> stores the rest of the stack. The fast_back_stack +although contains a stl container it only implments the back push_back(),pop_back() +and back() methods so is not as general purpose as stl stack implementation. +The focus of the fast_back_stack is purly to maximize the speed at which the +back can be accessed.
+
+ + + +
oinline fast_back_stack() +

+ + +

oinline fast_back_stack(const fast_back_stack& fbs) +

+ + +

oinline fast_back_stack(const T& value) +

+ + +

ofast_back_stack& operator = (const fast_back_stack& fbs) +

+ + +

oinline void clear() +

+ + +

oinline bool empty() const +

+ + +

oinline unsigned int size() const +

+ + +

oinline T& back() +

+ + +

oinline const T& back() const +

+ + +

oinline void push_back() +

+ + +

oinline void push_back(const T& value) +

+ + +

oinline void pop_back() +

+ + +

oT _value +

+ + +

ostd::vector<T> _stack +

+ + +

ounsigned int _size +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/for_each_triangle.html b/doc/doc++/osg/for_each_triangle.html new file mode 100644 index 000000000..b2554a0ae --- /dev/null +++ b/doc/doc++/osg/for_each_triangle.html @@ -0,0 +1,22 @@ + + + + + template<class T> void osg::for_each_triangle + + + + +

template<class T> void osg::for_each_triangle

(GeoSet& gset,
  T& op)

Template function for iterating through a GeoSet operating on triangles with templated functor.
+ + +
+

Documentation

+
Template function for iterating through a GeoSet operating on triangles +with templated functor. Function automatically decomposes quads and polygons +into sub triangles which are passed onto functor.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/getGLExtensionFuncPtr.2.html b/doc/doc++/osg/getGLExtensionFuncPtr.2.html new file mode 100644 index 000000000..f2c043255 --- /dev/null +++ b/doc/doc++/osg/getGLExtensionFuncPtr.2.html @@ -0,0 +1,23 @@ + + + + + inline void* osg::getGLExtensionFuncPtr + + + + +

inline void* osg::getGLExtensionFuncPtr

(const char* funcName,
  const char* fallbackFuncName)

return the address of the specified OpenGL function, if not found then check a second function name, if this fails then return NULL as function is not supported by OpenGL library.
+ + +
+

Documentation

+
return the address of the specified OpenGL function, if not found then +check a second function name, if this fails then return NULL as function is +not supported by OpenGL library. This is usual for checking something +like glActiveTexture (which is in OGL1.3) or glActiveTextureARB.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/getGLExtensionFuncPtr.html b/doc/doc++/osg/getGLExtensionFuncPtr.html new file mode 100644 index 000000000..3c7eb60d6 --- /dev/null +++ b/doc/doc++/osg/getGLExtensionFuncPtr.html @@ -0,0 +1,25 @@ + + + + + inline void* osg::getGLExtensionFuncPtr + + + + +

inline void* osg::getGLExtensionFuncPtr

(const char* funcName)

return the address of the specified OpenGL function.
+ + +
+

Documentation

+
return the address of the specified OpenGL function. +return NULL if function not supported by OpenGL library. +Note, glGLExtensionFuncPtr is declared inline so that the code +is compiled localy to the calling code. This should get by Windows +dumb implementation of having different GL function ptr's for each +library when links to it.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/getNotifyLevel.html b/doc/doc++/osg/getNotifyLevel.html new file mode 100644 index 000000000..26febe253 --- /dev/null +++ b/doc/doc++/osg/getNotifyLevel.html @@ -0,0 +1,20 @@ + + + + + extern SG_EXPORT NotifySeverity osg::getNotifyLevel + + + + +

extern SG_EXPORT NotifySeverity osg::getNotifyLevel

()

get the notify level.
+ + +
+

Documentation

+
get the notify level.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/globalnotifylevel..html b/doc/doc++/osg/globalnotifylevel..html new file mode 100644 index 000000000..b914235ef --- /dev/null +++ b/doc/doc++/osg/globalnotifylevel..html @@ -0,0 +1,16 @@ + + + + + osg::global notify level. + + + + +

osg::global notify level.

+
global notify level.
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/globalnotifynulstream..html b/doc/doc++/osg/globalnotifynulstream..html new file mode 100644 index 000000000..92d5d7d4c --- /dev/null +++ b/doc/doc++/osg/globalnotifynulstream..html @@ -0,0 +1,16 @@ + + + + + osg::global notify nul stream. + + + + +

osg::global notify nul stream.

+
global notify nul stream. added for Mac OSX global notify nul stream. added for Mac OSX
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/icon1.gif b/doc/doc++/osg/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osg/icon2.gif b/doc/doc++/osg/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osg/index.html b/doc/doc++/osg/index.html new file mode 100644 index 000000000..b44018ea9 --- /dev/null +++ b/doc/doc++/osg/index.html @@ -0,0 +1,299 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Variables

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/initNotifyLevel.html b/doc/doc++/osg/initNotifyLevel.html new file mode 100644 index 000000000..679a4ddf7 --- /dev/null +++ b/doc/doc++/osg/initNotifyLevel.html @@ -0,0 +1,20 @@ + + + + + extern SG_EXPORT bool osg::initNotifyLevel + + + + +

extern SG_EXPORT bool osg::initNotifyLevel

()

initialize notify level.
+ + +
+

Documentation

+
initialize notify level.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/isGLExtensionSupported.html b/doc/doc++/osg/isGLExtensionSupported.html new file mode 100644 index 000000000..76cb0c7a6 --- /dev/null +++ b/doc/doc++/osg/isGLExtensionSupported.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT bool osg::isGLExtensionSupported + + + + +

extern SG_EXPORT bool osg::isGLExtensionSupported

(const char* extension)

return true if OpenGL "extension" is supported.
+ + +
+

Documentation

+
return true if OpenGL "extension" is supported. +note: Must only called within a valid OpenGL context, +undefined behavior may occur otherwise.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/isGLUExtensionSupported.html b/doc/doc++/osg/isGLUExtensionSupported.html new file mode 100644 index 000000000..df949a5dc --- /dev/null +++ b/doc/doc++/osg/isGLUExtensionSupported.html @@ -0,0 +1,22 @@ + + + + + extern SG_EXPORT bool osg::isGLUExtensionSupported + + + + +

extern SG_EXPORT bool osg::isGLUExtensionSupported

(const char* extension)

return true if OpenGL "extension" is supported.
+ + +
+

Documentation

+
return true if OpenGL "extension" is supported. +note: Must only called within a valid OpenGL context, +undefined behavior may occur otherwise.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/notify.html b/doc/doc++/osg/notify.html new file mode 100644 index 000000000..a2ef67960 --- /dev/null +++ b/doc/doc++/osg/notify.html @@ -0,0 +1,32 @@ + + + + + extern SG_EXPORT std::ostream& osg::notify + + + + +

extern SG_EXPORT std::ostream& osg::notify

(const NotifySeverity severity)

notify messaging function for providing fatal through to verbose debugging messages.
+ + +
+

Documentation

+
notify messaging function for providing fatal through to verbose +debugging messages. Level of messages sent to the console can +be controlled by setting the NotifyLevel either within your +application or via the an environmental variable. For instance +setenv OSGNOTIFYLEVEL DEBUG (for tsh), export OSGNOTIFYLEVEL=DEBUG +(for bourne shell) or set OSGNOTIFYLEVEL=DEBUG (for Windows) all +set tell the osg to redirect all debugging and more important messages +to the console (useful for debugging :-) setting ALWAYS will force +all messages to be absorbed, which might be appropriate for final +applications. Default NotifyLevel is NOTICE. Check the enum +NotifySeverity for full range of possibilities. To use the notify +with your code simply use the notify function as a normal file +stream (like cout) i.e osg::notify(osg::DEBUG) << "Hello Bugs!"< +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/operator.2.html b/doc/doc++/osg/operator.2.html new file mode 100644 index 000000000..e6c751b47 --- /dev/null +++ b/doc/doc++/osg/operator.2.html @@ -0,0 +1,20 @@ + + + + + inline float osg::operator * + + + + +

inline float osg::operator *

(const Vec4& lhs,
  const Vec3& rhs)

Compute the dot product of a Vec4 and a (Vec3,10)
+ + +
+

Documentation

+
Compute the dot product of a Vec4 and a (Vec3,10)
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/operator.html b/doc/doc++/osg/operator.html new file mode 100644 index 000000000..c12c6fcad --- /dev/null +++ b/doc/doc++/osg/operator.html @@ -0,0 +1,20 @@ + + + + + inline float osg::operator * + + + + +

inline float osg::operator *

(const Vec3& lhs,
  const Vec4& rhs)

Compute the dot product of a (Vec3,10) and a Vec4
+ + +
+

Documentation

+
Compute the dot product of a (Vec3,10) and a Vec4
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/osg.html b/doc/doc++/osg/osg.html new file mode 100644 index 000000000..b510d5fb4 --- /dev/null +++ b/doc/doc++/osg/osg.html @@ -0,0 +1,725 @@ + + + + + namespace osg + + + + +

namespace osg

+
+

+
+class SG_EXPORT AlphaFunc: public StateAttribute +
Encapsulate OpenGL glAlphaFunc +
+class SG_EXPORT AnimationPath: public virtual osg::Object +
AnimationPath for specify the time varying transformation pathway to use when update camera and model objects. +
+class SG_EXPORT AnimationPathCallback: public NodeCallback +
+class SG_EXPORT ApplicationUsage +
+class ApplicationUsageProxy +
+class SG_EXPORT ArgumentParser +
+class SG_EXPORT Array: public Object +
+template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class TemplateArray: public Array, public std::vector<T> +
+class SG_EXPORT IndexArray: public Array +
+template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType> class TemplateIndexArray: public IndexArray, public std::vector<T> +
+[more]typedef TemplateIndexArray<GLbyte,Array::ByteArrayType,1,GL_BYTE> ByteArray +
+[more]typedef TemplateIndexArray<GLshort,Array::ShortArrayType,1,GL_SHORT> ShortArray +
+[more]typedef TemplateIndexArray<GLint,Array::IntArrayType,1,GL_INT> IntArray +
+[more]typedef TemplateIndexArray<GLubyte,Array::UByteArrayType,1,GL_UNSIGNED_BYTE> UByteArray +
+[more]typedef TemplateIndexArray<GLushort,Array::UShortArrayType,1,GL_UNSIGNED_SHORT> UShortArray +
+[more]typedef TemplateIndexArray<GLuint,Array::UIntArrayType,1,GL_UNSIGNED_INT> UIntArray +
+[more]typedef TemplateArray<GLfloat,Array::FloatArrayType,1,GL_FLOAT> FloatArray +
+[more]typedef TemplateArray<UByte4,Array::UByte4ArrayType,4,GL_UNSIGNED_BYTE> UByte4Array +
+[more]typedef TemplateArray<Vec2,Array::Vec2ArrayType,2,GL_FLOAT> Vec2Array +
+[more]typedef TemplateArray<Vec3,Array::Vec3ArrayType,3,GL_FLOAT> Vec3Array +
+[more]typedef TemplateArray<Vec4,Array::Vec4ArrayType,4,GL_FLOAT> Vec4Array +
+class ArrayVisitor +
+class ConstArrayVisitor +
+class ValueVisitor +
+class ConstValueVisitor +
+class SG_EXPORT Billboard: public Geode +
Billboard - a Geode which orientates its child osg::Drawable's to face the eye point. +
+class SG_EXPORT BlendFunc: public StateAttribute +
BlendFunc - encapsulates the OpenGL blend/transparency state +
+class SG_EXPORT BoundingBox +
General purpose axis-aligned bounding box class for enclosing objects/vertices. +
+class SG_EXPORT BoundingSphere +
General purpose bounding sphere class for enclosing nodes/objects/vertices. +
+template<class T>inline void clampGEQUAL(T& value, const T minValue, const char* valueName) +
if value is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class T>inline void clampLEQUAL(T& value, const T maxValue, const char* valueName) +
if value is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class T>inline void clampBetweenRange(T& value, const T minValue, 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 to range and return warning with valueName specifying which variable was clamped. +
+template<class A, class T>inline void clampArrayElementGEQUAL(A& value, unsigned int i, const T minValue, const char* valueName) +
if array element value[i] is greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArrayElementLEQUAL(A& value, unsigned int i, const T maxValue, const char* valueName) +
if array element value[i] is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArrayElementBetweenRange(A& value, unsigned int i, const T minValue, const T maxValue, const char* valueName) +
if array element value[i] is between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped. +
+template<class A, class T>inline void clampArrayElementsGEQUAL(A& value, unsigned int first, unsigned int last, const T minValue, const char* valueName) +
if array elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArrayElementsLEQUAL(A& value, unsigned int first, unsigned int last, const T maxValue, const char* valueName) +
if array elements are less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArrayElementsBetweenRange(A& value, unsigned int first, unsigned int last, const T minValue, const T maxValue, const char* valueName) +
if array elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped. +
+template<class A, class T>inline void clampArray3GEQUAL(A& value, const T minValue, const char* valueName) +
if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArray3LEQUAL(A& value, const T maxValue, const char* valueName) +
if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArray3BetweenRange(A& value, const T minValue, const T maxValue, const char* valueName) +
if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped. +
+template<class A, class T>inline void clampArray4GEQUAL(A& value, const T minValue, const char* valueName) +
if array4 elements are greater than or equal to minValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArray4LEQUAL(A& value, unsigned int first, unsigned int last, const T maxValue, const char* valueName) +
if array4 elements are is less than or equal to maxValue do nothing - legal value, otherwise clamp value to specified maximum value and return warning with valueName specifying which variable was clamped +
+template<class A, class T>inline void clampArray4BetweenRange(A& value, const T minValue, const T maxValue, const char* valueName) +
if array4 elements are between or equal to minValue and maxValue do nothing - legal value, otherwise clamp value to specified to range and return warning with valueName specifying which variable was clamped. +
+class SG_EXPORT Camera: public osg::Referenced +
Camera class for encapsulating the view position and orientation and projection (lens) used. +
+class SG_EXPORT ClearNode: public Group +
ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame. +
+class SG_EXPORT ClipNode: public Group +
Leaf Node for defining the position of ClipPlanes in the scene +
+class SG_EXPORT ClipPlane: public StateAttribute +
ClipPlane state class which encapsulates OpenGL glClipPlane() functionality +
+class SG_EXPORT CollectOccludersVisitor: public osg::NodeVisitor, public osg::CullStack +
+class SG_EXPORT ColorMask: public StateAttribute +
Encapsulate OpenGL glColorMaskFunc/Op/Mask functions +
+class SG_EXPORT ColorMatrix: public StateAttribute +
Texture Matrix state class for encapsulating OpenGL texture matrix functionality +
+class SG_EXPORT ConvexPlanarOccluder: public Object +
A class for representing convex clipping volumes made up. +
+class SG_EXPORT ConvexPlanarPolygon +
A class for representing convex clipping volumes made up. +
+class SG_EXPORT CopyOp +
Copy Op(erator) used to control the whether shallow or deep copy is used during copy construction and clone operation +
+class SG_EXPORT CullFace: public StateAttribute +
Class to globally enable/disable OpenGL's polygon culling mode= +
+class SG_EXPORT CullStack +
A CullStack class which accumulates the current project, modelview matrices and the CullingSet. +
+class SG_EXPORT CullingSet: public Referenced +
A CullingSet class which contains a frustum and a list of occluder. +
+class SG_EXPORT DOFTransform: public Transform +
DOFTransform - encapsulates Multigen DOF behavior +
+class SG_EXPORT Depth: public StateAttribute +
Encapsulate OpenGL glDepthFunc/Mask/Range functions +
+class SG_EXPORT DisplaySettings: public osg::Referenced +
DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing +
+class SG_EXPORT DrawPixels: public Drawable +
DrawPixels is an osg::Drawable subclass which encapsulates the drawing of images using glDrawPixels +
+[more]#define USE_SEPARATE_COMPILE_AND_EXECUTE +
+class SG_EXPORT Drawable: public Object +
Pure virtual base class for drawable Geometry. +
+enum Endian +
+[more]inline Endian getCpuByteOrder() +
+[more]template<class T>inline void swapBytes( T& in ) +
+class SG_EXPORT Fog: public StateAttribute +
Fog - encapsulates OpenGL fog state. +
+class SG_EXPORT FrameStamp: public Referenced +
Class which encapsulates the frame number, reference time and calander time of specific frame, used to synchonize operations on the scene graph and other machines when using a graphics cluster. +
+class SG_EXPORT FrontFace: public StateAttribute +
Class to specifies the orientation of front-facing polygons +
+extern SG_EXPORT bool isGLExtensionSupported(const char* extension) +
return true if OpenGL "extension" is supported. +
+inline void* getGLExtensionFuncPtr(const char* funcName) +
return the address of the specified OpenGL function. +
+inline void* getGLExtensionFuncPtr(const char* funcName, const char* fallbackFuncName) +
return the address of the specified OpenGL function, if not found then check a second function name, if this fails then return NULL as function is not supported by OpenGL library. +
+extern SG_EXPORT bool isGLUExtensionSupported(const char* extension) +
return true if OpenGL "extension" is supported. +
+class SG_EXPORT GeoSet: public Drawable +
Note, osg::GeoSet is now deprecated, please use osg::Geometry instead. +
+template<class T> void for_each_triangle(GeoSet& gset, T& op) +
Template function for iterating through a GeoSet operating on triangles with templated functor. +
+class SG_EXPORT Geode: public Node +
Leaf Node for grouping Drawables +
+class SG_EXPORT Geometry: public Drawable +
+class SG_EXPORT Group: public Node +
General group node which maintains a list of children. +
+class SG_EXPORT Image: public Object +
Image class for encapsulating the storage texture image data +
+extern SG_EXPORT Geode* createGeodeForImage(Image* image) +
Convenience function to be used by images loaders to generate a valid geode to return for readNode(). +
+extern SG_EXPORT Geode* createGeodeForImage(Image* image, float s, float t) +
Convenience function to be used by images loaders to generate a valid geode to return for readNode(). +
+class SG_EXPORT Impostor: public LOD +
Impostor - is a form of Level Of Detail group node which allows both switching between children depending on distance from eye point and image caching. +
+class SG_EXPORT ImpostorSprite: public Drawable +
An ImposterSprite is a textured quad which is rendered in place a 3D geometry. +
+class SG_EXPORT ImpostorSpriteManager: public Referenced +
Helper class for managing the reuse of ImpostorSprite resources +
+class SG_EXPORT LOD: public Group +
LOD - Level Of Detail group node which allows switching between children depending on distance from eye point. +
+class SG_EXPORT Light: public StateAttribute +
Light state class which encapsulates OpenGL glLight() functionality +
+class SG_EXPORT LightModel: public StateAttribute +
+class SG_EXPORT LightSource: public Group +
Leaf Node for defining a light in the scene +
+class SG_EXPORT LineSegment: public Referenced +
LineSegment class for representing a line segment +
+class SG_EXPORT LineStipple: public StateAttribute +
+class SG_EXPORT LineWidth: public StateAttribute +
LineWidth - encapsulates the OpenGL glLineWidth for setting the width of lines in pixels +
+class SG_EXPORT Material: public StateAttribute +
Material - encapsulates OpenGL glMaterial state +
+class SG_EXPORT Matrix +
+class RefMatrix: public Object, public Matrix +
+[more]inline Vec3 operator* (const Vec3& v, const Matrix& m ) +
+[more]inline Vec4 operator* (const Vec4& v, const Matrix& m ) +
+[more]inline std::ostream& operator<< (std::ostream& os, const Matrix& m ) +
+class SG_EXPORT MatrixTransform: public Transform +
MatrixTransform - is a subclass of Transform which has an osg::Matrix which represent a 4x4 transformation of its children from local cordinates into the Transform's parent coordinates +
+#define META_Node(library,name) +
META_Node macro define the standard clone, isSameKindAs, className and accept methods. +
+class SG_EXPORT Node: public Object +
Base class for all internal nodes in the scene graph. +
+typedef std::vector<Node*> NodePath +
A vector of Nodes pointers which is used to describe the path from a root node to a descendant +
+class SG_EXPORT NodeCallback: public virtual Object +
+class SG_EXPORT NodeVisitor: public virtual Referenced +
Visitor for type safe operations on osg::Node's. +
+struct NodeAcceptOp +
Convenience functor for assisting visiting of arrays of osg::Node's +
+enum NotifySeverity +
Range of notify levels from DEBUG_FP through to FATAL, ALWAYS is reserved for forcing the absorption of all messages. +
+ global notify level. +
+ xtern SG_EXPORT NotifySeverity g_NotifyLevel; +
+ xtern SG_EXPORT std::auto_ptr g_NotifyNulStream; +
+ global notify nul stream. +
+ xtern SG_EXPORT bool g_NotifyInit; +
+extern SG_EXPORT void setNotifyLevel(NotifySeverity severity) +
set the notify level, overriding the default or value set by the environmental variable OSGNOTIFYLEVEL +
+extern SG_EXPORT NotifySeverity getNotifyLevel() +
get the notify level. +
+extern SG_EXPORT bool initNotifyLevel() +
initialize notify level. +
+extern SG_EXPORT std::ostream& notify(const NotifySeverity severity) +
notify messaging function for providing fatal through to verbose debugging messages. +
+[more]inline std::ostream& notify(void) +
+#define META_Object(library,name) +
META_Object macro define the standard clone, isSameKindAs and className methods. +
+class SG_EXPORT Object: public Referenced +
Base class/standard interface for objects which require IO support, cloning and reference counting. +
+class SG_EXPORT OccluderNode: public Group +
OccluderNode is a Group node which allows OccluderNodeing between children. +
+class SG_EXPORT Plane +
A plane class. +
+[more]inline std::ostream& operator << (std::ostream& output, const Plane& pl) +
+class SG_EXPORT Point: public StateAttribute +
Point - encapsulates the OpenGL point smoothing and size state +
+class SG_EXPORT PolygonMode: public StateAttribute +
Class to for setting OpenGL's polygon culling mode +
+class SG_EXPORT PolygonOffset: public StateAttribute +
PolygonOffset - encapsulates the OpenGL glPolygonOffset state +
+class SG_EXPORT PolygonStipple: public StateAttribute +
+class SG_EXPORT Polytope +
A Polytope class for representing convex clipping volumes made up. +
+class SG_EXPORT PositionAttitudeTransform: public Transform +
PositionAttitideTransform - is Transform the set the coordinates transform up via a Vec3 position and Quat attitude +
+typedef std::vector<GLsizei> VectorSizei +
+typedef std::vector<GLubyte> VectorUByte +
+typedef std::vector<GLushort> VectorUShort +
+typedef std::vector<GLuint> VectorUInt +
+class VectorSizei: public std::vector<GLsizei> +
+class VectorUByte: public std::vector<GLubyte> +
+class VectorUShort: public std::vector<GLushort> +
+class VectorUInt: public std::vector<GLuint> +
+class PrimitiveSet: public Object +
+class SG_EXPORT DrawArrays: public PrimitiveSet +
+class SG_EXPORT DrawArrayLengths: public PrimitiveSet, public VectorSizei +
+class SG_EXPORT DrawElementsUByte: public PrimitiveSet, public VectorUByte +
+class SG_EXPORT DrawElementsUShort: public PrimitiveSet, public VectorUShort +
+class SG_EXPORT DrawElementsUInt: public PrimitiveSet, public VectorUInt +
+class SG_EXPORT Projection: public Group +
Projection nodes set up the frustum/orthographic projection used when rendering the scene +
+class SG_EXPORT Quat +
A quaternion class. +
+[more]inline std::ostream& operator << (std::ostream& output, const Quat& vec) +
+class SG_EXPORT Referenced +
Base class from providing referencing counted objects +
+class DeleteHandler +
Class for override the default delete behavior so that users can implment their own object deletion schemes. +
+class SG_EXPORT Sequence: public Group +
Sequence is a Group node which allows automatic, time based switching between children +
+class SG_EXPORT ShadeModel: public StateAttribute +
Class which encapsulates glShadeModel() +
+class SG_EXPORT ShadowVolumeOccluder +
ShadowVolumeOccluder is a helper class for implementating shadow occlusion culling. +
+typedef std::vector<ShadowVolumeOccluder> ShadowVolumeOccluderList +
A list of ShadowVolumeOccluder, used by CollectOccluderVisitor and CullVistor's +
+#define META_Shape(library,name) +
META_StateAttribute macro define the standard clone, isSameKindAs, className and getType methods. +
+class SG_EXPORT Shape: public Object +
Base class for all shape types. +
+class ShapeVisitor +
+class ConstShapeVisitor +
+class Sphere: public Shape +
+class Box: public Shape +
+class Cone: public Shape +
+class Cylinder: public Shape +
+class InfinitePlane: public Shape, public Plane +
+class TriangleMesh: public Shape +
+class ConvexHull: public TriangleMesh +
+class SG_EXPORT HeightField: public Shape +
+class SG_EXPORT Grid: public HeightField +
+class CompositeShape: public Shape +
+class TessellationHints: public Object +
+class SG_EXPORT ShapeDrawable: public Drawable +
+[more]#define GL_TEXTURE0 +
+[more]#define GL_FOG_COORDINATE_ARRAY +
+[more]#define GL_SECONDARY_COLOR_ARRAY +
+#define OSG_GL_DEBUG(message) +
macro for use with osg::StateAttrbiute::apply methods for detected and reporting OpenGL error messages +
+class SG_EXPORT State: public Referenced +
State class for managing a state stack. +
+#define META_StateAttribute(library,name,type) +
META_StateAttribute macro define the standard clone, isSameKindAs, className and getType methods. +
+#define COMPARE_StateAttribute_Types(TYPE,rhs_attribute) +
COMPARE_StateAttribute_Types macro is a helper for implementing the StatateAtribute::compare() method +
+#define COMPARE_StateAttribute_Parameter(parameter) +
COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare() method. +
+[more]#define GL_COLOR_SUM +
+class SG_EXPORT StateAttribute: public Object +
Base class for state attribuets +
+class SG_EXPORT StateSet: public Object +
Encapsulates OpenGL state modes and attributes. +
+class Statistics: public osg::Drawable::PrimitiveFunctor +
Statistics base class. +
+class SG_EXPORT Stencil: public StateAttribute +
Encapsulate OpenGL glStencilFunc/Op/Mask functions +
+class SG_EXPORT Switch: public Group +
Switch is a Group node which allows switching between children. +
+class SG_EXPORT TexEnv: public StateAttribute +
TexEnv - encapsulates the OpenGL glTexEnv (texture environment) state +
+class SG_EXPORT TexEnvCombine: public StateAttribute +
TexEnvCombine - encapsulates the OpenGL glTexEnvCombine (texture environment) state +
+[more]#define GL_NORMAL_MAP_ARB +
+[more]#define GL_REFLECTION_MAP_ARB +
+class SG_EXPORT TexGen: public StateAttribute +
TexGen - encapsulates the OpenGL glTexGen (texture coordinate generation) state +
+class SG_EXPORT TexMat: public StateAttribute +
Texture Matrix state class for encapsulating OpenGL texture matrix functionality +
+class SG_EXPORT Texture: public osg::StateAttribute +
Texture base class which encapsulates OpenGl texture functionality which common betweent the various types of OpenGL textures +
+class SG_EXPORT Texture1D: public Texture +
Texture state class which encapsulates OpenGl 1D texture functionality +
+class SG_EXPORT Texture2D: public Texture +
Texture state class which encapsulates OpenGl texture functionality +
+class SG_EXPORT Texture3D: public Texture +
Texture state class which encapsulates OpenGl 3D texture functionality +
+class SG_EXPORT TextureCubeMap: public Texture +
TextureCubeMap state class which encapsulates OpenGl texture cubemap functionality +
+class SG_EXPORT TextureRectangle: public Texture +
Texture state class which encapsulates OpenGL texture functionality +
+[more]typedef __int64 Timer_t +
+[more]typedef unsigned long long Timer_t +
+[more]typedef double Timer_t +
+[more]typedef std::clock_t Timer_t +
+class SG_EXPORT Timer +
A high resolution, low latency time stamper +
+extern SG_EXPORT Matrix computeLocalToWorld(NodePath& nodePath) +
compute the matrix which transforms objects in local coords to world coords, by accumulating the Transform local to world matrices along the specified node path +
+extern SG_EXPORT Matrix computeWorldToLocal(NodePath& nodePath) +
compute the matrix which transforms objects in world coords to local coords, by accumulating the Transform world to local matrices along the specified node path +
+extern SG_EXPORT Matrix computeLocalToEye(const Matrix& modelview, NodePath& nodePath) +
compute the matrix which transforms objects in local coords to world coords, by accumulating the Transform local to world matrices along the specified node path the supplied initialial camera modelview +
+extern SG_EXPORT Matrix computeEyeToLocal(const Matrix& modelview, NodePath& nodePath) +
compute the matrix which transforms objects in world coords to local coords, by accumulating the Transform world to local matrices along the specified node path the inverse of the supplied initialial camera modelview +
+class SG_EXPORT Transform: public Group +
A Transform is a group node for which all children are transformed by a 4x4 matrix. +
+template<class T> class TriangleFunctor: public Drawable::PrimitiveFunctor, public T +
+class UByte4 +
General purpose float quad, uses include representation of colour coordinates. +
+class Vec2 +
General purpose float pair, uses include representation of texture coordinates. +
+class Vec3 +
General purpose float triple for use as vertices, vectors and normals. +
+[more]inline std::ostream& operator << (std::ostream& output, const Vec3& vec) +
+[more]const Vec3 X_AXIS(1.0f, 0.0f, 0.0f) +
+[more]const Vec3 Y_AXIS(0.0f, 1.0f, 0.0f) +
+[more]const Vec3 Z_AXIS(0.0f, 0.0f, 1.0f) +
+class Vec4 +
General purpose float quad, uses include representation of colour coordinates. +
+inline float operator * (const Vec3& lhs, const Vec4& rhs) +
Compute the dot product of a (Vec3,10) and a Vec4 +
+inline float operator * (const Vec4& lhs, const Vec3& rhs) +
Compute the dot product of a Vec4 and a (Vec3,10) +
+class SG_EXPORT VertexProgram: public StateAttribute +
VertexProgram - encapsulates the OpenGL ARB vertex program state +
+class SG_EXPORT Viewport: public StateAttribute +
Encapsulte OpenGL glViewport +
+template<class T> class buffered_value +
Simple buffered value array which is used for values that need to multibuffered on one per graphics context basis +
+template<class T> class buffered_object +
+template<class T> class fast_back_stack +
Simple stack implementation that keeps the back() cached locally for fast access rather than at the back of the vector which is the traditional stack implementation. +
+template<class T> class ref_ptr +
Smart pointer for handling referenced counted objects +

+ + + +
+

Documentation

+
+ + + +
otypedef TemplateIndexArray<GLbyte,Array::ByteArrayType,1,GL_BYTE> ByteArray +

+ + +

otypedef TemplateIndexArray<GLshort,Array::ShortArrayType,1,GL_SHORT> ShortArray +

+ + +

otypedef TemplateIndexArray<GLint,Array::IntArrayType,1,GL_INT> IntArray +

+ + +

otypedef TemplateIndexArray<GLubyte,Array::UByteArrayType,1,GL_UNSIGNED_BYTE> UByteArray +

+ + +

otypedef TemplateIndexArray<GLushort,Array::UShortArrayType,1,GL_UNSIGNED_SHORT> UShortArray +

+ + +

otypedef TemplateIndexArray<GLuint,Array::UIntArrayType,1,GL_UNSIGNED_INT> UIntArray +

+ + +

otypedef TemplateArray<GLfloat,Array::FloatArrayType,1,GL_FLOAT> FloatArray +

+ + +

otypedef TemplateArray<UByte4,Array::UByte4ArrayType,4,GL_UNSIGNED_BYTE> UByte4Array +

+ + +

otypedef TemplateArray<Vec2,Array::Vec2ArrayType,2,GL_FLOAT> Vec2Array +

+ + +

otypedef TemplateArray<Vec3,Array::Vec3ArrayType,3,GL_FLOAT> Vec3Array +

+ + +

otypedef TemplateArray<Vec4,Array::Vec4ArrayType,4,GL_FLOAT> Vec4Array +

+ + +

o#define USE_SEPARATE_COMPILE_AND_EXECUTE +

+ + +

oinline Endian getCpuByteOrder() +

+ + +

otemplate<class T>inline void swapBytes( T& in ) +

+ + +

oinline Vec3 operator* (const Vec3& v, const Matrix& m ) +

+ + +

oinline Vec4 operator* (const Vec4& v, const Matrix& m ) +

+ + +

oinline std::ostream& operator<< (std::ostream& os, const Matrix& m ) +

+ + +

oinline std::ostream& notify(void) +

+ + +

oinline std::ostream& operator << (std::ostream& output, const Plane& pl) +

+ + +

oinline std::ostream& operator << (std::ostream& output, const Quat& vec) +

+ + +

o#define GL_TEXTURE0 +

+ + +

o#define GL_FOG_COORDINATE_ARRAY +

+ + +

o#define GL_SECONDARY_COLOR_ARRAY +

+ + +

o#define GL_COLOR_SUM +

+ + +

o#define GL_NORMAL_MAP_ARB +

+ + +

o#define GL_REFLECTION_MAP_ARB +

+ + +

otypedef __int64 Timer_t +

+ + +

otypedef unsigned long long Timer_t +

+ + +

otypedef double Timer_t +

+ + +

otypedef std::clock_t Timer_t +

+ + +

oinline std::ostream& operator << (std::ostream& output, const Vec3& vec) +

+ + +

oconst Vec3 X_AXIS(1.0f, 0.0f, 0.0f) +

+ + +

oconst Vec3 Y_AXIS(0.0f, 1.0f, 0.0f) +

+ + +

oconst Vec3 Z_AXIS(0.0f, 0.0f, 1.0f) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/osgGetLibraryName.html b/doc/doc++/osg/osgGetLibraryName.html new file mode 100644 index 000000000..ff95206eb --- /dev/null +++ b/doc/doc++/osg/osgGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern SG_EXPORT const char* osgGetLibraryName + + + + +

extern SG_EXPORT const char* osgGetLibraryName

()

osgGetLibraryName() returns the library name in human friendly form
+ + +
+

Documentation

+
+osgGetLibraryName() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/osgGetVersion.html b/doc/doc++/osg/osgGetVersion.html new file mode 100644 index 000000000..4e0aab93f --- /dev/null +++ b/doc/doc++/osg/osgGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern SG_EXPORT const char* osgGetVersion + + + + +

extern SG_EXPORT const char* osgGetVersion

()

osgGetVersion() returns the library version number.
+ + +
+

Documentation

+
+osgGetVersion() returns the library version number. +Numbering convention : OpenSceneGraph-0.8-31 will return 0.8.31 from osgGetVersion. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) library +# +AC_CHECK_LIB(osg, osgGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/osgUtx.html b/doc/doc++/osg/osgUtx.html new file mode 100644 index 000000000..a5d317758 --- /dev/null +++ b/doc/doc++/osg/osgUtx.html @@ -0,0 +1,73 @@ + + + + + namespace osgUtx + + + + +

namespace osgUtx

+
+

+
+class SG_EXPORT Test: public osg::Referenced +
Test, an abstract base class, is the Composite pattern's \em component class for our graph of test cases, and defines the basic interface for all Test components. +
+class SG_EXPORT TestContext +
TestContext wraps up information which is passed to tests as they are run, and may contain test-specific information or 'global' test objects, such as an output stream for verbose output during the running of tests. +
+class TestVisitor +
Visits while maintaining the current hierarchical context. +
+class TestCase: public Test +
TestCase, is the supplies the interface for a Composite pattern's \em leaf class, though it is not a leaf in itself +
+class TestX +
Base class catchable for the exception's which may be thrown to indicate problems during the run of a TestCase +
+class TestFailureX: public TestX +
A TestFailureX indicates a failure in the tested component +
+class TestErrorX: public TestX +
A TestErrorX indicates an error while testing a component, which prevents the test from being run; it does not indicate a problem with the component, but rather a problem during the run which prevents the component from being tested +
+template< typename FixtureT > class TestCase_: public TestCase +
TestCase_ is a class template for a leaf TestCase, which allows TestFixture classes to be easily collected into the tree of tests, and have their public test methods called. +
+class SG_EXPORT TestSuite: public Test +
A TestSuite is the \em composite component of the Composite pattern, and allows aggregation of Tests into hierarchies +
+class SG_EXPORT TestGraph +
TestGraph is a singleton providing central access to the tree of tests; primarily, it provides access to the root suite +
+class SG_EXPORT TestQualifier: public TestVisitor +
Maintains a string that when accessed in the "visit" member, returns the current qualified TestSuite path +
+class SG_EXPORT QualifiedTestPrinter: public TestQualifier +
QualifiedTestPrinter prints to standard output a list of fully qualified tests +
+class SG_EXPORT TestRecord +
A TestRecord records the output of a given test case, ie. +
+class SG_EXPORT TestReport +
A TestReport represents the complete set of results (TestRecords) for a given test run. +
+class SG_EXPORT TestRunner: public TestQualifier +
A TestRunner is a visitor which will run specified tests as it traverses the test graph. +
+struct TestSuiteAutoRegistrationAgent +
A helper struct to perform automatic registration at program startup; not for direct use, it should be used via the following macros. +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/ref_ptr.html b/doc/doc++/osg/ref_ptr.html new file mode 100644 index 000000000..8d57db3fa --- /dev/null +++ b/doc/doc++/osg/ref_ptr.html @@ -0,0 +1,181 @@ + + + + + template<class T> class osg::ref_ptr + + + + +

template<class T> class osg::ref_ptr

Smart pointer for handling referenced counted objects
+
+ +
+

+

Public Methods

+[more] ref_ptr() +
+[more] ref_ptr(T* t) +
+[more] ref_ptr(const ref_ptr& rp) +
+[more] ~ref_ptr() +
+[more]inline ref_ptr& operator = (const ref_ptr& rp) +
+[more]inline ref_ptr& operator = (T* ptr) +
+[more]inline bool operator == (const ref_ptr& rp) const +
+[more]inline bool operator != (const ref_ptr& rp) const +
+[more]inline bool operator < (const ref_ptr& rp) const +
+[more]inline bool operator > (const ref_ptr& rp) const +
+[more]inline bool operator == (const T* ptr) const +
+[more]inline bool operator != (const T* ptr) const +
+[more]inline bool operator < (const T* ptr) const +
+[more]inline bool operator > (const T* ptr) const +
+[more]inline T& operator*() +
+[more]inline const T& operator*() const +
+[more]inline T* operator->() +
+[more]inline const T* operator->() const +
+[more]inline bool operator!() const +
+[more]inline bool valid() const +
+[more]inline T* get() +
+[more]inline const T* get() const +
+[more]inline T* take() +
take control over the object pointed to by ref_ptr, unreference but do not delete even if ref count goes to 0, return the pointer to the object. +
+[more]inline T* release() +

+ +
+ + +
+

Documentation

+
Smart pointer for handling referenced counted objects
+
+ + + +
o ref_ptr() +

+ + +

o ref_ptr(T* t) +

+ + +

o ref_ptr(const ref_ptr& rp) +

+ + +

o ~ref_ptr() +

+ + +

oinline ref_ptr& operator = (const ref_ptr& rp) +

+ + +

oinline ref_ptr& operator = (T* ptr) +

+ + +

oinline bool operator == (const ref_ptr& rp) const +

+ + +

oinline bool operator != (const ref_ptr& rp) const +

+ + +

oinline bool operator < (const ref_ptr& rp) const +

+ + +

oinline bool operator > (const ref_ptr& rp) const +

+ + +

oinline bool operator == (const T* ptr) const +

+ + +

oinline bool operator != (const T* ptr) const +

+ + +

oinline bool operator < (const T* ptr) const +

+ + +

oinline bool operator > (const T* ptr) const +

+ + +

oinline T& operator*() +

+ + +

oinline const T& operator*() const +

+ + +

oinline T* operator->() +

+ + +

oinline const T* operator->() const +

+ + +

oinline bool operator!() const +

+ + +

oinline bool valid() const +

+ + +

oinline T* get() +

+ + +

oinline const T* get() const +

+ + +

oinline T* take() +
take control over the object pointed to by ref_ptr, unreference but do not delete even if ref count goes to 0, +return the pointer to the object. +Note, do not use this unless you are 100% sure your code handles the deletion of the object correctly, and +only use when absolutely required. +

+ + +

oinline T* release() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/setNotifyLevel.html b/doc/doc++/osg/setNotifyLevel.html new file mode 100644 index 000000000..b39a16889 --- /dev/null +++ b/doc/doc++/osg/setNotifyLevel.html @@ -0,0 +1,21 @@ + + + + + extern SG_EXPORT void osg::setNotifyLevel + + + + +

extern SG_EXPORT void osg::setNotifyLevel

(NotifySeverity severity)

set the notify level, overriding the default or value set by the environmental variable OSGNOTIFYLEVEL
+ + +
+

Documentation

+
set the notify level, overriding the default or value set by +the environmental variable OSGNOTIFYLEVEL
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/xternSG_EXPORTNotifySeverityg_NotifyLevel.html b/doc/doc++/osg/xternSG_EXPORTNotifySeverityg_NotifyLevel.html new file mode 100644 index 000000000..8f93dbe16 --- /dev/null +++ b/doc/doc++/osg/xternSG_EXPORTNotifySeverityg_NotifyLevel.html @@ -0,0 +1,16 @@ + + + + + osg::xtern SG_EXPORT NotifySeverity g_NotifyLevel; + + + + +

osg::xtern SG_EXPORT NotifySeverity g_NotifyLevel;

+
xtern SG_EXPORT NotifySeverity g_NotifyLevel;
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/xternSG_EXPORTboolg_NotifyInit.html b/doc/doc++/osg/xternSG_EXPORTboolg_NotifyInit.html new file mode 100644 index 000000000..af3756ba7 --- /dev/null +++ b/doc/doc++/osg/xternSG_EXPORTboolg_NotifyInit.html @@ -0,0 +1,16 @@ + + + + + osg::xtern SG_EXPORT bool g_NotifyInit; + + + + +

osg::xtern SG_EXPORT bool g_NotifyInit;

+
xtern SG_EXPORT bool g_NotifyInit;
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osg/xternSG_EXPORTstdauto_ptrstdofstreamg_NotifyNulStream.html b/doc/doc++/osg/xternSG_EXPORTstdauto_ptrstdofstreamg_NotifyNulStream.html new file mode 100644 index 000000000..2001c9ecd --- /dev/null +++ b/doc/doc++/osg/xternSG_EXPORTstdauto_ptrstdofstreamg_NotifyNulStream.html @@ -0,0 +1,16 @@ + + + + + osg::xtern SG_EXPORT std::auto_ptr<std::ofstream> g_NotifyNulStream; + + + + +

osg::xtern SG_EXPORT std::auto_ptr g_NotifyNulStream;

+
xtern SG_EXPORT std::auto_ptr g_NotifyNulStream;
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/ClassGraph.class b/doc/doc++/osgDB/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..c6a7b6c79eefb07545a0b85e767db0a34067477d GIT binary patch literal 1237 zcma)6*-{fh6g@+hnS_afK|w^^#V{;!Ux zT+h!a)b2v}DxTm%X4(`QsclfhP)G8~Xw_zCWBVEWk6WrC% z+sJ92m^PjDN?b#NZYz*X$O3b#R&t&NRAdse&V07V8-1gWC{c{gs#ZqSPrp^7-UQnZ z?KrFRIdy|VGDj%h1IMLHu6NL0Y^2g$ccS9+UGDq5ly|-mxv0;BhLH$3@hyHT`(9Ph z8e-%(i$Uk6j})Y#zB-aUWUpeHWQM#$#1J9v+E%27i#gj0lUlW{9#U(z6(uzjwyhB9 zZ@6IpLUKD)hgHKU*~a$7aCmacu3?aVLv;-Nz_4w9$8Zhjw_3)f8b&DB+_tnj`fIrS bmF6i%^l#B((N9`2jM#PbwZroS^x)|~2>C-7 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgDB/ClassGraphPanel.class b/doc/doc++/osgDB/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..94b21b47a2a4b19b981fbe8827197a5d71dffc7a GIT binary patch literal 4084 zcmbtWX>eOt75<*}q^IS@c9f{CsBM;#)Rq&Qlwuk?DI`uC3{KL!~;QmGKkLv@kkI~3F3P}{5*)?2JsgIA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR44!k~$D@F9+4PkU* zJdAGa3u7bphtQ4#B5nyGid)0jfP*rf5OJGC91`ttnBqtnSK#(Ax-coWDG^7-<&7c4 z@Ftla3*$w2vuH_)utH2eEfJ|Ou0~qmZHbtX)mag90-BLpj?3x^an6dEm(`p= zv^zq$3I!2G6Zd0T#Ct@%PsIC8d=~F8@i{zf;`1WPc+kWbuxR3oIAh{VIA!9?a7;Xk z(I?{#OhTeL4qxo#UFe27OlXZR}pR;q$NW+(m z=Bq~ek~+lRg0(Q0Nfi~!Rjn4>w2cXBF=Jzw)-2Ur-GDQ0-I*^r`>dQbYrD0^yjAt3 z2d0mc%8@>jbZw*Eqp^{cv7BQIMr+U3l{hUhFZH~9i?y(jwVlCTY8cJ4qGe~q4bRbj z=-{{_a`*G5t$MjJE#ao7T*|NUK$=4u`$M?awrB|K$mBB4jhu{X2#;p1Vo~jphK~AV zK)Slga*LI-vl=4G$K59l`e;6FYgosRE3(C%!&bJ$xwePMH!Y{^1&7C>NCVG`HcrR! zhH&mpr}t$%J#Kqyh+fLChW7D%%E}(L3K?rUYZI_zzqOc|wVZrmcgb<`Il>=g&WU`f zkg{*iWTgmpN!w8-jvlRNalM&&gJ*1Hh%v`_2(5HlgWsBQ>;l=EwrBDM!uhAOR_cTp z@}*pwB^c8xGc`Sx$~mMa#TDna{0ZIygd&J9ogsvt&M&dRkPN#Dh5V9+V7g!}jc0Pi z4cK>-tSkfkGnqn>Fxnh>nzM@gn6?TQn6oppb6gB$a%mn`B4lc8chqj6Di`fFi(-`& zG#I?2-E7P`7OP>gb^Z7;YM<~Zrs(`p93uJ|4ht%lqmqze#L3X3Mmqpw0Xbw@W9gQLjVQ8^5T~xO` zyRo#uwka)mfqJPR`)(}Cp*b+an%NotrA%6C(paE&H^7(lO3DcT`6NeMwq8j-es*&%d8u^l`k&h@xga7yAy~O<}!JmQ2mmS*0#2Q|b=#1^rK8{VMvZdewk#v>ee53f^prM4$lu$liVZikpAINPKwVFp(% z*DFhimh-r|f>#~ThCAZz6>NV98!w=HG9HMxui={EjxzKkzM)RKE7QRp{_N0teJC0?qiq!oK8S#CC`yMuNqGUClks)&j<`S88H>i&)22!pSi{RE5|i}M zldG(rA9~&CXQK%QbWE<{#Z#*os^GQ0p-34wBm^xMVd9q`@zl;9L5f8NIBZr++x^+( zTrASrGgraL$%qz29MM9!OU8YB+zDwF+mKkU5n-*^r%jb9VkFd*N`& z?uPVtN%rP&{_1nXeGjnjLxAr-vb2r=eLm8=YXz@N>$0JK-%z0JOULzCAQsS*(tU?Qx*F@L(I3otzg;z8wi+Gp1NWR3pHH`(pY=$mj|l6tys zywNjy_)^TCa@$i(&ju%HQ+3#;-1JvlSgq~9%2{qZ#soYsOmL{bt6I%vCy-(#p_IV- zbu|-;DtL9dt&P|`nZ(|Inb=K>u+XoW14HSa-L+fR6(g17#U zngzLmo2{2{gTFElZv%2OcbRz_zp(+k+Dr|m7U`ClE}+uQ*ExA^8>@ZeZO~XfZEF6% zw67bu^JJhc7KpPEw(IFL|2pMf5gLAqcY0@h5dr=I$NSIW+6rFd8`8_Tl~oL_;0Ax% zcOJvM?{>y?N;xLda+_m1Px4M`eM;*c_Q(Az7!&cj2nih82>HF?q-+mL1DoFse%e^QYffI4N#SGSZ!&wS_MV3O}6RQWH)X$EyY{w zecz&Z;B=;=pVVmsBQuVl^)K+B5ufMXBu$0P>~p`*{l59@-{1d01bc8X23tizg`;9d z#j`42Qt`5iS5&;J;x!cuDqdIdhKe^;yrtr874PV1$L%^|xI;%L4lqbFxKo3MyL3cx zw+P>yBgt;Cs{VCqXT2?`5_JK@i2pN15-G~;0%MDfhsHplLltt8kj@Yz*#(EV4m4? zs2F$-rwu&M)C(+o5fcX9W9oedAK);2HQ7PaF6Qj~e)#V|>Yquh{rJ zgRdEUgU1bAVCq{uVcUs8^>}l1wf#tZif3PK7Ye8GCZ%l6b>Kc*8=;Vx@3mQ&ZGCNY8nj-K2 zGp|=$k9j?Fv(LYSt0rVo z@V&WVdx|v5wCxn8nQ+AJQVz{EZ#rEotnW{&u(>~!PxE+q8R+UXC1GhJmTMJkpE}f3 zh#Nw8NeI?YN)=zQ!T1>ttxt{>#7y{^Uz84Q>um=M+n3RBI#%%xs0vT zX*rTsmN1brl^V8Z)VNy1?o5o)&Wskx& zph%{YxOnyFB*nXdLhYb0l?`J?uON1+Zy7hymn6?w!h7l4LXNVRu<;j4mVfk@RWD(d z+N+XehO<8$8Cb%ZRDu%z6LKaRk8;j(Ji3fNIWAMS93~shGb&!j&DpfV%EWn?rb5CU zi`bSl6>9bpx`ZUP2u(;*3lS-?{o>WdMu$IYwy}!_#vN9;q+MZ-65eg(C?%-P>uEL{ zM9K9;snJW=oiZs!ku2rM$trP$`j()mf*4qcN@kS8{u4>dOZYowl9jM0L$;^6P+78Q z-;ZdIt0B39eQ`yo7XF)mWhr!`Z%040*vm{02*i<;0KkC}q*6CIis4)QD5 zzXUTLW1~J(3r9sl3P3a7Z-x;$gG62~W^1_RH{5y!ou^FsGWsuJQs_8(Zl|D6Z9j5;Sf~rkj literal 0 HcmV?d00001 diff --git a/doc/doc++/osgDB/DirectoryContents.html b/doc/doc++/osgDB/DirectoryContents.html new file mode 100644 index 000000000..17d46da6b --- /dev/null +++ b/doc/doc++/osgDB/DirectoryContents.html @@ -0,0 +1,20 @@ + + + + + typedef std::vector<std::string> osgDB::DirectoryContents + + + + +

typedef std::vector<std::string> osgDB::DirectoryContents

simple list of names to represent a directory's contents.
+ + +
+

Documentation

+
simple list of names to represent a directory's contents.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/DotOsgWrapper.html b/doc/doc++/osgDB/DotOsgWrapper.html new file mode 100644 index 000000000..6914243bc --- /dev/null +++ b/doc/doc++/osgDB/DotOsgWrapper.html @@ -0,0 +1,188 @@ + + + + + class OSGDB_EXPORT osgDB::DotOsgWrapper + + + + +

class OSGDB_EXPORT osgDB::DotOsgWrapper

Wrapper class for specifying read and write functions for extending the osg file format.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]typedef bool (*ReadFunc)(osg::Object&, osgDB::Input&) +
+[more]typedef bool (*WriteFunc)(const osg::Object&, osgDB::Output&) +
+[more] DotOsgWrapper(osg::Object* proto, const std::string& name, const std::string& associates, ReadFunc readFunc, WriteFunc writeFunc, ReadWriteMode readWriteMode=READ_AND_WRITE) +
+[more]inline const osg::Object* getPrototype() const +
+[more]inline const std::string& getName() const +
+[more]inline const Associates& getAssociates() const +
+[more]inline ReadFunc getReadFunc() const +
+[more]inline WriteFunc getWriteFunc() const +
+[more]inline ReadWriteMode getReadWriteMode() const +

+ +

+

Public Members

+[more]typedef std::vector<std::string> Associates +
+[more]enum ReadWriteMode +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::Object> _prototype +
+[more]std::string _name +
+[more]Associates _associates +
+[more]ReadFunc _readFunc +
+[more]WriteFunc _writeFunc +
+[more]ReadWriteMode _readWriteMode +

+ +

+

Protected Methods

+[more] DotOsgWrapper() +
protected to prevent inappropriate creation of wrappers +
+[more] DotOsgWrapper(DotOsgWrapper&) +
protected to prevent inappropriate creation of wrappers +
+[more]virtual ~DotOsgWrapper() +
protected to prevent wrapper being created on stack +

+ +
+ + +
+

Documentation

+
Wrapper class for specifying read and write functions for extending +the osg file format.
+
+ + + +
otypedef std::vector<std::string> Associates +

+ + +

otypedef bool (*ReadFunc)(osg::Object&, osgDB::Input&) +

+ + +

otypedef bool (*WriteFunc)(const osg::Object&, osgDB::Output&) +

+ + +

oenum ReadWriteMode +

+ + + +
o READ_AND_WRITE +

+ + +

o READ_ONLY +

+ + + +
o DotOsgWrapper(osg::Object* proto, const std::string& name, const std::string& associates, ReadFunc readFunc, WriteFunc writeFunc, ReadWriteMode readWriteMode=READ_AND_WRITE) +

+ + +

oinline const osg::Object* getPrototype() const +

+ + +

oinline const std::string& getName() const +

+ + +

oinline const Associates& getAssociates() const +

+ + +

oinline ReadFunc getReadFunc() const +

+ + +

oinline WriteFunc getWriteFunc() const +

+ + +

oinline ReadWriteMode getReadWriteMode() const +

+ + +

o DotOsgWrapper() +
protected to prevent inappropriate creation of wrappers +

+ + +

o DotOsgWrapper(DotOsgWrapper&) +
protected to prevent inappropriate creation of wrappers +

+ + +

ovirtual ~DotOsgWrapper() +
protected to prevent wrapper being created on stack +

+ + +

oosg::ref_ptr<osg::Object> _prototype +

+ + +

ostd::string _name +

+ + +

oAssociates _associates +

+ + +

oReadFunc _readFunc +

+ + +

oWriteFunc _writeFunc +

+ + +

oReadWriteMode _readWriteMode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/DynamicLibrary.html b/doc/doc++/osgDB/DynamicLibrary.html new file mode 100644 index 000000000..922d10115 --- /dev/null +++ b/doc/doc++/osgDB/DynamicLibrary.html @@ -0,0 +1,171 @@ + + + + + class OSGDB_EXPORT osgDB::DynamicLibrary + + + + +

class OSGDB_EXPORT osgDB::DynamicLibrary

DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]static DynamicLibrary* loadLibrary(const std::string& libraryName) +
returns a pointer to a DynamicLibrary object on successfully opening of library returns NULL on failure +
+[more]const std::string& getName() const +
return name of library stripped of path +
+[more]const std::string& getFullName() const +
return name of library including full path to it +
+[more]HANDLE getHandle() const +
return handle to dso/dll dynamic library itself +
+[more]PROC_ADDRESS getProcAddress(const std::string& procName) +
return address of function located in library +

+ +

+

Public Members

+[more]typedef void* HANDLE +
+[more]typedef void* PROC_ADDRESS +

+ +

+

Protected Fields

+[more]HANDLE _handle +
+[more]std::string _name +
+[more]std::string _fullName +

+ +

+

Protected Methods

+[more]static HANDLE getLibraryHandle( const std::string& libraryName) +
get handle to library file +
+[more] DynamicLibrary() +
disallow default constructor +
+[more] DynamicLibrary(const DynamicLibrary&) +
disallow copy constructor +
+[more]DynamicLibrary& operator == (const DynamicLibrary&) +
disallow copy operator +
+[more] DynamicLibrary(const std::string& name, HANDLE handle) +
Disallow public construction so that users have to go through loadLibrary() above which returns NULL on failure, a valid DynamicLibrary object on success +
+[more] ~DynamicLibrary() +

+ +
+ + +
+

Documentation

+
DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, +typically used for loading ReaderWriter plug-ins
+
+ + + +
otypedef void* HANDLE +

+ + +

otypedef void* PROC_ADDRESS +

+ + +

ostatic DynamicLibrary* loadLibrary(const std::string& libraryName) +
returns a pointer to a DynamicLibrary object on successfully +opening of library returns NULL on failure +

+ + +

oconst std::string& getName() const +
return name of library stripped of path +

+ + +

oconst std::string& getFullName() const +
return name of library including full path to it +

+ + +

oHANDLE getHandle() const +
return handle to dso/dll dynamic library itself +

+ + +

oPROC_ADDRESS getProcAddress(const std::string& procName) +
return address of function located in library +

+ + +

ostatic HANDLE getLibraryHandle( const std::string& libraryName) +
get handle to library file +

+ + +

o DynamicLibrary() +
disallow default constructor +

+ + +

o DynamicLibrary(const DynamicLibrary&) +
disallow copy constructor +

+ + +

oDynamicLibrary& operator == (const DynamicLibrary&) +
disallow copy operator +

+ + +

o DynamicLibrary(const std::string& name, HANDLE handle) +
Disallow public construction so that users have to go +through loadLibrary() above which returns NULL on +failure, a valid DynamicLibrary object on success +

+ + +

o ~DynamicLibrary() +

+ + +

oHANDLE _handle +

+ + +

ostd::string _name +

+ + +

ostd::string _fullName +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/Field.html b/doc/doc++/osgDB/Field.html new file mode 100644 index 000000000..80e2e6d7c --- /dev/null +++ b/doc/doc++/osgDB/Field.html @@ -0,0 +1,367 @@ + + + + + class OSGDB_EXPORT osgDB::Field + + + + +

class OSGDB_EXPORT osgDB::Field

+ +
+

+

Public Methods

+[more] Field() +
+[more] Field(const Field& field) +
+[more]virtual ~Field() +
+[more]virtual Field& operator = (const Field& ic) +
+[more]void reset() +
+[more]void addChar(char c) +
+[more]int getNoCharacters() const +
+[more]void setWithinQuotes(bool withinQuotes=true) +
+[more]bool getWithinQuotes() +
+[more]void setNoNestedBrackets(int no) +
+[more]int getNoNestedBrackets() +
+[more]FieldType getFieldType() const +
+[more]bool isValid() const +
+[more]bool isOpenBracket() const +
+[more]bool isCloseBracket() const +
+[more]bool isWord() const +
+[more]bool matchWord(const char* str) const +
+[more]bool matchWord(const char* str, int noCharacters) const +
+[more]bool isString() const +
+[more]bool matchString(const char* str) const +
+[more]bool matchString(const char* str, int noCharacters) const +
+[more]bool isQuotedString() const +
+[more]const char* getStr() const +
+[more]char* takeStr() +
+[more]bool isInt() const +
+[more]bool matchInt(int i) const +
+[more]bool getInt(int& i) const +
+[more]bool isUInt() const +
+[more]bool matchUInt(unsigned int i) const +
+[more]bool getUInt(unsigned int& i) const +
+[more]bool isFloat() const +
+[more]bool matchFloat(float f) const +
+[more]bool getFloat(float& f) const +
+[more]bool isDouble() const +
+[more]bool matchDouble(double f) const +
+[more]bool getDouble(double& d) const +
+[more]static FieldType calculateFieldType(const char* str, bool withinQuotes=false) +

+ +

+

Public Members

+[more]enum +
+[more]enum FieldType +

+ +

+

Protected Fields

+[more]int _fieldCacheCapacity +
+[more]int _fieldCacheSize +
+[more]char* _fieldCache +
+[more]mutable FieldType _fieldType +
+[more]bool _withinQuotes +
+[more]int _noNestedBrackets +

+ +

+

Protected Methods

+[more]void _init() +
+[more]void _free() +
+[more]void _copy(const Field& ic) +

+ +
+ + +
+

Documentation

+
+ + + +
oenum +

+ + + +
o MIN_CACHE_SIZE +

+ + + +
o Field() +

+ + +

o Field(const Field& field) +

+ + +

ovirtual ~Field() +

+ + +

ovirtual Field& operator = (const Field& ic) +

+ + +

ovoid reset() +

+ + +

ovoid addChar(char c) +

+ + +

oint getNoCharacters() const +

+ + +

ovoid setWithinQuotes(bool withinQuotes=true) +

+ + +

obool getWithinQuotes() +

+ + +

ovoid setNoNestedBrackets(int no) +

+ + +

oint getNoNestedBrackets() +

+ + +

oenum FieldType +

+ + + +
o OPEN_BRACKET +

+ + +

o CLOSE_BRACKET +

+ + +

o STRING +

+ + +

o WORD +

+ + +

o REAL +

+ + +

o INTEGER +

+ + +

o BLANK +

+ + +

o UNINITIALISED +

+ + + +
oFieldType getFieldType() const +

+ + +

obool isValid() const +

+ + +

obool isOpenBracket() const +

+ + +

obool isCloseBracket() const +

+ + +

obool isWord() const +

+ + +

obool matchWord(const char* str) const +

+ + +

obool matchWord(const char* str, int noCharacters) const +

+ + +

obool isString() const +

+ + +

obool matchString(const char* str) const +

+ + +

obool matchString(const char* str, int noCharacters) const +

+ + +

obool isQuotedString() const +

+ + +

oconst char* getStr() const +

+ + +

ochar* takeStr() +

+ + +

obool isInt() const +

+ + +

obool matchInt(int i) const +

+ + +

obool getInt(int& i) const +

+ + +

obool isUInt() const +

+ + +

obool matchUInt(unsigned int i) const +

+ + +

obool getUInt(unsigned int& i) const +

+ + +

obool isFloat() const +

+ + +

obool matchFloat(float f) const +

+ + +

obool getFloat(float& f) const +

+ + +

obool isDouble() const +

+ + +

obool matchDouble(double f) const +

+ + +

obool getDouble(double& d) const +

+ + +

ostatic FieldType calculateFieldType(const char* str, bool withinQuotes=false) +

+ + +

ovoid _init() +

+ + +

ovoid _free() +

+ + +

ovoid _copy(const Field& ic) +

+ + +

oint _fieldCacheCapacity +

+ + +

oint _fieldCacheSize +

+ + +

ochar* _fieldCache +

+ + +

omutable FieldType _fieldType +

+ + +

obool _withinQuotes +

+ + +

oint _noNestedBrackets +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/FieldReader.html b/doc/doc++/osgDB/FieldReader.html new file mode 100644 index 000000000..ac12532ef --- /dev/null +++ b/doc/doc++/osgDB/FieldReader.html @@ -0,0 +1,92 @@ + + + + + class OSGDB_EXPORT osgDB::FieldReader + + + + +

class OSGDB_EXPORT osgDB::FieldReader

+ +
+

+

Public Methods

+[more] FieldReader() +
+[more] FieldReader(const FieldReader& ic) +
+[more]virtual ~FieldReader() +
+[more]virtual FieldReader& operator = (const FieldReader& ic) +
+[more]void attach(std::istream* input) +
+[more]void detach() +
+[more]virtual bool eof() const +
+[more]bool readField(Field& fieldPtr) +
+[more]void ignoreField() +
+[more]int getNoNestedBrackets() const +
no of unmatched `{' encountered so far in file +

+ +
+ + +
+

Documentation

+
+ + + +
o FieldReader() +

+ + +

o FieldReader(const FieldReader& ic) +

+ + +

ovirtual ~FieldReader() +

+ + +

ovirtual FieldReader& operator = (const FieldReader& ic) +

+ + +

ovoid attach(std::istream* input) +

+ + +

ovoid detach() +

+ + +

ovirtual bool eof() const +

+ + +

obool readField(Field& fieldPtr) +

+ + +

ovoid ignoreField() +

+ + +

oint getNoNestedBrackets() const +
no of unmatched `{' encountered so far in file +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/FieldReaderIterator.html b/doc/doc++/osgDB/FieldReaderIterator.html new file mode 100644 index 000000000..bdc935434 --- /dev/null +++ b/doc/doc++/osgDB/FieldReaderIterator.html @@ -0,0 +1,252 @@ + + + + + class OSGDB_EXPORT osgDB::FieldReaderIterator + + + + +

class OSGDB_EXPORT osgDB::FieldReaderIterator

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FieldReaderIterator() +
+[more] FieldReaderIterator(const FieldReaderIterator& ic) +
+[more]virtual ~FieldReaderIterator() +
+[more]FieldReaderIterator& operator = (const FieldReaderIterator& ic) +
+[more]void attach(std::istream* input) +
+[more]void detach() +
+[more]virtual bool eof() const +
+[more]FieldReader& getFieldReader() +
+[more]void insert(int pos, Field* field) +
+[more]void insert(int pos, const char* str) +
+[more]Field& operator [] (int pos) +
+[more]Field& field(int pos) +
+[more]FieldReaderIterator& operator ++ () +
+[more]FieldReaderIterator& operator += (int no) +
+[more]void advanceOverCurrentFieldOrBlock() +
increments the iterator of the next simple field or whole block if the current field[0] is an open bracket +
+[more]void advanceToEndOfCurrentBlock() +
+[more]void advanceToEndOfBlock(int noNestBrackets) +
+[more]bool matchSequence(const char* str) +
+[more]bool readSequence(const char* keyword, std::string& value) +
+[more]bool readSequence(const char* keyword, unsigned int& value) +
+[more]bool readSequence(const char* keyword, int& value) +
+[more]bool readSequence(const char* keyword, float& value) +
+[more]bool readSequence(const char* keyword, osg::Vec2& value) +
+[more]bool readSequence(const char* keyword, osg::Vec3& value) +
+[more]bool readSequence(const char* keyword, osg::Vec4& value) +
+[more]bool readSequence(std::string& value) +
+[more]bool readSequence(unsigned int& value) +
+[more]bool readSequence(int& value) +
+[more]bool readSequence(float& value) +
+[more]bool readSequence(osg::Vec2& value) +
+[more]bool readSequence(osg::Vec3& value) +
+[more]bool readSequence(osg::Vec4& value) +

+ +

+

Public Members

+[more]enum +

+ +
+ + +
+

Documentation

+
+ + + +
oenum +

+ + + +
o MINIMUM_FIELD_READER_QUEUE_SIZE +

+ + + +
o FieldReaderIterator() +

+ + +

o FieldReaderIterator(const FieldReaderIterator& ic) +

+ + +

ovirtual ~FieldReaderIterator() +

+ + +

oFieldReaderIterator& operator = (const FieldReaderIterator& ic) +

+ + +

ovoid attach(std::istream* input) +

+ + +

ovoid detach() +

+ + +

ovirtual bool eof() const +

+ + +

oFieldReader& getFieldReader() +

+ + +

ovoid insert(int pos, Field* field) +

+ + +

ovoid insert(int pos, const char* str) +

+ + +

oField& operator [] (int pos) +

+ + +

oField& field(int pos) +

+ + +

oFieldReaderIterator& operator ++ () +

+ + +

oFieldReaderIterator& operator += (int no) +

+ + +

ovoid advanceOverCurrentFieldOrBlock() +
increments the iterator of the next simple field or +whole block if the current field[0] is an open bracket +

+ + +

ovoid advanceToEndOfCurrentBlock() +

+ + +

ovoid advanceToEndOfBlock(int noNestBrackets) +

+ + +

obool matchSequence(const char* str) +

+ + +

obool readSequence(const char* keyword, std::string& value) +

+ + +

obool readSequence(const char* keyword, unsigned int& value) +

+ + +

obool readSequence(const char* keyword, int& value) +

+ + +

obool readSequence(const char* keyword, float& value) +

+ + +

obool readSequence(const char* keyword, osg::Vec2& value) +

+ + +

obool readSequence(const char* keyword, osg::Vec3& value) +

+ + +

obool readSequence(const char* keyword, osg::Vec4& value) +

+ + +

obool readSequence(std::string& value) +

+ + +

obool readSequence(unsigned int& value) +

+ + +

obool readSequence(int& value) +

+ + +

obool readSequence(float& value) +

+ + +

obool readSequence(osg::Vec2& value) +

+ + +

obool readSequence(osg::Vec3& value) +

+ + +

obool readSequence(osg::Vec4& value) +

+
+
Direct child classes: +
Input
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/FilePathList.html b/doc/doc++/osgDB/FilePathList.html new file mode 100644 index 000000000..fff37d6ca --- /dev/null +++ b/doc/doc++/osgDB/FilePathList.html @@ -0,0 +1,20 @@ + + + + + typedef std::deque<std::string> osgDB::FilePathList + + + + +

typedef std::deque<std::string> osgDB::FilePathList

list of directories to search through which searching for files.
+ + +
+

Documentation

+
list of directories to search through which searching for files.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/General.html b/doc/doc++/osgDB/General.html new file mode 100644 index 000000000..870a5d43e --- /dev/null +++ b/doc/doc++/osgDB/General.html @@ -0,0 +1,73 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGDB_DOTOSGWRAPPER
+ +o#define +OSG_DYNAMICLIBRARY
+ +o#define +OSGDB_EXPORT_
+ +o#define +OSGDB_EXPORT(dllexport)
+ +o#define +OSGDB_EXPORT(dllimport)
+ +o#define +OSGDB_EXPORT
+ +o#define +OSGDB_FIELD
+ +o#define +OSGDB_FIELDREADER
+ +o#define +OSGDB_FIELDREADERITERATOR
+ +o#define +OSGDB_FILENAMEUTILS
+ +o#define +OSGDB_FILEUTILS
+ +o#define +OSGDB_INPUT
+ +o#define +OSGDB_OUTPUT
+ +o#define +OSGDB_PARAMETEROUTPUT
+ +o#define +OSGDB_READFILE
+ +o#define +OSGDB_READERWRITER
+ +o#define +OSGDB_REGISTRY
+ +o#define +OSG_VERSION
+ +o#define +OSGDB_WRITEFILE
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/HIER.html b/doc/doc++/osgDB/HIER.html new file mode 100644 index 000000000..ff9fb81f3 --- /dev/null +++ b/doc/doc++/osgDB/HIER.html @@ -0,0 +1,34 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/HIERjava.html b/doc/doc++/osgDB/HIERjava.html new file mode 100644 index 000000000..7f023ef50 --- /dev/null +++ b/doc/doc++/osgDB/HIERjava.html @@ -0,0 +1,121 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/Input.html b/doc/doc++/osgDB/Input.html new file mode 100644 index 000000000..32945ce48 --- /dev/null +++ b/doc/doc++/osgDB/Input.html @@ -0,0 +1,189 @@ + + + + + class OSGDB_EXPORT osgDB::Input + + + + +

class OSGDB_EXPORT osgDB::Input

Class for managing the reading of ASCII osg files
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Input() +
+[more]virtual ~Input() +
+[more]virtual osg::Object* readObjectOfType(const osg::Object& compObj) +
+[more]virtual osg::Object* readObject() +
+[more]virtual osg::Image* readImage() +
+[more]virtual osg::Drawable* readDrawable() +
+[more]virtual osg::StateAttribute* readStateAttribute() +
+[more]virtual osg::Node* readNode() +
+[more]virtual osg::Object* readObject(const std::string& fileName) +
+[more]virtual osg::Image* readImage(const std::string& fileName) +
+[more]virtual osg::Node* readNode(const std::string& fileName) +
+[more]virtual osg::Object* getObjectForUniqueID(const std::string& uniqueID) +
+[more]virtual void regisiterUniqueIDForObject(const std::string& uniqueID, osg::Object* obj) +

+ +
+

Inherited from FieldReaderIterator:

+
+

+

Public Methods

+oFieldReaderIterator& operator = (const FieldReaderIterator& ic) +
+ovoid attach(std::istream* input) +
+ovoid detach() +
+ovirtual bool eof() const +
+oFieldReader& getFieldReader() +
+ovoid insert(int pos, Field* field) +
+ovoid insert(int pos, const char* str) +
+oField& operator [] (int pos) +
+oField& field(int pos) +
+oFieldReaderIterator& operator ++ () +
+oFieldReaderIterator& operator += (int no) +
+ovoid advanceOverCurrentFieldOrBlock() +
+ovoid advanceToEndOfCurrentBlock() +
+ovoid advanceToEndOfBlock(int noNestBrackets) +
+obool matchSequence(const char* str) +
+obool readSequence(const char* keyword, std::string& value) +
+obool readSequence(const char* keyword, unsigned int& value) +
+obool readSequence(const char* keyword, int& value) +
+obool readSequence(const char* keyword, float& value) +
+obool readSequence(const char* keyword, osg::Vec2& value) +
+obool readSequence(const char* keyword, osg::Vec3& value) +
+obool readSequence(const char* keyword, osg::Vec4& value) +
+obool readSequence(std::string& value) +
+obool readSequence(unsigned int& value) +
+obool readSequence(int& value) +
+obool readSequence(float& value) +
+obool readSequence(osg::Vec2& value) +
+obool readSequence(osg::Vec3& value) +
+obool readSequence(osg::Vec4& value) +

+ +

+

Public Members

+oenum +

+ +
+ + +
+

Documentation

+
Class for managing the reading of ASCII osg files
+
+ + + +
o Input() +

+ + +

ovirtual ~Input() +

+ + +

ovirtual osg::Object* readObjectOfType(const osg::Object& compObj) +

+ + +

ovirtual osg::Object* readObject() +

+ + +

ovirtual osg::Image* readImage() +

+ + +

ovirtual osg::Drawable* readDrawable() +

+ + +

ovirtual osg::StateAttribute* readStateAttribute() +

+ + +

ovirtual osg::Node* readNode() +

+ + +

ovirtual osg::Object* readObject(const std::string& fileName) +

+ + +

ovirtual osg::Image* readImage(const std::string& fileName) +

+ + +

ovirtual osg::Node* readNode(const std::string& fileName) +

+ + +

ovirtual osg::Object* getObjectForUniqueID(const std::string& uniqueID) +

+ + +

ovirtual void regisiterUniqueIDForObject(const std::string& uniqueID, osg::Object* obj) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/NavigatorButton.class b/doc/doc++/osgDB/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..5fa134ee0f22ae5659bc0091d4cc98b3e6a0532a GIT binary patch literal 1816 zcma)7S#ujj5dOxJHIlr(EguO9h9t&b+fld=C4tzn6A=-+FmbSpYrI~`YgW5rHIi-4 z-$D2RyyS%xl7Uq5NUHcz6g{)6i}C{x>hAfbr|)h3{m&nNB8FxBki?B7wvzaWqrh>W zV}s)pjxRY}jxvYG;d4|tzTyZtsvI(n6z0ROx-Zk(Yb`5-w z+YE!VPIWf#NjoSC%VrpzUnm@ky2y$nnO*linPZq}VXp8>*)173UWwq?{K7WF_%P`iZr@g7ia}n61-1WX4!P5UyT&Wd{c0d95 zs7FSkY`ZdRt7p2cx6~=TsWb3=UIo5##!VQvXUpt^4+~KhM5W>qa7(jQDzbenbGy5t zkxnX)xbAq4yvdMWbw#y$ClHkbhT+cPs_Iz}vMD^xc6Ni!s=rnV?kV}?S!m9YYROSs!2aKxT#Q&7YAMcpY0=?5z{DSeM(-tudK zWv@FfCBSHu62ej$D4|lZy?x4dPiGh3^IbY66;pvQa4W1iNhMo`Sh5uOM+Lh`*9phl zr;#NCs_Iljr`q*}q#Y?-#|mG~gx|^;HKCZ>-%%^(p*EsxMC0EDlqXx9{5MMeXCa13G`PhdY2@n-wGmD3uqX5UCrA@5ujCwKO;dq7Wm0rJjIxq>2KhIx!k~v zxzxa%nTa=W-pnK#xNK&41J9YiV)_}z&8IMS#$xdi;}jDOOcQ*u1NTSpMS?Hs!+@!*H1Ptl%a6k2G#!7@!807-y(s88 z#7P3qMHa{U$e!86xh689#nzk8u@b$xhCcdlgU(>?FHDk?8RhqPT~V#~za| R#{{M@M4Akr679nW{{js3#=-yq literal 0 HcmV?d00001 diff --git a/doc/doc++/osgDB/Options.html b/doc/doc++/osgDB/Options.html new file mode 100644 index 000000000..0e286b997 --- /dev/null +++ b/doc/doc++/osgDB/Options.html @@ -0,0 +1,82 @@ + + + + + class osgDB::ReaderWriter::Options + + + + +

class Options

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Options() +
+[more] Options(const std::string& str) +
+[more]void setOptionString(const std::string& str) +
+[more]const std::string& getOptionString() const +

+ +

+

Protected Fields

+[more]std::string _str +

+ +

+

Protected Methods

+[more]virtual ~Options() +

+ +
+ + +
+

Documentation

+
+ + + +
o Options() +

+ + +

o Options(const std::string& str) +

+ + +

ovoid setOptionString(const std::string& str) +

+ + +

oconst std::string& getOptionString() const +

+ + +

ovirtual ~Options() +

+ + +

ostd::string _str +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/Output.html b/doc/doc++/osgDB/Output.html new file mode 100644 index 000000000..4018dfb02 --- /dev/null +++ b/doc/doc++/osgDB/Output.html @@ -0,0 +1,267 @@ + + + + + class OSGDB_EXPORT osgDB::Output + + + + +

class OSGDB_EXPORT osgDB::Output

ofstream wrapper class for adding support for indenting.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Output() +
+[more] Output(const char* name) +
+[more]virtual ~Output() +
+[more]void open(const char* name) +
+[more]Output& indent() +
+[more]std::string wrapString(const std::string& str) +
wrap a string with "" quotes and use \" for any internal quotes +
+[more]inline void setIndentStep(int step) +
+[more]inline int getIndentStep() const +
+[more]inline void setIndent(int indent) +
+[more]inline int getIndent() const +
+[more]inline void setNumIndicesPerLine(int num) +
+[more]inline int getNumIndicesPerLine() const +
+[more]void moveIn() +
+[more]void moveOut() +
+[more]virtual bool writeObject(const osg::Object& obj) +
+[more]bool getUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +
+[more]bool createUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +
+[more]bool registerUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +
+[more]inline void setPathNameHint(const PathNameHint pnh) +
+[more]inline const PathNameHint getPathNameHint() const +
+[more]virtual const std::string getFileNameForOutput(const std::string& filename) const +

+ +

+

Public Members

+[more]enum PathNameHint +

+ +

+

Protected Fields

+[more]int _indent +
+[more]int _indentStep +
+[more]int _numIndicesPerLine +
+[more]UniqueIDToLabelMapping _objectToUniqueIDMap +
+[more]std::string _filename +
+[more]PathNameHint _pathNameHint +

+ +

+

Protected Methods

+[more] Output(const Output&) +
+[more]Output& operator = (const Output&) +
+[more]virtual void init() +

+ +

+

Protected Members

+[more]typedef std::map<const osg::Object*,std::string> UniqueIDToLabelMapping +

+ +
+ + +
+

Documentation

+
ofstream wrapper class for adding support for indenting. +Used in output of .osg ASCII files to improve their readability.
+
+ + + +
o Output() +

+ + +

o Output(const char* name) +

+ + +

ovirtual ~Output() +

+ + +

ovoid open(const char* name) +

+ + +

oOutput& indent() +

+ + +

ostd::string wrapString(const std::string& str) +
wrap a string with "" quotes and use \" for any internal quotes +

+ + +

oinline void setIndentStep(int step) +

+ + +

oinline int getIndentStep() const +

+ + +

oinline void setIndent(int indent) +

+ + +

oinline int getIndent() const +

+ + +

oinline void setNumIndicesPerLine(int num) +

+ + +

oinline int getNumIndicesPerLine() const +

+ + +

ovoid moveIn() +

+ + +

ovoid moveOut() +

+ + +

ovirtual bool writeObject(const osg::Object& obj) +

+ + +

obool getUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +

+ + +

obool createUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +

+ + +

obool registerUniqueIDForObject(const osg::Object* obj, std::string& uniqueID) +

+ + +

oenum PathNameHint +

+ + + +
o AS_IS +

+ + +

o FULL_PATH +

+ + +

o RELATIVE_PATH +

+ + +

o FILENAME_ONLY +

+ + + +
oinline void setPathNameHint(const PathNameHint pnh) +

+ + +

oinline const PathNameHint getPathNameHint() const +

+ + +

ovirtual const std::string getFileNameForOutput(const std::string& filename) const +

+ + +

o Output(const Output&) +

+ + +

oOutput& operator = (const Output&) +

+ + +

ovirtual void init() +

+ + +

oint _indent +

+ + +

oint _indentStep +

+ + +

oint _numIndicesPerLine +

+ + +

otypedef std::map<const osg::Object*,std::string> UniqueIDToLabelMapping +

+ + +

oUniqueIDToLabelMapping _objectToUniqueIDMap +

+ + +

ostd::string _filename +

+ + +

oPathNameHint _pathNameHint +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/ParameterOutput.html b/doc/doc++/osgDB/ParameterOutput.html new file mode 100644 index 000000000..2fc6e991e --- /dev/null +++ b/doc/doc++/osgDB/ParameterOutput.html @@ -0,0 +1,87 @@ + + + + + class osgDB::ParameterOutput + + + + +

class osgDB::ParameterOutput

+ +
+

+

Public Methods

+[more] ParameterOutput(Output& fw) +
+[more] ParameterOutput(Output& fw, int numItemsPerLine) +
+[more]void begin() +
+[more]template<class T> void write(const T& t) +
+[more]template<class Iterator> void write(Iterator first, Iterator last) +
+[more]template<class Iterator> void writeAsInts(Iterator first, Iterator last) +

+ +

+

Protected Fields

+[more]Output& _fw +
+[more]int _numItemsPerLine +
+[more]int _column +

+ +
+ + +
+

Documentation

+
+ + + +
o ParameterOutput(Output& fw) +

+ + +

o ParameterOutput(Output& fw, int numItemsPerLine) +

+ + +

ovoid begin() +

+ + +

otemplate<class T> void write(const T& t) +

+ + +

otemplate<class Iterator> void write(Iterator first, Iterator last) +

+ + +

otemplate<class Iterator> void writeAsInts(Iterator first, Iterator last) +

+ + +

oOutput& _fw +

+ + +

oint _numItemsPerLine +

+ + +

oint _column +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/PushAndPopDataPath.html b/doc/doc++/osgDB/PushAndPopDataPath.html new file mode 100644 index 000000000..2613ea7a1 --- /dev/null +++ b/doc/doc++/osgDB/PushAndPopDataPath.html @@ -0,0 +1,46 @@ + + + + + class osgDB::PushAndPopDataPath + + + + +

class osgDB::PushAndPopDataPath

Convinience class for pushing a path on construction, and popping the path and destruction.
+
+ +
+

+

Public Methods

+[more] PushAndPopDataPath(const std::string& path) +
+[more] ~PushAndPopDataPath() +

+ +
+ + +
+

Documentation

+
Convinience class for pushing a path on construction, and popping the path +and destruction. This helps keep the addition of a path local to a block +of code, even in the presence of exceptions.
+
+ + + +
o PushAndPopDataPath(const std::string& path) +

+ + +

o ~PushAndPopDataPath() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/ReadResult.html b/doc/doc++/osgDB/ReadResult.html new file mode 100644 index 000000000..3ecd7b9b7 --- /dev/null +++ b/doc/doc++/osgDB/ReadResult.html @@ -0,0 +1,188 @@ + + + + + class osgDB::ReaderWriter::ReadResult + + + + +

class ReadResult

+ +
+

+

Public Methods

+[more] ReadResult(ReadStatus status=FILE_NOT_HANDLED) +
+[more] ReadResult(const std::string& m) +
+[more] ReadResult(osg::Object* obj) +
+[more] ReadResult(const ReadResult& rr) +
+[more]ReadResult& operator = (const ReadResult& rr) +
+[more]osg::Object* getObject() +
+[more]osg::Image* getImage() +
+[more]osg::Node* getNode() +
+[more]bool validObject() +
+[more]bool validImage() +
+[more]bool validNode() +
+[more]osg::Object* takeObject() +
+[more]osg::Image* takeImage() +
+[more]osg::Node* takeNode() +
+[more]const std::string& message() const +
+[more]ReadStatus status() const +
+[more]bool success() const +
+[more]bool error() const +
+[more]bool notHandled() const +

+ +

+

Public Members

+[more]enum ReadStatus +

+ +

+

Protected Fields

+[more]ReadStatus _status +
+[more]std::string _message +
+[more]osg::ref_ptr<osg::Object> _object +

+ +
+ + +
+

Documentation

+
+ + + +
oenum ReadStatus +

+ + + +
o FILE_NOT_HANDLED +

+ + +

o FILE_LOADED +

+ + +

o ERROR_IN_READING_FILE +

+ + + +
o ReadResult(ReadStatus status=FILE_NOT_HANDLED) +

+ + +

o ReadResult(const std::string& m) +

+ + +

o ReadResult(osg::Object* obj) +

+ + +

o ReadResult(const ReadResult& rr) +

+ + +

oReadResult& operator = (const ReadResult& rr) +

+ + +

oosg::Object* getObject() +

+ + +

oosg::Image* getImage() +

+ + +

oosg::Node* getNode() +

+ + +

obool validObject() +

+ + +

obool validImage() +

+ + +

obool validNode() +

+ + +

oosg::Object* takeObject() +

+ + +

oosg::Image* takeImage() +

+ + +

oosg::Node* takeNode() +

+ + +

oconst std::string& message() const +

+ + +

oReadStatus status() const +

+ + +

obool success() const +

+ + +

obool error() const +

+ + +

obool notHandled() const +

+ + +

oReadStatus _status +

+ + +

ostd::string _message +

+ + +

oosg::ref_ptr<osg::Object> _object +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/ReaderWriter.html b/doc/doc++/osgDB/ReaderWriter.html new file mode 100644 index 000000000..10c71d409 --- /dev/null +++ b/doc/doc++/osgDB/ReaderWriter.html @@ -0,0 +1,105 @@ + + + + + class OSGDB_EXPORT osgDB::ReaderWriter + + + + +

class OSGDB_EXPORT osgDB::ReaderWriter

pure virtual base class for reading and writing of non native formats.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual ~ReaderWriter() +
+[more]virtual const char* className() = 0 +
+[more]virtual bool acceptsExtension(const std::string&xtension*/) +
+[more]virtual ReadResult readObject(const std::string& , const Options* =NULL) +
+[more]virtual ReadResult readImage(const std::string& , const Options* =NULL) +
+[more]virtual ReadResult readNode(const std::string& , const Options* =NULL) +
+[more]virtual WriteResult writeObject(const osg::Object& , const std::string& , const Options* =NULL) +
+[more]virtual WriteResult writeImage(const osg::Image& , const std::string& , const Options* =NULL) +
+[more]virtual WriteResult writeNode(const osg::Node& , const std::string& , const Options* =NULL) +

+ +

+

Public Members

+class Options: public osg::Referenced +
+class ReadResult +
+class WriteResult +

+ +
+ + +
+

Documentation

+
pure virtual base class for reading and writing of non native formats.
+
+ + + +
ovirtual ~ReaderWriter() +

+ + +

ovirtual const char* className() = 0 +

+ + +

ovirtual bool acceptsExtension(const std::string&xtension*/) +

+ + +

ovirtual ReadResult readObject(const std::string& , const Options* =NULL) +

+ + +

ovirtual ReadResult readImage(const std::string& , const Options* =NULL) +

+ + +

ovirtual ReadResult readNode(const std::string& , const Options* =NULL) +

+ + +

ovirtual WriteResult writeObject(const osg::Object& , const std::string& , const Options* =NULL) +

+ + +

ovirtual WriteResult writeImage(const osg::Image& , const std::string& , const Options* =NULL) +

+ + +

ovirtual WriteResult writeNode(const osg::Node& , const std::string& , const Options* =NULL) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html b/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html new file mode 100644 index 000000000..3087a1722 --- /dev/null +++ b/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html @@ -0,0 +1,53 @@ + + + + + class osgDB::RegisterDotOsgWrapperProxy + + + + +

class osgDB::RegisterDotOsgWrapperProxy

Proxy class for automatic registration of DotOsgWrappers with the Registry
+
+ +
+

+

Public Methods

+[more] RegisterDotOsgWrapperProxy(osg::Object* proto, const std::string& name, const std::string& associates, DotOsgWrapper::ReadFunc readFunc, DotOsgWrapper::WriteFunc writeFunc, DotOsgWrapper::ReadWriteMode readWriteMode=DotOsgWrapper::READ_AND_WRITE) +
+[more] ~RegisterDotOsgWrapperProxy() +

+ +

+

Protected Fields

+[more]osg::ref_ptr<DotOsgWrapper> _wrapper +

+ +
+ + +
+

Documentation

+
Proxy class for automatic registration of DotOsgWrappers with the Registry
+
+ + + +
o RegisterDotOsgWrapperProxy(osg::Object* proto, const std::string& name, const std::string& associates, DotOsgWrapper::ReadFunc readFunc, DotOsgWrapper::WriteFunc writeFunc, DotOsgWrapper::ReadWriteMode readWriteMode=DotOsgWrapper::READ_AND_WRITE) +

+ + +

o ~RegisterDotOsgWrapperProxy() +

+ + +

oosg::ref_ptr<DotOsgWrapper> _wrapper +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/RegisterReaderWriterProxy.html b/doc/doc++/osgDB/RegisterReaderWriterProxy.html new file mode 100644 index 000000000..d352c64be --- /dev/null +++ b/doc/doc++/osgDB/RegisterReaderWriterProxy.html @@ -0,0 +1,53 @@ + + + + + template<class T> class osgDB::RegisterReaderWriterProxy + + + + +

template<class T> class osgDB::RegisterReaderWriterProxy

Proxy class for automatic registration of reader/writers with the Registry
+
+ +
+

+

Public Methods

+[more] RegisterReaderWriterProxy() +
+[more] ~RegisterReaderWriterProxy() +

+ +

+

Protected Fields

+[more]osg::ref_ptr<T> _rw +

+ +
+ + +
+

Documentation

+
Proxy class for automatic registration of reader/writers with the Registry
+
+ + + +
o RegisterReaderWriterProxy() +

+ + +

o ~RegisterReaderWriterProxy() +

+ + +

oosg::ref_ptr<T> _rw +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/Registry.html b/doc/doc++/osgDB/Registry.html new file mode 100644 index 000000000..0d1dc5f96 --- /dev/null +++ b/doc/doc++/osgDB/Registry.html @@ -0,0 +1,579 @@ + + + + + class OSGDB_EXPORT osgDB::Registry + + + + +

class OSGDB_EXPORT osgDB::Registry

Registry is a singleton factory which stores the reader/writers which are linked in at runtime for reading non-native file formats.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]static Registry* instance() +
+[more]void readCommandLine(osg::ArgumentParser& commandLine) +
read the command line arguments +
+[more]void addFileExtensionAlias(const std::string mapExt, const std::string toExt) +
register an fileextension alias to mapExt toExt, the later should the the extension name of the readerwriter plugin library. +
+[more]void addDotOsgWrapper(DotOsgWrapper* wrapper) +
+[more]void removeDotOsgWrapper(DotOsgWrapper* wrapper) +
+[more]void addReaderWriter(ReaderWriter* rw) +
+[more]void removeReaderWriter(ReaderWriter* rw) +
+[more]std::string createLibraryNameForFile(const std::string& fileName) +
create the platform specific library name associated with file +
+[more]std::string createLibraryNameForExt(const std::string& ext) +
create the platform specific library name associated with file extension +
+[more]std::string createLibraryNameForNodeKit(const std::string& name) +
create the platform specific library name associated with nodekit library name +
+[more]bool loadLibrary(const std::string& fileName) +
find the library in the SG_LIBRARY_PATH and load it +
+[more]bool closeLibrary(const std::string& fileName) +
close the attached library with specified name +
+[more]osg::Object* readObjectOfType(const osg::Object& compObj, Input& fr) +
+[more]osg::Object* readObject(Input& fr) +
+[more]osg::Image* readImage(Input& fr) +
+[more]osg::Drawable* readDrawable(Input& fr) +
+[more]osg::StateAttribute* readStateAttribute(Input& fr) +
+[more]osg::Node* readNode(Input& fr) +
+[more]bool writeObject(const osg::Object& obj, Output& fw) +
+[more]ReaderWriter::ReadResult readObject(const std::string& fileName, bool useObjectCache) +
+[more]ReaderWriter::WriteResult writeObject(const osg::Object& obj, const std::string& fileName) +
+[more]ReaderWriter::ReadResult readImage(const std::string& fileName, bool useObjectCache) +
+[more]ReaderWriter::WriteResult writeImage(const osg::Image& obj, const std::string& fileName) +
+[more]ReaderWriter::ReadResult readNode(const std::string& fileName, bool useObjectCache) +
+[more]ReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& fileName) +
+[more]void setCreateNodeFromImage(bool flag) +
+[more]bool getCreateNodeFromImage() const +
+[more]void setOptions(ReaderWriter::Options* opt) +
+[more]ReaderWriter::Options* getOptions() +
+[more]const ReaderWriter::Options* getOptions() const +
+[more]void initFilePathLists() +
initilize both the Data and Library FilePaths, by default called by the constructor, so it should only be required if you want to force the re-reading of environmental variables +
+[more]void initDataFilePathList() +
initilize the Data FilePath by reading the OSG_FILE_PATH environmental variable +
+[more]void setDataFilePathList(const FilePathList& filepath) +
Set the data file path using a list of paths stored in a FilePath, which is used when search for data files +
+[more]void setDataFilePathList(const std::string& paths) +
Set the data file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files +
+[more]FilePathList& getDataFilePathList() +
get the data file path which is used when search for data files +
+[more]const FilePathList& getDataFilePathList() const +
get the const data file path which is used when search for data files +
+[more]void initLibraryFilePathList() +
initilize the Library FilePath by reading the OSG_LIBRARY_PATH and the appropriate system environmental variables +
+[more]void setLibraryFilePathList(const FilePathList& filepath) +
Set the library file path using a list of paths stored in a FilePath, which is used when search for data files +
+[more]void setLibraryFilePathList(const std::string& paths) +
Set the library file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files +
+[more]FilePathList& getLibraryFilePathList() +
get the library file path which is used when search for library (dso/dll's) files +
+[more]const FilePathList& getLibraryFilePathList() const +
get the const library file path which is used when search for library (dso/dll's) files +
+[more]static void convertStringPathIntoFilePathList(const std::string& paths, FilePathList& filepath) +
convert a string containing a list of paths deliminated either with ';' (Windows) or ':' (All other platforms) into FilePath represetation +
+[more]void updateTimeStampOfObjectsInCacheWithExtenalReferences(double currentTime) +
For each object in the cache which has an reference count greater than 1 (and therefore referenced by elsewhere in the application) set the time stamp for that object in the cache to specified time. +
+[more]void removeExpiredObjectsInCache(double expiryTime) +
Removed object in the cache which have a time stamp at or before the specified expiry time. +
+[more]void clearObjectCache() +
Remove all objects in the cache regardless of having external references or expiry times +

+ +

+

Protected Fields

+[more]bool _createNodeFromImage +
+[more]DotOsgWrapperMap _objectWrapperMap +
+[more]DotOsgWrapperMap _imageWrapperMap +
+[more]DotOsgWrapperMap _drawableWrapperMap +
+[more]DotOsgWrapperMap _stateAttrWrapperMap +
+[more]DotOsgWrapperMap _nodeWrapperMap +
+[more]DotOsgWrapperMap _classNameWrapperMap +
+[more]ReaderWriterList _rwList +
+[more]DynamicLibraryList _dlList +
+[more]bool _openingLibrary +
+[more]ExtensionAliasMap _extAliasMap +
+[more]osg::ref_ptr<ReaderWriter::Options> _options +
+[more]FilePathList _dataFilePath +
+[more]FilePathList _libraryFilePath +
+[more]ObjectCache _objectCache +

+ +

+

Protected Methods

+[more]virtual ~Registry() +
+[more] Registry() +
constructor is private, as its a singleton, preventing construction other than via the instance() method and therefore ensuring only one copy is ever constructed +
+[more]DynamicLibraryList::iterator getLibraryItr(const std::string& fileName) +
get the attached library with specified name +
+[more]DynamicLibrary* getLibrary(const std::string& fileName) +
+[more]osg::Object* readObject(DotOsgWrapperMap& dowMap, Input& fr) +
+[more]void eraseWrapper(DotOsgWrapperMap& wrappermap, DotOsgWrapper* wrapper) +
+[more]ReaderWriter::ReadResult readObject(const std::string& fileName) +
+[more]ReaderWriter::ReadResult readImage(const std::string& fileName) +
+[more]ReaderWriter::ReadResult readNode(const std::string& fileName) +

+ +

+

Protected Members

+[more]typedef std::map< std::string, osg::ref_ptr<DotOsgWrapper> > DotOsgWrapperMap +
+[more]typedef std::vector< osg::ref_ptr<ReaderWriter> > ReaderWriterList +
+[more]typedef std::vector< osg::ref_ptr<DynamicLibrary> > DynamicLibraryList +
+[more]typedef std::map< std::string, std::string> ExtensionAliasMap +
+[more]typedef std::pair<osg::ref_ptr<osg::Object>, double > ObjectTimeStampPair +
+[more]typedef std::map<std::string, ObjectTimeStampPair > ObjectCache +

+ +
+ + +
+

Documentation

+
+Registry is a singleton factory which stores +the reader/writers which are linked in +at runtime for reading non-native file formats. + +

The RegisterDotOsgWrapperProxy can be used to automatically register +DotOsgWrappers, at runtime with the Registry. A DotOsgWrapper encapsulates +the functions that can read and write to the .osg for each osg::Object. + +

The RegisterReaderWriterProxy can be used to automatically +register at runtime a reader/writer with the Registry.

+
+ + + +
ostatic Registry* instance() +

+ + +

ovoid readCommandLine(osg::ArgumentParser& commandLine) +
read the command line arguments +

+ + +

ovoid addFileExtensionAlias(const std::string mapExt, const std::string toExt) +
register an fileextension alias to mapExt toExt, the later +should the the extension name of the readerwriter plugin library. +For example to map .tif files to the tiff loader, use +addExtAlias("tif","tiff") which will enable .tif to be read +by the libdb_tiff readerwriter plugin. +

+ + +

ovoid addDotOsgWrapper(DotOsgWrapper* wrapper) +

+ + +

ovoid removeDotOsgWrapper(DotOsgWrapper* wrapper) +

+ + +

ovoid addReaderWriter(ReaderWriter* rw) +

+ + +

ovoid removeReaderWriter(ReaderWriter* rw) +

+ + +

ostd::string createLibraryNameForFile(const std::string& fileName) +
create the platform specific library name associated with file +

+ + +

ostd::string createLibraryNameForExt(const std::string& ext) +
create the platform specific library name associated with file extension +

+ + +

ostd::string createLibraryNameForNodeKit(const std::string& name) +
create the platform specific library name associated with nodekit library name +

+ + +

obool loadLibrary(const std::string& fileName) +
find the library in the SG_LIBRARY_PATH and load it +

+ + +

obool closeLibrary(const std::string& fileName) +
close the attached library with specified name +

+ + +

oosg::Object* readObjectOfType(const osg::Object& compObj, Input& fr) +

+ + +

oosg::Object* readObject(Input& fr) +

+ + +

oosg::Image* readImage(Input& fr) +

+ + +

oosg::Drawable* readDrawable(Input& fr) +

+ + +

oosg::StateAttribute* readStateAttribute(Input& fr) +

+ + +

oosg::Node* readNode(Input& fr) +

+ + +

obool writeObject(const osg::Object& obj, Output& fw) +

+ + +

oReaderWriter::ReadResult readObject(const std::string& fileName, bool useObjectCache) +

+ + +

oReaderWriter::WriteResult writeObject(const osg::Object& obj, const std::string& fileName) +

+ + +

oReaderWriter::ReadResult readImage(const std::string& fileName, bool useObjectCache) +

+ + +

oReaderWriter::WriteResult writeImage(const osg::Image& obj, const std::string& fileName) +

+ + +

oReaderWriter::ReadResult readNode(const std::string& fileName, bool useObjectCache) +

+ + +

oReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& fileName) +

+ + +

ovoid setCreateNodeFromImage(bool flag) +

+ + +

obool getCreateNodeFromImage() const +

+ + +

ovoid setOptions(ReaderWriter::Options* opt) +

+ + +

oReaderWriter::Options* getOptions() +

+ + +

oconst ReaderWriter::Options* getOptions() const +

+ + +

ovoid initFilePathLists() +
initilize both the Data and Library FilePaths, by default called by the +constructor, so it should only be required if you want to force +the re-reading of environmental variables +

+ + +

ovoid initDataFilePathList() +
initilize the Data FilePath by reading the OSG_FILE_PATH environmental variable +

+ + +

ovoid setDataFilePathList(const FilePathList& filepath) +
Set the data file path using a list of paths stored in a FilePath, which is used when search for data files +

+ + +

ovoid setDataFilePathList(const std::string& paths) +
Set the data file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files +

+ + +

oFilePathList& getDataFilePathList() +
get the data file path which is used when search for data files +

+ + +

oconst FilePathList& getDataFilePathList() const +
get the const data file path which is used when search for data files +

+ + +

ovoid initLibraryFilePathList() +
initilize the Library FilePath by reading the OSG_LIBRARY_PATH +and the appropriate system environmental variables +

+ + +

ovoid setLibraryFilePathList(const FilePathList& filepath) +
Set the library file path using a list of paths stored in a FilePath, which is used when search for data files +

+ + +

ovoid setLibraryFilePathList(const std::string& paths) +
Set the library file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files +

+ + +

oFilePathList& getLibraryFilePathList() +
get the library file path which is used when search for library (dso/dll's) files +

+ + +

oconst FilePathList& getLibraryFilePathList() const +
get the const library file path which is used when search for library (dso/dll's) files +

+ + +

ostatic void convertStringPathIntoFilePathList(const std::string& paths, FilePathList& filepath) +
convert a string containing a list of paths deliminated either with ';' (Windows) or ':' (All other platforms) into FilePath represetation +

+ + +

ovoid updateTimeStampOfObjectsInCacheWithExtenalReferences(double currentTime) +
For each object in the cache which has an reference count greater than 1 +(and therefore referenced by elsewhere in the application) set the time stamp +for that object in the cache to specified time. +This would typically be called once per frame by applications which are doing database paging, +and need to prune objects that are no longer required. +Time value is time in sceonds. +

+ + +

ovoid removeExpiredObjectsInCache(double expiryTime) +
Removed object in the cache which have a time stamp at or before the specified expiry time. +This would typically be called once per frame by applications which are doing database paging, +and need to prune objects that are no longer required, and called after the a called +after the call to updateTimeStampOfObjectsInCacheWithExtenalReferences(currentTime). +Note, the currentTime is not the expiryTime, one would typically set the expiry time +to a fixed amount of time before currentTime, such as expiryTime = currentTime-10.0. +Time value is time in sceonds. +

+ + +

ovoid clearObjectCache() +
Remove all objects in the cache regardless of having external references or expiry times +

+ + +

ovirtual ~Registry() +

+ + +

otypedef std::map< std::string, osg::ref_ptr<DotOsgWrapper> > DotOsgWrapperMap +

+ + +

otypedef std::vector< osg::ref_ptr<ReaderWriter> > ReaderWriterList +

+ + +

otypedef std::vector< osg::ref_ptr<DynamicLibrary> > DynamicLibraryList +

+ + +

otypedef std::map< std::string, std::string> ExtensionAliasMap +

+ + +

otypedef std::pair<osg::ref_ptr<osg::Object>, double > ObjectTimeStampPair +

+ + +

otypedef std::map<std::string, ObjectTimeStampPair > ObjectCache +

+ + +

o Registry() +
constructor is private, as its a singleton, preventing +construction other than via the instance() method and +therefore ensuring only one copy is ever constructed +

+ + +

oDynamicLibraryList::iterator getLibraryItr(const std::string& fileName) +
get the attached library with specified name +

+ + +

oDynamicLibrary* getLibrary(const std::string& fileName) +

+ + +

obool _createNodeFromImage +

+ + +

oosg::Object* readObject(DotOsgWrapperMap& dowMap, Input& fr) +

+ + +

ovoid eraseWrapper(DotOsgWrapperMap& wrappermap, DotOsgWrapper* wrapper) +

+ + +

oReaderWriter::ReadResult readObject(const std::string& fileName) +

+ + +

oReaderWriter::ReadResult readImage(const std::string& fileName) +

+ + +

oReaderWriter::ReadResult readNode(const std::string& fileName) +

+ + +

oDotOsgWrapperMap _objectWrapperMap +

+ + +

oDotOsgWrapperMap _imageWrapperMap +

+ + +

oDotOsgWrapperMap _drawableWrapperMap +

+ + +

oDotOsgWrapperMap _stateAttrWrapperMap +

+ + +

oDotOsgWrapperMap _nodeWrapperMap +

+ + +

oDotOsgWrapperMap _classNameWrapperMap +

+ + +

oReaderWriterList _rwList +

+ + +

oDynamicLibraryList _dlList +

+ + +

obool _openingLibrary +

+ + +

oExtensionAliasMap _extAliasMap +

+ + +

oosg::ref_ptr<ReaderWriter::Options> _options +

+ + +

oFilePathList _dataFilePath +

+ + +

oFilePathList _libraryFilePath +

+ + +

oObjectCache _objectCache +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/WriteResult.html b/doc/doc++/osgDB/WriteResult.html new file mode 100644 index 000000000..bd862b0ae --- /dev/null +++ b/doc/doc++/osgDB/WriteResult.html @@ -0,0 +1,122 @@ + + + + + class osgDB::ReaderWriter::WriteResult + + + + +

class WriteResult

+ +
+

+

Public Methods

+[more] WriteResult(WriteStatus status=FILE_NOT_HANDLED) +
+[more] WriteResult(const std::string& m) +
+[more] WriteResult(const WriteResult& rr) +
+[more]WriteResult& operator = (const WriteResult& rr) +
+[more]const std::string& message() const +
+[more]WriteStatus status() const +
+[more]bool success() const +
+[more]bool error() const +
+[more]bool notHandled() const +

+ +

+

Public Members

+[more]enum WriteStatus +

+ +

+

Protected Fields

+[more]WriteStatus _status +
+[more]std::string _message +

+ +
+ + +
+

Documentation

+
+ + + +
oenum WriteStatus +

+ + + +
o FILE_NOT_HANDLED +

+ + +

o FILE_SAVED +

+ + +

o ERROR_IN_WRITING_FILE +

+ + + +
o WriteResult(WriteStatus status=FILE_NOT_HANDLED) +

+ + +

o WriteResult(const std::string& m) +

+ + +

o WriteResult(const WriteResult& rr) +

+ + +

oWriteResult& operator = (const WriteResult& rr) +

+ + +

oconst std::string& message() const +

+ + +

oWriteStatus status() const +

+ + +

obool success() const +

+ + +

obool error() const +

+ + +

obool notHandled() const +

+ + +

oWriteStatus _status +

+ + +

ostd::string _message +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/fileExists.html b/doc/doc++/osgDB/fileExists.html new file mode 100644 index 000000000..53b66edab --- /dev/null +++ b/doc/doc++/osgDB/fileExists.html @@ -0,0 +1,20 @@ + + + + + extern OSGDB_EXPORT bool osgDB::fileExists + + + + +

extern OSGDB_EXPORT bool osgDB::fileExists

(const std::string& filename)

return true if a file exisits.
+ + +
+

Documentation

+
return true if a file exisits.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/findFileInDirectory.html b/doc/doc++/osgDB/findFileInDirectory.html new file mode 100644 index 000000000..88ce0a676 --- /dev/null +++ b/doc/doc++/osgDB/findFileInDirectory.html @@ -0,0 +1,23 @@ + + + + + extern OSGDB_EXPORT std::string osgDB::findFileInDirectory + + + + +

extern OSGDB_EXPORT std::string osgDB::findFileInDirectory

(const std::string& fileName,
  const std::string& dirName,
  bool caseInsensitive=false)

return the directory/filename of a file if its is contained within specified directory.
+ + +
+

Documentation

+
return the directory/filename of a file if its is contained within specified directory. +return "" if directory does not contain file. If caseInsensitive is set to true then +a case insensitive comparison is used to compare fileName to directory contents. +This is useful when unix programs attempt read case insentive windows filenames.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/findFileInPath.html b/doc/doc++/osgDB/findFileInPath.html new file mode 100644 index 000000000..353d1facb --- /dev/null +++ b/doc/doc++/osgDB/findFileInPath.html @@ -0,0 +1,20 @@ + + + + + extern OSGDB_EXPORT std::string osgDB::findFileInPath + + + + +

extern OSGDB_EXPORT std::string osgDB::findFileInPath

(const std::string& filename,
  const FilePathList& filePath)

find specified file in specified file path
+ + +
+

Documentation

+
find specified file in specified file path
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/getDirectoryContents.html b/doc/doc++/osgDB/getDirectoryContents.html new file mode 100644 index 000000000..ac00b93e8 --- /dev/null +++ b/doc/doc++/osgDB/getDirectoryContents.html @@ -0,0 +1,21 @@ + + + + + extern OSGDB_EXPORT DirectoryContents osgDB::getDirectoryContents + + + + +

extern OSGDB_EXPORT DirectoryContents osgDB::getDirectoryContents

(const std::string& dirName)

return the contents of a directory.
+ + +
+

Documentation

+
return the contents of a directory. +returns an empty array on any error.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/icon1.gif b/doc/doc++/osgDB/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgDB/icon2.gif b/doc/doc++/osgDB/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgDB/index.html b/doc/doc++/osgDB/index.html new file mode 100644 index 000000000..b498f1a26 --- /dev/null +++ b/doc/doc++/osgDB/index.html @@ -0,0 +1,49 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/osgDB.html b/doc/doc++/osgDB/osgDB.html new file mode 100644 index 000000000..546f823e9 --- /dev/null +++ b/doc/doc++/osgDB/osgDB.html @@ -0,0 +1,207 @@ + + + + + namespace osgDB + + + + +

namespace osgDB

+
+

+
+class OSGDB_EXPORT DotOsgWrapper: public osg::Referenced +
Wrapper class for specifying read and write functions for extending the osg file format. +
+class OSGDB_EXPORT DynamicLibrary: public osg::Referenced +
DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins +
+class OSGDB_EXPORT Field +
+class OSGDB_EXPORT FieldReader +
+class OSGDB_EXPORT FieldReaderIterator +
+[more]extern OSGDB_EXPORT std::string getFilePath(const std::string& filename) +
+[more]extern OSGDB_EXPORT std::string getFileExtension(const std::string& filename) +
+[more]extern OSGDB_EXPORT std::string getLowerCaseFileExtension(const std::string& filename) +
+[more]extern OSGDB_EXPORT std::string getSimpleFileName(const std::string& fileName) +
+[more]extern OSGDB_EXPORT std::string getStrippedName(const std::string& fileName) +
+[more]extern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs, const std::string& rhs) +
+[more]extern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs, const char* rhs) +
+extern OSGDB_EXPORT bool fileExists(const std::string& filename) +
return true if a file exisits. +
+extern OSGDB_EXPORT std::string findFileInPath(const std::string& filename, const FilePathList& filePath) +
find specified file in specified file path +
+extern OSGDB_EXPORT std::string findFileInDirectory(const std::string& fileName, const std::string& dirName, bool caseInsensitive=false) +
return the directory/filename of a file if its is contained within specified directory. +
+typedef std::vector<std::string> DirectoryContents +
simple list of names to represent a directory's contents. +
+extern OSGDB_EXPORT DirectoryContents getDirectoryContents(const std::string& dirName) +
return the contents of a directory. +
+[more]inline void setDataFilePathList(const FilePathList& filepath) +
+[more]inline void setDataFilePathList(const std::string& paths) +
+[more]inline FilePathList& getDataFilePathList() +
+[more]extern OSGDB_EXPORT std::string findDataFile(const std::string& filename) +
+class PushAndPopDataPath +
Convinience class for pushing a path on construction, and popping the path and destruction. +
+[more]inline void setLibraryFilePathList(const FilePathList& filepaths) +
+[more]inline void setLibraryFilePathList(const std::string& paths) +
+[more]inline FilePathList& getLibraryFilePathList() +
+[more]extern OSGDB_EXPORT std::string findLibraryFile(const std::string& filename) +
+class OSGDB_EXPORT Input: public FieldReaderIterator +
Class for managing the reading of ASCII osg files +
+class OSGDB_EXPORT Output: public std::ofstream +
ofstream wrapper class for adding support for indenting. +
+class ParameterOutput +
+[more]template<class Iterator> void writeArray(Output& fw, Iterator first, Iterator last, int noItemsPerLine=0) +
+[more]template<class Iterator> void writeArrayAsInts(Output& fw, Iterator first, Iterator last, int noItemsPerLine=0) +
+extern OSGDB_EXPORT osg::Object* readObjectFile(const std::string& filename, bool useObjectCache=false) +
Read an osg::Object from file. +
+extern OSGDB_EXPORT osg::Image* readImageFile(const std::string& filename, bool useObjectCache=false) +
Read an osg::Image from file. +
+extern OSGDB_EXPORT osg::Node* readNodeFile(const std::string& filename, bool useObjectCache=false) +
Read an osg::Node from file. +
+extern OSGDB_EXPORT osg::Node* readNodeFiles(std::vector<std::string>& commandLine, bool useObjectCache=false) +
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded +
+extern OSGDB_EXPORT osg::Node* readNodeFiles(osg::ArgumentParser& parser, bool useObjectCache=false) +
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded +
+class OSGDB_EXPORT ReaderWriter: public osg::Referenced +
pure virtual base class for reading and writing of non native formats. +
+typedef std::deque<std::string> FilePathList +
list of directories to search through which searching for files. +
+class OSGDB_EXPORT Registry: public osg::Referenced +
Registry is a singleton factory which stores the reader/writers which are linked in at runtime for reading non-native file formats. +
+inline void readCommandLine(osg::ArgumentParser& parser) +
read the command line arguments +
+class RegisterDotOsgWrapperProxy +
Proxy class for automatic registration of DotOsgWrappers with the Registry +
+template<class T> class RegisterReaderWriterProxy +
Proxy class for automatic registration of reader/writers with the Registry +
+extern OSGDB_EXPORT bool writeObjectFile(const osg::Object& object, const std::string& filename) +
Write an osg::Object to file. +
+extern OSGDB_EXPORT bool writeImageFile(const osg::Image& image, const std::string& filename) +
Write an osg::Image to file. +
+extern OSGDB_EXPORT bool writeNodeFile(const osg::Node& node, const std::string& filename) +
Write an osg::Node to file. +

+ + + +
+

Documentation

+
+ + + +
oextern OSGDB_EXPORT std::string getFilePath(const std::string& filename) +

+ + +

oextern OSGDB_EXPORT std::string getFileExtension(const std::string& filename) +

+ + +

oextern OSGDB_EXPORT std::string getLowerCaseFileExtension(const std::string& filename) +

+ + +

oextern OSGDB_EXPORT std::string getSimpleFileName(const std::string& fileName) +

+ + +

oextern OSGDB_EXPORT std::string getStrippedName(const std::string& fileName) +

+ + +

oextern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs, const std::string& rhs) +

+ + +

oextern OSGDB_EXPORT bool equalCaseInsensitive(const std::string& lhs, const char* rhs) +

+ + +

oinline void setDataFilePathList(const FilePathList& filepath) +

+ + +

oinline void setDataFilePathList(const std::string& paths) +

+ + +

oinline FilePathList& getDataFilePathList() +

+ + +

oextern OSGDB_EXPORT std::string findDataFile(const std::string& filename) +

+ + +

oinline void setLibraryFilePathList(const FilePathList& filepaths) +

+ + +

oinline void setLibraryFilePathList(const std::string& paths) +

+ + +

oinline FilePathList& getLibraryFilePathList() +

+ + +

oextern OSGDB_EXPORT std::string findLibraryFile(const std::string& filename) +

+ + +

otemplate<class Iterator> void writeArray(Output& fw, Iterator first, Iterator last, int noItemsPerLine=0) +

+ + +

otemplate<class Iterator> void writeArrayAsInts(Output& fw, Iterator first, Iterator last, int noItemsPerLine=0) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/osgDBGetLibraryName.html b/doc/doc++/osgDB/osgDBGetLibraryName.html new file mode 100644 index 000000000..339508338 --- /dev/null +++ b/doc/doc++/osgDB/osgDBGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGDB_EXPORT const char* osgDBGetLibraryName + + + + +

extern OSGDB_EXPORT const char* osgDBGetLibraryName

()

getLibraryName() returns the library name in human friendly form
+ + +
+

Documentation

+
+getLibraryName() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/osgDBGetVersion.html b/doc/doc++/osgDB/osgDBGetVersion.html new file mode 100644 index 000000000..b8d0aae32 --- /dev/null +++ b/doc/doc++/osgDB/osgDBGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGDB_EXPORT const char* osgDBGetVersion + + + + +

extern OSGDB_EXPORT const char* osgDBGetVersion

()

osgDBGetVersion() returns the library version number.
+ + +
+

Documentation

+
+osgDBGetVersion() returns the library version number. +Numbering convention : osg_src-0.8.31 will return 0.8.31 from getVersion_osg. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) library +# +AC_CHECK_LIB(osg, osgDBGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph DB library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readCommandLine.html b/doc/doc++/osgDB/readCommandLine.html new file mode 100644 index 000000000..86213949e --- /dev/null +++ b/doc/doc++/osgDB/readCommandLine.html @@ -0,0 +1,20 @@ + + + + + inline void osgDB::readCommandLine + + + + +

inline void osgDB::readCommandLine

(osg::ArgumentParser& parser)

read the command line arguments
+ + +
+

Documentation

+
read the command line arguments
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readImageFile.html b/doc/doc++/osgDB/readImageFile.html new file mode 100644 index 000000000..7dfc0142a --- /dev/null +++ b/doc/doc++/osgDB/readImageFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT osg::Image* osgDB::readImageFile + + + + +

extern OSGDB_EXPORT osg::Image* osgDB::readImageFile

(const std::string& filename,
  bool useObjectCache=false)

Read an osg::Image from file.
+ + +
+

Documentation

+
Read an osg::Image from file. +Return valid osg::Image on success, +return NULL on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to read the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readNodeFile.html b/doc/doc++/osgDB/readNodeFile.html new file mode 100644 index 000000000..0462d58f6 --- /dev/null +++ b/doc/doc++/osgDB/readNodeFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT osg::Node* osgDB::readNodeFile + + + + +

extern OSGDB_EXPORT osg::Node* osgDB::readNodeFile

(const std::string& filename,
  bool useObjectCache=false)

Read an osg::Node from file.
+ + +
+

Documentation

+
Read an osg::Node from file. +Return valid osg::Node on success, +return NULL on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to read the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readNodeFiles.2.html b/doc/doc++/osgDB/readNodeFiles.2.html new file mode 100644 index 000000000..65f2721af --- /dev/null +++ b/doc/doc++/osgDB/readNodeFiles.2.html @@ -0,0 +1,21 @@ + + + + + extern OSGDB_EXPORT osg::Node* osgDB::readNodeFiles + + + + +

extern OSGDB_EXPORT osg::Node* osgDB::readNodeFiles

(osg::ArgumentParser& parser,
  bool useObjectCache=false)

Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded
+ + +
+

Documentation

+
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more +than one subgraph has been loaded
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readNodeFiles.html b/doc/doc++/osgDB/readNodeFiles.html new file mode 100644 index 000000000..7ccec31bf --- /dev/null +++ b/doc/doc++/osgDB/readNodeFiles.html @@ -0,0 +1,21 @@ + + + + + extern OSGDB_EXPORT osg::Node* osgDB::readNodeFiles + + + + +

extern OSGDB_EXPORT osg::Node* osgDB::readNodeFiles

(std::vector<std::string>& commandLine,
  bool useObjectCache=false)

Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded
+ + +
+

Documentation

+
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more +than one subgraph has been loaded
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/readObjectFile.html b/doc/doc++/osgDB/readObjectFile.html new file mode 100644 index 000000000..214fe80b7 --- /dev/null +++ b/doc/doc++/osgDB/readObjectFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT osg::Object* osgDB::readObjectFile + + + + +

extern OSGDB_EXPORT osg::Object* osgDB::readObjectFile

(const std::string& filename,
  bool useObjectCache=false)

Read an osg::Object from file.
+ + +
+

Documentation

+
Read an osg::Object from file. +Return valid osg::Object on success, +return NULL on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to read the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/writeImageFile.html b/doc/doc++/osgDB/writeImageFile.html new file mode 100644 index 000000000..714c340e5 --- /dev/null +++ b/doc/doc++/osgDB/writeImageFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT bool osgDB::writeImageFile + + + + +

extern OSGDB_EXPORT bool osgDB::writeImageFile

(const osg::Image& image,
  const std::string& filename)

Write an osg::Image to file.
+ + +
+

Documentation

+
Write an osg::Image to file. +Return true on success, +return false on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to write the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/writeNodeFile.html b/doc/doc++/osgDB/writeNodeFile.html new file mode 100644 index 000000000..a60038d01 --- /dev/null +++ b/doc/doc++/osgDB/writeNodeFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT bool osgDB::writeNodeFile + + + + +

extern OSGDB_EXPORT bool osgDB::writeNodeFile

(const osg::Node& node,
  const std::string& filename)

Write an osg::Node to file.
+ + +
+

Documentation

+
Write an osg::Node to file. +Return true on success, +return false on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to write the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgDB/writeObjectFile.html b/doc/doc++/osgDB/writeObjectFile.html new file mode 100644 index 000000000..b3380e936 --- /dev/null +++ b/doc/doc++/osgDB/writeObjectFile.html @@ -0,0 +1,25 @@ + + + + + extern OSGDB_EXPORT bool osgDB::writeObjectFile + + + + +

extern OSGDB_EXPORT bool osgDB::writeObjectFile

(const osg::Object& object,
  const std::string& filename)

Write an osg::Object to file.
+ + +
+

Documentation

+
Write an osg::Object to file. +Return true on success, +return false on failure. +The osgDB::Registry is used to load the appropriate ReaderWriter plugin +for the filename extension, and this plugin then handles the request +to write the specified file.
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/AnimationPathManipulator.html b/doc/doc++/osgGA/AnimationPathManipulator.html new file mode 100644 index 000000000..72f2aba8d --- /dev/null +++ b/doc/doc++/osgGA/AnimationPathManipulator.html @@ -0,0 +1,209 @@ + + + + + class OSGGA_EXPORT osgGA::AnimationPathManipulator + + + + +

class OSGGA_EXPORT osgGA::AnimationPathManipulator

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AnimationPathManipulator( osg::AnimationPath* animationPath=0 ) +
+[more] AnimationPathManipulator( const std::string& filename ) +
+[more]virtual const char* className() const +
+[more]void setAnimationPath( osg::AnimationPath* animationPath ) +
+[more]osg::AnimationPath* getAnimationPath() +
+[more]const osg::AnimationPath* getAnimationPath() const +
+[more]bool valid() const +
+[more]void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +

+

Protected Fields

+[more]bool _valid +
+[more]osg::ref_ptr<osg::AnimationPath> _animationPath +
+[more]double _timeOffset +
+[more]double _timeScale +
+[more]double _pauseTime +
+[more]bool _isPaused +
+[more]double _realStartOfTimedPeriod +
+[more]double _animStartOfTimedPeriod +
+[more]int _numOfFramesSinceStartOfTimedPeriod +

+ +

+

Protected Methods

+[more]void handleFrame( double time ) +

+ +
+

Inherited from CameraManipulator:

+
+

+

Public Methods

+ovirtual void setCamera(osg::Camera*) +
+ovirtual const osg::Camera* getCamera() const +
+ovirtual osg::Camera* getCamera() +
+ovirtual void setNode(osg::Node*) +
+ovirtual const osg::Node* getNode() const +
+ovirtual osg::Node* getNode() +
+ovirtual void accept(GUIEventHandlerVisitor& v) +

+ +

+

Protected Fields

+oosg::ref_ptr<osg::Camera> _camera +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+ + + +
o AnimationPathManipulator( osg::AnimationPath* animationPath=0 ) +

+ + +

o AnimationPathManipulator( const std::string& filename ) +

+ + +

ovirtual const char* className() const +

+ + +

ovoid setAnimationPath( osg::AnimationPath* animationPath ) +

+ + +

oosg::AnimationPath* getAnimationPath() +

+ + +

oconst osg::AnimationPath* getAnimationPath() const +

+ + +

obool valid() const +

+ + +

ovoid init(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovoid home(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

obool _valid +

+ + +

ovoid handleFrame( double time ) +

+ + +

oosg::ref_ptr<osg::AnimationPath> _animationPath +

+ + +

odouble _timeOffset +

+ + +

odouble _timeScale +

+ + +

odouble _pauseTime +

+ + +

obool _isPaused +

+ + +

odouble _realStartOfTimedPeriod +

+ + +

odouble _animStartOfTimedPeriod +

+ + +

oint _numOfFramesSinceStartOfTimedPeriod +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/CameraManipulator.html b/doc/doc++/osgGA/CameraManipulator.html new file mode 100644 index 000000000..1952d81ff --- /dev/null +++ b/doc/doc++/osgGA/CameraManipulator.html @@ -0,0 +1,181 @@ + + + + + class OSGGA_EXPORT osgGA::CameraManipulator + + + + +

class OSGGA_EXPORT osgGA::CameraManipulator

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* className() const +
+[more]virtual void setCamera(osg::Camera*) +
Attach a camera to the manipulator to be used for specifying view +
+[more]virtual const osg::Camera* getCamera() const +
Get the attached camera +
+[more]virtual osg::Camera* getCamera() +
Get the attached camera +
+[more]virtual void setNode(osg::Node*) +
Attach a node to the manipulator, automatically detaching any previously attached node. +
+[more]virtual const osg::Node* getNode() const +
Return const node if attached +
+[more]virtual osg::Node* getNode() +
Return node if attached +
+[more]virtual void home(const GUIEventAdapter&, GUIActionAdapter&) +
Move the camera to the default position. +
+[more]virtual void init(const GUIEventAdapter&, GUIActionAdapter&) +
Start/restart the manipulator. +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Handle events, return true if handled, false otherwise. +
+[more]virtual void accept(GUIEventHandlerVisitor& v) +
Handle visitations +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::Camera> _camera +

+ +

+

Protected Methods

+[more] CameraManipulator() +
+[more]virtual ~CameraManipulator() +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +
+ovirtual void getUsage(osg::ApplicationUsage&) const +

+ +
+ + +
+

Documentation

+
+ +

CameraManipulator is an abstract base class defining the interface, and a certain +amount of default functionality, for classes which wish to control OSG cameras +in response to GUI events. +

+
+ + + +
ovirtual const char* className() const +

+ + +

ovirtual void setCamera(osg::Camera*) +
Attach a camera to the manipulator to be used for specifying view +

+ + +

ovirtual const osg::Camera* getCamera() const +
Get the attached camera +

+ + +

ovirtual osg::Camera* getCamera() +
Get the attached camera +

+ + +

ovirtual void setNode(osg::Node*) +
+Attach a node to the manipulator, automatically detaching any previously attached node. +setNode(NULL) detaches previous nodes. +May be ignored by manipulators which do not require a reference model. +

+ + +

ovirtual const osg::Node* getNode() const +
Return const node if attached +

+ + +

ovirtual osg::Node* getNode() +
Return node if attached +

+ + +

ovirtual void home(const GUIEventAdapter&, GUIActionAdapter&) +
+Move the camera to the default position. +May be ignored by manipulators if home functionality is not appropriate. +

+ + +

ovirtual void init(const GUIEventAdapter&, GUIActionAdapter&) +
+Start/restart the manipulator. +FIXME: what does this actually mean? Provide examples. +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Handle events, return true if handled, false otherwise. +

+ + +

ovirtual void accept(GUIEventHandlerVisitor& v) +
Handle visitations +

+ + +

o CameraManipulator() +

+ + +

ovirtual ~CameraManipulator() +

+ + +

oosg::ref_ptr<osg::Camera> _camera +

+
+
Direct child classes: +
TrackballManipulator
+KeySwitchCameraManipulator
+FlightManipulator
+DriveManipulator
+AnimationPathManipulator
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/ClassGraph.class b/doc/doc++/osgGA/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..4f41a1fb2fdf65525a700ad591fe8a696f29497f GIT binary patch literal 1237 zcma)6*-{fh6g@+hNrou`K|w^^#V{;!Uxf)I{zh+h=K3 zsd!waUo=!!3dIjq#=y{V{6M7_+&wM=R|*RBw*!KzHaBtvg;Em*1L4$)R)eWlU#iPW zPx={+I$h{qMG7udrcI%d+6D~_cO;*T)@?>RB02V1R@EvKtjwE3##>R3iE=uxd{>m) zBRU}i>WsuD>(0FYN6y?~v%I|}%|80f6|R~yU}ZfP1j|0Fd@ztWac1<5bRp|ZaL+(* zBd2*{+H_Wyxb7lFpqNkv=2f-7cv$2WMb{J<7|5NpZ8V{KN}fKEfxet9GOxgVm+g3* zDidpL-z_sG{rRd=Qc&Z(tolX1yd+@k)$&&}|#YQU4bz2pm?{eSgrM&xv$VGh~Gz=@?#JBjV?8~a4HN?qp z7K6@BA1O#fe|02#$X>+^$qadih$BMUbCQu7F65kKnAED1>>;)0B%`Ee!%i|p`WwzW zzmV7t)sd`WjO^I<MT3FyI-fA42Q3jhEB literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/ClassGraphPanel.class b/doc/doc++/osgGA/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..4f3ea86bb625e4e043d10fafb3b0b05cf2f96537 GIT binary patch literal 4084 zcmbtWX>c4@5&lLyyR*lXB(J?mmPm#W>_{tH!Xb!QvIDl97=dgjR%}Nym>unoq_tNw z%I>VBgm4=IB%DP##03F|V>uGQMp~IT2Uj@Eec$=X4~qX(Q550pH+#lP%0Q{quiy8& zzwYVR@4dbF@5i1*09)})825$ofiON6#sgt|GK|lJ@kkh73FCWV{5*``hVd5zA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR24!kakD@AO?>!awz zSQOpZ7sUqbkDwg~MBExd9JfWW9tUMQF5-6aI3(KPD8-Q|uD~5pbYViUNfAfI&*JSSK8J@*d|pHu51RM_7EF8*XH0wvr%Zeqo{2|s z+Qe7!P7`0lTTPtByG@+Kr%ZfZOqOw%i51Z*__T>t@%TPIZsG^x@k3d-DA3DR-0hY=%^o*qaSt+1JW2YqzSe4J&p86+`L;D7Btm@&ds}y?RdjYUozs> zK>3me#omH7Kby-G70Xp?E%;%Z1Jr#+M=#A;vbnm6XUw|GEqVJa$C|PIToct*^`!@< zjRC}bMqcQ21 zu5LkYwH!OIA*O8nebS(hxLI3RT&Ktu_YPb666e|;VmB{k?0JvJp-6ydMH?eH*5uB; z>8ySkPmkZ88seAMS3~=lo3ZkTtwPS4%G)ID*l#W5W-QMw>@Inp>yZ8+>BrqtA!FZ? z%S#gMlD4A^96#EK;#)KF`YPC5A^IHSA+)kt4MA(#vkR=&ls)YhNEe*STbUCAxFsjc z6pSeqnVO!-I37!r;fi;=dxEzBsYnvY=18Gu-9;uCkzrS%;4W$iXA9QiSk57D$iA~= z<>?Td&J~KJ(PsG}vsQ5*!`8?`vvzJ~mW!dBljUJ0L#|%!j`|H$t3`VqQB`FLntfcPqv2V(ktLL=Fr?7pN#~O4t zT>bN{!BkMS#Wf_=wB+UT)r(Y>D|feihsItF<<)h<(&z1IuUdLT^f_xumThN7A_de` zpK}+u9}$PAR1tAY=2;aMJEBH^zci9Z3$h!vy)4>ZwagK!^`lW_B6Ka5ri$v8XE&DS z**2y5s-s>i$i5p3a%c`rGiP>2a50yaoHQn=-2?C?y^=Ds z$a&mS!7C4FLmkQX3bsFl4HwWokqjl*oH55|*bysd(P2N4Pk#%a(iAuphFA{k9~B!h|0L_D#Mm`bI86)zo6P0&J5uP}Rl z==G0)F|mplPp)9Fg4YBFV`bc!61GH)fnRo{s&;M^rbMit!)CR#J(y3=CSsi% zXDb*!8PgImE~U;q`}A4v?BDPY{1ZvF>-^E$2Jx${@qTJG!;R!&7vH$|u38lAt%Uf5lt`!0Q5 z61~-(zxsUlzys|22oSiBRoce?-T=$HYZawB1z+k8x$R_nfC=t@r(tU}CDC6Txg<7h+oWC&S9_bii!b$r|mIZMwTUqixDJN$c4LcvBUu z@=G#%%56_EJR6)vn{3dw#HPL4!dh z$DJobZHZ8ljj&zMp83})|BBG?Q@o>k#upIcA8@?y9ImV2)qz31jN6#S;4*FuW&`Ij z#QSb%LZ_5tA}zN$q4Ol~q}Hpno}pkexQtN|uTAf)T5a;JPU>1hrz!8rM^XVkaJ3vB JV$?Q#=szD|0>A(O literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/ClassLayout.class b/doc/doc++/osgGA/ClassLayout.class new file mode 100644 index 0000000000000000000000000000000000000000..69a6f494ed99e62d55c975c56b11981104a3dca9 GIT binary patch literal 2443 zcmZuy>2nih82>HVBfIRhrLbUtR6&I{DHK$q7O2{CSZ$$Nt%9Q2CfjstvKu#>mg24T zzHd=Ha5~e`PwKRRkr~I&`WN`mh|lwGlBPmt_IaQCe&77{@9%#ghCR3#hohmO!PPLM z;aLqYX?R(~D;i$a@S27N4XL&KXI-qP^4hIb6K;dTRY++m;t2N+}++^IvyT?S;_ zZ9qf6PS`;PhnPI9L&1PfX7@08FDu{2(m?|%h71@u!q`zA8*q%h9B1-=115$Udw?w- zWQ!4YHOe7RFz=*+c8sy-hjgsR!wkkvOyLxRGYoPjs<0VMnwW)WVh&joXYq)Mc_z=H zV&XZRHt{@TFEH;#Oqh6&vG*B#fX7UHh$l^a%uYXnZ{kxtZQ?ULYT|Q_@g)nsV&(G; zzGm33dyX)(nv%74O84+E zrzTF}VKu{5d-k2`Zk2eU?Rrjduq9k;L0hh`Om2GX5|PHq$r&dXHk`C%HdvjSBJclG zuUA`-c|CQj)q6voqV`;e-&#(iQCz6hFF`%zdTux%!5AvqmCEtJE>BBnUnTbP9M^Eh zY|kl5STA%&?0LT$N|1;Ayu)66uM*l`IAIs7Odma)bIKtNze4e-{Z^EW>-UY(Ktsyh zu}f5b+lZgDixYO>+LJ|xl-p0(vu?o-{a~;fhCZ#9G45A`oO8@Al4I#Kt&N?}NAa5j zq=M{n+41s(O!{P3lAx30+;~WhCa*ca>V-{piWASfoN$hODpPJyp<2v>v#LTGg}|R1 zai&P3PCIU4nh{s*F6Gc%^QP0a%=-ScGMoED`83U=%RpDB$%#rEwLQDw1k|CXK->_z zOM@}OVR(HM<{iBPJGTV>xi>CIn7>q>+lze`I>9e1LGbe_PI?r@Nsld^8tKs+P4F3_c3~Z1z}D0ybf!AGRtQs8u!BK5C9h!H zufkSBh0*h0e%K+{VJLtfkb2bvmOgsFI~7 zFJApQMe%N+P&?>LXQP<%6~s^VF5@QpQsg;H=U)1@kfZD+Z2X0i;qSCXT0)-`S)b-YWhtV4KcX$6 zMd%9lB~&3|&{abZtMBZObCF6uqg(m~sIiRBbjILV)P$}?+!A=N=+LxqkYB<6C0L0# zEA?7>G%8|J0GjcBD~iY&B=br!Tf;5C;npkYIAtl9(RT@(I;9#mb9}3YJvDSMD3Ya6 OO$QpS45)eQF#R7oR!vR- literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/CompositeGUIEventHandler.html b/doc/doc++/osgGA/CompositeGUIEventHandler.html new file mode 100644 index 000000000..bff47269e --- /dev/null +++ b/doc/doc++/osgGA/CompositeGUIEventHandler.html @@ -0,0 +1,140 @@ + + + + + class OSGGA_EXPORT osgGA::CompositeGUIEventHandler + + + + +

class OSGGA_EXPORT osgGA::CompositeGUIEventHandler

CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* className() +
+[more]virtual const CompositeGUIEventHandler* getComposite() const +
+[more]virtual CompositeGUIEventHandler* getComposite() +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& aa) +
+[more]virtual void accept(GUIEventHandlerVisitor& v) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +
+[more]virtual bool addChild(GUIEventHandler* geh) +
+[more]virtual bool removeChild(GUIEventHandler* geh) +
+[more]const int getNumChildren() const +
+[more]GUIEventHandler* getChild( int i) +
+[more]const GUIEventHandler* getChild( int i ) const +
+[more]bool containsNode( const GUIEventHandler* node ) const +
+[more]ChildList::iterator findChild( const GUIEventHandler* node ) +

+ +

+

Public Members

+[more]typedef std::vector< osg::ref_ptr<GUIEventHandler> > ChildList +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +

+ +
+ + +
+

Documentation

+
+CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies
+
+ + + +
otypedef std::vector< osg::ref_ptr<GUIEventHandler> > ChildList +

+ + +

ovirtual const char* className() +

+ + +

ovirtual const CompositeGUIEventHandler* getComposite() const +

+ + +

ovirtual CompositeGUIEventHandler* getComposite() +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& aa) +

+ + +

ovirtual void accept(GUIEventHandlerVisitor& v) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

ovirtual bool addChild(GUIEventHandler* geh) +

+ + +

ovirtual bool removeChild(GUIEventHandler* geh) +

+ + +

oconst int getNumChildren() const +

+ + +

oGUIEventHandler* getChild( int i) +

+ + +

oconst GUIEventHandler* getChild( int i ) const +

+ + +

obool containsNode( const GUIEventHandler* node ) const +

+ + +

oChildList::iterator findChild( const GUIEventHandler* node ) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/DriveManipulator.html b/doc/doc++/osgGA/DriveManipulator.html new file mode 100644 index 000000000..a922e5e7c --- /dev/null +++ b/doc/doc++/osgGA/DriveManipulator.html @@ -0,0 +1,271 @@ + + + + + class OSGGA_EXPORT osgGA::DriveManipulator + + + + +

class OSGGA_EXPORT osgGA::DriveManipulator

DriveManipulator is a camera manipulator which provides drive-like functionality.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DriveManipulator() +
+[more]virtual const char* className() const +
+[more]virtual void setNode(osg::Node*) +
+[more]virtual const osg::Node* getNode() const +
+[more]virtual osg::Node* getNode() +
+[more]virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +

+

Protected Fields

+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t1 +
+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t0 +
+[more]osg::ref_ptr<osg::Node> _node +
+[more]float _modelScale +
+[more]float _velocity +
+[more]float _height +
+[more]float _buffer +
+[more]SpeedControlMode _speedMode +
+[more]osg::Vec3 _eye +
+[more]osg::Quat _rotation +
+[more]float _distance +

+ +

+

Protected Methods

+[more]virtual ~DriveManipulator() +
+[more]void flushMouseEventStack() +
Reset the internal GUIEvent stack +
+[more]void addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +
+[more]void computeLocalDataFromCamera() +
+[more]void computeCameraFromLocalData() +
+[more]void computeCameraFromLocalData(const osg::Vec3& lv, const osg::Vec3& up) +
+[more]bool calcMovement() +
For the give mouse movement calculate the movement of the camera. +

+ +

+

Protected Members

+[more]enum SpeedControlMode +

+ +
+

Inherited from CameraManipulator:

+
+

+

Public Methods

+ovirtual void setCamera(osg::Camera*) +
+ovirtual const osg::Camera* getCamera() const +
+ovirtual osg::Camera* getCamera() +
+ovirtual void accept(GUIEventHandlerVisitor& v) +

+ +

+

Protected Fields

+oosg::ref_ptr<osg::Camera> _camera +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+DriveManipulator is a camera manipulator which provides drive-like +functionality. By default, the left mouse button accelerates, the right +mouse button decelerates, and the middle mouse button (or left and +right simultaneously) stops dead.
+
+ + + +
o DriveManipulator() +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void setNode(osg::Node*) +

+ + +

ovirtual const osg::Node* getNode() const +

+ + +

ovirtual osg::Node* getNode() +

+ + +

ovirtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

ovirtual ~DriveManipulator() +

+ + +

ovoid flushMouseEventStack() +
Reset the internal GUIEvent stack +

+ + +

ovoid addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +

+ + +

ovoid computeLocalDataFromCamera() +

+ + +

ovoid computeCameraFromLocalData() +

+ + +

ovoid computeCameraFromLocalData(const osg::Vec3& lv, const osg::Vec3& up) +

+ + +

obool calcMovement() +
For the give mouse movement calculate the movement of the camera. +Return true is camera has moved and a redraw is required. +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t1 +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t0 +

+ + +

oosg::ref_ptr<osg::Node> _node +

+ + +

ofloat _modelScale +

+ + +

ofloat _velocity +

+ + +

ofloat _height +

+ + +

ofloat _buffer +

+ + +

oenum SpeedControlMode +

+ + + +
o USE_MOUSE_Y_FOR_SPEED +

+ + +

o USE_MOUSE_BUTTONS_FOR_SPEED +

+ + + +
oSpeedControlMode _speedMode +

+ + +

oosg::Vec3 _eye +

+ + +

oosg::Quat _rotation +

+ + +

ofloat _distance +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/FlightManipulator.html b/doc/doc++/osgGA/FlightManipulator.html new file mode 100644 index 000000000..0437878c1 --- /dev/null +++ b/doc/doc++/osgGA/FlightManipulator.html @@ -0,0 +1,261 @@ + + + + + class OSGGA_EXPORT osgGA::FlightManipulator + + + + +

class OSGGA_EXPORT osgGA::FlightManipulator

FlightManipulator is a CameraManipulator which provides flight simulator-like updating of the camera position & orientation.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FlightManipulator() +
+[more]virtual const char* className() const +
+[more]virtual void setNode(osg::Node*) +
+[more]virtual const osg::Node* getNode() const +
+[more]virtual osg::Node* getNode() +
+[more]virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +
+[more]void setYawControlMode(YawControlMode ycm) +
Configure the Yaw control for the flight model. +

+ +

+

Public Members

+[more]enum YawControlMode +

+ +

+

Protected Fields

+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t1 +
+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t0 +
+[more]osg::ref_ptr<osg::Node> _node +
+[more]float _modelScale +
+[more]float _velocity +
+[more]YawControlMode _yawMode +
+[more]osg::Vec3 _eye +
+[more]osg::Quat _rotation +
+[more]float _distance +

+ +

+

Protected Methods

+[more]virtual ~FlightManipulator() +
+[more]void flushMouseEventStack() +
Reset the internal GUIEvent stack +
+[more]void addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +
+[more]void computeLocalDataFromCamera() +
+[more]void computeCameraFromLocalData() +
+[more]bool calcMovement() +
For the give mouse movement calculate the movement of the camera. +

+ +
+

Inherited from CameraManipulator:

+
+

+

Public Methods

+ovirtual void setCamera(osg::Camera*) +
+ovirtual const osg::Camera* getCamera() const +
+ovirtual osg::Camera* getCamera() +
+ovirtual void accept(GUIEventHandlerVisitor& v) +

+ +

+

Protected Fields

+oosg::ref_ptr<osg::Camera> _camera +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+FlightManipulator is a CameraManipulator which provides flight simulator-like +updating of the camera position & orientation. By default, the left mouse +button accelerates, the right mouse button decelerates, and the middle mouse +button (or left and right simultaneously) stops dead.
+
+ + + +
o FlightManipulator() +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void setNode(osg::Node*) +

+ + +

ovirtual const osg::Node* getNode() const +

+ + +

ovirtual osg::Node* getNode() +

+ + +

ovirtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

oenum YawControlMode +

+ + + +
o YAW_AUTOMATICALLY_WHEN_BANKED +

+ + +

o NO_AUTOMATIC_YAW +

+ + + +
ovoid setYawControlMode(YawControlMode ycm) +
Configure the Yaw control for the flight model. +

+ + +

ovirtual ~FlightManipulator() +

+ + +

ovoid flushMouseEventStack() +
Reset the internal GUIEvent stack +

+ + +

ovoid addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +

+ + +

ovoid computeLocalDataFromCamera() +

+ + +

ovoid computeCameraFromLocalData() +

+ + +

obool calcMovement() +
For the give mouse movement calculate the movement of the camera. +Return true is camera has moved and a redraw is required. +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t1 +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t0 +

+ + +

oosg::ref_ptr<osg::Node> _node +

+ + +

ofloat _modelScale +

+ + +

ofloat _velocity +

+ + +

oYawControlMode _yawMode +

+ + +

oosg::Vec3 _eye +

+ + +

oosg::Quat _rotation +

+ + +

ofloat _distance +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/GUIActionAdapter.html b/doc/doc++/osgGA/GUIActionAdapter.html new file mode 100644 index 000000000..7c9e6d5a6 --- /dev/null +++ b/doc/doc++/osgGA/GUIActionAdapter.html @@ -0,0 +1,97 @@ + + + + + class osgGA::GUIActionAdapter + + + + +

class osgGA::GUIActionAdapter

Abstract base class defining the interface by which GUIEventHandlers may request actions of the GUI system in use.
+
+ +
+

+

Public Methods

+[more]virtual void requestRedraw() = 0 +
requestRedraw() requests a single redraw +
+[more]virtual void requestContinuousUpdate(bool needed=true) = 0 +
requestContinousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a CameraManipulator, though other GUIEventHandler's may also provide functionality). +
+[more]virtual void requestWarpPointer(float x, float y) = 0 +
requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer to a specified x,y location on the window. +

+ +
+ + +
+

Documentation

+
+Abstract base class defining the interface by which GUIEventHandlers may request +actions of the GUI system in use. These requests for actions should then be honoured +by the GUI toolkit of the user's application. + +

To provide more detail, when a GUIEventHandler (e.g. a TrackballManipulator) +handles an incoming event, such as a mouse event, it may wish to make +a request of the GUI. E.g. if a model is 'thrown', the trackball manipulator +may wish to start a timer, and be repeatedly called, to continuously refresh the +camera's position and orientation. However, it has no way of doing this, as it +knows nothing of the window system in which it's operating. Instead, the +GUIEventHandler issues it's request via a GUIActionAdapter, and the viewer +in use should honour the request, using the GUI system in play. + +

There is more than one way of using the GUIActionAdapter. E.g. it may be inherited +into a Viewer class, as is done with osgGLUT::Viewer. Alternatively, a simple +subclass of GUIActionAdapter (e.g. osgQt::QtActionAdapter) may be passed to +the GUIEventHandler::handle() function; once the function has returned, the viewer +will then unpack the results and work out what to do to respond to the +requests. + +

Also there are several ways to run your app and handle the updating of +the window. osgGLUT::Viewer always has a idle callback registered which does a +redraw all the time. osgGLUT::Viewer can safely ignore both requestRedraw() and +requestContinousUpdate() as these are happening all the time anyway. + +

Other apps will probably want to respond to the requestRedraw() and +requestContinousUpdate(bool) and again there is more than one way to handle it. +You can override requestRedraw() and implement to call your own window +redraw straight away. Or you can implement so that a flag is set and +then you then respond the flag being set in your own leisure. +

+
+ + + +
ovirtual void requestRedraw() = 0 +
+requestRedraw() requests a single redraw +

+ + +

ovirtual void requestContinuousUpdate(bool needed=true) = 0 +
+requestContinousUpdate(bool) is for en/disabling a throw or idle +callback to be requested by a GUIEventHandler (typically a CameraManipulator, +though other GUIEventHandler's may also provide functionality). +GUI toolkits can respond to this immediately by registering an idle/timed +callback, or can delay setting the callback and update at their own leisure. +

+ + +

ovirtual void requestWarpPointer(float x, float y) = 0 +
+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. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/GUIEventAdapter.html b/doc/doc++/osgGA/GUIEventAdapter.html new file mode 100644 index 000000000..93dd3fd1c --- /dev/null +++ b/doc/doc++/osgGA/GUIEventAdapter.html @@ -0,0 +1,852 @@ + + + + + class OSGGA_EXPORT osgGA::GUIEventAdapter + + + + +

class OSGGA_EXPORT osgGA::GUIEventAdapter

Pure virtual base class for adapting platform specific events into generic keyboard and mouse events.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual EventType getEventType() const = 0 +
Get the EventType of the GUI event +
+[more]virtual int getKey() const = 0 +
key pressed, return -1 if inappr opriate for this event. +
+[more]virtual int getButton() const = 0 +
button pressed/released, return -1 if inappropriate for this event +
+[more]void setMouseYOrientation(MouseYOrientation myo) +
+[more]MouseYOrientation getMouseYOrientation() const +
+[more]virtual float getXmin() const = 0 +
manimum x mouse position. +
+[more]virtual float getXmax() const = 0 +
maximum x mouse position. +
+[more]virtual float getYmin() const = 0 +
minimum y mouse position. +
+[more]virtual float getYmax() const = 0 +
maximum y mouse position. +
+[more]virtual float getX() const = 0 +
current mouse x position +
+[more]virtual float getY() const = 0 +
current mouse y position +
+[more]virtual unsigned int getButtonMask() const = 0 +
current mouse button state +
+[more]virtual unsigned int getModKeyMask() const = 0 +
current modkey state +
+[more]virtual double time() const = 0 +
time in seconds of event. +
+[more]inline float getXnormalized() const +
return the getX() value normalised to the range of -1 to 1. +
+[more]inline float getYnormalized() const +
return the getY() value normalised to the range of -1 to 1. +

+ +

+

Public Members

+[more]enum MouseButtonMask +
+[more]enum EventType +
+[more]enum KeySymbol +
+[more]enum ModKeyMask +
+[more]enum MouseYOrientation +

+ +

+

Protected Fields

+[more]MouseYOrientation _mouseYOrientation +

+ +

+

Protected Methods

+[more] GUIEventAdapter(MouseYOrientation myo=Y_INCREASING_DOWNWARDS) +
+[more]virtual ~GUIEventAdapter() +
Force users to create on heap, so that multiple referencing is safe +

+ +
+ + +
+

Documentation

+
+Pure virtual base class for adapting platform specific events into +generic keyboard and mouse events. + +

Used as GUI toolkit-independent input into GUIEventAdapters. Viewer +writers should subclass this base class to implement the functionality +to translate one of their GUI events, e.g. a Qt Event or an MFC Event, +as appropriate.

+
+ + + +
oenum MouseButtonMask +

+ + + +
o LEFT_MOUSE_BUTTON +

+ + +

o MIDDLE_MOUSE_BUTTON +

+ + +

o RIGHT_MOUSE_BUTTON +

+ + + +
oenum EventType +

+ + + +
o PUSH +

+ + +

o RELEASE +

+ + +

o DOUBLECLICK +

+ + +

o DRAG +

+ + +

o MOVE +

+ + +

o KEYDOWN +

+ + +

o KEYUP +

+ + +

o FRAME +

+ + +

o RESIZE +

+ + +

o NONE +

+ + + +
oenum KeySymbol +

+ + + +
o KEY_Space +

+ + +

o KEY_BackSpace +

+ + +

o KEY_Tab +

+ + +

o KEY_Linefeed +

+ + +

o KEY_Clear +

+ + +

o KEY_Return +

+ + +

o KEY_Pause +

+ + +

o KEY_Scroll_Lock +

+ + +

o KEY_Sys_Req +

+ + +

o KEY_Escape +

+ + +

o KEY_Delete +

+ + +

o KEY_Home +

+ + +

o KEY_Left +

+ + +

o KEY_Up +

+ + +

o KEY_Right +

+ + +

o KEY_Down +

+ + +

o KEY_Prior +

+ + +

o KEY_Page_Up +

+ + +

o KEY_Next +

+ + +

o KEY_Page_Down +

+ + +

o KEY_End +

+ + +

o KEY_Begin +

+ + +

o KEY_Select +

+ + +

o KEY_Print +

+ + +

o KEY_Execute +

+ + +

o KEY_Insert +

+ + +

o KEY_Undo +

+ + +

o KEY_Redo +

+ + +

o KEY_Menu +

+ + +

o KEY_Find +

+ + +

o KEY_Cancel +

+ + +

o KEY_Help +

+ + +

o KEY_Break +

+ + +

o KEY_Mode_switch +

+ + +

o KEY_Script_switch +

+ + +

o KEY_Num_Lock +

+ + +

o KEY_KP_Space +

+ + +

o KEY_KP_Tab +

+ + +

o KEY_KP_Enter +

+ + +

o KEY_KP_F1 +

+ + +

o KEY_KP_F2 +

+ + +

o KEY_KP_F3 +

+ + +

o KEY_KP_F4 +

+ + +

o KEY_KP_Home +

+ + +

o KEY_KP_Left +

+ + +

o KEY_KP_Up +

+ + +

o KEY_KP_Right +

+ + +

o KEY_KP_Down +

+ + +

o KEY_KP_Prior +

+ + +

o KEY_KP_Page_Up +

+ + +

o KEY_KP_Next +

+ + +

o KEY_KP_Page_Down +

+ + +

o KEY_KP_End +

+ + +

o KEY_KP_Begin +

+ + +

o KEY_KP_Insert +

+ + +

o KEY_KP_Delete +

+ + +

o KEY_KP_Equal +

+ + +

o KEY_KP_Multiply +

+ + +

o KEY_KP_Add +

+ + +

o KEY_KP_Separator +

+ + +

o KEY_KP_Subtract +

+ + +

o KEY_KP_Decimal +

+ + +

o KEY_KP_Divide +

+ + +

o KEY_KP_0 +

+ + +

o KEY_KP_1 +

+ + +

o KEY_KP_2 +

+ + +

o KEY_KP_3 +

+ + +

o KEY_KP_4 +

+ + +

o KEY_KP_5 +

+ + +

o KEY_KP_6 +

+ + +

o KEY_KP_7 +

+ + +

o KEY_KP_8 +

+ + +

o KEY_KP_9 +

+ + +

o KEY_F1 +

+ + +

o KEY_F2 +

+ + +

o KEY_F3 +

+ + +

o KEY_F4 +

+ + +

o KEY_F5 +

+ + +

o KEY_F6 +

+ + +

o KEY_F7 +

+ + +

o KEY_F8 +

+ + +

o KEY_F9 +

+ + +

o KEY_F10 +

+ + +

o KEY_F11 +

+ + +

o KEY_F12 +

+ + +

o KEY_F13 +

+ + +

o KEY_F14 +

+ + +

o KEY_F15 +

+ + +

o KEY_F16 +

+ + +

o KEY_F17 +

+ + +

o KEY_F18 +

+ + +

o KEY_F19 +

+ + +

o KEY_F20 +

+ + +

o KEY_F21 +

+ + +

o KEY_F22 +

+ + +

o KEY_F23 +

+ + +

o KEY_F24 +

+ + +

o KEY_F25 +

+ + +

o KEY_F26 +

+ + +

o KEY_F27 +

+ + +

o KEY_F28 +

+ + +

o KEY_F29 +

+ + +

o KEY_F30 +

+ + +

o KEY_F31 +

+ + +

o KEY_F32 +

+ + +

o KEY_F33 +

+ + +

o KEY_F34 +

+ + +

o KEY_F35 +

+ + +

o KEY_Shift_L +

+ + +

o KEY_Shift_R +

+ + +

o KEY_Control_L +

+ + +

o KEY_Control_R +

+ + +

o KEY_Caps_Lock +

+ + +

o KEY_Shift_Lock +

+ + +

o KEY_Meta_L +

+ + +

o KEY_Meta_R +

+ + +

o KEY_Alt_L +

+ + +

o KEY_Alt_R +

+ + +

o KEY_Super_L +

+ + +

o KEY_Super_R +

+ + +

o KEY_Hyper_L +

+ + +

o KEY_Hyper_R +

+ + + +
oenum ModKeyMask +

+ + + +
o MODKEY_LEFT_SHIFT +

+ + +

o MODKEY_RIGHT_SHIFT +

+ + +

o MODKEY_LEFT_CTRL +

+ + +

o MODKEY_RIGHT_CTRL +

+ + +

o MODKEY_LEFT_ALT +

+ + +

o MODKEY_RIGHT_ALT +

+ + +

o MODKEY_LEFT_META +

+ + +

o MODKEY_RIGHT_META +

+ + +

o MODKEY_NUM_LOCK +

+ + +

o MODKEY_CAPS_LOCK +

+ + +

o MODKEY_CTRL +

+ + +

o MODKEY_SHIFT +

+ + +

o MODKEY_ALT +

+ + +

o MODKEY_META +

+ + + +
ovirtual EventType getEventType() const = 0 +
Get the EventType of the GUI event +

+ + +

ovirtual int getKey() const = 0 +
key pressed, return -1 if inappr opriate for this event. +

+ + +

ovirtual int getButton() const = 0 +
button pressed/released, return -1 if inappropriate for this event +

+ + +

oenum MouseYOrientation +

+ + + +
o Y_INCREASING_UPWARDS +

+ + +

o Y_INCREASING_DOWNWARDS +

+ + + +
ovoid setMouseYOrientation(MouseYOrientation myo) +

+ + +

oMouseYOrientation getMouseYOrientation() const +

+ + +

ovirtual float getXmin() const = 0 +
manimum x mouse position. +

+ + +

ovirtual float getXmax() const = 0 +
maximum x mouse position. +

+ + +

ovirtual float getYmin() const = 0 +
minimum y mouse position. +

+ + +

ovirtual float getYmax() const = 0 +
maximum y mouse position. +

+ + +

ovirtual float getX() const = 0 +
current mouse x position +

+ + +

ovirtual float getY() const = 0 +
current mouse y position +

+ + +

ovirtual unsigned int getButtonMask() const = 0 +
current mouse button state +

+ + +

ovirtual unsigned int getModKeyMask() const = 0 +
current modkey state +

+ + +

ovirtual double time() const = 0 +
time in seconds of event. +

+ + +

oinline float getXnormalized() const +
return the getX() value normalised to the range of -1 to 1. +-1 would be the left hand side of the window. +0.0 would be the middle of the window. ++1 would be the right hand side of the window. +

+ + +

oinline float getYnormalized() const +
return the getY() value normalised to the range of -1 to 1. +-1 would be the bottom of the window. +0.0 would be the middle of the window. ++1 would be the top of the window. +

+ + +

o GUIEventAdapter(MouseYOrientation myo=Y_INCREASING_DOWNWARDS) +

+ + +

ovirtual ~GUIEventAdapter() +
Force users to create on heap, so that multiple referencing is safe +

+ + +

oMouseYOrientation _mouseYOrientation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/GUIEventHandler.html b/doc/doc++/osgGA/GUIEventHandler.html new file mode 100644 index 000000000..23d663c00 --- /dev/null +++ b/doc/doc++/osgGA/GUIEventHandler.html @@ -0,0 +1,110 @@ + + + + + class OSGGA_EXPORT osgGA::GUIEventHandler + + + + +

class OSGGA_EXPORT osgGA::GUIEventHandler

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] GUIEventHandler() +
+[more] GUIEventHandler(const GUIEventHandler&, const osg::CopyOp&) +
+[more]META_Object (osgGA, GUIEventHandler) const () const +
+[more]virtual CompositeGUIEventHandler* getComposite() +
Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler. +
+[more]virtual bool handle(const GUIEventAdapter&, GUIActionAdapter&) +
Handle events, return true if handled, false otherwise. +
+[more]virtual void accept(GUIEventHandlerVisitor&) +
Accept visits from GUIEventHandler visitors +
+[more]virtual void getUsage(osg::ApplicationUsage&) const +
Get the keyboard and mouse usage of this manipulator +

+ +
+ + +
+

Documentation

+
+ +

GUIEventHandler provides a basic interface for any class which wants to handle +a GUI Events. + +

The GUIEvent is supplied by a GUIEventAdapter. Feedback resulting from the +handle method is supplied by a GUIActionAdapter, which allows the GUIEventHandler +to ask the GUI to take some action in response to an incoming event. + +

For example, consider a Trackball Viewer class which takes mouse events and +manipulates a scene camera in response. The Trackball Viewer is a GUIEventHandler, +and receives the events via the handle method. If the user 'throws' the model, +the Trackball Viewer class can detect this via the incoming events, and +request that the GUI set up a timer callback to continually redraw the view. +This request is made via the GUIActionAdapter class. +

+
+ + + +
o GUIEventHandler() +

+ + +

o GUIEventHandler(const GUIEventHandler&, const osg::CopyOp&) +

+ + +

oMETA_Object (osgGA, GUIEventHandler) const () const +

+ + +

ovirtual CompositeGUIEventHandler* getComposite() +
Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler. +

+ + +

ovirtual bool handle(const GUIEventAdapter&, GUIActionAdapter&) +
Handle events, return true if handled, false otherwise. +

+ + +

ovirtual void accept(GUIEventHandlerVisitor&) +
Accept visits from GUIEventHandler visitors +

+ + +

ovirtual void getUsage(osg::ApplicationUsage&) const +
Get the keyboard and mouse usage of this manipulator +

+
+
Direct child classes: +
StateSetManipulator
+CompositeGUIEventHandler
+CameraManipulator
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/GUIEventHandlerVisitor.html b/doc/doc++/osgGA/GUIEventHandlerVisitor.html new file mode 100644 index 000000000..c96605b26 --- /dev/null +++ b/doc/doc++/osgGA/GUIEventHandlerVisitor.html @@ -0,0 +1,105 @@ + + + + + class OSGGA_EXPORT osgGA::GUIEventHandlerVisitor + + + + +

class OSGGA_EXPORT osgGA::GUIEventHandlerVisitor

Base class for visiting GUIEventHandlers.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void visit(GUIEventHandler&) +
+[more]virtual void visit(CompositeGUIEventHandler&) +
+[more]virtual void visit(CameraManipulator&) +
+[more]virtual void visit(StateSetManipulator&) +
+[more]const GUIEventAdapter* getGUIEventAdapter() +
Get the GUI EventAdapter associated with this GUIEventHandlerVisitor +
+[more]GUIActionAdapter* getGUIActionAdapter() +
Get the GUI Action Adapter associated with this GEH Visitor +

+ +

+

Protected Methods

+[more] GUIEventHandlerVisitor(GUIEventAdapter* in, GUIActionAdapter* out) +
+[more]virtual ~GUIEventHandlerVisitor() +

+ +
+ + +
+

Documentation

+
+Base class for visiting GUIEventHandlers. + +

A Default Visitor, (Might want to make it an Extrinsic Visitor at some point). +By default, it does nothing to the things it visits. Sub classes of this Visitor +need only override visit operations for the types of object they're interested in. +

+
+ + + +
ovirtual void visit(GUIEventHandler&) +

+ + +

ovirtual void visit(CompositeGUIEventHandler&) +

+ + +

ovirtual void visit(CameraManipulator&) +

+ + +

ovirtual void visit(StateSetManipulator&) +

+ + +

oconst GUIEventAdapter* getGUIEventAdapter() +
Get the GUI EventAdapter associated with this GUIEventHandlerVisitor +

+ + +

oGUIActionAdapter* getGUIActionAdapter() +
Get the GUI Action Adapter associated with this GEH Visitor +

+ + +

o GUIEventHandlerVisitor(GUIEventAdapter* in, GUIActionAdapter* out) +

+ + +

ovirtual ~GUIEventHandlerVisitor() +

+
+
Direct child classes: +
SetSceneViewVisitor
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/General.html b/doc/doc++/osgGA/General.html new file mode 100644 index 000000000..5be97a896 --- /dev/null +++ b/doc/doc++/osgGA/General.html @@ -0,0 +1,64 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGGA_ANIMATION_PATH_MANIPULATOR
+ +o#define +OSGGA_CAMERAMANIPULATOR
+ +o#define +OSGGA_DRIVEMANIPULATOR
+ +o#define +OSGGA_EXPORT_
+ +o#define +OSGGA_EXPORT(dllexport)
+ +o#define +OSGGA_EXPORT(dllimport)
+ +o#define +OSGGA_EXPORT
+ +o#define +OSGGA_GUIACTIONADAPTER
+ +o#define +OSGGA_GUIEVENTADAPTER
+ +o#define +OSGGA_GUIEVENTHANDLER
+ +o#define +OSGGA_GUIEVENTHANDLERVISITOR
+ +o#define +OSGUTIL_KEYSWITCHCAMERAMANIPULATORER
+ +o#define +OSGGA_SETSCENEVIEWGEHVISITOR
+ +o#define +OSGGA_GEOSTATE_MANIPULATOR
+ +o#define +OSGGA_TRACKBALLMANIPULATOR
+ +o#define +OSGGA_VERSION
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/HIER.html b/doc/doc++/osgGA/HIER.html new file mode 100644 index 000000000..c3b40ebf1 --- /dev/null +++ b/doc/doc++/osgGA/HIER.html @@ -0,0 +1,35 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/HIERjava.html b/doc/doc++/osgGA/HIERjava.html new file mode 100644 index 000000000..467531fed --- /dev/null +++ b/doc/doc++/osgGA/HIERjava.html @@ -0,0 +1,44 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/KeySwitchCameraManipulator.html b/doc/doc++/osgGA/KeySwitchCameraManipulator.html new file mode 100644 index 000000000..90ed03916 --- /dev/null +++ b/doc/doc++/osgGA/KeySwitchCameraManipulator.html @@ -0,0 +1,192 @@ + + + + + class OSGGA_EXPORT osgGA::KeySwitchCameraManipulator + + + + +

class OSGGA_EXPORT osgGA::KeySwitchCameraManipulator

KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* className() +
+[more]void addCameraManipulator(int key, std::string name, CameraManipulator* cm) +
Add a camera manipulator with an associated name, and a key to trigger the switch, +
+[more]void addNumberedCameraManipulator(CameraManipulator* cm) +
Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd +
+[more]unsigned int getNumCameraManipualtors() const +
+[more]void selectCameraManipulator(unsigned int num) +
+[more]CameraManipulator* getCurrentCameraManipulator() +
+[more]const CameraManipulator* getCurrentCameraManipulator() const +
+[more]CameraManipulator* getCameraManipulator(unsigned int num) +
+[more]const CameraManipulator* getCameraManipulator(unsigned int num) const +
+[more]virtual void setCamera(osg::Camera* c) +
+[more]virtual const osg::Camera* getCamera() const +
+[more]virtual osg::Camera* getCamera() +
+[more]virtual void setNode(osg::Node* n) +
+[more]virtual const osg::Node* getNode() const +
+[more]virtual osg::Node* getNode() +
+[more]virtual void home(const GUIEventAdapter& ee, GUIActionAdapter& aa) +
+[more]virtual void init(const GUIEventAdapter& ee, GUIActionAdapter& aa) +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +
+

Inherited from CameraManipulator:

+
+

+

Public Methods

+ovirtual void accept(GUIEventHandlerVisitor& v) +

+ +

+

Protected Fields

+oosg::ref_ptr<osg::Camera> _camera +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator +being used to be switched by pressing a key. E.g. '1' for a TrackballManipultor, +'2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available, +and the associated switch keys, can be configured.
+
+ + + +
ovirtual const char* className() +

+ + +

ovoid addCameraManipulator(int key, std::string name, CameraManipulator* cm) +
+Add a camera manipulator with an associated name, and a key to +trigger the switch, +

+ + +

ovoid addNumberedCameraManipulator(CameraManipulator* cm) +
+Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd +

+ + +

ounsigned int getNumCameraManipualtors() const +

+ + +

ovoid selectCameraManipulator(unsigned int num) +

+ + +

oCameraManipulator* getCurrentCameraManipulator() +

+ + +

oconst CameraManipulator* getCurrentCameraManipulator() const +

+ + +

oCameraManipulator* getCameraManipulator(unsigned int num) +

+ + +

oconst CameraManipulator* getCameraManipulator(unsigned int num) const +

+ + +

ovirtual void setCamera(osg::Camera* c) +

+ + +

ovirtual const osg::Camera* getCamera() const +

+ + +

ovirtual osg::Camera* getCamera() +

+ + +

ovirtual void setNode(osg::Node* n) +

+ + +

ovirtual const osg::Node* getNode() const +

+ + +

ovirtual osg::Node* getNode() +

+ + +

ovirtual void home(const GUIEventAdapter& ee, GUIActionAdapter& aa) +

+ + +

ovirtual void init(const GUIEventAdapter& ee, GUIActionAdapter& aa) +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/NavigatorButton.class b/doc/doc++/osgGA/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..fad9c3f2df2c760c687fdc6eda2469ed021768b5 GIT binary patch literal 1816 zcma)7S#ujj5dPMZHPU*^hiv&sNH8Q3_S%lZeK-lkik*mv*oBFMU0kE}N?xv1xibqn#kD}+gU5_!BX#;D;n`B(a^uM+`-V z`wW{5pD=vM;4)MhJO-bk#_$zGz))upI#O8BF)oRLMJbt*ETy1hIR%ClNv`S`K~757 zBzakqS0s5gg$cZ-lk)3Q0_&1&7~ptl zz{1A{_OWBY#!Uldd}g462L>D|9m?A#b`2a!1INf4IKeFgU*mlP-$=c0@vedIuxH?V z+}5DaJN5a3C+wiiEnCCH!ea4|H+ha9iQI6RyBUt`liffH>*$yb+ z0rkj8lx<&TUG+@A^^Q7)H**GFD9FIq&bSHV_H2=R@L@5k0#PCEt(-gHMMz_8Z#Q=os1>mTio5@fx}C#O+k&_=S`==g&(Xngz!CzdE0LU zmc8M)lz>K~l;D=kKnk^*?d?;xC6!&gdDXjM=wniy z2a87EokG>zcDqMy=%L}nYMA~n6b|^H?nzzPRVu3I2UYHdeq(B6SWULdrMj|ur&hX> z0-H+KkcBqt2maA*-)dA<0>ky1+9gThcY=sD0vblvl=HS(258l#i0bsCWkwWoCn-)_ zN^#n1iqncyycBU-bm~l-P;uIMiZ>LGk$evYXxJj@XC!FH0*}n4Q>4wza0?gAl@{jA zq%Gm~iHvYBBmJZJuj*=LwEpTgKp$KvD0DW+POCHP_w9**FP1Yh_Om&_-a zY2(Ewc>XEIcb9&{OQ)DjYi&%oaixuUQp-NWh$*eK@dB~SKZVCxI{u=9*KmOMqM);g zlLVZLET)IZp4rB^HZq~b&YRD%7QMNKA^LBF${_m}rpd{i^!qz54N(>1595zxk4cwd Q3NsibO%0zC9l{6y0?tduvj6}9 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/SetSceneViewVisitor.html b/doc/doc++/osgGA/SetSceneViewVisitor.html new file mode 100644 index 000000000..bed5739f0 --- /dev/null +++ b/doc/doc++/osgGA/SetSceneViewVisitor.html @@ -0,0 +1,79 @@ + + + + + class OSGGA_EXPORT osgGA::SetSceneViewVisitor + + + + +

class OSGGA_EXPORT osgGA::SetSceneViewVisitor

SetSceneViewGUIEventHandlerVisitor which visits various types of GUIEventHandler and sets them up appropriately, given a new scene view
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] SetSceneViewVisitor(GUIEventAdapter* in, GUIActionAdapter* out, osgUtil::SceneView* sv) +
+[more]virtual ~SetSceneViewVisitor() +
+[more]virtual void visit(CameraManipulator& cm) +
+[more]virtual void visit(StateSetManipulator& cm) +

+ +
+

Inherited from GUIEventHandlerVisitor:

+
+

+

Public Methods

+oconst GUIEventAdapter* getGUIEventAdapter() +
+oGUIActionAdapter* getGUIActionAdapter() +

+ +
+ + +
+

Documentation

+
+SetSceneViewGUIEventHandlerVisitor which visits various types of +GUIEventHandler and sets them up appropriately, given a new scene +view
+
+ + + +
o SetSceneViewVisitor(GUIEventAdapter* in, GUIActionAdapter* out, osgUtil::SceneView* sv) +

+ + +

ovirtual ~SetSceneViewVisitor() +

+ + +

ovirtual void visit(CameraManipulator& cm) +

+ + +

ovirtual void visit(StateSetManipulator& cm) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/StateSetManipulator.html b/doc/doc++/osgGA/StateSetManipulator.html new file mode 100644 index 000000000..5b0ee2458 --- /dev/null +++ b/doc/doc++/osgGA/StateSetManipulator.html @@ -0,0 +1,147 @@ + + + + + class OSGGA_EXPORT osgGA::StateSetManipulator + + + + +

class OSGGA_EXPORT osgGA::StateSetManipulator

Experimental class, not been looked at for a while, but which will be returned to at some point :-\
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] StateSetManipulator() +
+[more]virtual ~StateSetManipulator() +
+[more]virtual const char* className() +
+[more]virtual void setStateSet(osg::StateSet*) +
attach a geostate to the manipulator to be used for specifying view +
+[more]virtual osg::StateSet* getStateSet() +
get the attached a geostate +
+[more]virtual const osg::StateSet* getStateSet() const +
get the attached a geostate +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Handle events, return true if handled, false otherwise +
+[more]virtual void accept(GUIEventHandlerVisitor&) +
Handle visitations +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::StateSet> _drawState +
+[more]bool _backface +
+[more]bool _lighting +
+[more]bool _texture +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+Experimental class, not been looked at for a while, but which will +be returned to at some point :-\
+
+ + + +
o StateSetManipulator() +

+ + +

ovirtual ~StateSetManipulator() +

+ + +

ovirtual const char* className() +

+ + +

ovirtual void setStateSet(osg::StateSet*) +
attach a geostate to the manipulator to be used for specifying view +

+ + +

ovirtual osg::StateSet* getStateSet() +
get the attached a geostate +

+ + +

ovirtual const osg::StateSet* getStateSet() const +
get the attached a geostate +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Handle events, return true if handled, false otherwise +

+ + +

ovirtual void accept(GUIEventHandlerVisitor&) +
Handle visitations +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

oosg::ref_ptr<osg::StateSet> _drawState +

+ + +

obool _backface +

+ + +

obool _lighting +

+ + +

obool _texture +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/TrackballManipulator.html b/doc/doc++/osgGA/TrackballManipulator.html new file mode 100644 index 000000000..8d2c32b12 --- /dev/null +++ b/doc/doc++/osgGA/TrackballManipulator.html @@ -0,0 +1,265 @@ + + + + + class OSGGA_EXPORT osgGA::TrackballManipulator + + + + +

class OSGGA_EXPORT osgGA::TrackballManipulator

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TrackballManipulator() +
+[more]virtual const char* className() const +
+[more]virtual void setNode(osg::Node*) +
Attach a node to the manipulator. +
+[more]virtual const osg::Node* getNode() const +
Return node if attached +
+[more]virtual osg::Node* getNode() +
Return node if attached +
+[more]virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Move the camera to the default position. +
+[more]virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Start/restart the manipulator +
+[more]virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
handle events, return true if handled, false otherwise +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ +

+

Protected Fields

+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t1 +
+[more]osg::ref_ptr<const GUIEventAdapter> _ga_t0 +
+[more]osg::ref_ptr<osg::Node> _node +
+[more]float _modelScale +
+[more]float _minimumZoomScale +
+[more]bool _thrown +
+[more]osg::Vec3 _center +
+[more]osg::Quat _rotation +
+[more]float _distance +

+ +

+

Protected Methods

+[more]virtual ~TrackballManipulator() +
+[more]void flushMouseEventStack() +
Reset the internal GUIEvent stack +
+[more]void addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +
+[more]void computeLocalDataFromCamera() +
+[more]void computeCameraFromLocalData() +
+[more]bool calcMovement() +
For the give mouse movement calculate the movement of the camera. +
+[more]void trackball(osg::Vec3& axis, float& angle, float p1x, float p1y, float p2x, float p2y) +
+[more]float tb_project_to_sphere(float r, float x, float y) +
+[more]bool isMouseMoving() +
Check the speed at which the mouse is moving. +

+ +
+

Inherited from CameraManipulator:

+
+

+

Public Methods

+ovirtual void setCamera(osg::Camera*) +
+ovirtual const osg::Camera* getCamera() const +
+ovirtual osg::Camera* getCamera() +
+ovirtual void accept(GUIEventHandlerVisitor& v) +

+ +

+

Protected Fields

+oosg::ref_ptr<osg::Camera> _camera +

+ +
+

Inherited from GUIEventHandler:

+
+

+

Public Methods

+oMETA_Object (osgGA, GUIEventHandler) const () const +
+ovirtual CompositeGUIEventHandler* getComposite() +

+ +
+ + +
+

Documentation

+
+ + + +
o TrackballManipulator() +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void setNode(osg::Node*) +
Attach a node to the manipulator. +Automatically detaches previously attached node. +setNode(NULL) detaches previously nodes. +Is ignored by manipulators which do not require a reference model. +

+ + +

ovirtual const osg::Node* getNode() const +
Return node if attached +

+ + +

ovirtual osg::Node* getNode() +
Return node if attached +

+ + +

ovirtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Move the camera to the default position. +May be ignored by manipulators if home functionality is not appropriate. +

+ + +

ovirtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us) +
Start/restart the manipulator +

+ + +

ovirtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) +
handle events, return true if handled, false otherwise +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

ovirtual ~TrackballManipulator() +

+ + +

ovoid flushMouseEventStack() +
Reset the internal GUIEvent stack +

+ + +

ovoid addMouseEvent(const GUIEventAdapter& ea) +
Add the current mouse GUIEvent to internal stack +

+ + +

ovoid computeLocalDataFromCamera() +

+ + +

ovoid computeCameraFromLocalData() +

+ + +

obool calcMovement() +
For the give mouse movement calculate the movement of the camera. +Return true is camera has moved and a redraw is required. +

+ + +

ovoid trackball(osg::Vec3& axis, float& angle, float p1x, float p1y, float p2x, float p2y) +

+ + +

ofloat tb_project_to_sphere(float r, float x, float y) +

+ + +

obool isMouseMoving() +
Check the speed at which the mouse is moving. +If speed is below a threshold then return false, otherwise return true. +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t1 +

+ + +

oosg::ref_ptr<const GUIEventAdapter> _ga_t0 +

+ + +

oosg::ref_ptr<osg::Node> _node +

+ + +

ofloat _modelScale +

+ + +

ofloat _minimumZoomScale +

+ + +

obool _thrown +

+ + +

oosg::Vec3 _center +

+ + +

oosg::Quat _rotation +

+ + +

ofloat _distance +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/icon1.gif b/doc/doc++/osgGA/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/icon2.gif b/doc/doc++/osgGA/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgGA/index.html b/doc/doc++/osgGA/index.html new file mode 100644 index 000000000..48b5e933a --- /dev/null +++ b/doc/doc++/osgGA/index.html @@ -0,0 +1,50 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

General stuff

+ +

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/osgGA.html b/doc/doc++/osgGA/osgGA.html new file mode 100644 index 000000000..b2093e7c0 --- /dev/null +++ b/doc/doc++/osgGA/osgGA.html @@ -0,0 +1,60 @@ + + + + + namespace osgGA + + + + +

namespace osgGA

+
+

+
+class OSGGA_EXPORT AnimationPathManipulator: public CameraManipulator +
+class OSGGA_EXPORT CameraManipulator: public GUIEventHandler +
+class OSGGA_EXPORT DriveManipulator: public CameraManipulator +
DriveManipulator is a camera manipulator which provides drive-like functionality. +
+class OSGGA_EXPORT FlightManipulator: public CameraManipulator +
FlightManipulator is a CameraManipulator which provides flight simulator-like updating of the camera position & orientation. +
+class GUIActionAdapter +
Abstract base class defining the interface by which GUIEventHandlers may request actions of the GUI system in use. +
+class OSGGA_EXPORT GUIEventAdapter: public osg::Referenced +
Pure virtual base class for adapting platform specific events into generic keyboard and mouse events. +
+class OSGGA_EXPORT GUIEventHandler: public virtual osg::Object +
+class OSGGA_EXPORT CompositeGUIEventHandler: public GUIEventHandler +
CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies +
+class OSGGA_EXPORT GUIEventHandlerVisitor +
Base class for visiting GUIEventHandlers. +
+class OSGGA_EXPORT KeySwitchCameraManipulator: public CameraManipulator +
KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key. +
+class OSGGA_EXPORT SetSceneViewVisitor: public GUIEventHandlerVisitor +
SetSceneViewGUIEventHandlerVisitor which visits various types of GUIEventHandler and sets them up appropriately, given a new scene view +
+class OSGGA_EXPORT StateSetManipulator: public GUIEventHandler +
Experimental class, not been looked at for a while, but which will be returned to at some point :-\ +
+class OSGGA_EXPORT TrackballManipulator: public CameraManipulator +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/osgGAGetLibraryName.html b/doc/doc++/osgGA/osgGAGetLibraryName.html new file mode 100644 index 000000000..f72a742b7 --- /dev/null +++ b/doc/doc++/osgGA/osgGAGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGGA_EXPORT const char* osgGAGetLibraryName + + + + +

extern OSGGA_EXPORT const char* osgGAGetLibraryName

()

getLibraryName_osgGA() returns the library name in human friendly form
+ + +
+

Documentation

+
+getLibraryName_osgGA() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/osgGAGetVersion.html b/doc/doc++/osgGA/osgGAGetVersion.html new file mode 100644 index 000000000..8823a2e08 --- /dev/null +++ b/doc/doc++/osgGA/osgGAGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGGA_EXPORT const char* osgGAGetVersion + + + + +

extern OSGGA_EXPORT const char* osgGAGetVersion

()

getVersion_osgGA() returns the library version number.
+ + +
+

Documentation

+
+getVersion_osgGA() returns the library version number. +Numbering convention : osg_src-0.8-31 will return 0.8.31 from getVersion_osgGA. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) utility library +# +AC_CHECK_LIB(osg, osgGAGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph utility library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgGA/spaceosgGA.html b/doc/doc++/osgGA/spaceosgGA.html new file mode 100644 index 000000000..b9c942f0c --- /dev/null +++ b/doc/doc++/osgGA/spaceosgGA.html @@ -0,0 +1,40 @@ + + + + + #define space osgGA + + + + +

#define space osgGA

+
+ +

+The 'GA' in osgGA stands for 'GUI Abstraction'; the osgGA namespace provides facilities to +help developers write the glue to allow the osg to work with varying window systems. + +

As a cross-platform, window system-agnostic class library, the OpenSceneGraph +has no direct ties to any given windowing environment. Viewers, however, must at +some level interact with a window system - where Window system may refer to a windowing +API, e.g. GLUT, Qt, FLTK, MFC, ... + +

There is much commonality in the implementation of Viewers for varying windowing +environments. E.g. most Viewers will update a Camera position in response to a mouse +event, and may request that a timer be started as a result of a model being 'spun'. + +

The purpose of the osgGA namespace is to centralise the common areas of this +functionality. The viewer writer needs then only write a GUIEventAdapter, a +GUIActionAdapter, and assemble a collection of GUIEventHandlers +as appropriate for the viewer. + +

Events from the windowing environment are adpated, and then fed into the GUIEventHandlers. +The GUIEventHandlers analyse and take action, and make requests of the windowing +environemnt via the GUIActionAdapter. The viewer writer should then honour these +requests, translating them into calls to the windowing API. +

+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/AccelOperator.html b/doc/doc++/osgParticle/AccelOperator.html new file mode 100644 index 000000000..11236f329 --- /dev/null +++ b/doc/doc++/osgParticle/AccelOperator.html @@ -0,0 +1,134 @@ + + + + + class osgParticle::AccelOperator + + + + +

class osgParticle::AccelOperator

An operator class that applies a constant acceleration to the particles
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, AccelOperator) +
+[more]inline AccelOperator() +
+[more]inline AccelOperator(const AccelOperator &copy, const osg::CopyOp &copyop) +
+[more]inline const osg::Vec3& getAcceleration() const +
Get the acceleration vector +
+[more]inline void setAcceleration(const osg::Vec3 &v) +
Set the acceleration vector +
+[more]inline void setToGravity(float scale) +
Quickly set the acceleration vector to the gravity on earth (0, 0, -981). +
+[more]inline void operate(Particle* P, double dt) +
Apply the acceleration to a particle. +
+[more]inline void beginOperate(Program* prg) +
Perform some initializations. +

+ +

+

Protected Methods

+[more]virtual ~AccelOperator() +
+[more]AccelOperator& operator=(const AccelOperator &) +

+ +
+

Inherited from Operator:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual void endOperate() +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +

+ +
+ + +
+

Documentation

+
An operator class that applies a constant acceleration to the particles
+
+ + + +
o META_Object(osgParticle, AccelOperator) +

+ + +

ovirtual ~AccelOperator() +

+ + +

oAccelOperator& operator=(const AccelOperator &) +

+ + +

oinline AccelOperator() +

+ + +

oinline AccelOperator(const AccelOperator &copy, const osg::CopyOp &copyop) +

+ + +

oinline const osg::Vec3& getAcceleration() const +
Get the acceleration vector +

+ + +

oinline void setAcceleration(const osg::Vec3 &v) +
Set the acceleration vector +

+ + +

oinline void setToGravity(float scale) +
Quickly set the acceleration vector to the gravity on earth (0, 0, -981). +The acceleration will be multiplied by the scale parameter. +

+ + +

oinline void operate(Particle* P, double dt) +
Apply the acceleration to a particle. Do not call this method manually. +

+ + +

oinline void beginOperate(Program* prg) +
Perform some initializations. Do not call this method manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/CenteredPlacer.html b/doc/doc++/osgParticle/CenteredPlacer.html new file mode 100644 index 000000000..1c934d20f --- /dev/null +++ b/doc/doc++/osgParticle/CenteredPlacer.html @@ -0,0 +1,121 @@ + + + + + class osgParticle::CenteredPlacer + + + + +

class osgParticle::CenteredPlacer

An abstract placer base class for placers which need a center point
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]inline CenteredPlacer() +
+[more]inline CenteredPlacer(const CenteredPlacer &copy, const osg::CopyOp &copyop) +
+[more]inline const osg::Vec3& getCenter() const +
Get the center point +
+[more]inline void setCenter(const osg::Vec3 &v) +
Set the center point +
+[more]inline void setCenter(float x, float y, float z) +
Set the center point +

+ +

+

Protected Methods

+[more]virtual ~CenteredPlacer() +

+ +
+

Inherited from Placer:

+
+

+

Public Methods

+ovirtual void place(Particle* P) const +

+ +

+

Protected Methods

+oPlacer& operator=(const Placer &) +

+ +
+ + +
+

Documentation

+
An abstract placer base class for placers which need a center point
+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual ~CenteredPlacer() +

+ + +

oinline CenteredPlacer() +

+ + +

oinline CenteredPlacer(const CenteredPlacer &copy, const osg::CopyOp &copyop) +

+ + +

oinline const osg::Vec3& getCenter() const +
Get the center point +

+ + +

oinline void setCenter(const osg::Vec3 &v) +
Set the center point +

+ + +

oinline void setCenter(float x, float y, float z) +
Set the center point +

+
+
Direct child classes: +
SectorPlacer
+PointPlacer
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ClassGraph.class b/doc/doc++/osgParticle/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..4f41a1fb2fdf65525a700ad591fe8a696f29497f GIT binary patch literal 1237 zcma)6*-{fh6g@+hNrou`K|w^^#V{;!Uxf)I{zh+h=K3 zsd!waUo=!!3dIjq#=y{V{6M7_+&wM=R|*RBw*!KzHaBtvg;Em*1L4$)R)eWlU#iPW zPx={+I$h{qMG7udrcI%d+6D~_cO;*T)@?>RB02V1R@EvKtjwE3##>R3iE=uxd{>m) zBRU}i>WsuD>(0FYN6y?~v%I|}%|80f6|R~yU}ZfP1j|0Fd@ztWac1<5bRp|ZaL+(* zBd2*{+H_Wyxb7lFpqNkv=2f-7cv$2WMb{J<7|5NpZ8V{KN}fKEfxet9GOxgVm+g3* zDidpL-z_sG{rRd=Qc&Z(tolX1yd+@k)$&&}|#YQU4bz2pm?{eSgrM&xv$VGh~Gz=@?#JBjV?8~a4HN?qp z7K6@BA1O#fe|02#$X>+^$qadih$BMUbCQu7F65kKnAED1>>;)0B%`Ee!%i|p`WwzW zzmV7t)sd`WjO^I<MT3FyI-fA42Q3jhEB literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/ClassGraphPanel.class b/doc/doc++/osgParticle/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..4f3ea86bb625e4e043d10fafb3b0b05cf2f96537 GIT binary patch literal 4084 zcmbtWX>c4@5&lLyyR*lXB(J?mmPm#W>_{tH!Xb!QvIDl97=dgjR%}Nym>unoq_tNw z%I>VBgm4=IB%DP##03F|V>uGQMp~IT2Uj@Eec$=X4~qX(Q550pH+#lP%0Q{quiy8& zzwYVR@4dbF@5i1*09)})825$ofiON6#sgt|GK|lJ@kkh73FCWV{5*``hVd5zA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR24!kakD@AO?>!awz zSQOpZ7sUqbkDwg~MBExd9JfWW9tUMQF5-6aI3(KPD8-Q|uD~5pbYViUNfAfI&*JSSK8J@*d|pHu51RM_7EF8*XH0wvr%Zeqo{2|s z+Qe7!P7`0lTTPtByG@+Kr%ZfZOqOw%i51Z*__T>t@%TPIZsG^x@k3d-DA3DR-0hY=%^o*qaSt+1JW2YqzSe4J&p86+`L;D7Btm@&ds}y?RdjYUozs> zK>3me#omH7Kby-G70Xp?E%;%Z1Jr#+M=#A;vbnm6XUw|GEqVJa$C|PIToct*^`!@< zjRC}bMqcQ21 zu5LkYwH!OIA*O8nebS(hxLI3RT&Ktu_YPb666e|;VmB{k?0JvJp-6ydMH?eH*5uB; z>8ySkPmkZ88seAMS3~=lo3ZkTtwPS4%G)ID*l#W5W-QMw>@Inp>yZ8+>BrqtA!FZ? z%S#gMlD4A^96#EK;#)KF`YPC5A^IHSA+)kt4MA(#vkR=&ls)YhNEe*STbUCAxFsjc z6pSeqnVO!-I37!r;fi;=dxEzBsYnvY=18Gu-9;uCkzrS%;4W$iXA9QiSk57D$iA~= z<>?Td&J~KJ(PsG}vsQ5*!`8?`vvzJ~mW!dBljUJ0L#|%!j`|H$t3`VqQB`FLntfcPqv2V(ktLL=Fr?7pN#~O4t zT>bN{!BkMS#Wf_=wB+UT)r(Y>D|feihsItF<<)h<(&z1IuUdLT^f_xumThN7A_de` zpK}+u9}$PAR1tAY=2;aMJEBH^zci9Z3$h!vy)4>ZwagK!^`lW_B6Ka5ri$v8XE&DS z**2y5s-s>i$i5p3a%c`rGiP>2a50yaoHQn=-2?C?y^=Ds z$a&mS!7C4FLmkQX3bsFl4HwWokqjl*oH55|*bysd(P2N4Pk#%a(iAuphFA{k9~B!h|0L_D#Mm`bI86)zo6P0&J5uP}Rl z==G0)F|mplPp)9Fg4YBFV`bc!61GH)fnRo{s&;M^rbMit!)CR#J(y3=CSsi% zXDb*!8PgImE~U;q`}A4v?BDPY{1ZvF>-^E$2Jx${@qTJG!;R!&7vH$|u38lAt%Uf5lt`!0Q5 z61~-(zxsUlzys|22oSiBRoce?-T=$HYZawB1z+k8x$R_nfC=t@r(tU}CDC6Txg<7h+oWC&S9_bii!b$r|mIZMwTUqixDJN$c4LcvBUu z@=G#%%56_EJR6)vn{3dw#HPL4!dh z$DJobZHZ8ljj&zMp83})|BBG?Q@o>k#upIcA8@?y9ImV2)qz31jN6#S;4*FuW&`Ij z#QSb%LZ_5tA}zN$q4Ol~q}Hpno}pkexQtN|uTAf)T5a;JPU>1hrz!8rM^XVkaJ3vB JV$?Q#=szD|0>A(O literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/ClassLayout.class b/doc/doc++/osgParticle/ClassLayout.class new file mode 100644 index 0000000000000000000000000000000000000000..69a6f494ed99e62d55c975c56b11981104a3dca9 GIT binary patch literal 2443 zcmZuy>2nih82>HVBfIRhrLbUtR6&I{DHK$q7O2{CSZ$$Nt%9Q2CfjstvKu#>mg24T zzHd=Ha5~e`PwKRRkr~I&`WN`mh|lwGlBPmt_IaQCe&77{@9%#ghCR3#hohmO!PPLM z;aLqYX?R(~D;i$a@S27N4XL&KXI-qP^4hIb6K;dTRY++m;t2N+}++^IvyT?S;_ zZ9qf6PS`;PhnPI9L&1PfX7@08FDu{2(m?|%h71@u!q`zA8*q%h9B1-=115$Udw?w- zWQ!4YHOe7RFz=*+c8sy-hjgsR!wkkvOyLxRGYoPjs<0VMnwW)WVh&joXYq)Mc_z=H zV&XZRHt{@TFEH;#Oqh6&vG*B#fX7UHh$l^a%uYXnZ{kxtZQ?ULYT|Q_@g)nsV&(G; zzGm33dyX)(nv%74O84+E zrzTF}VKu{5d-k2`Zk2eU?Rrjduq9k;L0hh`Om2GX5|PHq$r&dXHk`C%HdvjSBJclG zuUA`-c|CQj)q6voqV`;e-&#(iQCz6hFF`%zdTux%!5AvqmCEtJE>BBnUnTbP9M^Eh zY|kl5STA%&?0LT$N|1;Ayu)66uM*l`IAIs7Odma)bIKtNze4e-{Z^EW>-UY(Ktsyh zu}f5b+lZgDixYO>+LJ|xl-p0(vu?o-{a~;fhCZ#9G45A`oO8@Al4I#Kt&N?}NAa5j zq=M{n+41s(O!{P3lAx30+;~WhCa*ca>V-{piWASfoN$hODpPJyp<2v>v#LTGg}|R1 zai&P3PCIU4nh{s*F6Gc%^QP0a%=-ScGMoED`83U=%RpDB$%#rEwLQDw1k|CXK->_z zOM@}OVR(HM<{iBPJGTV>xi>CIn7>q>+lze`I>9e1LGbe_PI?r@Nsld^8tKs+P4F3_c3~Z1z}D0ybf!AGRtQs8u!BK5C9h!H zufkSBh0*h0e%K+{VJLtfkb2bvmOgsFI~7 zFJApQMe%N+P&?>LXQP<%6~s^VF5@QpQsg;H=U)1@kfZD+Z2X0i;qSCXT0)-`S)b-YWhtV4KcX$6 zMd%9lB~&3|&{abZtMBZObCF6uqg(m~sIiRBbjILV)P$}?+!A=N=+LxqkYB<6C0L0# zEA?7>G%8|J0GjcBD~iY&B=br!Tf;5C;npkYIAtl9(RT@(I;9#mb9}3YJvDSMD3Ya6 OO$QpS45)eQF#R7oR!vR- literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/Counter.html b/doc/doc++/osgParticle/Counter.html new file mode 100644 index 000000000..a5d6887b1 --- /dev/null +++ b/doc/doc++/osgParticle/Counter.html @@ -0,0 +1,93 @@ + + + + + class osgParticle::Counter + + + + +

class osgParticle::Counter

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual int numParticlesToCreate(double dt) const = 0 +
+[more]inline Counter() +
+[more]inline Counter(const Counter &copy, const osg::CopyOp &copyop) +

+ +

+

Protected Methods

+[more] ~Counter() +
+[more]Counter& operator=(const Counter &) +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual int numParticlesToCreate(double dt) const = 0 +

+ + +

o ~Counter() +

+ + +

oCounter& operator=(const Counter &) +

+ + +

oinline Counter() +

+ + +

oinline Counter(const Counter &copy, const osg::CopyOp &copyop) +

+
+
Direct child classes: +
VariableRateCounter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Emitter.html b/doc/doc++/osgParticle/Emitter.html new file mode 100644 index 000000000..e3ccf41b8 --- /dev/null +++ b/doc/doc++/osgParticle/Emitter.html @@ -0,0 +1,187 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::Emitter + + + + +

class OSGPARTICLE_EXPORT osgParticle::Emitter

An abstract base class for particle emitters.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Emitter() +
+[more] Emitter(const Emitter &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void accept(osg::NodeVisitor& nv) +
+[more]inline const Particle& getParticleTemplate() const +
Get the particle template +
+[more]inline void setParticleTemplate(const Particle &p) +
Set the particle template (particle is copied) +
+[more]inline bool getUseDefaultTemplate() const +
Return whether the particle system's default template should be used +
+[more]inline void setUseDefaultTemplate(bool v) +
Set whether the default particle template should be used. +
+[more]inline void process(double dt) +

+ +

+

Protected Methods

+[more]virtual ~Emitter() +
+[more]Emitter& operator=(const Emitter &) +
+[more]virtual void emit(double dt) = 0 +

+ +
+

Inherited from ParticleProcessor:

+
+

+

Public Methods

+oinline ReferenceFrame getReferenceFrame() const +
+ovoid traverse(osg::NodeVisitor &nv) +
+oinline ParticleProcessor::ReferenceFrame getReferenceFrame() const +
+oinline void setReferenceFrame(ReferenceFrame rf) +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +
+oinline ParticleSystem* getParticleSystem() +
+oinline const ParticleSystem* getParticleSystem() const +
+oinline void setParticleSystem(ParticleSystem* ps) +
+oinline bool computeBound() const +
+oinline const osg::Matrix& getLocalToWorldMatrix() +
+oinline const osg::Matrix& getWorldToLocalMatrix() +
+oinline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +

+ +

+

Public Members

+oenum ReferenceFrame +

+ +
+ + +
+

Documentation

+
An abstract base class for particle emitters. +Descendant classes must override the emit() method to generate new particles by +calling the ParticleSystem::createParticle() method on the particle system associated +to the emitter.
+
+ + + +
o Emitter() +

+ + +

o Emitter(const Emitter &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void accept(osg::NodeVisitor& nv) +

+ + +

ovirtual ~Emitter() +

+ + +

oEmitter& operator=(const Emitter &) +

+ + +

ovirtual void emit(double dt) = 0 +

+ + +

oinline const Particle& getParticleTemplate() const +
Get the particle template +

+ + +

oinline void setParticleTemplate(const Particle &p) +
Set the particle template (particle is copied) +

+ + +

oinline bool getUseDefaultTemplate() const +
Return whether the particle system's default template should be used +

+ + +

oinline void setUseDefaultTemplate(bool v) +
Set whether the default particle template should be used. +When this flag is true, the particle template is ignored, and the +particle system's default template is used instead. +

+ + +

oinline void process(double dt) +

+
+
Direct child classes: +
ModularEmitter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/FluidFrictionOperator.html b/doc/doc++/osgParticle/FluidFrictionOperator.html new file mode 100644 index 000000000..31599a40b --- /dev/null +++ b/doc/doc++/osgParticle/FluidFrictionOperator.html @@ -0,0 +1,177 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::FluidFrictionOperator + + + + +

class OSGPARTICLE_EXPORT osgParticle::FluidFrictionOperator

An operator that simulates the friction of a fluid.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FluidFrictionOperator() +
+[more] FluidFrictionOperator(const FluidFrictionOperator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Object(osgParticle, FluidFrictionOperator) +
+[more]void operate(Particle* P, double dt) +
Apply the friction forces to a particle. +
+[more]inline float getFluidDensity() const +
Get the density of the fluid +
+[more]inline float getFluidViscosity() const +
Get the viscosity of the fluid +
+[more]inline void setFluidDensity(float d) +
Set the density of the fluid +
+[more]inline void setFluidViscosity(float v) +
Set the viscosity of the fluid +
+[more]inline void setFluidToAir() +
Set the fluid parameters as for air (20°C temperature) +
+[more]inline void setFluidToWater() +
Set the fluid parameters as for pure water (20°C temperature) +
+[more]inline float getOverrideRadius() const +
Get the overriden radius value +
+[more]inline void setOverrideRadius(float r) +
Set the overriden radius value (pass 0 if you want to use particle's radius) +
+[more]inline void beginOperate(Program* prg) +
Perform some initializations. +

+ +

+

Protected Methods

+[more]virtual ~FluidFrictionOperator() +
+[more]FluidFrictionOperator& operator=(const FluidFrictionOperator &) +

+ +
+

Inherited from Operator:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual void endOperate() +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +

+ +
+ + +
+

Documentation

+
An operator that simulates the friction of a fluid. +By using this operator you can let the particles move in a fluid of a given density +and viscosity. There are two functions to quickly setup the parameters for pure water +and air. You can decide whether to compute the forces using the particle's physical +radius or another value, by calling the setOverrideRadius() method.
+
+ + + +
o FluidFrictionOperator() +

+ + +

o FluidFrictionOperator(const FluidFrictionOperator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osgParticle, FluidFrictionOperator) +

+ + +

ovoid operate(Particle* P, double dt) +
Apply the friction forces to a particle. Do not call this method manually. +

+ + +

ovirtual ~FluidFrictionOperator() +

+ + +

oFluidFrictionOperator& operator=(const FluidFrictionOperator &) +

+ + +

oinline float getFluidDensity() const +
Get the density of the fluid +

+ + +

oinline float getFluidViscosity() const +
Get the viscosity of the fluid +

+ + +

oinline void setFluidDensity(float d) +
Set the density of the fluid +

+ + +

oinline void setFluidViscosity(float v) +
Set the viscosity of the fluid +

+ + +

oinline void setFluidToAir() +
Set the fluid parameters as for air (20°C temperature) +

+ + +

oinline void setFluidToWater() +
Set the fluid parameters as for pure water (20°C temperature) +

+ + +

oinline float getOverrideRadius() const +
Get the overriden radius value +

+ + +

oinline void setOverrideRadius(float r) +
Set the overriden radius value (pass 0 if you want to use particle's radius) +

+ + +

oinline void beginOperate(Program* prg) +
Perform some initializations. Do not call this method manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ForceOperator.html b/doc/doc++/osgParticle/ForceOperator.html new file mode 100644 index 000000000..53d191268 --- /dev/null +++ b/doc/doc++/osgParticle/ForceOperator.html @@ -0,0 +1,127 @@ + + + + + class osgParticle::ForceOperator + + + + +

class osgParticle::ForceOperator

An operator that applies a constant force to the particles.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, ForceOperator) +
+[more]inline ForceOperator() +
+[more]inline ForceOperator(const ForceOperator &copy, const osg::CopyOp &copyop) +
+[more]inline const osg::Vec3& getForce() const +
Get the force vector +
+[more]inline void setForce(const osg::Vec3 &v) +
Set the force vector +
+[more]inline void operate(Particle* P, double dt) +
Apply the force to a particle. +
+[more]inline void beginOperate(Program* prg) +
Perform some initialization. +

+ +

+

Protected Methods

+[more]virtual ~ForceOperator() +
+[more]ForceOperator& operator=(const ForceOperator &) +

+ +
+

Inherited from Operator:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual void endOperate() +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +

+ +
+ + +
+

Documentation

+
An operator that applies a constant force to the particles. +Remember that if the mass of particles is expressed in kg and the lengths are +expressed in meters, then the force should be expressed in Newtons.
+
+ + + +
o META_Object(osgParticle, ForceOperator) +

+ + +

ovirtual ~ForceOperator() +

+ + +

oForceOperator& operator=(const ForceOperator &) +

+ + +

oinline ForceOperator() +

+ + +

oinline ForceOperator(const ForceOperator &copy, const osg::CopyOp &copyop) +

+ + +

oinline const osg::Vec3& getForce() const +
Get the force vector +

+ + +

oinline void setForce(const osg::Vec3 &v) +
Set the force vector +

+ + +

oinline void operate(Particle* P, double dt) +
Apply the force to a particle. Do not call this method manually. +

+ + +

oinline void beginOperate(Program* prg) +
Perform some initialization. Do not call this method manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/General.html b/doc/doc++/osgParticle/General.html new file mode 100644 index 000000000..8d98f5214 --- /dev/null +++ b/doc/doc++/osgParticle/General.html @@ -0,0 +1,115 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGPARTICLE_ACCELOPERATOR_
+ +o#define +OSGPARTICLE_CENTEREDPLACER_
+ +o#define +OSGPARTICLE_COUNTER_
+ +o#define +OSGPARTICLE_EMITTER_
+ +o#define +OSGPARTICLE_EXPORT_
+ +o#define +OSGPARTICLE_EXPORT(dllexport)
+ +o#define +OSGPARTICLE_EXPORT(dllimport)
+ +o#define +OSGPARTICLE_EXPORT
+ +o#define +OSGPARTICLE_FLUIDFRICTIONOPERATOR_
+ +o#define +OSGPARTICLE_FORCEOPERATOR_
+ +o#define +OSGPARTICLE_INTERPOLATOR_
+ +o#define +OSGPARTICLE_LINEARINTERPOLATOR_
+ +o#define +OSGPARTICLE_MODULAREMITTER_
+ +o#define +OSGPARTICLE_MODULARPROGRAM_
+ +o#define +OSGPARTICLE_MULTISEGMENTPLACER_
+ +o#define +OSGPARTICLE_OPERATOR_
+ +o#define +OSGPARTICLE_PARTICLE_
+ +o#define +OSGPARTICLE_PARTICLEPROCESSOR_
+ +o#define +OSGPARTICLE_PARTICLESYSTEM_
+ +o#define +OSGPARTICLE_PARTICLESYSTEMUPDATER_
+ +o#define +OSGPARTICLE_PLACER_
+ +o#define +OSGPARTICLE_POINTPLACER_
+ +o#define +OSGPARTICLE_PROGRAM_
+ +o#define +OSGPARTICLE_RADIALSHOOTER_
+ +o#define +OSGPARTICLE_RANDOMRATECOUNTER_
+ +o#define +OSGPARTICLE_SECTORPLACER_
+ +o#define +OSGPARTICLE_SEGMENTPLACER_
+ +o#define +OSGPARTICLE_SHOOTER_
+ +o#define +OSGPARTICLE_VARIABLERATECOUNTER_
+ +o#define +OSGPARTICLE_VERSION_
+ +oOSGPARTICLE_EXPORT const char* +osgParticleGetVersion()
+ +oOSGPARTICLE_EXPORT const char* +osgParticleGetLibraryName()
+ +o#define +OSGPARTICLE_RANGE_
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/HIER.html b/doc/doc++/osgParticle/HIER.html new file mode 100644 index 000000000..8d5646367 --- /dev/null +++ b/doc/doc++/osgParticle/HIER.html @@ -0,0 +1,61 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/HIERjava.html b/doc/doc++/osgParticle/HIERjava.html new file mode 100644 index 000000000..c8d28b52f --- /dev/null +++ b/doc/doc++/osgParticle/HIERjava.html @@ -0,0 +1,79 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Interpolator.html b/doc/doc++/osgParticle/Interpolator.html new file mode 100644 index 000000000..a25a910ac --- /dev/null +++ b/doc/doc++/osgParticle/Interpolator.html @@ -0,0 +1,121 @@ + + + + + class osgParticle::Interpolator + + + + +

class osgParticle::Interpolator

An abstract base class for implementing interpolators
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Interpolator() +
+[more] Interpolator(const Interpolator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual float interpolate(float t, float y1, float y2) const = 0 +
Interpolate between floats. +
+[more]virtual osg::Vec2 interpolate(float t, const osg::Vec2 &y1, const osg::Vec2 &y2) const +
Interpolate between 2-dimensional vectors. +
+[more]virtual osg::Vec3 interpolate(float t, const osg::Vec3 &y1, const osg::Vec3 &y2) const +
Interpolate between 3-dimensional vectors. +
+[more]virtual osg::Vec4 interpolate(float t, const osg::Vec4 &y1, const osg::Vec4 &y2) const +
Interpolate between 4-dimensional vectors. +
+[more]template<class T_> T_ interpolate(float t, const range<T_> &r) const +

+ +

+

Protected Methods

+[more]virtual ~Interpolator() +

+ +
+ + +
+

Documentation

+
An abstract base class for implementing interpolators
+
+ + + +
o Interpolator() +

+ + +

o Interpolator(const Interpolator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual float interpolate(float t, float y1, float y2) const = 0 +
Interpolate between floats. Must be overriden in descendant classes. +

+ + +

ovirtual osg::Vec2 interpolate(float t, const osg::Vec2 &y1, const osg::Vec2 &y2) const +
Interpolate between 2-dimensional vectors. Default behavior is to interpolate each component separately. +

+ + +

ovirtual osg::Vec3 interpolate(float t, const osg::Vec3 &y1, const osg::Vec3 &y2) const +
Interpolate between 3-dimensional vectors. Default behavior is to interpolate each component separately. +

+ + +

ovirtual osg::Vec4 interpolate(float t, const osg::Vec4 &y1, const osg::Vec4 &y2) const +
Interpolate between 4-dimensional vectors. Default behavior is to interpolate each component separately. +

+ + +

otemplate<class T_> T_ interpolate(float t, const range<T_> &r) const +

+ + +

ovirtual ~Interpolator() +

+
+
Direct child classes: +
LinearInterpolator
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/LinearInterpolator.html b/doc/doc++/osgParticle/LinearInterpolator.html new file mode 100644 index 000000000..6e922ad70 --- /dev/null +++ b/doc/doc++/osgParticle/LinearInterpolator.html @@ -0,0 +1,87 @@ + + + + + class osgParticle::LinearInterpolator + + + + +

class osgParticle::LinearInterpolator

A linear interpolator
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LinearInterpolator() +
+[more] LinearInterpolator(const LinearInterpolator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Object(osgParticle, LinearInterpolator) +
+[more]virtual float interpolate(float t, float y1, float y2) const +

+ +

+

Protected Methods

+[more]virtual ~LinearInterpolator() +

+ +
+

Inherited from Interpolator:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ +
+ + +
+

Documentation

+
A linear interpolator
+
+ + + +
o LinearInterpolator() +

+ + +

o LinearInterpolator(const LinearInterpolator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osgParticle, LinearInterpolator) +

+ + +

ovirtual float interpolate(float t, float y1, float y2) const +

+ + +

ovirtual ~LinearInterpolator() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ModularEmitter.html b/doc/doc++/osgParticle/ModularEmitter.html new file mode 100644 index 000000000..d477476ad --- /dev/null +++ b/doc/doc++/osgParticle/ModularEmitter.html @@ -0,0 +1,225 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::ModularEmitter + + + + +

class OSGPARTICLE_EXPORT osgParticle::ModularEmitter

An emitter class that holds three objects to control the creation of particles.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ModularEmitter() +
+[more] ModularEmitter(const ModularEmitter &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Node(osgParticle, ModularEmitter) +
+[more]inline Counter* getCounter() +
Get the counter object +
+[more]inline const Counter* getCounter() const +
Get the const Counter object +
+[more]inline void setCounter(Counter* c) +
Set the Counter object +
+[more]inline Placer* getPlacer() +
Get the Placer object +
+[more]inline const Placer* getPlacer() const +
Get the const Placer object. +
+[more]inline void setPlacer(Placer* p) +
Set the Placer object +
+[more]inline Shooter* getShooter() +
Get the Shooter object +
+[more]inline const Shooter* getShooter() const +
Get the const Shooter object +
+[more]inline void setShooter(Shooter* s) +
Set the Shooter object +

+ +

+

Protected Methods

+[more]virtual ~ModularEmitter() +
+[more]ModularEmitter& operator=(const ModularEmitter &) +
+[more]void emit(double dt) +

+ +
+

Inherited from Emitter:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual void accept(osg::NodeVisitor& nv) +
+oinline const Particle& getParticleTemplate() const +
+oinline void setParticleTemplate(const Particle &p) +
+oinline bool getUseDefaultTemplate() const +
+oinline void setUseDefaultTemplate(bool v) +
+oinline void process(double dt) +

+ +
+

Inherited from ParticleProcessor:

+
+

+

Public Methods

+oinline ReferenceFrame getReferenceFrame() const +
+ovoid traverse(osg::NodeVisitor &nv) +
+oinline ParticleProcessor::ReferenceFrame getReferenceFrame() const +
+oinline void setReferenceFrame(ReferenceFrame rf) +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +
+oinline ParticleSystem* getParticleSystem() +
+oinline const ParticleSystem* getParticleSystem() const +
+oinline void setParticleSystem(ParticleSystem* ps) +
+oinline bool computeBound() const +
+oinline const osg::Matrix& getLocalToWorldMatrix() +
+oinline const osg::Matrix& getWorldToLocalMatrix() +
+oinline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +

+ +

+

Public Members

+oenum ReferenceFrame +

+ +
+ + +
+

Documentation

+
An emitter class that holds three objects to control the creation of particles. +These objects are a counter, a placer and a shooter. +The counter controls the number of particles to be emitted at each frame; +the placer must initialize the particle's position vector, while the shooter initializes +its velocity vector. +You can use the predefined counter/placer/shooter classes, or you can create your own.
+
+ + + +
o ModularEmitter() +

+ + +

o ModularEmitter(const ModularEmitter &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osgParticle, ModularEmitter) +

+ + +

ovirtual ~ModularEmitter() +

+ + +

oModularEmitter& operator=(const ModularEmitter &) +

+ + +

ovoid emit(double dt) +

+ + +

oinline Counter* getCounter() +
Get the counter object +

+ + +

oinline const Counter* getCounter() const +
Get the const Counter object +

+ + +

oinline void setCounter(Counter* c) +
Set the Counter object +

+ + +

oinline Placer* getPlacer() +
Get the Placer object +

+ + +

oinline const Placer* getPlacer() const +
Get the const Placer object. +

+ + +

oinline void setPlacer(Placer* p) +
Set the Placer object +

+ + +

oinline Shooter* getShooter() +
Get the Shooter object +

+ + +

oinline const Shooter* getShooter() const +
Get the const Shooter object +

+ + +

oinline void setShooter(Shooter* s) +
Set the Shooter object +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ModularProgram.html b/doc/doc++/osgParticle/ModularProgram.html new file mode 100644 index 000000000..f5f37091d --- /dev/null +++ b/doc/doc++/osgParticle/ModularProgram.html @@ -0,0 +1,183 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::ModularProgram + + + + +

class OSGPARTICLE_EXPORT osgParticle::ModularProgram

A program class for performing operations on particles using a sequence of operators.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ModularProgram() +
+[more] ModularProgram(const ModularProgram &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Node(osgParticle, ModularProgram) +
+[more]inline int numOperators() const +
Get the number of operators +
+[more]inline void addOperator(Operator* o) +
Add an operator to the list. +
+[more]inline Operator* getOperator(int i) +
Get a pointer to an operator in the list +
+[more]inline const Operator* getOperator(int i) const +
Get a const pointer to an operator in the list +
+[more]inline void removeOperator(int i) +
Remove an operator from the list +

+ +

+

Protected Methods

+[more]virtual ~ModularProgram() +
+[more]ModularProgram& operator=(const ModularProgram &) +
+[more]void execute(double dt) +

+ +
+

Inherited from Program:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+ovirtual void accept(osg::NodeVisitor& nv) +
+oinline void process(double dt) +

+ +
+

Inherited from ParticleProcessor:

+
+

+

Public Methods

+oinline ReferenceFrame getReferenceFrame() const +
+ovoid traverse(osg::NodeVisitor &nv) +
+oinline ParticleProcessor::ReferenceFrame getReferenceFrame() const +
+oinline void setReferenceFrame(ReferenceFrame rf) +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +
+oinline ParticleSystem* getParticleSystem() +
+oinline const ParticleSystem* getParticleSystem() const +
+oinline void setParticleSystem(ParticleSystem* ps) +
+oinline bool computeBound() const +
+oinline const osg::Matrix& getLocalToWorldMatrix() +
+oinline const osg::Matrix& getWorldToLocalMatrix() +
+oinline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +

+ +

+

Public Members

+oenum ReferenceFrame +

+ +
+ + +
+

Documentation

+
A program class for performing operations on particles using a sequence of operators. +To use a ModularProgram you have to create some Operator objects and +add them to the program. +All operators will be applied to each particle in the same order they've been added to the program.
+
+ + + +
o ModularProgram() +

+ + +

o ModularProgram(const ModularProgram &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osgParticle, ModularProgram) +

+ + +

ovirtual ~ModularProgram() +

+ + +

oModularProgram& operator=(const ModularProgram &) +

+ + +

ovoid execute(double dt) +

+ + +

oinline int numOperators() const +
Get the number of operators +

+ + +

oinline void addOperator(Operator* o) +
Add an operator to the list. +

+ + +

oinline Operator* getOperator(int i) +
Get a pointer to an operator in the list +

+ + +

oinline const Operator* getOperator(int i) const +
Get a const pointer to an operator in the list +

+ + +

oinline void removeOperator(int i) +
Remove an operator from the list +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/MultiSegmentPlacer.html b/doc/doc++/osgParticle/MultiSegmentPlacer.html new file mode 100644 index 000000000..8779633e6 --- /dev/null +++ b/doc/doc++/osgParticle/MultiSegmentPlacer.html @@ -0,0 +1,153 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::MultiSegmentPlacer + + + + +

class OSGPARTICLE_EXPORT osgParticle::MultiSegmentPlacer

A polyline-shaped particle placer.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] MultiSegmentPlacer() +
+[more] MultiSegmentPlacer(const MultiSegmentPlacer &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Object(osgParticle, MultiSegmentPlacer) +
+[more]void place(Particle* P) const +
Place a partice. +
+[more]inline int numVertices() const +
Get the number of vertices which define the segments +
+[more]inline const osg::Vec3& getVertex(int i) const +
Get a vertex +
+[more]inline void setVertex(int i, const osg::Vec3 &v) +
Set a vertex +
+[more]inline void setVertex(int i, float x, float y, float z) +
Set a vertex +
+[more]inline void addVertex(const osg::Vec3 &v) +
Add a vertex +
+[more]inline void addVertex(float x, float y, float z) +
Add a vertex +
+[more]inline void removeVertex(int i) +
Remove a vertex +

+ +

+

Protected Methods

+[more]virtual ~MultiSegmentPlacer() +
+[more]MultiSegmentPlacer& operator=(const MultiSegmentPlacer &) +

+ +
+

Inherited from Placer:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ +
+ + +
+

Documentation

+
A polyline-shaped particle placer. +This placer class sets the position of incoming particles by choosing a random point on the +specified sequence of connected segments.
+
+ + + +
o MultiSegmentPlacer() +

+ + +

o MultiSegmentPlacer(const MultiSegmentPlacer &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osgParticle, MultiSegmentPlacer) +

+ + +

ovoid place(Particle* P) const +
Place a partice. Called automatically by ModularEmitter, do not call this method manually. +

+ + +

ovirtual ~MultiSegmentPlacer() +

+ + +

oMultiSegmentPlacer& operator=(const MultiSegmentPlacer &) +

+ + +

oinline int numVertices() const +
Get the number of vertices which define the segments +

+ + +

oinline const osg::Vec3& getVertex(int i) const +
Get a vertex +

+ + +

oinline void setVertex(int i, const osg::Vec3 &v) +
Set a vertex +

+ + +

oinline void setVertex(int i, float x, float y, float z) +
Set a vertex +

+ + +

oinline void addVertex(const osg::Vec3 &v) +
Add a vertex +

+ + +

oinline void addVertex(float x, float y, float z) +
Add a vertex +

+ + +

oinline void removeVertex(int i) +
Remove a vertex +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/NavigatorButton.class b/doc/doc++/osgParticle/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..fad9c3f2df2c760c687fdc6eda2469ed021768b5 GIT binary patch literal 1816 zcma)7S#ujj5dPMZHPU*^hiv&sNH8Q3_S%lZeK-lkik*mv*oBFMU0kE}N?xv1xibqn#kD}+gU5_!BX#;D;n`B(a^uM+`-V z`wW{5pD=vM;4)MhJO-bk#_$zGz))upI#O8BF)oRLMJbt*ETy1hIR%ClNv`S`K~757 zBzakqS0s5gg$cZ-lk)3Q0_&1&7~ptl zz{1A{_OWBY#!Uldd}g462L>D|9m?A#b`2a!1INf4IKeFgU*mlP-$=c0@vedIuxH?V z+}5DaJN5a3C+wiiEnCCH!ea4|H+ha9iQI6RyBUt`liffH>*$yb+ z0rkj8lx<&TUG+@A^^Q7)H**GFD9FIq&bSHV_H2=R@L@5k0#PCEt(-gHMMz_8Z#Q=os1>mTio5@fx}C#O+k&_=S`==g&(Xngz!CzdE0LU zmc8M)lz>K~l;D=kKnk^*?d?;xC6!&gdDXjM=wniy z2a87EokG>zcDqMy=%L}nYMA~n6b|^H?nzzPRVu3I2UYHdeq(B6SWULdrMj|ur&hX> z0-H+KkcBqt2maA*-)dA<0>ky1+9gThcY=sD0vblvl=HS(258l#i0bsCWkwWoCn-)_ zN^#n1iqncyycBU-bm~l-P;uIMiZ>LGk$evYXxJj@XC!FH0*}n4Q>4wza0?gAl@{jA zq%Gm~iHvYBBmJZJuj*=LwEpTgKp$KvD0DW+POCHP_w9**FP1Yh_Om&_-a zY2(Ewc>XEIcb9&{OQ)DjYi&%oaixuUQp-NWh$*eK@dB~SKZVCxI{u=9*KmOMqM);g zlLVZLET)IZp4rB^HZq~b&YRD%7QMNKA^LBF${_m}rpd{i^!qz54N(>1595zxk4cwd Q3NsibO%0zC9l{6y0?tduvj6}9 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/Operator.html b/doc/doc++/osgParticle/Operator.html new file mode 100644 index 000000000..68d51ebf5 --- /dev/null +++ b/doc/doc++/osgParticle/Operator.html @@ -0,0 +1,141 @@ + + + + + class osgParticle::Operator + + + + +

class osgParticle::Operator

An abstract base class used by ModularProgram to perform operations on particles before they are updated.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void operate(Particle* P, double dt) = 0 +
Do something on a particle. +
+[more]virtual void beginOperate(Program* ) +
Do something before processing particles via the operate() method. +
+[more]virtual void endOperate() +
Do something after all particles have been processed +
+[more]inline Operator() +
+[more]inline Operator(const Operator &copy, const osg::CopyOp &copyop) +
+[more]inline bool isEnabled() const +
Get whether this operator is enabled +
+[more]inline void setEnabled(bool v) +
Enable or disable this operator +

+ +

+

Protected Methods

+[more]virtual ~Operator() +
+[more]Operator& operator=(const Operator &) +

+ +
+ + +
+

Documentation

+
An abstract base class used by ModularProgram to perform operations on particles before they are updated. +To implement a new operator, derive from this class and override the operate() method. +You should also override the beginOperate() method to query the calling program for the reference frame +used, and initialize the right transformations if needed.
+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void operate(Particle* P, double dt) = 0 +
Do something on a particle. +This method is called by ModularProgram objects to perform some operations +on the particles. You must override it in descendant classes. Common operations +consist of modifying the particle's velocity vector. The dt parameter is +the time elapsed from last operation. +

+ + +

ovirtual void beginOperate(Program* ) +
Do something before processing particles via the operate() method. +Overriding this method could be necessary to query the calling Program object +for the current reference frame. If the reference frame is RELATIVE_TO_PARENTS, then your +class should prepare itself to do all operations in local coordinates. +

+ + +

ovirtual void endOperate() +
Do something after all particles have been processed +

+ + +

ovirtual ~Operator() +

+ + +

oOperator& operator=(const Operator &) +

+ + +

oinline Operator() +

+ + +

oinline Operator(const Operator &copy, const osg::CopyOp &copyop) +

+ + +

oinline bool isEnabled() const +
Get whether this operator is enabled +

+ + +

oinline void setEnabled(bool v) +
Enable or disable this operator +

+
+
Direct child classes: +
ForceOperator
+FluidFrictionOperator
+AccelOperator
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Particle.html b/doc/doc++/osgParticle/Particle.html new file mode 100644 index 000000000..4d4b7c7e4 --- /dev/null +++ b/doc/doc++/osgParticle/Particle.html @@ -0,0 +1,385 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::Particle + + + + +

class OSGPARTICLE_EXPORT osgParticle::Particle

Implementation of a particle.
+
+ +
+

+

Public Methods

+[more] Particle() +
+[more]inline Shape getShape() const +
Get the shape of the particle +
+[more]bool update(double dt) +
Update the particle (don't call this method manually). +
+[more]void render(const osg::Vec3 &xpos, const osg::Vec3 &px, const osg::Vec3 &py, float scale = 1.0f) const +
Render the particle. +
+[more]inline Particle::Shape getShape() const +
+[more]inline void setShape(Shape s) +
Set the shape of the particle +
+[more]inline bool isAlive() const +
Get whether the particle is still alive +
+[more]inline double getLifeTime() const +
Get the life time of the particle (in seconds) +
+[more]inline double getAge() const +
Get the age of the particle (in seconds) +
+[more]inline float getRadius() const +
Get the physical radius of the particle. +
+[more]inline void setRadius(float r) +
Set the physical radius of the particle. +
+[more]inline const rangef& getSizeRange() const +
Get the minimum and maximum values for polygon size +
+[more]inline const rangef& getAlphaRange() const +
Get the minimum and maximum values for alpha +
+[more]inline const rangev4& getColorRange() const +
Get the minimum and maximum values for color +
+[more]inline const Interpolator* getSizeInterpolator() const +
Get the interpolator for computing the size of polygons +
+[more]inline const Interpolator* getAlphaInterpolator() const +
Get the interpolator for computing alpha values +
+[more]inline const Interpolator* getColorInterpolator() const +
Get the interpolator for computing color values +
+[more]inline const osg::Vec3& getPosition() const +
Get the position vector +
+[more]inline const osg::Vec3& getVelocity() const +
Get the velocity vector. +
+[more]inline const osg::Vec3& getPreviousPosition() const +
Get the previous position (the position before last update) +
+[more]inline void kill() +
Kill the particle on next update NOTE: after calling this function, the isAlive() method will still return true until the particle is updated again +
+[more]inline void setLifeTime(double t) +
Set the life time of the particle +
+[more]inline void setSizeRange(const rangef &r) +
Set the minimum and maximum values for polygon size +
+[more]inline void setAlphaRange(const rangef &r) +
Set the minimum and maximum values for alpha +
+[more]inline void setColorRange(const rangev4 &r) +
Set the minimum and maximum values for color +
+[more]inline void setSizeInterpolator(Interpolator* ri) +
Set the interpolator for computing size values +
+[more]inline void setAlphaInterpolator(Interpolator* ai) +
Set the interpolator for computing alpha values. +
+[more]inline void setColorInterpolator(Interpolator* ci) +
Set the interpolator for computing color values +
+[more]inline void setPosition(const osg::Vec3 &p) +
Set the position vector. +
+[more]inline void setVelocity(const osg::Vec3 &v) +
Set the velocity vector. +
+[more]inline void addVelocity(const osg::Vec3 &v) +
Add a vector to the velocity vector +
+[more]inline void transformPositionVelocity(const osg::Matrix &xform) +
Transform position and velocity vectors by a matrix +
+[more]inline float getMass() const +
Get the mass of the particle. +
+[more]inline float getMassInv() const +
Get 1 / getMass() +
+[more]inline void setMass(float m) +
Set the mass of the particle. +
+[more]inline void beginRender() const +
Perform some pre-rendering tasks. +
+[more]inline void endRender() const +
Perform some post-rendering tasks. +
+[more]inline float getCurrentSize() const +
Get the current (interpolated) polygon size. +

+ +

+

Public Members

+[more]enum Shape +

+ +
+ + +
+

Documentation

+
Implementation of a particle. +Objects of this class are particles, they have some graphical properties +and some physical properties. Particles are created by emitters and then placed +into Particle Systems, where they live and get updated at each frame. +Particles can either live forever (lifeTime < 0), or die after a specified +time (lifeTime >= 0). For each property which is defined as a range of values, a +"current" value will be evaluated at each frame by interpolating the min +and max values so that curr_value = min when t == 0, and +curr_value = max when t == lifeTime. +You may customize the interpolator objects to achieve any kind of transition. +If you want the particle to live forever, set its lifetime to any value <= 0; +in that case, no interpolation is done to compute real-time properties, and only +minimum values are used.
+
+ + + +
oenum Shape +

+ + + +
o POINT +

+ + +

o QUAD +

+ + +

o QUAD_TRIANGLESTRIP +

+ + +

o HEXAGON +

+ + + +
o Particle() +

+ + +

oinline Shape getShape() const +
Get the shape of the particle +

+ + +

obool update(double dt) +
Update the particle (don't call this method manually). +This method is called automatically by ParticleSystem::update(); it +updates the graphical properties of the particle for the current time, +checks whether the particle is still alive, and then updates its position +by computing P = P + V * dt (where P is the position and V is the velocity). +

+ + +

ovoid render(const osg::Vec3 &xpos, const osg::Vec3 &px, const osg::Vec3 &py, float scale = 1.0f) const +
Render the particle. Called automatically by particle systems. +

+ + +

oinline Particle::Shape getShape() const +

+ + +

oinline void setShape(Shape s) +
Set the shape of the particle +

+ + +

oinline bool isAlive() const +
Get whether the particle is still alive +

+ + +

oinline double getLifeTime() const +
Get the life time of the particle (in seconds) +

+ + +

oinline double getAge() const +
Get the age of the particle (in seconds) +

+ + +

oinline float getRadius() const +
Get the physical radius of the particle. +For built-in operators to work correctly, lengths must be expressed in meters. +

+ + +

oinline void setRadius(float r) +
Set the physical radius of the particle. +For built-in operators to work correctly, lengths must be expressed in meters. +

+ + +

oinline const rangef& getSizeRange() const +
Get the minimum and maximum values for polygon size +

+ + +

oinline const rangef& getAlphaRange() const +
Get the minimum and maximum values for alpha +

+ + +

oinline const rangev4& getColorRange() const +
Get the minimum and maximum values for color +

+ + +

oinline const Interpolator* getSizeInterpolator() const +
Get the interpolator for computing the size of polygons +

+ + +

oinline const Interpolator* getAlphaInterpolator() const +
Get the interpolator for computing alpha values +

+ + +

oinline const Interpolator* getColorInterpolator() const +
Get the interpolator for computing color values +

+ + +

oinline const osg::Vec3& getPosition() const +
Get the position vector +

+ + +

oinline const osg::Vec3& getVelocity() const +
Get the velocity vector. +For built-in operators to work correctly, remember that velocity components are expressed +in meters per second. +

+ + +

oinline const osg::Vec3& getPreviousPosition() const +
Get the previous position (the position before last update) +

+ + +

oinline void kill() +
Kill the particle on next update +NOTE: after calling this function, the isAlive() method will still +return true until the particle is updated again +

+ + +

oinline void setLifeTime(double t) +
Set the life time of the particle +

+ + +

oinline void setSizeRange(const rangef &r) +
Set the minimum and maximum values for polygon size +

+ + +

oinline void setAlphaRange(const rangef &r) +
Set the minimum and maximum values for alpha +

+ + +

oinline void setColorRange(const rangev4 &r) +
Set the minimum and maximum values for color +

+ + +

oinline void setSizeInterpolator(Interpolator* ri) +
Set the interpolator for computing size values +

+ + +

oinline void setAlphaInterpolator(Interpolator* ai) +
Set the interpolator for computing alpha values. +

+ + +

oinline void setColorInterpolator(Interpolator* ci) +
Set the interpolator for computing color values +

+ + +

oinline void setPosition(const osg::Vec3 &p) +
Set the position vector. +

+ + +

oinline void setVelocity(const osg::Vec3 &v) +
Set the velocity vector. +For built-in operators to work correctly, remember that velocity components are expressed +in meters per second. +

+ + +

oinline void addVelocity(const osg::Vec3 &v) +
Add a vector to the velocity vector +

+ + +

oinline void transformPositionVelocity(const osg::Matrix &xform) +
Transform position and velocity vectors by a matrix +

+ + +

oinline float getMass() const +
Get the mass of the particle. +For built-in operators to work correctly, remember that the mass is expressed in kg. +

+ + +

oinline float getMassInv() const +
Get 1 / getMass() +

+ + +

oinline void setMass(float m) +
Set the mass of the particle. +For built-in operators to work correctly, remember that the mass is expressed in kg. +

+ + +

oinline void beginRender() const +
Perform some pre-rendering tasks. Called automatically by particle systems. +

+ + +

oinline void endRender() const +
Perform some post-rendering tasks. Called automatically by particle systems. +

+ + +

oinline float getCurrentSize() const +
Get the current (interpolated) polygon size. Valid only after the first call to update(). +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ParticleProcessor.html b/doc/doc++/osgParticle/ParticleProcessor.html new file mode 100644 index 000000000..4bd3d1f6f --- /dev/null +++ b/doc/doc++/osgParticle/ParticleProcessor.html @@ -0,0 +1,247 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::ParticleProcessor + + + + +

class OSGPARTICLE_EXPORT osgParticle::ParticleProcessor

A common base interface for those classes which need to do something on particles.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ParticleProcessor() +
+[more] ParticleProcessor(const ParticleProcessor &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void accept(osg::NodeVisitor& nv) +
+[more]inline ReferenceFrame getReferenceFrame() const +
Get the reference frame +
+[more]void traverse(osg::NodeVisitor &nv) +
+[more]inline ParticleProcessor::ReferenceFrame getReferenceFrame() const +
+[more]inline void setReferenceFrame(ReferenceFrame rf) +
Set the reference frame +
+[more]inline bool isEnabled() const +
Get whether this processor is enabled or not +
+[more]inline void setEnabled(bool v) +
Set whether this processor is enabled or not +
+[more]inline ParticleSystem* getParticleSystem() +
Get a pointer to the destination particle system +
+[more]inline const ParticleSystem* getParticleSystem() const +
Get a const pointer to the destination particle system +
+[more]inline void setParticleSystem(ParticleSystem* ps) +
Set the destination particle system +
+[more]inline bool computeBound() const +
+[more]inline const osg::Matrix& getLocalToWorldMatrix() +
Get the current local-to-world transformation matrix (valid only during cull traversal) +
+[more]inline const osg::Matrix& getWorldToLocalMatrix() +
Get the current world-to-local transformation matrix (valid only during cull traversal) +
+[more]inline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
Transform a point from local to world coordinates (valid only during cull traversal) +
+[more]inline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
Transform a point from world to local coordinates (valid only during cull traversal) +
+[more]inline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal) +
+[more]inline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +
Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal) +

+ +

+

Public Members

+[more]enum ReferenceFrame +

+ +

+

Protected Methods

+[more]virtual ~ParticleProcessor() +
+[more]ParticleProcessor& operator=(const ParticleProcessor &) +
+[more]virtual void process(double dt) = 0 +

+ +
+ + +
+

Documentation

+
A common base interface for those classes which need to do something on particles. Such classes +are, for example, Emitter (particle generation) and Program (particle animation). +This class holds some properties, like a reference frame and a reference to a ParticleSystem; +descendant classes should process the particles taking into account the reference frame, computing the right +transformations when needed.
+
+ + + +
oenum ReferenceFrame +

+ + + +
o RELATIVE_TO_PARENTS +

+ + +

o RELATIVE_TO_ABSOLUTE +

+ + + +
o ParticleProcessor() +

+ + +

o ParticleProcessor(const ParticleProcessor &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void accept(osg::NodeVisitor& nv) +

+ + +

oinline ReferenceFrame getReferenceFrame() const +
Get the reference frame +

+ + +

ovoid traverse(osg::NodeVisitor &nv) +

+ + +

ovirtual ~ParticleProcessor() +

+ + +

oParticleProcessor& operator=(const ParticleProcessor &) +

+ + +

ovirtual void process(double dt) = 0 +

+ + +

oinline ParticleProcessor::ReferenceFrame getReferenceFrame() const +

+ + +

oinline void setReferenceFrame(ReferenceFrame rf) +
Set the reference frame +

+ + +

oinline bool isEnabled() const +
Get whether this processor is enabled or not +

+ + +

oinline void setEnabled(bool v) +
Set whether this processor is enabled or not +

+ + +

oinline ParticleSystem* getParticleSystem() +
Get a pointer to the destination particle system +

+ + +

oinline const ParticleSystem* getParticleSystem() const +
Get a const pointer to the destination particle system +

+ + +

oinline void setParticleSystem(ParticleSystem* ps) +
Set the destination particle system +

+ + +

oinline bool computeBound() const +

+ + +

oinline const osg::Matrix& getLocalToWorldMatrix() +
Get the current local-to-world transformation matrix (valid only during cull traversal) +

+ + +

oinline const osg::Matrix& getWorldToLocalMatrix() +
Get the current world-to-local transformation matrix (valid only during cull traversal) +

+ + +

oinline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
Transform a point from local to world coordinates (valid only during cull traversal) +

+ + +

oinline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
Transform a point from world to local coordinates (valid only during cull traversal) +

+ + +

oinline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal) +

+ + +

oinline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +
Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal) +

+
+
Direct child classes: +
Program
+Emitter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ParticleSystem.html b/doc/doc++/osgParticle/ParticleSystem.html new file mode 100644 index 000000000..f1f301815 --- /dev/null +++ b/doc/doc++/osgParticle/ParticleSystem.html @@ -0,0 +1,380 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::ParticleSystem + + + + +

class OSGPARTICLE_EXPORT osgParticle::ParticleSystem

The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ParticleSystem() +
+[more] ParticleSystem(const ParticleSystem &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Object(osgParticle, ParticleSystem) +
+[more]inline Alignment getParticleAlignment() const +
Get the alignment type of particles +
+[more]inline virtual Particle* createParticle(const Particle* ptemplate) +
Create a new particle from the specified template (or the default one if ptemplate is null) +
+[more]inline virtual void destroyParticle(int i) +
Destroy the i-th particle +
+[more]void setDefaultAttributes(const std::string &texturefile = "", bool emissive_particles = true, bool lighting = false, int texture_unit = 0) +
A useful method to set the most common StateAttribute's in one call. +
+[more]virtual void update(double dt) +
Update the particles. +
+[more]inline ParticleSystem::Alignment getParticleAlignment() const +
+[more]inline void setParticleAlignment(Alignment a) +
Set the alignment type of particles +
+[more]inline const osg::Vec3& getAlignVectorX() const +
Get the X-axis alignment vector +
+[more]inline void setAlignVectorX(const osg::Vec3 &v) +
Set the X-axis alignment vector +
+[more]inline const osg::Vec3& getAlignVectorY() const +
Get the Y-axis alignment vector +
+[more]inline void setAlignVectorY(const osg::Vec3 &v) +
Set the Y-axis alignment vector +
+[more]inline void setAlignVectors(const osg::Vec3 &X, const osg::Vec3 &Y) +
Set the alignment vectors +
+[more]inline bool isFrozen() const +
Return true if the particle system is frozen +
+[more]inline void setFrozen(bool v) +
Set or reset the frozen state. +
+[more]inline const osg::BoundingBox& getDefaultBoundingBox() const +
Get the default bounding box +
+[more]inline void setDefaultBoundingBox(const osg::BoundingBox &bbox) +
Set the default bounding box. +
+[more]inline bool getDoublePassRendering() const +
Get the double pass rendering flag +
+[more]inline void setDoublePassRendering(bool v) +
Set the double pass rendering flag. +
+[more]inline int numParticles() const +
Get the number of allocated particles (alive + dead) +
+[more]inline int numDeadParticles() const +
Get the number of dead particles +
+[more]inline Particle* getParticle(int i) +
Get a pointer to the i-th particle +
+[more]inline const Particle* getParticle(int i) const +
Get a const pointer to the i-th particle +
+[more]inline void destroyParticle(int i) +
+[more]inline int getLastFrameNumber() const +
Get the last frame number +
+[more]inline bool computeBound() const +
+[more]inline void update_bounds(const osg::Vec3 &p, float r) +
+[more]inline const Particle& getDefaultParticleTemplate() const +
Get a reference to the default particle template +
+[more]inline void setDefaultParticleTemplate(const Particle &p) +
Set the default particle template (particle is copied) +
+[more]inline bool getFreezeOnCull() const +
Get whether the particle system can freeze when culled +
+[more]inline void setFreezeOnCull(bool v) +
Set whether the particle system can freeze when culled (default is true) +
+[more]inline int getLevelOfDetail() const +
(EXPERIMENTAL) Get the level of detail +
+[more]inline void setLevelOfDetail(int v) +
(EXPERIMENTAL) Set the level of detail. +
+[more]inline Particle* createParticle(const Particle* ptemplate) +

+ +

+

Public Members

+[more]enum Alignment +

+ +

+

Protected Methods

+[more]virtual ~ParticleSystem() +
+[more]ParticleSystem& operator=(const ParticleSystem &) +
+[more]inline virtual bool computeBound() const +
+[more]virtual void drawImplementation(osg::State &state) const +
+[more]void single_pass_render(osg::State &state, const osg::Matrix &modelview) const +

+ +
+ + +
+

Documentation

+
The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction. +You can add this drawable to any Geode as you usually do with other +Drawable classes. Each instance of ParticleSystem is a separate set of +particles; it provides the interface for creating particles and iterating +through them (see the Emitter and Program classes).
+
+ + + +
oenum Alignment +

+ + + +
o BILLBOARD +

+ + +

o FIXED +

+ + + +
o ParticleSystem() +

+ + +

o ParticleSystem(const ParticleSystem &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Object(osgParticle, ParticleSystem) +

+ + +

oinline Alignment getParticleAlignment() const +
Get the alignment type of particles +

+ + +

oinline virtual Particle* createParticle(const Particle* ptemplate) +
Create a new particle from the specified template (or the default one if ptemplate is null) +

+ + +

oinline virtual void destroyParticle(int i) +
Destroy the i-th particle +

+ + +

ovoid setDefaultAttributes(const std::string &texturefile = "", bool emissive_particles = true, bool lighting = false, int texture_unit = 0) +
A useful method to set the most common StateAttribute's in one call. +If texturefile is empty, then texturing is turned off. +

+ + +

ovirtual void update(double dt) +
Update the particles. Don't call this directly, use a ParticleSystemUpdater instead. +

+ + +

ovirtual ~ParticleSystem() +

+ + +

oParticleSystem& operator=(const ParticleSystem &) +

+ + +

oinline virtual bool computeBound() const +

+ + +

ovirtual void drawImplementation(osg::State &state) const +

+ + +

ovoid single_pass_render(osg::State &state, const osg::Matrix &modelview) const +

+ + +

oinline ParticleSystem::Alignment getParticleAlignment() const +

+ + +

oinline void setParticleAlignment(Alignment a) +
Set the alignment type of particles +

+ + +

oinline const osg::Vec3& getAlignVectorX() const +
Get the X-axis alignment vector +

+ + +

oinline void setAlignVectorX(const osg::Vec3 &v) +
Set the X-axis alignment vector +

+ + +

oinline const osg::Vec3& getAlignVectorY() const +
Get the Y-axis alignment vector +

+ + +

oinline void setAlignVectorY(const osg::Vec3 &v) +
Set the Y-axis alignment vector +

+ + +

oinline void setAlignVectors(const osg::Vec3 &X, const osg::Vec3 &Y) +
Set the alignment vectors +

+ + +

oinline bool isFrozen() const +
Return true if the particle system is frozen +

+ + +

oinline void setFrozen(bool v) +
Set or reset the frozen state. +When the particle system is frozen, emitters and programs won't do anything on it. +

+ + +

oinline const osg::BoundingBox& getDefaultBoundingBox() const +
Get the default bounding box +

+ + +

oinline void setDefaultBoundingBox(const osg::BoundingBox &bbox) +
Set the default bounding box. +The default bounding box is used when a real bounding box cannot be computed, for example +because no particles has been updated yet. +

+ + +

oinline bool getDoublePassRendering() const +
Get the double pass rendering flag +

+ + +

oinline void setDoublePassRendering(bool v) +
Set the double pass rendering flag. +Double pass rendering avoids overdraw problems between particle systems +and other opaque objects. If you can render all the particle systems after +the opaque objects, then double pass is not necessary and can be turned off (best choice). +If you set the default attributes with setDefaultAttributes, then the particle +system will fall into a transparent bin. +

+ + +

oinline int numParticles() const +
Get the number of allocated particles (alive + dead) +

+ + +

oinline int numDeadParticles() const +
Get the number of dead particles +

+ + +

oinline Particle* getParticle(int i) +
Get a pointer to the i-th particle +

+ + +

oinline const Particle* getParticle(int i) const +
Get a const pointer to the i-th particle +

+ + +

oinline void destroyParticle(int i) +

+ + +

oinline int getLastFrameNumber() const +
Get the last frame number +

+ + +

oinline bool computeBound() const +

+ + +

oinline void update_bounds(const osg::Vec3 &p, float r) +

+ + +

oinline const Particle& getDefaultParticleTemplate() const +
Get a reference to the default particle template +

+ + +

oinline void setDefaultParticleTemplate(const Particle &p) +
Set the default particle template (particle is copied) +

+ + +

oinline bool getFreezeOnCull() const +
Get whether the particle system can freeze when culled +

+ + +

oinline void setFreezeOnCull(bool v) +
Set whether the particle system can freeze when culled (default is true) +

+ + +

oinline int getLevelOfDetail() const +
(EXPERIMENTAL) Get the level of detail +

+ + +

oinline void setLevelOfDetail(int v) +
(EXPERIMENTAL) Set the level of detail. The total number of particles is divided by the detail value to +get the actual number of particles to be drawn. This value must be greater than zero. +

+ + +

oinline Particle* createParticle(const Particle* ptemplate) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/ParticleSystemUpdater.html b/doc/doc++/osgParticle/ParticleSystemUpdater.html new file mode 100644 index 000000000..62241a0e7 --- /dev/null +++ b/doc/doc++/osgParticle/ParticleSystemUpdater.html @@ -0,0 +1,152 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::ParticleSystemUpdater + + + + +

class OSGPARTICLE_EXPORT osgParticle::ParticleSystemUpdater

A useful node class for updating particle systems automatically.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ParticleSystemUpdater() +
+[more] ParticleSystemUpdater(const ParticleSystemUpdater &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more] META_Node(osgParticle, ParticleSystemUpdater) +
+[more]virtual void traverse(osg::NodeVisitor &nv) +
+[more]inline bool computeBound() const +
+[more]inline int numParticleSystems() const +
Return the number of particle systems on the list +
+[more]inline void addParticleSystem(ParticleSystem* ps) +
Add a particle system to the list +
+[more]inline const ParticleSystem* getParticleSystem(int i) const +
Get a const particle system from the list +
+[more]inline ParticleSystem* getParticleSystem(int i) +
Get a particle system from the list +
+[more]inline void removeParticleSystem(int i) +
Remove a particle system from the list (by index) +
+[more]inline int findParticleSystem(ParticleSystem* ps) const +
Find a particle system +
+[more]inline bool removeParticleSystem(ParticleSystem* ps) +
Remove a particle system from the list (by pointer) +

+ +

+

Protected Methods

+[more]virtual ~ParticleSystemUpdater() +
+[more]ParticleSystemUpdater& operator=(const ParticleSystemUpdater &) +
+[more]inline virtual bool computeBound() const +

+ +
+ + +
+

Documentation

+
A useful node class for updating particle systems automatically. +When a ParticleSystemUpdater is traversed by a cull visitor, it calls the +update() method on the specified particle systems. You should place this updater +AFTER other nodes like emitters and programs.
+
+ + + +
o ParticleSystemUpdater() +

+ + +

o ParticleSystemUpdater(const ParticleSystemUpdater &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

o META_Node(osgParticle, ParticleSystemUpdater) +

+ + +

ovirtual void traverse(osg::NodeVisitor &nv) +

+ + +

ovirtual ~ParticleSystemUpdater() +

+ + +

oParticleSystemUpdater& operator=(const ParticleSystemUpdater &) +

+ + +

oinline virtual bool computeBound() const +

+ + +

oinline bool computeBound() const +

+ + +

oinline int numParticleSystems() const +
Return the number of particle systems on the list +

+ + +

oinline void addParticleSystem(ParticleSystem* ps) +
Add a particle system to the list +

+ + +

oinline const ParticleSystem* getParticleSystem(int i) const +
Get a const particle system from the list +

+ + +

oinline ParticleSystem* getParticleSystem(int i) +
Get a particle system from the list +

+ + +

oinline void removeParticleSystem(int i) +
Remove a particle system from the list (by index) +

+ + +

oinline int findParticleSystem(ParticleSystem* ps) const +
Find a particle system +

+ + +

oinline bool removeParticleSystem(ParticleSystem* ps) +
Remove a particle system from the list (by pointer) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Placer.html b/doc/doc++/osgParticle/Placer.html new file mode 100644 index 000000000..214d32755 --- /dev/null +++ b/doc/doc++/osgParticle/Placer.html @@ -0,0 +1,101 @@ + + + + + class osgParticle::Placer + + + + +

class osgParticle::Placer

An abstract base class for implementing particle placers.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void place(Particle* P) const = 0 +
Place a particle. +
+[more]inline Placer() +
+[more]inline Placer(const Placer &copy, const osg::CopyOp &copyop) +

+ +

+

Protected Methods

+[more] ~Placer() +
+[more]Placer& operator=(const Placer &) +

+ +
+ + +
+

Documentation

+
An abstract base class for implementing particle placers. A placer is an object which take +a particle as input, and places it somewhere by setting its position vector. Placer objects are +used by the ModularEmitter class as part of the particle emission process.
+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void place(Particle* P) const = 0 +
Place a particle. Must be implemented in descendant classes. +

+ + +

o ~Placer() +

+ + +

oPlacer& operator=(const Placer &) +

+ + +

oinline Placer() +

+ + +

oinline Placer(const Placer &copy, const osg::CopyOp &copyop) +

+
+
Direct child classes: +
SegmentPlacer
+MultiSegmentPlacer
+CenteredPlacer
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/PointPlacer.html b/doc/doc++/osgParticle/PointPlacer.html new file mode 100644 index 000000000..be52b1293 --- /dev/null +++ b/doc/doc++/osgParticle/PointPlacer.html @@ -0,0 +1,108 @@ + + + + + class osgParticle::PointPlacer + + + + +

class osgParticle::PointPlacer

A point-shaped particle placer.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, PointPlacer) +
+[more]inline PointPlacer() +
+[more]inline PointPlacer(const PointPlacer &copy, const osg::CopyOp &copyop) +
+[more]inline void place(Particle* P) const +
Place a particle. +

+ +

+

Protected Methods

+[more]virtual ~PointPlacer() +
+[more]PointPlacer& operator=(const PointPlacer &) +

+ +
+

Inherited from CenteredPlacer:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+oinline const osg::Vec3& getCenter() const +
+oinline void setCenter(const osg::Vec3 &v) +
+oinline void setCenter(float x, float y, float z) +

+ +
+

Inherited from Placer:

+
+
+ + +
+

Documentation

+
A point-shaped particle placer. +This placer class uses the center point defined in its base class CenteredPlacer +to place there all incoming particles.
+
+ + + +
o META_Object(osgParticle, PointPlacer) +

+ + +

ovirtual ~PointPlacer() +

+ + +

oPointPlacer& operator=(const PointPlacer &) +

+ + +

oinline PointPlacer() +

+ + +

oinline PointPlacer(const PointPlacer &copy, const osg::CopyOp &copyop) +

+ + +

oinline void place(Particle* P) const +
Place a particle. +This method is called automatically by ModularEmitter and should not be called +manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Program.html b/doc/doc++/osgParticle/Program.html new file mode 100644 index 000000000..8a3edc558 --- /dev/null +++ b/doc/doc++/osgParticle/Program.html @@ -0,0 +1,158 @@ + + + + + class OSGPARTICLE_EXPORT osgParticle::Program + + + + +

class OSGPARTICLE_EXPORT osgParticle::Program

An abstract ParticleProcessor descendant for modifying particles "on the fly" during the cull traversal.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Program() +
+[more] Program(const Program &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void accept(osg::NodeVisitor& nv) +
+[more]inline void process(double dt) +
Implementation of ParticleProcessor::process(). +

+ +

+

Protected Methods

+[more]virtual ~Program() +
+[more]Program& operator=(const Program &) +
+[more]virtual void execute(double dt) = 0 +
Execute the program on the particle system. +

+ +
+

Inherited from ParticleProcessor:

+
+

+

Public Methods

+oinline ReferenceFrame getReferenceFrame() const +
+ovoid traverse(osg::NodeVisitor &nv) +
+oinline ParticleProcessor::ReferenceFrame getReferenceFrame() const +
+oinline void setReferenceFrame(ReferenceFrame rf) +
+oinline bool isEnabled() const +
+oinline void setEnabled(bool v) +
+oinline ParticleSystem* getParticleSystem() +
+oinline const ParticleSystem* getParticleSystem() const +
+oinline void setParticleSystem(ParticleSystem* ps) +
+oinline bool computeBound() const +
+oinline const osg::Matrix& getLocalToWorldMatrix() +
+oinline const osg::Matrix& getWorldToLocalMatrix() +
+oinline osg::Vec3 transformLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 transformWorldToLocal(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateLocalToWorld(const osg::Vec3 &P) +
+oinline osg::Vec3 rotateWorldToLocal(const osg::Vec3 &P) +

+ +

+

Public Members

+oenum ReferenceFrame +

+ +
+ + +
+

Documentation

+
An abstract ParticleProcessor descendant for modifying particles "on the fly" +during the cull traversal. +Descendants of this class must implement the execute() method, which should iterate +through all particles in the linked particle system and modify them somehow +(usually updating their velocity vector).
+
+ + + +
o Program() +

+ + +

o Program(const Program &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void accept(osg::NodeVisitor& nv) +

+ + +

ovirtual ~Program() +

+ + +

oProgram& operator=(const Program &) +

+ + +

ovirtual void execute(double dt) = 0 +
Execute the program on the particle system. Must be overriden in descendant classes. +

+ + +

oinline void process(double dt) +
Implementation of ParticleProcessor::process(). Do not call this method by yourself. +

+
+
Direct child classes: +
ModularProgram
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/RadialShooter.html b/doc/doc++/osgParticle/RadialShooter.html new file mode 100644 index 000000000..b695b5925 --- /dev/null +++ b/doc/doc++/osgParticle/RadialShooter.html @@ -0,0 +1,172 @@ + + + + + class osgParticle::RadialShooter + + + + +

class osgParticle::RadialShooter

A shooter class that shoots particles radially.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, RadialShooter) +
+[more]inline RadialShooter() +
+[more]inline RadialShooter(const RadialShooter &copy, const osg::CopyOp &copyop) +
+[more]inline const rangef& getThetaRange() const +
Get the range of possible values for theta angle +
+[more]inline const rangef& getPhiRange() const +
Get the range of possible values for phi angle +
+[more]inline const rangef& getInitialSpeedRange() const +
Get the range of possible values for initial speed of particles +
+[more]inline void setThetaRange(const rangef &r) +
Set the range of possible values for theta angle +
+[more]inline void setThetaRange(float r1, float r2) +
Set the range of possible values for theta angle +
+[more]inline void setPhiRange(const rangef &r) +
Set the range of possible values for phi angle +
+[more]inline void setPhiRange(float r1, float r2) +
Set the range of possible values for phi angle +
+[more]inline void setInitialSpeedRange(const rangef &r) +
Set the range of possible values for initial speed of particles +
+[more]inline void setInitialSpeedRange(float r1, float r2) +
Set the range of possible values for initial speed of particles +
+[more]inline void shoot(Particle* P) const +
Shoot a particle. +

+ +

+

Protected Methods

+[more]virtual ~RadialShooter() +
+[more]RadialShooter& operator=(const RadialShooter &) +

+ +
+

Inherited from Shooter:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ +
+ + +
+

Documentation

+
A shooter class that shoots particles radially. +This shooter computes the velocity vector of incoming particles by choosing a +random direction and a random speed. Both direction and speed are chosen within +specified ranges. The direction is defined by two angles: theta, which +is the angle between the velocity vector and the Z axis, and phi, which is +the angle between the X axis and the velocity vector projected onto the X-Y plane.
+
+ + + +
o META_Object(osgParticle, RadialShooter) +

+ + +

ovirtual ~RadialShooter() +

+ + +

oRadialShooter& operator=(const RadialShooter &) +

+ + +

oinline RadialShooter() +

+ + +

oinline RadialShooter(const RadialShooter &copy, const osg::CopyOp &copyop) +

+ + +

oinline const rangef& getThetaRange() const +
Get the range of possible values for theta angle +

+ + +

oinline const rangef& getPhiRange() const +
Get the range of possible values for phi angle +

+ + +

oinline const rangef& getInitialSpeedRange() const +
Get the range of possible values for initial speed of particles +

+ + +

oinline void setThetaRange(const rangef &r) +
Set the range of possible values for theta angle +

+ + +

oinline void setThetaRange(float r1, float r2) +
Set the range of possible values for theta angle +

+ + +

oinline void setPhiRange(const rangef &r) +
Set the range of possible values for phi angle +

+ + +

oinline void setPhiRange(float r1, float r2) +
Set the range of possible values for phi angle +

+ + +

oinline void setInitialSpeedRange(const rangef &r) +
Set the range of possible values for initial speed of particles +

+ + +

oinline void setInitialSpeedRange(float r1, float r2) +
Set the range of possible values for initial speed of particles +

+ + +

oinline void shoot(Particle* P) const +
Shoot a particle. Do not call this method manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/RandomRateCounter.html b/doc/doc++/osgParticle/RandomRateCounter.html new file mode 100644 index 000000000..fc2a3e84d --- /dev/null +++ b/doc/doc++/osgParticle/RandomRateCounter.html @@ -0,0 +1,101 @@ + + + + + class osgParticle::RandomRateCounter + + + + +

class osgParticle::RandomRateCounter

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, RandomRateCounter) +
+[more]inline RandomRateCounter() +
+[more]inline RandomRateCounter(const RandomRateCounter &copy, const osg::CopyOp &copyop) +
+[more]inline int numParticlesToCreate(double dt) const +
Return the number of particles to be created in this frame +

+ +

+

Protected Methods

+[more]virtual ~RandomRateCounter() +

+ +
+

Inherited from VariableRateCounter:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+oinline const rangef& getRateRange() const +
+oinline void setRateRange(const rangef &r) +
+oinline void setRateRange(float minrange, float maxrange) +

+ +
+

Inherited from Counter:

+
+

+

Protected Methods

+oCounter& operator=(const Counter &) +

+ +
+ + +
+

Documentation

+
+ + + +
o META_Object(osgParticle, RandomRateCounter) +

+ + +

ovirtual ~RandomRateCounter() +

+ + +

oinline RandomRateCounter() +

+ + +

oinline RandomRateCounter(const RandomRateCounter &copy, const osg::CopyOp &copyop) +

+ + +

oinline int numParticlesToCreate(double dt) const +
Return the number of particles to be created in this frame +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/SectorPlacer.html b/doc/doc++/osgParticle/SectorPlacer.html new file mode 100644 index 000000000..b5d60e740 --- /dev/null +++ b/doc/doc++/osgParticle/SectorPlacer.html @@ -0,0 +1,156 @@ + + + + + class osgParticle::SectorPlacer + + + + +

class osgParticle::SectorPlacer

A sector-shaped particle placer.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, SectorPlacer) +
+[more]inline SectorPlacer() +
+[more]inline SectorPlacer(const SectorPlacer &copy, const osg::CopyOp &copyop) +
+[more]inline const rangef& getRadiusRange() const +
Get the range of possible values for radius +
+[more]inline const rangef& getPhiRange() const +
Get the range of possible values for the central angle +
+[more]inline void setRadiusRange(const rangef &r) +
Set the range of possible values for radius +
+[more]inline void setRadiusRange(float r1, float r2) +
Set the range of possible values for radius +
+[more]inline void setPhiRange(const rangef &r) +
Set the range of possible values for the central angle +
+[more]inline void setPhiRange(float r1, float r2) +
Set the range of possible values for the central angle +
+[more]inline void place(Particle* P) const +
Place a particle. +

+ +

+

Protected Methods

+[more]virtual ~SectorPlacer() +
+[more]SectorPlacer& operator=(const SectorPlacer &) +

+ +
+

Inherited from CenteredPlacer:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +
+oinline const osg::Vec3& getCenter() const +
+oinline void setCenter(const osg::Vec3 &v) +
+oinline void setCenter(float x, float y, float z) +

+ +
+

Inherited from Placer:

+
+
+ + +
+

Documentation

+
A sector-shaped particle placer. +This placer sets the initial position of incoming particle by choosing a random position +within a circular sector; this sector is defined by three parameters: a center point, +which is inherited directly from osgParticle::CenteredPlacer, a range of values +for radius, and a range of values for the central angle (sometimes called phi).
+
+ + + +
o META_Object(osgParticle, SectorPlacer) +

+ + +

ovirtual ~SectorPlacer() +

+ + +

oSectorPlacer& operator=(const SectorPlacer &) +

+ + +

oinline SectorPlacer() +

+ + +

oinline SectorPlacer(const SectorPlacer &copy, const osg::CopyOp &copyop) +

+ + +

oinline const rangef& getRadiusRange() const +
Get the range of possible values for radius +

+ + +

oinline const rangef& getPhiRange() const +
Get the range of possible values for the central angle +

+ + +

oinline void setRadiusRange(const rangef &r) +
Set the range of possible values for radius +

+ + +

oinline void setRadiusRange(float r1, float r2) +
Set the range of possible values for radius +

+ + +

oinline void setPhiRange(const rangef &r) +
Set the range of possible values for the central angle +

+ + +

oinline void setPhiRange(float r1, float r2) +
Set the range of possible values for the central angle +

+ + +

oinline void place(Particle* P) const +
Place a particle. Do not call it manually. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/SegmentPlacer.html b/doc/doc++/osgParticle/SegmentPlacer.html new file mode 100644 index 000000000..ca2a737d3 --- /dev/null +++ b/doc/doc++/osgParticle/SegmentPlacer.html @@ -0,0 +1,154 @@ + + + + + class osgParticle::SegmentPlacer + + + + +

class osgParticle::SegmentPlacer

A segment-shaped particle placer.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] META_Object(osgParticle, SegmentPlacer) +
+[more]inline SegmentPlacer() +
+[more]inline SegmentPlacer(const SegmentPlacer &copy, const osg::CopyOp &copyop) +
+[more]inline const osg::Vec3& getVertexA() const +
get vertex A +
+[more]inline const osg::Vec3& getVertexB() const +
get vertex B +
+[more]inline void setSegment(const osg::Vec3 &A, const osg::Vec3 &B) +
Set both vertices +
+[more]inline void place(Particle* P) const +
Place a particle. +
+[more]inline void setVertexA(const osg::Vec3 &v) +
Set vertex A of the segment as a vector +
+[more]inline void setVertexA(float x, float y, float z) +
Set vertex A of the segment as three floats +
+[more]inline void setVertexB(const osg::Vec3 &v) +
Set vertex B of the segment as a vector +
+[more]inline void setVertexB(float x, float y, float z) +
Set vertex B of the segment as three floats +

+ +

+

Protected Methods

+[more]virtual ~SegmentPlacer() +
+[more]SegmentPlacer& operator=(const SegmentPlacer &) +

+ +
+

Inherited from Placer:

+
+

+

Public Methods

+ovirtual const char* libraryName() const +
+ovirtual const char* className() const +
+ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ +
+ + +
+

Documentation

+
A segment-shaped particle placer. +To use this placer you have to define a segment, by setting its two vertices (A and B); +when an emitter requests a SegmentPlacer to place a particle, the position is chosen randomly +within that segment.
+
+ + + +
o META_Object(osgParticle, SegmentPlacer) +

+ + +

ovirtual ~SegmentPlacer() +

+ + +

oSegmentPlacer& operator=(const SegmentPlacer &) +

+ + +

oinline SegmentPlacer() +

+ + +

oinline SegmentPlacer(const SegmentPlacer &copy, const osg::CopyOp &copyop) +

+ + +

oinline const osg::Vec3& getVertexA() const +
get vertex A +

+ + +

oinline const osg::Vec3& getVertexB() const +
get vertex B +

+ + +

oinline void setSegment(const osg::Vec3 &A, const osg::Vec3 &B) +
Set both vertices +

+ + +

oinline void place(Particle* P) const +
Place a particle. This method is called by ModularEmitter, do not call it manually. +

+ + +

oinline void setVertexA(const osg::Vec3 &v) +
Set vertex A of the segment as a vector +

+ + +

oinline void setVertexA(float x, float y, float z) +
Set vertex A of the segment as three floats +

+ + +

oinline void setVertexB(const osg::Vec3 &v) +
Set vertex B of the segment as a vector +

+ + +

oinline void setVertexB(float x, float y, float z) +
Set vertex B of the segment as three floats +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/Shooter.html b/doc/doc++/osgParticle/Shooter.html new file mode 100644 index 000000000..1ab3f7eaf --- /dev/null +++ b/doc/doc++/osgParticle/Shooter.html @@ -0,0 +1,100 @@ + + + + + class osgParticle::Shooter + + + + +

class osgParticle::Shooter

An abstract base class used by ModularEmitter to "shoot" the particles after they have been placed.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual void shoot(Particle* P) const = 0 +
Shoot a particle. +
+[more]inline Shooter() +
+[more]inline Shooter(const Shooter &copy, const osg::CopyOp &copyop) +

+ +

+

Protected Methods

+[more]virtual ~Shooter() +
+[more]Shooter& operator=(const Shooter &) +

+ +
+ + +
+

Documentation

+
An abstract base class used by ModularEmitter to "shoot" the particles after they have been placed. +Descendants of this class must override the shoot() method.
+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual void shoot(Particle* P) const = 0 +
Shoot a particle. Must be overriden by descendants. +This method should only set the velocity vector of particle P, leaving other +attributes unchanged. +

+ + +

ovirtual ~Shooter() +

+ + +

oShooter& operator=(const Shooter &) +

+ + +

oinline Shooter() +

+ + +

oinline Shooter(const Shooter &copy, const osg::CopyOp &copyop) +

+
+
Direct child classes: +
RadialShooter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/VariableRateCounter.html b/doc/doc++/osgParticle/VariableRateCounter.html new file mode 100644 index 000000000..fe5285859 --- /dev/null +++ b/doc/doc++/osgParticle/VariableRateCounter.html @@ -0,0 +1,112 @@ + + + + + class osgParticle::VariableRateCounter + + + + +

class osgParticle::VariableRateCounter

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]inline VariableRateCounter() +
+[more]inline VariableRateCounter(const VariableRateCounter &copy, const osg::CopyOp &copyop) +
+[more]inline const rangef& getRateRange() const +
+[more]inline void setRateRange(const rangef &r) +
+[more]inline void setRateRange(float minrange, float maxrange) +

+ +

+

Protected Methods

+[more]virtual ~VariableRateCounter() +

+ +
+

Inherited from Counter:

+
+

+

Public Methods

+ovirtual int numParticlesToCreate(double dt) const +

+ +

+

Protected Methods

+oCounter& operator=(const Counter &) +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual ~VariableRateCounter() +

+ + +

oinline VariableRateCounter() +

+ + +

oinline VariableRateCounter(const VariableRateCounter &copy, const osg::CopyOp &copyop) +

+ + +

oinline const rangef& getRateRange() const +

+ + +

oinline void setRateRange(const rangef &r) +

+ + +

oinline void setRateRange(float minrange, float maxrange) +

+
+
Direct child classes: +
RandomRateCounter
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/icon1.gif b/doc/doc++/osgParticle/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/icon2.gif b/doc/doc++/osgParticle/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgParticle/index.html b/doc/doc++/osgParticle/index.html new file mode 100644 index 000000000..5f987f2b7 --- /dev/null +++ b/doc/doc++/osgParticle/index.html @@ -0,0 +1,61 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/osgParticle.html b/doc/doc++/osgParticle/osgParticle.html new file mode 100644 index 000000000..7fb223215 --- /dev/null +++ b/doc/doc++/osgParticle/osgParticle.html @@ -0,0 +1,112 @@ + + + + + namespace osgParticle + + + + +

namespace osgParticle

+
+

+
+class AccelOperator: public Operator +
An operator class that applies a constant acceleration to the particles +
+class CenteredPlacer: public Placer +
An abstract placer base class for placers which need a center point +
+class Counter: public osg::Object +
+class OSGPARTICLE_EXPORT Emitter: public ParticleProcessor +
An abstract base class for particle emitters. +
+class OSGPARTICLE_EXPORT FluidFrictionOperator: public Operator +
An operator that simulates the friction of a fluid. +
+class ForceOperator: public Operator +
An operator that applies a constant force to the particles. +
+class Interpolator: public osg::Object +
An abstract base class for implementing interpolators +
+class LinearInterpolator: public Interpolator +
A linear interpolator +
+class OSGPARTICLE_EXPORT ModularEmitter: public Emitter +
An emitter class that holds three objects to control the creation of particles. +
+class OSGPARTICLE_EXPORT ModularProgram: public Program +
A program class for performing operations on particles using a sequence of operators. +
+class OSGPARTICLE_EXPORT MultiSegmentPlacer: public Placer +
A polyline-shaped particle placer. +
+class Operator: public osg::Object +
An abstract base class used by ModularProgram to perform operations on particles before they are updated. +
+class OSGPARTICLE_EXPORT Particle +
Implementation of a particle. +
+class OSGPARTICLE_EXPORT ParticleProcessor: public osg::Node +
A common base interface for those classes which need to do something on particles. +
+class OSGPARTICLE_EXPORT ParticleSystem: public osg::Drawable +
The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction. +
+class OSGPARTICLE_EXPORT ParticleSystemUpdater: public osg::Node +
A useful node class for updating particle systems automatically. +
+class Placer: public osg::Object +
An abstract base class for implementing particle placers. +
+class PointPlacer: public CenteredPlacer +
A point-shaped particle placer. +
+class OSGPARTICLE_EXPORT Program: public ParticleProcessor +
An abstract ParticleProcessor descendant for modifying particles "on the fly" during the cull traversal. +
+class RadialShooter: public Shooter +
A shooter class that shoots particles radially. +
+class RandomRateCounter: public VariableRateCounter +
+class SectorPlacer: public CenteredPlacer +
A sector-shaped particle placer. +
+class SegmentPlacer: public Placer +
A segment-shaped particle placer. +
+class Shooter: public osg::Object +
An abstract base class used by ModularEmitter to "shoot" the particles after they have been placed. +
+class VariableRateCounter: public Counter +
+template<class T_> struct range +
A simple struct template useful to store ranges of values as min/max pairs. +
+typedef range<float> rangef +
Range of floats +
+typedef range<osg::Vec2> rangev2 +
Range of osg::Vec2s +
+typedef range<osg::Vec3> rangev3 +
Range of osg::Vec3s +
+typedef range<osg::Vec4> rangev4 +
Range of osg::Vec4s +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/range.html b/doc/doc++/osgParticle/range.html new file mode 100644 index 000000000..3aafcb7fc --- /dev/null +++ b/doc/doc++/osgParticle/range.html @@ -0,0 +1,81 @@ + + + + + template<class T_> struct osgParticle::range + + + + +

template<class T_> struct osgParticle::range

A simple struct template useful to store ranges of values as min/max pairs.
+ +
+

+
+[more]T_ minimum +
Lower bound +
+[more]T_ maximum +
Higher bound +
+[more] range() +
Construct the object by calling default constructors for min and max +
+[more] range(const T_ &mn, const T_ &mx) +
Construct and initialize min and max directly +
+[more]void set(const T_ &mn, const T_ &mx) +
Set min and max +
+[more]T_ get_random() const +
Get a random value between min and max +

+ + + +
+

Documentation

+
+A simple struct template useful to store ranges of values as min/max pairs. +This struct template helps storing min/max ranges for values of any kind; class T_ is +the type of values to be stored, and it must support operations T_ + T_, T_ - T_, +and T_ * float, otherwise the get_random() method will not compile. +This struct could be extended to customize the random number generator (now it uses only +std::rand()).
+
+ + + +
oT_ minimum +
Lower bound +

+ + +

oT_ maximum +
Higher bound +

+ + +

o range() +
Construct the object by calling default constructors for min and max +

+ + +

o range(const T_ &mn, const T_ &mx) +
Construct and initialize min and max directly +

+ + +

ovoid set(const T_ &mn, const T_ &mx) +
Set min and max +

+ + +

oT_ get_random() const +
Get a random value between min and max +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/rangef.html b/doc/doc++/osgParticle/rangef.html new file mode 100644 index 000000000..b44c9a71d --- /dev/null +++ b/doc/doc++/osgParticle/rangef.html @@ -0,0 +1,20 @@ + + + + + typedef range<float> osgParticle::rangef + + + + +

typedef range<float> osgParticle::rangef

Range of floats
+ + +
+

Documentation

+
Range of floats
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/rangev2.html b/doc/doc++/osgParticle/rangev2.html new file mode 100644 index 000000000..a4e323f68 --- /dev/null +++ b/doc/doc++/osgParticle/rangev2.html @@ -0,0 +1,20 @@ + + + + + typedef range<osg::Vec2> osgParticle::rangev2 + + + + +

typedef range<osg::Vec2> osgParticle::rangev2

Range of osg::Vec2s
+ + +
+

Documentation

+
Range of osg::Vec2s
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/rangev3.html b/doc/doc++/osgParticle/rangev3.html new file mode 100644 index 000000000..45dbd72f7 --- /dev/null +++ b/doc/doc++/osgParticle/rangev3.html @@ -0,0 +1,20 @@ + + + + + typedef range<osg::Vec3> osgParticle::rangev3 + + + + +

typedef range<osg::Vec3> osgParticle::rangev3

Range of osg::Vec3s
+ + +
+

Documentation

+
Range of osg::Vec3s
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgParticle/rangev4.html b/doc/doc++/osgParticle/rangev4.html new file mode 100644 index 000000000..ccfaa7cf5 --- /dev/null +++ b/doc/doc++/osgParticle/rangev4.html @@ -0,0 +1,20 @@ + + + + + typedef range<osg::Vec4> osgParticle::rangev4 + + + + +

typedef range<osg::Vec4> osgParticle::rangev4

Range of osg::Vec4s
+ + +
+

Documentation

+
Range of osg::Vec4s
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/Callback.html b/doc/doc++/osgProducer/Callback.html new file mode 100644 index 000000000..efb3abe47 --- /dev/null +++ b/doc/doc++/osgProducer/Callback.html @@ -0,0 +1,52 @@ + + + + + class osgProducer::OsgSceneHandler::Callback + + + + +

class Callback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual ~Callback() +
+[more]virtual void operator()(OsgSceneHandler&, const Producer::Camera &) = 0 +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual ~Callback() +

+ + +

ovirtual void operator()(OsgSceneHandler&, const Producer::Camera &) = 0 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/ClassGraph.class b/doc/doc++/osgProducer/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..4f41a1fb2fdf65525a700ad591fe8a696f29497f GIT binary patch literal 1237 zcma)6*-{fh6g@+hNrou`K|w^^#V{;!Uxf)I{zh+h=K3 zsd!waUo=!!3dIjq#=y{V{6M7_+&wM=R|*RBw*!KzHaBtvg;Em*1L4$)R)eWlU#iPW zPx={+I$h{qMG7udrcI%d+6D~_cO;*T)@?>RB02V1R@EvKtjwE3##>R3iE=uxd{>m) zBRU}i>WsuD>(0FYN6y?~v%I|}%|80f6|R~yU}ZfP1j|0Fd@ztWac1<5bRp|ZaL+(* zBd2*{+H_Wyxb7lFpqNkv=2f-7cv$2WMb{J<7|5NpZ8V{KN}fKEfxet9GOxgVm+g3* zDidpL-z_sG{rRd=Qc&Z(tolX1yd+@k)$&&}|#YQU4bz2pm?{eSgrM&xv$VGh~Gz=@?#JBjV?8~a4HN?qp z7K6@BA1O#fe|02#$X>+^$qadih$BMUbCQu7F65kKnAED1>>;)0B%`Ee!%i|p`WwzW zzmV7t)sd`WjO^I<MT3FyI-fA42Q3jhEB literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/ClassGraphPanel.class b/doc/doc++/osgProducer/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..4f3ea86bb625e4e043d10fafb3b0b05cf2f96537 GIT binary patch literal 4084 zcmbtWX>c4@5&lLyyR*lXB(J?mmPm#W>_{tH!Xb!QvIDl97=dgjR%}Nym>unoq_tNw z%I>VBgm4=IB%DP##03F|V>uGQMp~IT2Uj@Eec$=X4~qX(Q550pH+#lP%0Q{quiy8& zzwYVR@4dbF@5i1*09)})825$ofiON6#sgt|GK|lJ@kkh73FCWV{5*``hVd5zA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR24!kakD@AO?>!awz zSQOpZ7sUqbkDwg~MBExd9JfWW9tUMQF5-6aI3(KPD8-Q|uD~5pbYViUNfAfI&*JSSK8J@*d|pHu51RM_7EF8*XH0wvr%Zeqo{2|s z+Qe7!P7`0lTTPtByG@+Kr%ZfZOqOw%i51Z*__T>t@%TPIZsG^x@k3d-DA3DR-0hY=%^o*qaSt+1JW2YqzSe4J&p86+`L;D7Btm@&ds}y?RdjYUozs> zK>3me#omH7Kby-G70Xp?E%;%Z1Jr#+M=#A;vbnm6XUw|GEqVJa$C|PIToct*^`!@< zjRC}bMqcQ21 zu5LkYwH!OIA*O8nebS(hxLI3RT&Ktu_YPb666e|;VmB{k?0JvJp-6ydMH?eH*5uB; z>8ySkPmkZ88seAMS3~=lo3ZkTtwPS4%G)ID*l#W5W-QMw>@Inp>yZ8+>BrqtA!FZ? z%S#gMlD4A^96#EK;#)KF`YPC5A^IHSA+)kt4MA(#vkR=&ls)YhNEe*STbUCAxFsjc z6pSeqnVO!-I37!r;fi;=dxEzBsYnvY=18Gu-9;uCkzrS%;4W$iXA9QiSk57D$iA~= z<>?Td&J~KJ(PsG}vsQ5*!`8?`vvzJ~mW!dBljUJ0L#|%!j`|H$t3`VqQB`FLntfcPqv2V(ktLL=Fr?7pN#~O4t zT>bN{!BkMS#Wf_=wB+UT)r(Y>D|feihsItF<<)h<(&z1IuUdLT^f_xumThN7A_de` zpK}+u9}$PAR1tAY=2;aMJEBH^zci9Z3$h!vy)4>ZwagK!^`lW_B6Ka5ri$v8XE&DS z**2y5s-s>i$i5p3a%c`rGiP>2a50yaoHQn=-2?C?y^=Ds z$a&mS!7C4FLmkQX3bsFl4HwWokqjl*oH55|*bysd(P2N4Pk#%a(iAuphFA{k9~B!h|0L_D#Mm`bI86)zo6P0&J5uP}Rl z==G0)F|mplPp)9Fg4YBFV`bc!61GH)fnRo{s&;M^rbMit!)CR#J(y3=CSsi% zXDb*!8PgImE~U;q`}A4v?BDPY{1ZvF>-^E$2Jx${@qTJG!;R!&7vH$|u38lAt%Uf5lt`!0Q5 z61~-(zxsUlzys|22oSiBRoce?-T=$HYZawB1z+k8x$R_nfC=t@r(tU}CDC6Txg<7h+oWC&S9_bii!b$r|mIZMwTUqixDJN$c4LcvBUu z@=G#%%56_EJR6)vn{3dw#HPL4!dh z$DJobZHZ8ljj&zMp83})|BBG?Q@o>k#upIcA8@?y9ImV2)qz31jN6#S;4*FuW&`Ij z#QSb%LZ_5tA}zN$q4Ol~q}Hpno}pkexQtN|uTAf)T5a;JPU>1hrz!8rM^XVkaJ3vB JV$?Q#=szD|0>A(O literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/ClassLayout.class b/doc/doc++/osgProducer/ClassLayout.class new file mode 100644 index 0000000000000000000000000000000000000000..69a6f494ed99e62d55c975c56b11981104a3dca9 GIT binary patch literal 2443 zcmZuy>2nih82>HVBfIRhrLbUtR6&I{DHK$q7O2{CSZ$$Nt%9Q2CfjstvKu#>mg24T zzHd=Ha5~e`PwKRRkr~I&`WN`mh|lwGlBPmt_IaQCe&77{@9%#ghCR3#hohmO!PPLM z;aLqYX?R(~D;i$a@S27N4XL&KXI-qP^4hIb6K;dTRY++m;t2N+}++^IvyT?S;_ zZ9qf6PS`;PhnPI9L&1PfX7@08FDu{2(m?|%h71@u!q`zA8*q%h9B1-=115$Udw?w- zWQ!4YHOe7RFz=*+c8sy-hjgsR!wkkvOyLxRGYoPjs<0VMnwW)WVh&joXYq)Mc_z=H zV&XZRHt{@TFEH;#Oqh6&vG*B#fX7UHh$l^a%uYXnZ{kxtZQ?ULYT|Q_@g)nsV&(G; zzGm33dyX)(nv%74O84+E zrzTF}VKu{5d-k2`Zk2eU?Rrjduq9k;L0hh`Om2GX5|PHq$r&dXHk`C%HdvjSBJclG zuUA`-c|CQj)q6voqV`;e-&#(iQCz6hFF`%zdTux%!5AvqmCEtJE>BBnUnTbP9M^Eh zY|kl5STA%&?0LT$N|1;Ayu)66uM*l`IAIs7Odma)bIKtNze4e-{Z^EW>-UY(Ktsyh zu}f5b+lZgDixYO>+LJ|xl-p0(vu?o-{a~;fhCZ#9G45A`oO8@Al4I#Kt&N?}NAa5j zq=M{n+41s(O!{P3lAx30+;~WhCa*ca>V-{piWASfoN$hODpPJyp<2v>v#LTGg}|R1 zai&P3PCIU4nh{s*F6Gc%^QP0a%=-ScGMoED`83U=%RpDB$%#rEwLQDw1k|CXK->_z zOM@}OVR(HM<{iBPJGTV>xi>CIn7>q>+lze`I>9e1LGbe_PI?r@Nsld^8tKs+P4F3_c3~Z1z}D0ybf!AGRtQs8u!BK5C9h!H zufkSBh0*h0e%K+{VJLtfkb2bvmOgsFI~7 zFJApQMe%N+P&?>LXQP<%6~s^VF5@QpQsg;H=U)1@kfZD+Z2X0i;qSCXT0)-`S)b-YWhtV4KcX$6 zMd%9lB~&3|&{abZtMBZObCF6uqg(m~sIiRBbjILV)P$}?+!A=N=+LxqkYB<6C0L0# zEA?7>G%8|J0GjcBD~iY&B=br!Tf;5C;npkYIAtl9(RT@(I;9#mb9}3YJvDSMD3Ya6 OO$QpS45)eQF#R7oR!vR- literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/EventAdapter.html b/doc/doc++/osgProducer/EventAdapter.html new file mode 100644 index 000000000..5037f627d --- /dev/null +++ b/doc/doc++/osgProducer/EventAdapter.html @@ -0,0 +1,352 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::EventAdapter + + + + +

class OSGPRODUCER_EXPORT osgProducer::EventAdapter

Class for adapting Producer events so that they can be used as input to osgGA::CameraManipulators
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]static unsigned int _s_accumulatedButtonMask +
+[more]static int _s_button +
+[more]static float _s_Xmin +
+[more]static float _s_Xmax +
+[more]static float _s_Ymin +
+[more]static float _s_Ymax +
+[more]static float _s_mx +
+[more]static float _s_my +
+[more]static int _s_modKeyMask +

+ +

+

Public Methods

+[more] EventAdapter() +
+[more]virtual ~EventAdapter() +
+[more]virtual EventType getEventType() const +
Get the EventType of the GUI event +
+[more]virtual int getKey() const +
key pressed, return -1 if inappropriate for this event. +
+[more]virtual int getButton() const +
button pressed/released, return -1 if inappropriate for this event +
+[more]virtual float getXmin() const +
window minimum x. +
+[more]virtual float getXmax() const +
window maximum x. +
+[more]virtual float getYmin() const +
window minimum y. +
+[more]virtual float getYmax() const +
window maximum y. +
+[more]virtual float getX() const +
current mouse x position +
+[more]virtual float getY() const +
current mouse y position +
+[more]virtual unsigned int getButtonMask() const +
current mouse button state +
+[more]virtual double time() const +
time in seconds of event. +
+[more]virtual unsigned int getModKeyMask() const +
+[more]static void setWindowSize(float Xmin, float Ymin, float Xmax, float Ymax) +
static method for setting window dimensions +
+[more]static void setButtonMask(unsigned int buttonMask) +
static method for setting button state +
+[more]void adaptResize(double t, float Xmin, float Ymin, float Xmax, float Ymax) +
method for adapting resize events. +
+[more]void adaptMouseMotion(double t, float x, float y) +
method for adapting mouse motion events whilst mouse buttons are pressed +
+[more]void adaptButtonPress(double t, float x, float y, unsigned int button) +
+[more]void adaptButtonRelease(double t, float x, float y, unsigned int button) +
+[more]void adaptKeyPress( double t, Producer::KeySymbol key) +
method for adapting keyboard events +
+[more]void adaptKeyRelease( double t, Producer::KeySymbol key) +
+[more]void adaptFrame(double t) +
method for adapting frame events, ie. +
+[more]void copyStaticVariables() +

+ +

+

Protected Fields

+[more]EventType _eventType +
+[more]int _key +
+[more]int _button +
+[more]float _Xmin +
+[more]float _Xmax +
+[more]float _Ymin +
+[more]float _Ymax +
+[more]float _mx +
+[more]float _my +
+[more]unsigned int _buttonMask +
+[more]unsigned int _modKeyMask +
+[more]double _time +

+ +
+ + +
+

Documentation

+
Class for adapting Producer events so that they can be used as input to osgGA::CameraManipulators
+
+ + + +
o EventAdapter() +

+ + +

ovirtual ~EventAdapter() +

+ + +

ovirtual EventType getEventType() const +
Get the EventType of the GUI event +

+ + +

ovirtual int getKey() const +
key pressed, return -1 if inappropriate for this event. +

+ + +

ovirtual int getButton() const +
button pressed/released, return -1 if inappropriate for this event +

+ + +

ovirtual float getXmin() const +
window minimum x. +

+ + +

ovirtual float getXmax() const +
window maximum x. +

+ + +

ovirtual float getYmin() const +
window minimum y. +

+ + +

ovirtual float getYmax() const +
window maximum y. +

+ + +

ovirtual float getX() const +
current mouse x position +

+ + +

ovirtual float getY() const +
current mouse y position +

+ + +

ovirtual unsigned int getButtonMask() const +
current mouse button state +

+ + +

ovirtual double time() const +
time in seconds of event. +

+ + +

ovirtual unsigned int getModKeyMask() const +

+ + +

ostatic void setWindowSize(float Xmin, float Ymin, float Xmax, float Ymax) +
static method for setting window dimensions +

+ + +

ostatic void setButtonMask(unsigned int buttonMask) +
static method for setting button state +

+ + +

ovoid adaptResize(double t, float Xmin, float Ymin, float Xmax, float Ymax) +
method for adapting resize events. +

+ + +

ovoid adaptMouseMotion(double t, float x, float y) +
method for adapting mouse motion events whilst mouse buttons are pressed +

+ + +

ovoid adaptButtonPress(double t, float x, float y, unsigned int button) +

+ + +

ovoid adaptButtonRelease(double t, float x, float y, unsigned int button) +

+ + +

ovoid adaptKeyPress( double t, Producer::KeySymbol key) +
method for adapting keyboard events +

+ + +

ovoid adaptKeyRelease( double t, Producer::KeySymbol key) +

+ + +

ovoid adaptFrame(double t) +
method for adapting frame events, ie. idle/display callback. +

+ + +

ovoid copyStaticVariables() +

+ + +

oEventType _eventType +

+ + +

oint _key +

+ + +

oint _button +

+ + +

ofloat _Xmin +

+ + +

ofloat _Xmax +

+ + +

ofloat _Ymin +

+ + +

ofloat _Ymax +

+ + +

ofloat _mx +

+ + +

ofloat _my +

+ + +

ounsigned int _buttonMask +

+ + +

ounsigned int _modKeyMask +

+ + +

odouble _time +

+ + +

ostatic unsigned int _s_accumulatedButtonMask +

+ + +

ostatic int _s_button +

+ + +

ostatic float _s_Xmin +

+ + +

ostatic float _s_Xmax +

+ + +

ostatic float _s_Ymin +

+ + +

ostatic float _s_Ymax +

+ + +

ostatic float _s_mx +

+ + +

ostatic float _s_my +

+ + +

ostatic int _s_modKeyMask +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/General.html b/doc/doc++/osgProducer/General.html new file mode 100644 index 000000000..e2531a179 --- /dev/null +++ b/doc/doc++/osgProducer/General.html @@ -0,0 +1,49 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGGLUT_ProducerEventAdapter
+ +o#define +OSGPRODUCER_EXPORT_
+ +o#define +OSGPRODUCER_EXPORT(dllexport)
+ +o#define +OSGPRODUCER_EXPORT(dllimport)
+ +o#define +OSGPRODUCER_EXPORT
+ +o#define +OSGPRODUCER_EVENTCALLBACK
+ +o#define +OSGPRODUCER_OSGCAMERAGROUP_H
+ +o#define +OSGPRODUCER_OSGSCENEHANDLER
+ +o#define +OSGPRODUCER_VERSION
+ +o#define +OSG_VIEWER_H
+ +o#define +OSGPRODUCER_VIEWEREVENTHANDLER
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/HIER.html b/doc/doc++/osgProducer/HIER.html new file mode 100644 index 000000000..b7ed26c29 --- /dev/null +++ b/doc/doc++/osgProducer/HIER.html @@ -0,0 +1,26 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/HIERjava.html b/doc/doc++/osgProducer/HIERjava.html new file mode 100644 index 000000000..368e14742 --- /dev/null +++ b/doc/doc++/osgProducer/HIERjava.html @@ -0,0 +1,65 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/KeyboardMouseCallback.html b/doc/doc++/osgProducer/KeyboardMouseCallback.html new file mode 100644 index 000000000..0c754398a --- /dev/null +++ b/doc/doc++/osgProducer/KeyboardMouseCallback.html @@ -0,0 +1,250 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::KeyboardMouseCallback + + + + +

class OSGPRODUCER_EXPORT osgProducer::KeyboardMouseCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] KeyboardMouseCallback(Producer::KeyboardMouse* keyboardMouse, bool &done, bool escapeKeySetsDone=true) +
+[more]virtual ~KeyboardMouseCallback() +
+[more]virtual void mouseMotion( float mx, float my) +
+[more]virtual void passiveMouseMotion( float mx, float my) +
+[more]virtual void buttonPress( float mx, float my, unsigned int mbutton ) +
+[more]virtual void doubleButtonPress( float mx, float my, unsigned int mbutton) +
+[more]virtual void buttonRelease( float mx, float my, unsigned int mbutton ) +
+[more]virtual void keyPress( Producer::KeyCharacter key ) +
+[more]virtual void keyRelease( Producer::KeyCharacter key ) +
+[more]virtual void specialKeyPress( Producer::KeyCharacter key) +
+[more]virtual void specialKeyRelease( Producer::KeyCharacter key) +
+[more]void setEscapeSetDone(bool esc) +
+[more]bool getEscapeSetDone() const +
+[more]void getEventQueue(EventQueue& queue) +
+[more]bool done() +
+[more]float mx() +
+[more]float my() +
+[more]unsigned int mbutton() +
+[more]void setStartTick(osg::Timer_t tick) +
+[more]double getTime() +
+[more]Producer::KeyboardMouse* getKeyboardMouse() +
+[more]const Producer::KeyboardMouse* getKeyboardMouse() const +
+[more]EventAdapter* createEventAdapter() +

+ +

+

Public Members

+[more]typedef std::vector< osg::ref_ptr<EventAdapter> > EventQueue +

+ +

+

Protected Fields

+[more]Producer::KeyboardMouse* _keyboardMouse +
+[more]float _mx +
+[more]float _my +
+[more]unsigned int _mbutton +
+[more]bool& _done +
+[more]bool _escapeKeySetsDone +
+[more]osg::Timer_t _startTick +
+[more]osg::Timer _timer +
+[more]Producer::Mutex _eventQueueMutex +
+[more]EventQueue _eventQueue +

+ +
+ + +
+

Documentation

+
+ + + +
o KeyboardMouseCallback(Producer::KeyboardMouse* keyboardMouse, bool &done, bool escapeKeySetsDone=true) +

+ + +

ovirtual ~KeyboardMouseCallback() +

+ + +

ovirtual void mouseMotion( float mx, float my) +

+ + +

ovirtual void passiveMouseMotion( float mx, float my) +

+ + +

ovirtual void buttonPress( float mx, float my, unsigned int mbutton ) +

+ + +

ovirtual void doubleButtonPress( float mx, float my, unsigned int mbutton) +

+ + +

ovirtual void buttonRelease( float mx, float my, unsigned int mbutton ) +

+ + +

ovirtual void keyPress( Producer::KeyCharacter key ) +

+ + +

ovirtual void keyRelease( Producer::KeyCharacter key ) +

+ + +

ovirtual void specialKeyPress( Producer::KeyCharacter key) +

+ + +

ovirtual void specialKeyRelease( Producer::KeyCharacter key) +

+ + +

ovoid setEscapeSetDone(bool esc) +

+ + +

obool getEscapeSetDone() const +

+ + +

otypedef std::vector< osg::ref_ptr<EventAdapter> > EventQueue +

+ + +

ovoid getEventQueue(EventQueue& queue) +

+ + +

obool done() +

+ + +

ofloat mx() +

+ + +

ofloat my() +

+ + +

ounsigned int mbutton() +

+ + +

ovoid setStartTick(osg::Timer_t tick) +

+ + +

odouble getTime() +

+ + +

oProducer::KeyboardMouse* getKeyboardMouse() +

+ + +

oconst Producer::KeyboardMouse* getKeyboardMouse() const +

+ + +

oEventAdapter* createEventAdapter() +

+ + +

oProducer::KeyboardMouse* _keyboardMouse +

+ + +

ofloat _mx +

+ + +

ofloat _my +

+ + +

ounsigned int _mbutton +

+ + +

obool& _done +

+ + +

obool _escapeKeySetsDone +

+ + +

oosg::Timer_t _startTick +

+ + +

oosg::Timer _timer +

+ + +

oProducer::Mutex _eventQueueMutex +

+ + +

oEventQueue _eventQueue +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/NavigatorButton.class b/doc/doc++/osgProducer/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..fad9c3f2df2c760c687fdc6eda2469ed021768b5 GIT binary patch literal 1816 zcma)7S#ujj5dPMZHPU*^hiv&sNH8Q3_S%lZeK-lkik*mv*oBFMU0kE}N?xv1xibqn#kD}+gU5_!BX#;D;n`B(a^uM+`-V z`wW{5pD=vM;4)MhJO-bk#_$zGz))upI#O8BF)oRLMJbt*ETy1hIR%ClNv`S`K~757 zBzakqS0s5gg$cZ-lk)3Q0_&1&7~ptl zz{1A{_OWBY#!Uldd}g462L>D|9m?A#b`2a!1INf4IKeFgU*mlP-$=c0@vedIuxH?V z+}5DaJN5a3C+wiiEnCCH!ea4|H+ha9iQI6RyBUt`liffH>*$yb+ z0rkj8lx<&TUG+@A^^Q7)H**GFD9FIq&bSHV_H2=R@L@5k0#PCEt(-gHMMz_8Z#Q=os1>mTio5@fx}C#O+k&_=S`==g&(Xngz!CzdE0LU zmc8M)lz>K~l;D=kKnk^*?d?;xC6!&gdDXjM=wniy z2a87EokG>zcDqMy=%L}nYMA~n6b|^H?nzzPRVu3I2UYHdeq(B6SWULdrMj|ur&hX> z0-H+KkcBqt2maA*-)dA<0>ky1+9gThcY=sD0vblvl=HS(258l#i0bsCWkwWoCn-)_ zN^#n1iqncyycBU-bm~l-P;uIMiZ>LGk$evYXxJj@XC!FH0*}n4Q>4wza0?gAl@{jA zq%Gm~iHvYBBmJZJuj*=LwEpTgKp$KvD0DW+POCHP_w9**FP1Yh_Om&_-a zY2(Ewc>XEIcb9&{OQ)DjYi&%oaixuUQp-NWh$*eK@dB~SKZVCxI{u=9*KmOMqM);g zlLVZLET)IZp4rB^HZq~b&YRD%7QMNKA^LBF${_m}rpd{i^!qz54N(>1595zxk4cwd Q3NsibO%0zC9l{6y0?tduvj6}9 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/OsgCameraGroup.html b/doc/doc++/osgProducer/OsgCameraGroup.html new file mode 100644 index 000000000..8c55eb357 --- /dev/null +++ b/doc/doc++/osgProducer/OsgCameraGroup.html @@ -0,0 +1,438 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::OsgCameraGroup + + + + +

class OSGPRODUCER_EXPORT osgProducer::OsgCameraGroup

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] OsgCameraGroup() +
+[more] OsgCameraGroup(Producer::CameraConfig* cfg) +
+[more] OsgCameraGroup(const std::string& configFile) +
+[more] OsgCameraGroup(osg::ArgumentParser& arguments) +
+[more]virtual ~OsgCameraGroup() +
+[more]void setApplicationUsage(osg::ApplicationUsage* au) +
+[more]osg::ApplicationUsage* getApplicationUsage() +
+[more]const osg::ApplicationUsage* getApplicationUsage() const +
+[more]SceneHandlerList& getSceneHandlerList() +
+[more]const SceneHandlerList& getSceneHandlerList() const +
+[more]void setSceneData( osg::Node* scene ) +
+[more]osg::Node* getSceneData() +
+[more]const osg::Node* getSceneData() const +
+[more]void setSceneDecorator( osg::Group* decorator) +
+[more]osg::Group* getSceneDecorator() +
+[more]const osg::Group* getSceneDecorator() const +
+[more]osg::Node* getTopMostSceneData() +
+[more]const osg::Node* getTopMostSceneData() const +
+[more]void setDisplaySettings( osg::DisplaySettings* ds ) +
+[more]osg::DisplaySettings* getDisplaySettings() +
+[more]const osg::DisplaySettings* getDisplaySettings() const +
+[more]void setFrameStamp( osg::FrameStamp* fs ) +
+[more]osg::FrameStamp* getFrameStamp() +
+[more]const osg::FrameStamp* getFrameStamp() const +
+[more]void setGlobalStateSet( osg::StateSet* sset ) +
+[more]osg::StateSet* getGlobalStateSet() +
+[more]const osg::StateSet* getGlobalStateSet() const +
+[more]void setBackgroundColor( const osg::Vec4& backgroundColor ) +
+[more]osg::Vec4& getBackgroundColor() +
+[more]const osg::Vec4& getBackgroundColor() const +
+[more]void setLODScale( float scale ) +
+[more]void setFusionDistance( osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f) +
+[more]void setRealizeCallback( RealizeCallback* cb) +
Set the realize callback to use when once the render surfaces are realized +
+[more]RealizeCallback* getRealizeCallback() +
Get the realize callback +
+[more]const RealizeCallback* getRealizeCallback() const +
Get the const realize callback +
+[more]void advance() +
+[more]virtual bool realize(ThreadingModel thread_model ) +
Set the threading model and then call realize() +
+[more]virtual bool realize() +
Realize the render surfaces (OpenGL graphics) and various threads, and call any realize callbacks +
+[more]virtual void setView(const osg::Matrix& matrix) +
Set the model view matrix of the camera group, by individually set all the camera groups's camera +
+[more]const osg::Matrix getViewMatrix() const +
Get the model view martrix of the camera group, taking its value for camera 0 +
+[more]virtual void sync() +
+[more]virtual void frame() +
Dispatch the cull and draw for each of the Camera's for this frame +

+ +

+

Public Members

+[more]typedef std::vector< osg::ref_ptr<osgProducer::OsgSceneHandler> > SceneHandlerList +
+class OSGPRODUCER_EXPORT RealizeCallback: public osg::Referenced +
RealizeCallback class one should override to provide an the implemention of realize callbacks. +

+ +

+

Protected Fields

+[more]osg::ApplicationUsage* _applicationUsage +
+[more]osg::ref_ptr<osg::Node> _scene_data +
+[more]osg::ref_ptr<osg::Group> _scene_decorator +
+[more]osg::ref_ptr<osg::StateSet> _global_stateset +
+[more]osg::Vec4 _background_color +
+[more]float _LODScale +
+[more]osgUtil::SceneView::FusionDistanceMode _fusionDistanceMode +
+[more]float _fusionDistanceValue +
+[more]SceneHandlerList _shvec +
+[more]osg::ref_ptr<RealizeCallback> _realizeCallback +
+[more]osg::ref_ptr<osg::DisplaySettings> _ds +
+[more]bool _initialized +
+[more]unsigned int _frameNumber +
+[more]osg::Timer _timer +
+[more]osg::Timer_t _start_tick +
+[more]osg::ref_ptr<osg::FrameStamp> _frameStamp +

+ +

+

Protected Methods

+[more]void setUpSceneViewsWithData() +
+[more]void _init() +

+ +
+ + +
+

Documentation

+
+ + + +
o OsgCameraGroup() +

+ + +

o OsgCameraGroup(Producer::CameraConfig* cfg) +

+ + +

o OsgCameraGroup(const std::string& configFile) +

+ + +

o OsgCameraGroup(osg::ArgumentParser& arguments) +

+ + +

ovirtual ~OsgCameraGroup() +

+ + +

ovoid setApplicationUsage(osg::ApplicationUsage* au) +

+ + +

oosg::ApplicationUsage* getApplicationUsage() +

+ + +

oconst osg::ApplicationUsage* getApplicationUsage() const +

+ + +

otypedef std::vector< osg::ref_ptr<osgProducer::OsgSceneHandler> > SceneHandlerList +

+ + +

oSceneHandlerList& getSceneHandlerList() +

+ + +

oconst SceneHandlerList& getSceneHandlerList() const +

+ + +

ovoid setSceneData( osg::Node* scene ) +

+ + +

oosg::Node* getSceneData() +

+ + +

oconst osg::Node* getSceneData() const +

+ + +

ovoid setSceneDecorator( osg::Group* decorator) +

+ + +

oosg::Group* getSceneDecorator() +

+ + +

oconst osg::Group* getSceneDecorator() const +

+ + +

oosg::Node* getTopMostSceneData() +

+ + +

oconst osg::Node* getTopMostSceneData() const +

+ + +

ovoid setDisplaySettings( osg::DisplaySettings* ds ) +

+ + +

oosg::DisplaySettings* getDisplaySettings() +

+ + +

oconst osg::DisplaySettings* getDisplaySettings() const +

+ + +

ovoid setFrameStamp( osg::FrameStamp* fs ) +

+ + +

oosg::FrameStamp* getFrameStamp() +

+ + +

oconst osg::FrameStamp* getFrameStamp() const +

+ + +

ovoid setGlobalStateSet( osg::StateSet* sset ) +

+ + +

oosg::StateSet* getGlobalStateSet() +

+ + +

oconst osg::StateSet* getGlobalStateSet() const +

+ + +

ovoid setBackgroundColor( const osg::Vec4& backgroundColor ) +

+ + +

oosg::Vec4& getBackgroundColor() +

+ + +

oconst osg::Vec4& getBackgroundColor() const +

+ + +

ovoid setLODScale( float scale ) +

+ + +

ovoid setFusionDistance( osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f) +

+ + +

ovoid setRealizeCallback( RealizeCallback* cb) +
Set the realize callback to use when once the render surfaces are realized +

+ + +

oRealizeCallback* getRealizeCallback() +
Get the realize callback +

+ + +

oconst RealizeCallback* getRealizeCallback() const +
Get the const realize callback +

+ + +

ovoid advance() +

+ + +

ovirtual bool realize(ThreadingModel thread_model ) +
Set the threading model and then call realize() +

+ + +

ovirtual bool realize() +
Realize the render surfaces (OpenGL graphics) and various threads, and call any realize callbacks +

+ + +

ovirtual void setView(const osg::Matrix& matrix) +
Set the model view matrix of the camera group, +by individually set all the camera groups's camera +

+ + +

oconst osg::Matrix getViewMatrix() const +
Get the model view martrix of the camera group, +taking its value for camera 0 +

+ + +

ovirtual void sync() +

+ + +

ovirtual void frame() +
Dispatch the cull and draw for each of the Camera's for this frame +

+ + +

ovoid setUpSceneViewsWithData() +

+ + +

oosg::ApplicationUsage* _applicationUsage +

+ + +

oosg::ref_ptr<osg::Node> _scene_data +

+ + +

oosg::ref_ptr<osg::Group> _scene_decorator +

+ + +

oosg::ref_ptr<osg::StateSet> _global_stateset +

+ + +

oosg::Vec4 _background_color +

+ + +

ofloat _LODScale +

+ + +

oosgUtil::SceneView::FusionDistanceMode _fusionDistanceMode +

+ + +

ofloat _fusionDistanceValue +

+ + +

oSceneHandlerList _shvec +

+ + +

oosg::ref_ptr<RealizeCallback> _realizeCallback +

+ + +

oosg::ref_ptr<osg::DisplaySettings> _ds +

+ + +

obool _initialized +

+ + +

ounsigned int _frameNumber +

+ + +

oosg::Timer _timer +

+ + +

oosg::Timer_t _start_tick +

+ + +

oosg::ref_ptr<osg::FrameStamp> _frameStamp +

+ + +

ovoid _init() +

+
+
Direct child classes: +
Viewer
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/OsgSceneHandler.html b/doc/doc++/osgProducer/OsgSceneHandler.html new file mode 100644 index 000000000..59b223524 --- /dev/null +++ b/doc/doc++/osgProducer/OsgSceneHandler.html @@ -0,0 +1,185 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::OsgSceneHandler + + + + +

class OSGPRODUCER_EXPORT osgProducer::OsgSceneHandler

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] OsgSceneHandler(osg::DisplaySettings* ds = NULL) +
+[more]virtual void init() +
override the init method to force it be run one at a time +
+[more]virtual void clear(Producer::Camera& camera) +
+[more]virtual void clearImplementation(Producer::Camera& camera) +
+[more]void setClearCallback(Callback* callback) +
+[more]Callback* getClearCallback() +
+[more]const Callback* getClearCallback() const +
+[more]virtual void cull(Producer::Camera& camera) +
+[more]virtual void cullImplementation(Producer::Camera& camera) +
+[more]void setCullCallback(Callback* callback) +
+[more]Callback* getCullCallback() +
+[more]const Callback* getCullCallback() const +
+[more]virtual void draw(Producer::Camera& camera) +
+[more]virtual void drawImplementation(Producer::Camera& camera) +
+[more]void setDrawCallback(Callback* callback) +
+[more]Callback* getDrawCallback() +
+[more]const Callback* getDrawCallback() const +
+[more]void setContextID( int id ) +

+ +

+

Public Members

+class Callback: public osg::Referenced +

+ +

+

Protected Fields

+[more]osg::ref_ptr<Callback> _clearCallback +
+[more]osg::ref_ptr<Callback> _cullCallback +
+[more]osg::ref_ptr<Callback> _drawCallback +

+ +

+

Protected Methods

+[more]virtual ~OsgSceneHandler() +

+ +
+ + +
+

Documentation

+
+ + + +
o OsgSceneHandler(osg::DisplaySettings* ds = NULL) +

+ + +

ovirtual void init() +
override the init method to force it be run one at a time +

+ + +

ovirtual void clear(Producer::Camera& camera) +

+ + +

ovirtual void clearImplementation(Producer::Camera& camera) +

+ + +

ovoid setClearCallback(Callback* callback) +

+ + +

oCallback* getClearCallback() +

+ + +

oconst Callback* getClearCallback() const +

+ + +

ovirtual void cull(Producer::Camera& camera) +

+ + +

ovirtual void cullImplementation(Producer::Camera& camera) +

+ + +

ovoid setCullCallback(Callback* callback) +

+ + +

oCallback* getCullCallback() +

+ + +

oconst Callback* getCullCallback() const +

+ + +

ovirtual void draw(Producer::Camera& camera) +

+ + +

ovirtual void drawImplementation(Producer::Camera& camera) +

+ + +

ovoid setDrawCallback(Callback* callback) +

+ + +

oCallback* getDrawCallback() +

+ + +

oconst Callback* getDrawCallback() const +

+ + +

ovoid setContextID( int id ) +

+ + +

ovirtual ~OsgSceneHandler() +

+ + +

oosg::ref_ptr<Callback> _clearCallback +

+ + +

oosg::ref_ptr<Callback> _cullCallback +

+ + +

oosg::ref_ptr<Callback> _drawCallback +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/RealizeCallback.html b/doc/doc++/osgProducer/RealizeCallback.html new file mode 100644 index 000000000..0fa179397 --- /dev/null +++ b/doc/doc++/osgProducer/RealizeCallback.html @@ -0,0 +1,60 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::OsgCameraGroup::RealizeCallback + + + + +

class OSGPRODUCER_EXPORT RealizeCallback

RealizeCallback class one should override to provide an the implemention of realize callbacks.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual void operator()( OsgCameraGroup& cg, OsgSceneHandler& sh, const Producer::RenderSurface & rs) = 0 +

+ +

+

Protected Methods

+[more]virtual ~RealizeCallback() +

+ +
+ + +
+

Documentation

+
RealizeCallback class one should override to provide an the implemention of realize callbacks. +Note, this callback overrides the normal call to OsgSceneHandler::init() so it become the your +responisibility to call this within your callback if required, it is a safe assumption to +always call OsgSceneHandler::init() within your callback..
+
+ + + +
ovirtual void operator()( OsgCameraGroup& cg, OsgSceneHandler& sh, const Producer::RenderSurface & rs) = 0 +

+ + +

ovirtual ~RealizeCallback() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/Viewer.html b/doc/doc++/osgProducer/Viewer.html new file mode 100644 index 000000000..08743a4e8 --- /dev/null +++ b/doc/doc++/osgProducer/Viewer.html @@ -0,0 +1,504 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::Viewer + + + + +

class OSGPRODUCER_EXPORT osgProducer::Viewer

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Viewer() +
+[more] Viewer(Producer::CameraConfig* cfg) +
+[more] Viewer(const std::string& configFile) +
+[more] Viewer(osg::ArgumentParser& arguments) +
+[more]virtual ~Viewer() +
+[more]void setUpViewer(unsigned int options=STANDARD_SETTINGS) +
+[more]virtual bool done() const +
return true if the application is done and should exit +
+[more]virtual void setViewByMatrix( const Producer::Matrix & pm) +
Override the Producer::CameraGroup::setViewByMatrix to catch all changes to view +
+[more]virtual bool realize(ThreadingModel thread_model) +
Set the threading model and then call realize() +
+[more]virtual bool realize() +
+[more]virtual void update() +
+[more]virtual void frame() +
Dispatch the cull and draw for each of the Camera's for this frame +
+[more]virtual void requestRedraw() +
+[more]virtual void requestContinuousUpdate(bool) +
+[more]virtual void requestWarpPointer(float x, float y) +
+[more]bool computePixelCoords(float x, float y, unsigned int cameraNum, float& pixel_x, float& pixel_y) +
compute, from normalized mouse coords, for sepecified Camera, the pixel coords relative to that Camera's RenderSurface +
+[more]bool computeNearFarPoints(float x, float y, unsigned int cameraNum, osg::Vec3& near, osg::Vec3& far) +
compute, from normalized mouse coords, for sepecified Camera, the near and far points in worlds coords +
+[more]bool computeIntersections(float x, float y, unsigned int cameraNum, osgUtil::IntersectVisitor::HitList& hits) +
compute, from normalized mouse coords, for sepecified Camera, intersections with the scene +
+[more]bool computeIntersections(float x, float y, osgUtil::IntersectVisitor::HitList& hits) +
compute, from normalized mouse coords, for all Cameras, intersections with the scene +
+[more]Producer::KeyboardMouse* getKeyboardMouse() +
+[more]const Producer::KeyboardMouse* getKeyboardMouse() const +
+[more]KeyboardMouseCallback* getKeyboardMouseCallback() +
+[more]const KeyboardMouseCallback* getKeyboardMouseCallback() const +
+[more]EventHandlerList& getEventHandlerList() +
+[more]const EventHandlerList& getEventHandlerList() const +
+[more]osgGA::KeySwitchCameraManipulator* getKeySwitchCameraManipulator() +
+[more]const osgGA::KeySwitchCameraManipulator* getKeySwitchCameraManipulator() const +
+[more]unsigned int addCameraManipulator(osgGA::CameraManipulator* cm) +
+[more]void selectCameraManipulator(unsigned int no) +
+[more]void setRecordingAnimationPath(bool on) +
+[more]bool getRecordingAnimationPath() const +
+[more]void setAnimationPath(osg::AnimationPath* path) +
+[more]osg::AnimationPath* getAnimationPath() +
+[more]const osg::AnimationPath* getAnimationPath() const +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this viewer +

+ +

+

Public Members

+[more]enum ViewerOptions +
+[more]typedef std::list< osg::ref_ptr<osgGA::GUIEventHandler> > EventHandlerList +

+ +

+

Protected Fields

+[more]bool _done +
+[more]osgProducer::KeyboardMouseCallback* _kbmcb +
+[more]EventHandlerList _eventHandlerList +
+[more]osg::ref_ptr<osgGA::KeySwitchCameraManipulator> _keyswitchManipulator +
+[more]osg::ref_ptr<osg::Camera> _old_style_osg_camera +
+[more]osg::ref_ptr<osg::NodeVisitor> _updateVisitor +
+[more]bool _recordingAnimationPath +
+[more]osg::ref_ptr<osg::AnimationPath> _animationPath +

+ +
+

Inherited from OsgCameraGroup:

+
+

+

Public Methods

+ovoid setApplicationUsage(osg::ApplicationUsage* au) +
+oosg::ApplicationUsage* getApplicationUsage() +
+oconst osg::ApplicationUsage* getApplicationUsage() const +
+oSceneHandlerList& getSceneHandlerList() +
+oconst SceneHandlerList& getSceneHandlerList() const +
+ovoid setSceneData( osg::Node* scene ) +
+oosg::Node* getSceneData() +
+oconst osg::Node* getSceneData() const +
+ovoid setSceneDecorator( osg::Group* decorator) +
+oosg::Group* getSceneDecorator() +
+oconst osg::Group* getSceneDecorator() const +
+oosg::Node* getTopMostSceneData() +
+oconst osg::Node* getTopMostSceneData() const +
+ovoid setDisplaySettings( osg::DisplaySettings* ds ) +
+oosg::DisplaySettings* getDisplaySettings() +
+oconst osg::DisplaySettings* getDisplaySettings() const +
+ovoid setFrameStamp( osg::FrameStamp* fs ) +
+oosg::FrameStamp* getFrameStamp() +
+oconst osg::FrameStamp* getFrameStamp() const +
+ovoid setGlobalStateSet( osg::StateSet* sset ) +
+oosg::StateSet* getGlobalStateSet() +
+oconst osg::StateSet* getGlobalStateSet() const +
+ovoid setBackgroundColor( const osg::Vec4& backgroundColor ) +
+oosg::Vec4& getBackgroundColor() +
+oconst osg::Vec4& getBackgroundColor() const +
+ovoid setLODScale( float scale ) +
+ovoid setFusionDistance( osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f) +
+ovoid setRealizeCallback( RealizeCallback* cb) +
+oRealizeCallback* getRealizeCallback() +
+oconst RealizeCallback* getRealizeCallback() const +
+ovoid advance() +
+ovirtual void setView(const osg::Matrix& matrix) +
+oconst osg::Matrix getViewMatrix() const +
+ovirtual void sync() +

+ +

+

Public Members

+otypedef std::vector< osg::ref_ptr<osgProducer::OsgSceneHandler> > SceneHandlerList +
+class OSGPRODUCER_EXPORT RealizeCallback: public osg::Referenced +
RealizeCallback class one should override to provide an the implemention of realize callbacks. +

+ +

+

Protected Fields

+oosg::ApplicationUsage* _applicationUsage +
+oosg::ref_ptr<osg::Node> _scene_data +
+oosg::ref_ptr<osg::Group> _scene_decorator +
+oosg::ref_ptr<osg::StateSet> _global_stateset +
+oosg::Vec4 _background_color +
+ofloat _LODScale +
+oosgUtil::SceneView::FusionDistanceMode _fusionDistanceMode +
+ofloat _fusionDistanceValue +
+oSceneHandlerList _shvec +
+oosg::ref_ptr<RealizeCallback> _realizeCallback +
+oosg::ref_ptr<osg::DisplaySettings> _ds +
+obool _initialized +
+ounsigned int _frameNumber +
+oosg::Timer _timer +
+oosg::Timer_t _start_tick +
+oosg::ref_ptr<osg::FrameStamp> _frameStamp +

+ +

+

Protected Methods

+ovoid setUpSceneViewsWithData() +
+ovoid _init() +

+ +
+ + +
+

Documentation

+
+ + + +
o Viewer() +

+ + +

o Viewer(Producer::CameraConfig* cfg) +

+ + +

o Viewer(const std::string& configFile) +

+ + +

o Viewer(osg::ArgumentParser& arguments) +

+ + +

ovirtual ~Viewer() +

+ + +

oenum ViewerOptions +

+ + + +
o NO_EVENT_HANDLERS +

+ + +

o TRACKBALL_MANIPULATOR +

+ + +

o DRIVE_MANIPULATOR +

+ + +

o FLIGHT_MANIPULATOR +

+ + +

o STATE_MANIPULATOR +

+ + +

o HEAD_LIGHT_SOURCE +

+ + +

o SKY_LIGHT_SOURCE +

+ + +

o STATS_MANIPULATOR +

+ + +

o VIEWER_MANIPULATOR +

+ + +

o ESCAPE_SETS_DONE +

+ + +

o STANDARD_SETTINGS +

+ + + +
ovoid setUpViewer(unsigned int options=STANDARD_SETTINGS) +

+ + +

ovirtual bool done() const +
return true if the application is done and should exit +

+ + +

ovirtual void setViewByMatrix( const Producer::Matrix & pm) +
Override the Producer::CameraGroup::setViewByMatrix to catch all changes to view +

+ + +

ovirtual bool realize(ThreadingModel thread_model) +
Set the threading model and then call realize() +

+ + +

ovirtual bool realize() +

+ + +

ovirtual void update() +

+ + +

ovirtual void frame() +
Dispatch the cull and draw for each of the Camera's for this frame +

+ + +

ovirtual void requestRedraw() +

+ + +

ovirtual void requestContinuousUpdate(bool) +

+ + +

ovirtual void requestWarpPointer(float x, float y) +

+ + +

obool computePixelCoords(float x, float y, unsigned int cameraNum, float& pixel_x, float& pixel_y) +
compute, from normalized mouse coords, for sepecified Camera, the pixel coords relative to that Camera's RenderSurface +

+ + +

obool computeNearFarPoints(float x, float y, unsigned int cameraNum, osg::Vec3& near, osg::Vec3& far) +
compute, from normalized mouse coords, for sepecified Camera, the near and far points in worlds coords +

+ + +

obool computeIntersections(float x, float y, unsigned int cameraNum, osgUtil::IntersectVisitor::HitList& hits) +
compute, from normalized mouse coords, for sepecified Camera, intersections with the scene +

+ + +

obool computeIntersections(float x, float y, osgUtil::IntersectVisitor::HitList& hits) +
compute, from normalized mouse coords, for all Cameras, intersections with the scene +

+ + +

oProducer::KeyboardMouse* getKeyboardMouse() +

+ + +

oconst Producer::KeyboardMouse* getKeyboardMouse() const +

+ + +

oKeyboardMouseCallback* getKeyboardMouseCallback() +

+ + +

oconst KeyboardMouseCallback* getKeyboardMouseCallback() const +

+ + +

otypedef std::list< osg::ref_ptr<osgGA::GUIEventHandler> > EventHandlerList +

+ + +

oEventHandlerList& getEventHandlerList() +

+ + +

oconst EventHandlerList& getEventHandlerList() const +

+ + +

oosgGA::KeySwitchCameraManipulator* getKeySwitchCameraManipulator() +

+ + +

oconst osgGA::KeySwitchCameraManipulator* getKeySwitchCameraManipulator() const +

+ + +

ounsigned int addCameraManipulator(osgGA::CameraManipulator* cm) +

+ + +

ovoid selectCameraManipulator(unsigned int no) +

+ + +

ovoid setRecordingAnimationPath(bool on) +

+ + +

obool getRecordingAnimationPath() const +

+ + +

ovoid setAnimationPath(osg::AnimationPath* path) +

+ + +

oosg::AnimationPath* getAnimationPath() +

+ + +

oconst osg::AnimationPath* getAnimationPath() const +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this viewer +

+ + +

obool _done +

+ + +

oosgProducer::KeyboardMouseCallback* _kbmcb +

+ + +

oEventHandlerList _eventHandlerList +

+ + +

oosg::ref_ptr<osgGA::KeySwitchCameraManipulator> _keyswitchManipulator +

+ + +

oosg::ref_ptr<osg::Camera> _old_style_osg_camera +

+ + +

oosg::ref_ptr<osg::NodeVisitor> _updateVisitor +

+ + +

obool _recordingAnimationPath +

+ + +

oosg::ref_ptr<osg::AnimationPath> _animationPath +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/ViewerEventHandler.html b/doc/doc++/osgProducer/ViewerEventHandler.html new file mode 100644 index 000000000..5b263414b --- /dev/null +++ b/doc/doc++/osgProducer/ViewerEventHandler.html @@ -0,0 +1,191 @@ + + + + + class OSGPRODUCER_EXPORT osgProducer::ViewerEventHandler + + + + +

class OSGPRODUCER_EXPORT osgProducer::ViewerEventHandler

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ViewerEventHandler(OsgCameraGroup* cg) +
+[more]virtual bool handle(const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& aa) +
+[more]virtual void accept(osgGA::GUIEventHandlerVisitor& gehv) +
+[more]virtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +
+[more]OsgCameraGroup* getOsgCameraGroup() +
+[more]const OsgCameraGroup* getOsgCameraGroup() const +
+[more]void setWriteNodeFileName(const std::string& filename) +
+[more]const std::string& getWriteNodeFileName() const +
+[more]void setDisplayHelp(bool displayHelp) +
+[more]bool getDisplayHelp() const +
+[more]void setFrameStatsMode(FrameStatsMode mode) +
+[more]FrameStatsMode getFrameStatsMode() +

+ +

+

Public Members

+[more]enum FrameStatsMode +

+ +

+

Protected Fields

+[more]osgProducer::OsgCameraGroup* _cg +
+[more]std::string _writeNodeFileName +
+[more]bool _displayHelp +
+[more]FrameStatsMode _frameStatsMode +
+[more]bool _firstTimeTogglingFullScreen +
+[more]StatsAndHelpDrawCallback* _statsAndHelpDrawCallback +
+[more]SnapImageDrawCallbackList _snapImageDrawCallbackList +

+ +

+

Protected Members

+[more]typedef std::vector<SnapImageDrawCallback*> SnapImageDrawCallbackList +

+ +
+ + +
+

Documentation

+
+ + + +
o ViewerEventHandler(OsgCameraGroup* cg) +

+ + +

ovirtual bool handle(const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& aa) +

+ + +

ovirtual void accept(osgGA::GUIEventHandlerVisitor& gehv) +

+ + +

ovirtual void getUsage(osg::ApplicationUsage& usage) const +
Get the keyboard and mouse usage of this manipulator +

+ + +

oOsgCameraGroup* getOsgCameraGroup() +

+ + +

oconst OsgCameraGroup* getOsgCameraGroup() const +

+ + +

ovoid setWriteNodeFileName(const std::string& filename) +

+ + +

oconst std::string& getWriteNodeFileName() const +

+ + +

ovoid setDisplayHelp(bool displayHelp) +

+ + +

obool getDisplayHelp() const +

+ + +

oenum FrameStatsMode +

+ + + +
o NO_STATS +

+ + +

o FRAME_RATE +

+ + +

o CAMERA_STATS +

+ + + +
ovoid setFrameStatsMode(FrameStatsMode mode) +

+ + +

oFrameStatsMode getFrameStatsMode() +

+ + +

oosgProducer::OsgCameraGroup* _cg +

+ + +

ostd::string _writeNodeFileName +

+ + +

obool _displayHelp +

+ + +

oFrameStatsMode _frameStatsMode +

+ + +

obool _firstTimeTogglingFullScreen +

+ + +

oStatsAndHelpDrawCallback* _statsAndHelpDrawCallback +

+ + +

otypedef std::vector<SnapImageDrawCallback*> SnapImageDrawCallbackList +

+ + +

oSnapImageDrawCallbackList _snapImageDrawCallbackList +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/icon1.gif b/doc/doc++/osgProducer/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/icon2.gif b/doc/doc++/osgProducer/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgProducer/index.html b/doc/doc++/osgProducer/index.html new file mode 100644 index 000000000..e867014d0 --- /dev/null +++ b/doc/doc++/osgProducer/index.html @@ -0,0 +1,41 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/osgProducer.html b/doc/doc++/osgProducer/osgProducer.html new file mode 100644 index 000000000..ef60d3f29 --- /dev/null +++ b/doc/doc++/osgProducer/osgProducer.html @@ -0,0 +1,38 @@ + + + + + namespace osgProducer + + + + +

namespace osgProducer

+
+

+
+class OSGPRODUCER_EXPORT EventAdapter: public osgGA::GUIEventAdapter +
Class for adapting Producer events so that they can be used as input to osgGA::CameraManipulators +
+class OSGPRODUCER_EXPORT KeyboardMouseCallback: public Producer::KeyboardMouseCallback +
+class OSGPRODUCER_EXPORT OsgCameraGroup: public Producer::CameraGroup +
+class OSGPRODUCER_EXPORT OsgSceneHandler: public Producer::Camera::SceneHandler, public osgUtil::SceneView +
+class OSGPRODUCER_EXPORT Viewer: public OsgCameraGroup, public osgGA::GUIActionAdapter +
+class OSGPRODUCER_EXPORT ViewerEventHandler: public osgGA::GUIEventHandler +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/osgProducerGetLibraryName.html b/doc/doc++/osgProducer/osgProducerGetLibraryName.html new file mode 100644 index 000000000..dc2b6a8e1 --- /dev/null +++ b/doc/doc++/osgProducer/osgProducerGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGPRODUCER_EXPORT const char* osgProducerGetLibraryName + + + + +

extern OSGPRODUCER_EXPORT const char* osgProducerGetLibraryName

()

getLibraryName_osgProducer() returns the library name in human friendly form
+ + +
+

Documentation

+
+getLibraryName_osgProducer() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgProducer/osgProducerGetVersion.html b/doc/doc++/osgProducer/osgProducerGetVersion.html new file mode 100644 index 000000000..d05c4b76f --- /dev/null +++ b/doc/doc++/osgProducer/osgProducerGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGPRODUCER_EXPORT const char* osgProducerGetVersion + + + + +

extern OSGPRODUCER_EXPORT const char* osgProducerGetVersion

()

osgProducerGetVersion() returns the library version number.
+ + +
+

Documentation

+
+osgProducerGetVersion() returns the library version number. +Numbering convention : osg_src-0.8.31 will return 0.8.31. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) GLUT library +# +AC_CHECK_LIB(osg, osgProducerGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph GLUT library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/AzimElevationSector.html b/doc/doc++/osgSim/AzimElevationSector.html new file mode 100644 index 000000000..f4c1f8c66 --- /dev/null +++ b/doc/doc++/osgSim/AzimElevationSector.html @@ -0,0 +1,116 @@ + + + + + class OSGSIM_EXPORT osgSim::AzimElevationSector + + + + +

class OSGSIM_EXPORT osgSim::AzimElevationSector

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AzimElevationSector() +
+[more] AzimElevationSector(float minAzimuth, float maxAzimuth, float minElevation, float maxElevation, float fadeAngle=0.0f) +
+[more]virtual float operator() (const osg::Vec3& eyeLocal) const +

+ +

+

Protected Methods

+[more]virtual ~AzimElevationSector() +

+ +
+

Inherited from Sector:

+
+
+

Inherited from AzimRange:

+
+

+

Public Methods

+ovoid setAzimuthRange(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +
+oinline float azimSector(const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+ofloat _cosAzim +
+ofloat _sinAzim +
+ofloat _cosAngle +
+ofloat _cosFadeAngle +

+ +
+

Inherited from ElevationRange:

+
+

+

Public Methods

+ovoid setElevationRange(float minElevation, float maxElevation, float fadeAngle=0.0f) +
+ofloat getMinElevation() const +
+ofloat getMaxElevation() const +
+oinline float elevationSector(const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+ofloat _cosMinElevation +
+ofloat _cosMinFadeElevation +
+ofloat _cosMaxElevation +
+ofloat _cosMaxFadeElevation +

+ +
+ + +
+

Documentation

+
+ + + +
o AzimElevationSector() +

+ + +

o AzimElevationSector(float minAzimuth, float maxAzimuth, float minElevation, float maxElevation, float fadeAngle=0.0f) +

+ + +

ovirtual float operator() (const osg::Vec3& eyeLocal) const +

+ + +

ovirtual ~AzimElevationSector() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/AzimRange.html b/doc/doc++/osgSim/AzimRange.html new file mode 100644 index 000000000..0c3f0fe8c --- /dev/null +++ b/doc/doc++/osgSim/AzimRange.html @@ -0,0 +1,88 @@ + + + + + class OSGSIM_EXPORT osgSim::AzimRange + + + + +

class OSGSIM_EXPORT osgSim::AzimRange

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AzimRange() +
+[more]void setAzimuthRange(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +
+[more]inline float azimSector(const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+[more]float _cosAzim +
+[more]float _sinAzim +
+[more]float _cosAngle +
+[more]float _cosFadeAngle +

+ +
+ + +
+

Documentation

+
+ + + +
o AzimRange() +

+ + +

ovoid setAzimuthRange(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +

+ + +

oinline float azimSector(const osg::Vec3& eyeLocal) const +

+ + +

ofloat _cosAzim +

+ + +

ofloat _sinAzim +

+ + +

ofloat _cosAngle +

+ + +

ofloat _cosFadeAngle +

+
+
Direct child classes: +
AzimSector
+AzimElevationSector
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/AzimSector.html b/doc/doc++/osgSim/AzimSector.html new file mode 100644 index 000000000..604c51038 --- /dev/null +++ b/doc/doc++/osgSim/AzimSector.html @@ -0,0 +1,91 @@ + + + + + class OSGSIM_EXPORT osgSim::AzimSector + + + + +

class OSGSIM_EXPORT osgSim::AzimSector

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] AzimSector() +
+[more] AzimSector(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +
+[more]virtual float operator() (const osg::Vec3& eyeLocal) const +

+ +

+

Protected Methods

+[more]virtual ~AzimSector() +

+ +
+

Inherited from Sector:

+
+
+

Inherited from AzimRange:

+
+

+

Public Methods

+ovoid setAzimuthRange(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +
+oinline float azimSector(const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+ofloat _cosAzim +
+ofloat _sinAzim +
+ofloat _cosAngle +
+ofloat _cosFadeAngle +

+ +
+ + +
+

Documentation

+
+ + + +
o AzimSector() +

+ + +

o AzimSector(float minAzimuth, float maxAzimuth, float fadeAngle=0.0f) +

+ + +

ovirtual float operator() (const osg::Vec3& eyeLocal) const +

+ + +

ovirtual ~AzimSector() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/BlinkSequence.html b/doc/doc++/osgSim/BlinkSequence.html new file mode 100644 index 000000000..fd97d135f --- /dev/null +++ b/doc/doc++/osgSim/BlinkSequence.html @@ -0,0 +1,172 @@ + + + + + class OSGSIM_EXPORT osgSim::BlinkSequence + + + + +

class OSGSIM_EXPORT osgSim::BlinkSequence

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] BlinkSequence() +
+[more] BlinkSequence(const BlinkSequence& bs) +
+[more]inline double getPulsePeriod() const +
get the total pulse period of the blink sequence, which is equal to the sum of all the pulse periods +
+[more]inline void setSequenceGroup(SequenceGroup* sg) +
set the sequence group which can be used to synchronize related blink sequences +
+[more]inline SequenceGroup* getSequenceGroup() +
get the non const sequence group +
+[more]inline const SequenceGroup* getSequenceGroup() const +
get the const sequence group +
+[more]inline void setPhaseShift(double ps) +
set the phase shift of the blink sequence, this would be used to shift a sequence within a sequence group +
+[more]inline double getPhaseShift() const +
get the pahse shift +
+[more]inline double localTime(double time) const +
compute the local time clamped to this BlinkSequences period, and accounting for the phase shift and sequence group +
+[more]inline void addPulse(double length, const osg::Vec4& color) +
add a pulse of specified color and duration to the BlinkSequence +
+[more]inline osg::Vec4 color(double time, double length) const +
compute the color for the time interval sepecifed. +

+ +

+

Public Members

+class OSGSIM_EXPORT SequenceGroup: public osg::Referenced +
sequence group which can be used to synchronize related blink sequences +

+ +

+

Protected Fields

+[more]double _pulsePeriod +
+[more]double _phaseShift +
+[more]PulseData _pulseData +
+[more]osg::ref_ptr<SequenceGroup> _sequenceGroup +

+ +

+

Protected Members

+[more]typedef std::pair<double,osg::Vec4> IntervalColor +
+[more]typedef std::vector<IntervalColor> PulseData +

+ +
+ + +
+

Documentation

+
+ + + +
o BlinkSequence() +

+ + +

o BlinkSequence(const BlinkSequence& bs) +

+ + +

oinline double getPulsePeriod() const +
get the total pulse period of the blink sequence, which is equal to the sum of all the pulse periods +

+ + +

oinline void setSequenceGroup(SequenceGroup* sg) +
set the sequence group which can be used to synchronize related blink sequences +

+ + +

oinline SequenceGroup* getSequenceGroup() +
get the non const sequence group +

+ + +

oinline const SequenceGroup* getSequenceGroup() const +
get the const sequence group +

+ + +

oinline void setPhaseShift(double ps) +
set the phase shift of the blink sequence, this would be used to shift a sequence within a sequence group +

+ + +

oinline double getPhaseShift() const +
get the pahse shift +

+ + +

otypedef std::pair<double,osg::Vec4> IntervalColor +

+ + +

otypedef std::vector<IntervalColor> PulseData +

+ + +

odouble _pulsePeriod +

+ + +

odouble _phaseShift +

+ + +

oPulseData _pulseData +

+ + +

oosg::ref_ptr<SequenceGroup> _sequenceGroup +

+ + +

oinline double localTime(double time) const +
compute the local time clamped to this BlinkSequences period, and accounting for the phase shift and sequence group +

+ + +

oinline void addPulse(double length, const osg::Vec4& color) +
add a pulse of specified color and duration to the BlinkSequence +

+ + +

oinline osg::Vec4 color(double time, double length) const +
compute the color for the time interval sepecifed. Averages the colors if the length is greater than the current pulse. +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/ClassGraph.class b/doc/doc++/osgSim/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..4f41a1fb2fdf65525a700ad591fe8a696f29497f GIT binary patch literal 1237 zcma)6*-{fh6g@+hNrou`K|w^^#V{;!Uxf)I{zh+h=K3 zsd!waUo=!!3dIjq#=y{V{6M7_+&wM=R|*RBw*!KzHaBtvg;Em*1L4$)R)eWlU#iPW zPx={+I$h{qMG7udrcI%d+6D~_cO;*T)@?>RB02V1R@EvKtjwE3##>R3iE=uxd{>m) zBRU}i>WsuD>(0FYN6y?~v%I|}%|80f6|R~yU}ZfP1j|0Fd@ztWac1<5bRp|ZaL+(* zBd2*{+H_Wyxb7lFpqNkv=2f-7cv$2WMb{J<7|5NpZ8V{KN}fKEfxet9GOxgVm+g3* zDidpL-z_sG{rRd=Qc&Z(tolX1yd+@k)$&&}|#YQU4bz2pm?{eSgrM&xv$VGh~Gz=@?#JBjV?8~a4HN?qp z7K6@BA1O#fe|02#$X>+^$qadih$BMUbCQu7F65kKnAED1>>;)0B%`Ee!%i|p`WwzW zzmV7t)sd`WjO^I<MT3FyI-fA42Q3jhEB literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/ClassGraphPanel.class b/doc/doc++/osgSim/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..4f3ea86bb625e4e043d10fafb3b0b05cf2f96537 GIT binary patch literal 4084 zcmbtWX>c4@5&lLyyR*lXB(J?mmPm#W>_{tH!Xb!QvIDl97=dgjR%}Nym>unoq_tNw z%I>VBgm4=IB%DP##03F|V>uGQMp~IT2Uj@Eec$=X4~qX(Q550pH+#lP%0Q{quiy8& zzwYVR@4dbF@5i1*09)})825$ofiON6#sgt|GK|lJ@kkh73FCWV{5*``hVd5zA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR24!kakD@AO?>!awz zSQOpZ7sUqbkDwg~MBExd9JfWW9tUMQF5-6aI3(KPD8-Q|uD~5pbYViUNfAfI&*JSSK8J@*d|pHu51RM_7EF8*XH0wvr%Zeqo{2|s z+Qe7!P7`0lTTPtByG@+Kr%ZfZOqOw%i51Z*__T>t@%TPIZsG^x@k3d-DA3DR-0hY=%^o*qaSt+1JW2YqzSe4J&p86+`L;D7Btm@&ds}y?RdjYUozs> zK>3me#omH7Kby-G70Xp?E%;%Z1Jr#+M=#A;vbnm6XUw|GEqVJa$C|PIToct*^`!@< zjRC}bMqcQ21 zu5LkYwH!OIA*O8nebS(hxLI3RT&Ktu_YPb666e|;VmB{k?0JvJp-6ydMH?eH*5uB; z>8ySkPmkZ88seAMS3~=lo3ZkTtwPS4%G)ID*l#W5W-QMw>@Inp>yZ8+>BrqtA!FZ? z%S#gMlD4A^96#EK;#)KF`YPC5A^IHSA+)kt4MA(#vkR=&ls)YhNEe*STbUCAxFsjc z6pSeqnVO!-I37!r;fi;=dxEzBsYnvY=18Gu-9;uCkzrS%;4W$iXA9QiSk57D$iA~= z<>?Td&J~KJ(PsG}vsQ5*!`8?`vvzJ~mW!dBljUJ0L#|%!j`|H$t3`VqQB`FLntfcPqv2V(ktLL=Fr?7pN#~O4t zT>bN{!BkMS#Wf_=wB+UT)r(Y>D|feihsItF<<)h<(&z1IuUdLT^f_xumThN7A_de` zpK}+u9}$PAR1tAY=2;aMJEBH^zci9Z3$h!vy)4>ZwagK!^`lW_B6Ka5ri$v8XE&DS z**2y5s-s>i$i5p3a%c`rGiP>2a50yaoHQn=-2?C?y^=Ds z$a&mS!7C4FLmkQX3bsFl4HwWokqjl*oH55|*bysd(P2N4Pk#%a(iAuphFA{k9~B!h|0L_D#Mm`bI86)zo6P0&J5uP}Rl z==G0)F|mplPp)9Fg4YBFV`bc!61GH)fnRo{s&;M^rbMit!)CR#J(y3=CSsi% zXDb*!8PgImE~U;q`}A4v?BDPY{1ZvF>-^E$2Jx${@qTJG!;R!&7vH$|u38lAt%Uf5lt`!0Q5 z61~-(zxsUlzys|22oSiBRoce?-T=$HYZawB1z+k8x$R_nfC=t@r(tU}CDC6Txg<7h+oWC&S9_bii!b$r|mIZMwTUqixDJN$c4LcvBUu z@=G#%%56_EJR6)vn{3dw#HPL4!dh z$DJobZHZ8ljj&zMp83})|BBG?Q@o>k#upIcA8@?y9ImV2)qz31jN6#S;4*FuW&`Ij z#QSb%LZ_5tA}zN$q4Ol~q}Hpno}pkexQtN|uTAf)T5a;JPU>1hrz!8rM^XVkaJ3vB JV$?Q#=szD|0>A(O literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/ClassLayout.class b/doc/doc++/osgSim/ClassLayout.class new file mode 100644 index 0000000000000000000000000000000000000000..69a6f494ed99e62d55c975c56b11981104a3dca9 GIT binary patch literal 2443 zcmZuy>2nih82>HVBfIRhrLbUtR6&I{DHK$q7O2{CSZ$$Nt%9Q2CfjstvKu#>mg24T zzHd=Ha5~e`PwKRRkr~I&`WN`mh|lwGlBPmt_IaQCe&77{@9%#ghCR3#hohmO!PPLM z;aLqYX?R(~D;i$a@S27N4XL&KXI-qP^4hIb6K;dTRY++m;t2N+}++^IvyT?S;_ zZ9qf6PS`;PhnPI9L&1PfX7@08FDu{2(m?|%h71@u!q`zA8*q%h9B1-=115$Udw?w- zWQ!4YHOe7RFz=*+c8sy-hjgsR!wkkvOyLxRGYoPjs<0VMnwW)WVh&joXYq)Mc_z=H zV&XZRHt{@TFEH;#Oqh6&vG*B#fX7UHh$l^a%uYXnZ{kxtZQ?ULYT|Q_@g)nsV&(G; zzGm33dyX)(nv%74O84+E zrzTF}VKu{5d-k2`Zk2eU?Rrjduq9k;L0hh`Om2GX5|PHq$r&dXHk`C%HdvjSBJclG zuUA`-c|CQj)q6voqV`;e-&#(iQCz6hFF`%zdTux%!5AvqmCEtJE>BBnUnTbP9M^Eh zY|kl5STA%&?0LT$N|1;Ayu)66uM*l`IAIs7Odma)bIKtNze4e-{Z^EW>-UY(Ktsyh zu}f5b+lZgDixYO>+LJ|xl-p0(vu?o-{a~;fhCZ#9G45A`oO8@Al4I#Kt&N?}NAa5j zq=M{n+41s(O!{P3lAx30+;~WhCa*ca>V-{piWASfoN$hODpPJyp<2v>v#LTGg}|R1 zai&P3PCIU4nh{s*F6Gc%^QP0a%=-ScGMoED`83U=%RpDB$%#rEwLQDw1k|CXK->_z zOM@}OVR(HM<{iBPJGTV>xi>CIn7>q>+lze`I>9e1LGbe_PI?r@Nsld^8tKs+P4F3_c3~Z1z}D0ybf!AGRtQs8u!BK5C9h!H zufkSBh0*h0e%K+{VJLtfkb2bvmOgsFI~7 zFJApQMe%N+P&?>LXQP<%6~s^VF5@QpQsg;H=U)1@kfZD+Z2X0i;qSCXT0)-`S)b-YWhtV4KcX$6 zMd%9lB~&3|&{abZtMBZObCF6uqg(m~sIiRBbjILV)P$}?+!A=N=+LxqkYB<6C0L0# zEA?7>G%8|J0GjcBD~iY&B=br!Tf;5C;npkYIAtl9(RT@(I;9#mb9}3YJvDSMD3Ya6 OO$QpS45)eQF#R7oR!vR- literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/ConeSector.html b/doc/doc++/osgSim/ConeSector.html new file mode 100644 index 000000000..0b8e0e634 --- /dev/null +++ b/doc/doc++/osgSim/ConeSector.html @@ -0,0 +1,121 @@ + + + + + class OSGSIM_EXPORT osgSim::ConeSector + + + + +

class OSGSIM_EXPORT osgSim::ConeSector

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ConeSector() +
+[more] ConeSector(const osg::Vec3& axis, float angle, float fadeangle=0.0f) +
+[more]void setAxis(const osg::Vec3& axis) +
+[more]const osg::Vec3& getAxis() const +
+[more]void setAngle(float angle, float fadeangle=0.0f) +
+[more]float getAngle() const +
+[more]float getFadeAngle() const +
+[more]virtual float operator() (const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+[more]osg::Vec3 _axis +
+[more]float _cosAngle +
+[more]float _cosAngleFade +

+ +

+

Protected Methods

+[more]virtual ~ConeSector() +

+ +
+

Inherited from Sector:

+
+
+ + +
+

Documentation

+
+ + + +
o ConeSector() +

+ + +

o ConeSector(const osg::Vec3& axis, float angle, float fadeangle=0.0f) +

+ + +

ovoid setAxis(const osg::Vec3& axis) +

+ + +

oconst osg::Vec3& getAxis() const +

+ + +

ovoid setAngle(float angle, float fadeangle=0.0f) +

+ + +

ofloat getAngle() const +

+ + +

ofloat getFadeAngle() const +

+ + +

ovirtual float operator() (const osg::Vec3& eyeLocal) const +

+ + +

ovirtual ~ConeSector() +

+ + +

oosg::Vec3 _axis +

+ + +

ofloat _cosAngle +

+ + +

ofloat _cosAngleFade +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/ElevationRange.html b/doc/doc++/osgSim/ElevationRange.html new file mode 100644 index 000000000..9f6ae9d37 --- /dev/null +++ b/doc/doc++/osgSim/ElevationRange.html @@ -0,0 +1,100 @@ + + + + + class OSGSIM_EXPORT osgSim::ElevationRange + + + + +

class OSGSIM_EXPORT osgSim::ElevationRange

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ElevationRange() +
+[more]void setElevationRange(float minElevation, float maxElevation, float fadeAngle=0.0f) +
+[more]float getMinElevation() const +
+[more]float getMaxElevation() const +
+[more]inline float elevationSector(const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+[more]float _cosMinElevation +
+[more]float _cosMinFadeElevation +
+[more]float _cosMaxElevation +
+[more]float _cosMaxFadeElevation +

+ +
+ + +
+

Documentation

+
+ + + +
o ElevationRange() +

+ + +

ovoid setElevationRange(float minElevation, float maxElevation, float fadeAngle=0.0f) +

+ + +

ofloat getMinElevation() const +

+ + +

ofloat getMaxElevation() const +

+ + +

oinline float elevationSector(const osg::Vec3& eyeLocal) const +

+ + +

ofloat _cosMinElevation +

+ + +

ofloat _cosMinFadeElevation +

+ + +

ofloat _cosMaxElevation +

+ + +

ofloat _cosMaxFadeElevation +

+
+
Direct child classes: +
ElevationSector
+AzimElevationSector
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/ElevationSector.html b/doc/doc++/osgSim/ElevationSector.html new file mode 100644 index 000000000..de58ff343 --- /dev/null +++ b/doc/doc++/osgSim/ElevationSector.html @@ -0,0 +1,111 @@ + + + + + class OSGSIM_EXPORT osgSim::ElevationSector + + + + +

class OSGSIM_EXPORT osgSim::ElevationSector

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ElevationSector() +
+[more] ElevationSector(float minElevation, float maxElevation, float fadeAngle=0.0f) +
+[more]virtual float operator() (const osg::Vec3& eyeLocal) const +

+ +

+

Protected Fields

+[more]float _cosMinElevation +
+[more]float _cosMinFadeElevation +
+[more]float _cosMaxElevation +
+[more]float _cosMaxFadeElevation +

+ +

+

Protected Methods

+[more]virtual ~ElevationSector() +

+ +
+

Inherited from Sector:

+
+
+

Inherited from ElevationRange:

+
+

+

Public Methods

+ovoid setElevationRange(float minElevation, float maxElevation, float fadeAngle=0.0f) +
+ofloat getMinElevation() const +
+ofloat getMaxElevation() const +
+oinline float elevationSector(const osg::Vec3& eyeLocal) const +

+ +
+ + +
+

Documentation

+
+ + + +
o ElevationSector() +

+ + +

o ElevationSector(float minElevation, float maxElevation, float fadeAngle=0.0f) +

+ + +

ovirtual float operator() (const osg::Vec3& eyeLocal) const +

+ + +

ovirtual ~ElevationSector() +

+ + +

ofloat _cosMinElevation +

+ + +

ofloat _cosMinFadeElevation +

+ + +

ofloat _cosMaxElevation +

+ + +

ofloat _cosMaxFadeElevation +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/General.html b/doc/doc++/osgSim/General.html new file mode 100644 index 000000000..d97d14ea6 --- /dev/null +++ b/doc/doc++/osgSim/General.html @@ -0,0 +1,49 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGSIM_BLINKSQUENCE
+ +o#define +OSGSIM_EXPORT_
+ +o#define +OSGSIM_EXPORT(dllexport)
+ +o#define +OSGSIM_EXPORT(dllimport)
+ +o#define +OSGSIM_EXPORT
+ +o#define +NULL
+ +o#define +NULL((void *)
+ +o#define +OSGSIM_LIGHTPOINT
+ +o#define +OSGSIM_LIGHTPOINTNODE
+ +o#define +OSGSIM_SECTOR
+ +o#define +OSGSIM_VERSION
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/HIER.html b/doc/doc++/osgSim/HIER.html new file mode 100644 index 000000000..829c7b6de --- /dev/null +++ b/doc/doc++/osgSim/HIER.html @@ -0,0 +1,37 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/HIERjava.html b/doc/doc++/osgSim/HIERjava.html new file mode 100644 index 000000000..9531f7c28 --- /dev/null +++ b/doc/doc++/osgSim/HIERjava.html @@ -0,0 +1,65 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/LightPoint.html b/doc/doc++/osgSim/LightPoint.html new file mode 100644 index 000000000..4e4066c55 --- /dev/null +++ b/doc/doc++/osgSim/LightPoint.html @@ -0,0 +1,130 @@ + + + + + class OSGSIM_EXPORT osgSim::LightPoint + + + + +

class OSGSIM_EXPORT osgSim::LightPoint

+ +
+

+

Public Fields

+[more]bool _on +
+[more]osg::Vec3 _position +
+[more]osg::Vec4 _color +
+[more]float _intensity +
+[more]float _radius +
+[more]osg::ref_ptr<Sector> _sector +
+[more]osg::ref_ptr<BlinkSequence> _blinkSequence +
+[more]BlendingMode _blendingMode +

+ +

+

Public Methods

+[more] LightPoint() +
+[more] LightPoint(const osg::Vec3& position, const osg::Vec4& color) +
+[more] LightPoint(bool on, const osg::Vec3& position, const osg::Vec4& color, float intensity=1.0f, float radius=1.0f, Sector* sector=0, BlinkSequence* blinkSequence=0, BlendingMode blendingMode=BLENDED) +
+[more] LightPoint(const LightPoint& lp) +
+[more]LightPoint& operator = (const LightPoint& lp) +

+ +

+

Public Members

+[more]enum BlendingMode +

+ +
+ + +
+

Documentation

+
+ + + +
oenum BlendingMode +

+ + + +
o ADDITIVE +

+ + +

o BLENDED +

+ + + +
o LightPoint() +

+ + +

o LightPoint(const osg::Vec3& position, const osg::Vec4& color) +

+ + +

o LightPoint(bool on, const osg::Vec3& position, const osg::Vec4& color, float intensity=1.0f, float radius=1.0f, Sector* sector=0, BlinkSequence* blinkSequence=0, BlendingMode blendingMode=BLENDED) +

+ + +

o LightPoint(const LightPoint& lp) +

+ + +

oLightPoint& operator = (const LightPoint& lp) +

+ + +

obool _on +

+ + +

oosg::Vec3 _position +

+ + +

oosg::Vec4 _color +

+ + +

ofloat _intensity +

+ + +

ofloat _radius +

+ + +

oosg::ref_ptr<Sector> _sector +

+ + +

oosg::ref_ptr<BlinkSequence> _blinkSequence +

+ + +

oBlendingMode _blendingMode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/LightPointNode.html b/doc/doc++/osgSim/LightPointNode.html new file mode 100644 index 000000000..f1774295e --- /dev/null +++ b/doc/doc++/osgSim/LightPointNode.html @@ -0,0 +1,201 @@ + + + + + class OSGSIM_EXPORT osgSim::LightPointNode + + + + +

class OSGSIM_EXPORT osgSim::LightPointNode

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] LightPointNode() +
+[more] LightPointNode(const LightPointNode&, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more] META_Node(osgSim, LightPointNode) +
+[more]virtual void traverse(osg::NodeVisitor& nv) +
+[more]unsigned int addLightPoint(const LightPoint& lp) +
+[more]void removeLightPoint(unsigned int pos) +
+[more]LightPoint& getLightPoint(unsigned int pos) +
+[more]const LightPoint& getLightPoint(unsigned int pos) const +
+[more]void setLightPointList(const LightPointList& lpl) +
+[more]LightPointList& getLightPointList() +
+[more]const LightPointList& getLightPointList() const +
+[more]void setMinPixelSize(float minPixelSize) +
+[more]float getMinPixelSize() const +
+[more]void setMaxPixelSize(float maxPixelSize) +
+[more]float getMaxPixelSize() const +
+[more]void setMaxVisableDistance2(float maxVisableDistance2) +
+[more]float setMaxVisableDistance2() const +

+ +

+

Public Members

+[more]typedef std::vector< LightPoint > LightPointList +

+ +

+

Protected Fields

+[more]mutable osg::BoundingBox _bbox +
+[more]LightPointList _lightPointList +
+[more]float _minPixelSize +
+[more]float _maxPixelSize +
+[more]float _maxVisableDistance2 +

+ +

+

Protected Methods

+[more] ~LightPointNode() +
+[more]virtual bool computeBound() const +

+ +
+ + +
+

Documentation

+
+ + + +
otypedef std::vector< LightPoint > LightPointList +

+ + +

o LightPointNode() +

+ + +

o LightPointNode(const LightPointNode&, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

o META_Node(osgSim, LightPointNode) +

+ + +

ovirtual void traverse(osg::NodeVisitor& nv) +

+ + +

ounsigned int addLightPoint(const LightPoint& lp) +

+ + +

ovoid removeLightPoint(unsigned int pos) +

+ + +

oLightPoint& getLightPoint(unsigned int pos) +

+ + +

oconst LightPoint& getLightPoint(unsigned int pos) const +

+ + +

ovoid setLightPointList(const LightPointList& lpl) +

+ + +

oLightPointList& getLightPointList() +

+ + +

oconst LightPointList& getLightPointList() const +

+ + +

ovoid setMinPixelSize(float minPixelSize) +

+ + +

ofloat getMinPixelSize() const +

+ + +

ovoid setMaxPixelSize(float maxPixelSize) +

+ + +

ofloat getMaxPixelSize() const +

+ + +

ovoid setMaxVisableDistance2(float maxVisableDistance2) +

+ + +

ofloat setMaxVisableDistance2() const +

+ + +

o ~LightPointNode() +

+ + +

omutable osg::BoundingBox _bbox +

+ + +

ovirtual bool computeBound() const +

+ + +

oLightPointList _lightPointList +

+ + +

ofloat _minPixelSize +

+ + +

ofloat _maxPixelSize +

+ + +

ofloat _maxVisableDistance2 +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/NavigatorButton.class b/doc/doc++/osgSim/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..fad9c3f2df2c760c687fdc6eda2469ed021768b5 GIT binary patch literal 1816 zcma)7S#ujj5dPMZHPU*^hiv&sNH8Q3_S%lZeK-lkik*mv*oBFMU0kE}N?xv1xibqn#kD}+gU5_!BX#;D;n`B(a^uM+`-V z`wW{5pD=vM;4)MhJO-bk#_$zGz))upI#O8BF)oRLMJbt*ETy1hIR%ClNv`S`K~757 zBzakqS0s5gg$cZ-lk)3Q0_&1&7~ptl zz{1A{_OWBY#!Uldd}g462L>D|9m?A#b`2a!1INf4IKeFgU*mlP-$=c0@vedIuxH?V z+}5DaJN5a3C+wiiEnCCH!ea4|H+ha9iQI6RyBUt`liffH>*$yb+ z0rkj8lx<&TUG+@A^^Q7)H**GFD9FIq&bSHV_H2=R@L@5k0#PCEt(-gHMMz_8Z#Q=os1>mTio5@fx}C#O+k&_=S`==g&(Xngz!CzdE0LU zmc8M)lz>K~l;D=kKnk^*?d?;xC6!&gdDXjM=wniy z2a87EokG>zcDqMy=%L}nYMA~n6b|^H?nzzPRVu3I2UYHdeq(B6SWULdrMj|ur&hX> z0-H+KkcBqt2maA*-)dA<0>ky1+9gThcY=sD0vblvl=HS(258l#i0bsCWkwWoCn-)_ zN^#n1iqncyycBU-bm~l-P;uIMiZ>LGk$evYXxJj@XC!FH0*}n4Q>4wza0?gAl@{jA zq%Gm~iHvYBBmJZJuj*=LwEpTgKp$KvD0DW+POCHP_w9**FP1Yh_Om&_-a zY2(Ewc>XEIcb9&{OQ)DjYi&%oaixuUQp-NWh$*eK@dB~SKZVCxI{u=9*KmOMqM);g zlLVZLET)IZp4rB^HZq~b&YRD%7QMNKA^LBF${_m}rpd{i^!qz54N(>1595zxk4cwd Q3NsibO%0zC9l{6y0?tduvj6}9 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/Sector.html b/doc/doc++/osgSim/Sector.html new file mode 100644 index 000000000..1b2b7e04b --- /dev/null +++ b/doc/doc++/osgSim/Sector.html @@ -0,0 +1,60 @@ + + + + + class osgSim::Sector + + + + +

class osgSim::Sector

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]virtual float operator() (const osg::Vec3&yeLocal*/) const = 0 +

+ +

+

Protected Methods

+[more]virtual ~Sector() +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual float operator() (const osg::Vec3&yeLocal*/) const = 0 +

+ + +

ovirtual ~Sector() +

+
+
Direct child classes: +
ElevationSector
+ConeSector
+AzimSector
+AzimElevationSector
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/SequenceGroup.html b/doc/doc++/osgSim/SequenceGroup.html new file mode 100644 index 000000000..c72986861 --- /dev/null +++ b/doc/doc++/osgSim/SequenceGroup.html @@ -0,0 +1,63 @@ + + + + + class OSGSIM_EXPORT osgSim::BlinkSequence::SequenceGroup + + + + +

class OSGSIM_EXPORT SequenceGroup

sequence group which can be used to synchronize related blink sequences
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]double _baseTime +

+ +

+

Public Methods

+[more] SequenceGroup() +
+[more] SequenceGroup(double baseTime) +

+ +
+ + +
+

Documentation

+
sequence group which can be used to synchronize related blink sequences
+
+ + + +
o SequenceGroup() +

+ + +

o SequenceGroup(double baseTime) +

+ + +

odouble _baseTime +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/icon1.gif b/doc/doc++/osgSim/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/icon2.gif b/doc/doc++/osgSim/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgSim/index.html b/doc/doc++/osgSim/index.html new file mode 100644 index 000000000..f8af235f4 --- /dev/null +++ b/doc/doc++/osgSim/index.html @@ -0,0 +1,44 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/osgSim.html b/doc/doc++/osgSim/osgSim.html new file mode 100644 index 000000000..cd6548850 --- /dev/null +++ b/doc/doc++/osgSim/osgSim.html @@ -0,0 +1,45 @@ + + + + + namespace osgSim + + + + +

namespace osgSim

+
+

+
+class OSGSIM_EXPORT BlinkSequence: public osg::Referenced +
+class OSGSIM_EXPORT LightPoint +
+class OSGSIM_EXPORT LightPointNode: public osg::Node +
+class Sector: public osg::Referenced +
+class OSGSIM_EXPORT AzimRange +
+class OSGSIM_EXPORT ElevationRange +
+class OSGSIM_EXPORT AzimSector: public Sector, public AzimRange +
+class OSGSIM_EXPORT ElevationSector: public Sector, public ElevationRange +
+class OSGSIM_EXPORT AzimElevationSector: public Sector, public AzimRange, public ElevationRange +
+class OSGSIM_EXPORT ConeSector: public Sector +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/osgSimGetLibraryName.html b/doc/doc++/osgSim/osgSimGetLibraryName.html new file mode 100644 index 000000000..13fed6c7d --- /dev/null +++ b/doc/doc++/osgSim/osgSimGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGSIM_EXPORT const char* osgSimGetLibraryName + + + + +

extern OSGSIM_EXPORT const char* osgSimGetLibraryName

()

osgSimGetLibraryName() returns the library name in human friendly form
+ + +
+

Documentation

+
+osgSimGetLibraryName() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgSim/osgSimGetVersion.html b/doc/doc++/osgSim/osgSimGetVersion.html new file mode 100644 index 000000000..611517179 --- /dev/null +++ b/doc/doc++/osgSim/osgSimGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGSIM_EXPORT const char* osgSimGetVersion + + + + +

extern OSGSIM_EXPORT const char* osgSimGetVersion

()

osgSimGetVersion() returns the library version number.
+ + +
+

Documentation

+
+osgSimGetVersion() returns the library version number. +Numbering convention : OpenSceneGraph-Sim-0.1 will return 0.1 from osgSimgetVersion. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph-Sim library +# +AC_CHECK_LIB(osg, osgSimGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/ClassGraph.class b/doc/doc++/osgText/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..4f41a1fb2fdf65525a700ad591fe8a696f29497f GIT binary patch literal 1237 zcma)6*-{fh6g@+hNrou`K|w^^#V{;!Uxf)I{zh+h=K3 zsd!waUo=!!3dIjq#=y{V{6M7_+&wM=R|*RBw*!KzHaBtvg;Em*1L4$)R)eWlU#iPW zPx={+I$h{qMG7udrcI%d+6D~_cO;*T)@?>RB02V1R@EvKtjwE3##>R3iE=uxd{>m) zBRU}i>WsuD>(0FYN6y?~v%I|}%|80f6|R~yU}ZfP1j|0Fd@ztWac1<5bRp|ZaL+(* zBd2*{+H_Wyxb7lFpqNkv=2f-7cv$2WMb{J<7|5NpZ8V{KN}fKEfxet9GOxgVm+g3* zDidpL-z_sG{rRd=Qc&Z(tolX1yd+@k)$&&}|#YQU4bz2pm?{eSgrM&xv$VGh~Gz=@?#JBjV?8~a4HN?qp z7K6@BA1O#fe|02#$X>+^$qadih$BMUbCQu7F65kKnAED1>>;)0B%`Ee!%i|p`WwzW zzmV7t)sd`WjO^I<MT3FyI-fA42Q3jhEB literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/ClassGraphPanel.class b/doc/doc++/osgText/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..4f3ea86bb625e4e043d10fafb3b0b05cf2f96537 GIT binary patch literal 4084 zcmbtWX>c4@5&lLyyR*lXB(J?mmPm#W>_{tH!Xb!QvIDl97=dgjR%}Nym>unoq_tNw z%I>VBgm4=IB%DP##03F|V>uGQMp~IT2Uj@Eec$=X4~qX(Q550pH+#lP%0Q{quiy8& zzwYVR@4dbF@5i1*09)})825$ofiON6#sgt|GK|lJ@kkh73FCWV{5*``hVd5zA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR24!kakD@AO?>!awz zSQOpZ7sUqbkDwg~MBExd9JfWW9tUMQF5-6aI3(KPD8-Q|uD~5pbYViUNfAfI&*JSSK8J@*d|pHu51RM_7EF8*XH0wvr%Zeqo{2|s z+Qe7!P7`0lTTPtByG@+Kr%ZfZOqOw%i51Z*__T>t@%TPIZsG^x@k3d-DA3DR-0hY=%^o*qaSt+1JW2YqzSe4J&p86+`L;D7Btm@&ds}y?RdjYUozs> zK>3me#omH7Kby-G70Xp?E%;%Z1Jr#+M=#A;vbnm6XUw|GEqVJa$C|PIToct*^`!@< zjRC}bMqcQ21 zu5LkYwH!OIA*O8nebS(hxLI3RT&Ktu_YPb666e|;VmB{k?0JvJp-6ydMH?eH*5uB; z>8ySkPmkZ88seAMS3~=lo3ZkTtwPS4%G)ID*l#W5W-QMw>@Inp>yZ8+>BrqtA!FZ? z%S#gMlD4A^96#EK;#)KF`YPC5A^IHSA+)kt4MA(#vkR=&ls)YhNEe*STbUCAxFsjc z6pSeqnVO!-I37!r;fi;=dxEzBsYnvY=18Gu-9;uCkzrS%;4W$iXA9QiSk57D$iA~= z<>?Td&J~KJ(PsG}vsQ5*!`8?`vvzJ~mW!dBljUJ0L#|%!j`|H$t3`VqQB`FLntfcPqv2V(ktLL=Fr?7pN#~O4t zT>bN{!BkMS#Wf_=wB+UT)r(Y>D|feihsItF<<)h<(&z1IuUdLT^f_xumThN7A_de` zpK}+u9}$PAR1tAY=2;aMJEBH^zci9Z3$h!vy)4>ZwagK!^`lW_B6Ka5ri$v8XE&DS z**2y5s-s>i$i5p3a%c`rGiP>2a50yaoHQn=-2?C?y^=Ds z$a&mS!7C4FLmkQX3bsFl4HwWokqjl*oH55|*bysd(P2N4Pk#%a(iAuphFA{k9~B!h|0L_D#Mm`bI86)zo6P0&J5uP}Rl z==G0)F|mplPp)9Fg4YBFV`bc!61GH)fnRo{s&;M^rbMit!)CR#J(y3=CSsi% zXDb*!8PgImE~U;q`}A4v?BDPY{1ZvF>-^E$2Jx${@qTJG!;R!&7vH$|u38lAt%Uf5lt`!0Q5 z61~-(zxsUlzys|22oSiBRoce?-T=$HYZawB1z+k8x$R_nfC=t@r(tU}CDC6Txg<7h+oWC&S9_bii!b$r|mIZMwTUqixDJN$c4LcvBUu z@=G#%%56_EJR6)vn{3dw#HPL4!dh z$DJobZHZ8ljj&zMp83})|BBG?Q@o>k#upIcA8@?y9ImV2)qz31jN6#S;4*FuW&`Ij z#QSb%LZ_5tA}zN$q4Ol~q}Hpno}pkexQtN|uTAf)T5a;JPU>1hrz!8rM^XVkaJ3vB JV$?Q#=szD|0>A(O literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/ClassLayout.class b/doc/doc++/osgText/ClassLayout.class new file mode 100644 index 0000000000000000000000000000000000000000..69a6f494ed99e62d55c975c56b11981104a3dca9 GIT binary patch literal 2443 zcmZuy>2nih82>HVBfIRhrLbUtR6&I{DHK$q7O2{CSZ$$Nt%9Q2CfjstvKu#>mg24T zzHd=Ha5~e`PwKRRkr~I&`WN`mh|lwGlBPmt_IaQCe&77{@9%#ghCR3#hohmO!PPLM z;aLqYX?R(~D;i$a@S27N4XL&KXI-qP^4hIb6K;dTRY++m;t2N+}++^IvyT?S;_ zZ9qf6PS`;PhnPI9L&1PfX7@08FDu{2(m?|%h71@u!q`zA8*q%h9B1-=115$Udw?w- zWQ!4YHOe7RFz=*+c8sy-hjgsR!wkkvOyLxRGYoPjs<0VMnwW)WVh&joXYq)Mc_z=H zV&XZRHt{@TFEH;#Oqh6&vG*B#fX7UHh$l^a%uYXnZ{kxtZQ?ULYT|Q_@g)nsV&(G; zzGm33dyX)(nv%74O84+E zrzTF}VKu{5d-k2`Zk2eU?Rrjduq9k;L0hh`Om2GX5|PHq$r&dXHk`C%HdvjSBJclG zuUA`-c|CQj)q6voqV`;e-&#(iQCz6hFF`%zdTux%!5AvqmCEtJE>BBnUnTbP9M^Eh zY|kl5STA%&?0LT$N|1;Ayu)66uM*l`IAIs7Odma)bIKtNze4e-{Z^EW>-UY(Ktsyh zu}f5b+lZgDixYO>+LJ|xl-p0(vu?o-{a~;fhCZ#9G45A`oO8@Al4I#Kt&N?}NAa5j zq=M{n+41s(O!{P3lAx30+;~WhCa*ca>V-{piWASfoN$hODpPJyp<2v>v#LTGg}|R1 zai&P3PCIU4nh{s*F6Gc%^QP0a%=-ScGMoED`83U=%RpDB$%#rEwLQDw1k|CXK->_z zOM@}OVR(HM<{iBPJGTV>xi>CIn7>q>+lze`I>9e1LGbe_PI?r@Nsld^8tKs+P4F3_c3~Z1z}D0ybf!AGRtQs8u!BK5C9h!H zufkSBh0*h0e%K+{VJLtfkb2bvmOgsFI~7 zFJApQMe%N+P&?>LXQP<%6~s^VF5@QpQsg;H=U)1@kfZD+Z2X0i;qSCXT0)-`S)b-YWhtV4KcX$6 zMd%9lB~&3|&{abZtMBZObCF6uqg(m~sIiRBbjILV)P$}?+!A=N=+LxqkYB<6C0L0# zEA?7>G%8|J0GjcBD~iY&B=br!Tf;5C;npkYIAtl9(RT@(I;9#mb9}3YJvDSMD3Ya6 OO$QpS45)eQF#R7oR!vR- literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/Font.html b/doc/doc++/osgText/Font.html new file mode 100644 index 000000000..d0fe76e9d --- /dev/null +++ b/doc/doc++/osgText/Font.html @@ -0,0 +1,341 @@ + + + + + class OSGTEXT_EXPORT osgText::Font + + + + +

class OSGTEXT_EXPORT osgText::Font

Pure virtual base class for fonts.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Font(FontImplementation* implementation=0) +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp&) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* className() const +
+[more]virtual const char* libraryName() const +
+[more]virtual std::string getFileName() const +
+[more]virtual void setSize(unsigned int width, unsigned int height) +
Set the pixel width and height hint +
+[more]unsigned int getWidth() +
+[more]unsigned int getHeight() +
+[more]virtual Glyph* getGlyph(unsigned int charcode) +
Get a Glyph for specified charcode, and the font size nearest to the current font size hint +
+[more]virtual osg::Vec2 getKerning(unsigned int leftcharcode, unsigned int rightcharcode) +
Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, wrt the current font size hint +
+[more]virtual bool hasVertical() const +
Return true if this font provides vertical alignments and spacing or glyphs +
+[more]void setGlyphImageMargin(unsigned int margin) +
Set the margin around each glyph, to ensure that texture filtering doesn't bleed adjacent glyph's into each other. +
+[more]unsigned int getGlyphImageMargin() const +
+[more]void setTextureSizeHint(unsigned int width, unsigned int height) +
Set the size of texture to create to store the glyph images when rendering. +
+[more]unsigned int getTextureWidthHint() const +
+[more]unsigned int getTextureHeightHint() const +
+[more]void setMinFilterHint(osg::Texture::FilterMode mode) +
Set the minification texture filter to use when creating the texture to store the glyph images when rendering. +
+[more]osg::Texture::FilterMode getMinFilterHint() const +
+[more]void setMagFilterHint(osg::Texture::FilterMode mode) +
Set the magnification texture filter to use when creating the texture to store the glyph images when rendering. +
+[more]osg::Texture::FilterMode getMagFilterHint() const +
+[more]void setImplementation(FontImplementation* implementation) +
+[more]FontImplementation* getImplementation() +
+[more]const FontImplementation* getImplementation() const +

+ +

+

Public Members

+class FontImplementation: public osg::Referenced +
+class OSGTEXT_EXPORT GlyphTexture: public osg::Texture2D +
+class OSGTEXT_EXPORT Glyph: public osg::Image +

+ +

+

Protected Fields

+[more]SizeGlyphMap _sizeGlyphMap +
+[more]GlyphTextureList _glyphTextureList +
+[more]StateSetList _stateSetList +
+[more]unsigned int _width +
+[more]unsigned int _height +
+[more]unsigned int _margin +
+[more]unsigned int _textureWidthHint +
+[more]unsigned int _textureHeightHint +
+[more]osg::Texture::FilterMode _minFilterHint +
+[more]osg::Texture::FilterMode _magFilterHint +
+[more]osg::ref_ptr<FontImplementation> _implementation +

+ +

+

Protected Methods

+[more]virtual ~Font() +
+[more]void addGlyph(unsigned int width, unsigned int height, unsigned int charcode, Glyph* glyph) +

+ +

+

Protected Members

+[more]typedef std::vector< osg::ref_ptr<GlyphTexture> > GlyphTextureList +
+[more]typedef std::vector< osg::ref_ptr<osg::StateSet> > StateSetList +
+[more]typedef std::map< unsigned int, osg::ref_ptr<Glyph> > GlyphMap +
+[more]typedef std::pair< unsigned int, unsigned int > SizePair +
+[more]typedef std::map< SizePair, GlyphMap > SizeGlyphMap +

+ +
+ + +
+

Documentation

+
Pure virtual base class for fonts. +Concrete implementation are the DefaultFont found in src/osgText/DefaultFont.cpp +and FreeTypeFont found in src/osgPlugins/freetype/FreeTypeFont.cpp
+
+ + + +
o Font(FontImplementation* implementation=0) +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp&) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual std::string getFileName() const +

+ + +

ovirtual void setSize(unsigned int width, unsigned int height) +
Set the pixel width and height hint +

+ + +

ounsigned int getWidth() +

+ + +

ounsigned int getHeight() +

+ + +

ovirtual Glyph* getGlyph(unsigned int charcode) +
Get a Glyph for specified charcode, and the font size nearest to the current font size hint +

+ + +

ovirtual osg::Vec2 getKerning(unsigned int leftcharcode, unsigned int rightcharcode) +
Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, wrt the current font size hint +

+ + +

ovirtual bool hasVertical() const +
Return true if this font provides vertical alignments and spacing or glyphs +

+ + +

ovoid setGlyphImageMargin(unsigned int margin) +
Set the margin around each glyph, +to ensure that texture filtering doesn't bleed adjacent glyph's into each other. +Default margin is 2 texels. +

+ + +

ounsigned int getGlyphImageMargin() const +

+ + +

ovoid setTextureSizeHint(unsigned int width, unsigned int height) +
Set the size of texture to create to store the glyph images when rendering. +Note, this doesn't affect already created Texture Glhph's. +

+ + +

ounsigned int getTextureWidthHint() const +

+ + +

ounsigned int getTextureHeightHint() const +

+ + +

ovoid setMinFilterHint(osg::Texture::FilterMode mode) +
Set the minification texture filter to use when creating the texture to store the glyph images when rendering. +Note, this doesn't affect already created Texture Glhph's. +

+ + +

oosg::Texture::FilterMode getMinFilterHint() const +

+ + +

ovoid setMagFilterHint(osg::Texture::FilterMode mode) +
Set the magnification texture filter to use when creating the texture to store the glyph images when rendering. +Note, this doesn't affect already created Texture Glhph's. +

+ + +

oosg::Texture::FilterMode getMagFilterHint() const +

+ + +

ovoid setImplementation(FontImplementation* implementation) +

+ + +

oFontImplementation* getImplementation() +

+ + +

oconst FontImplementation* getImplementation() const +

+ + +

ovirtual ~Font() +

+ + +

ovoid addGlyph(unsigned int width, unsigned int height, unsigned int charcode, Glyph* glyph) +

+ + +

otypedef std::vector< osg::ref_ptr<GlyphTexture> > GlyphTextureList +

+ + +

otypedef std::vector< osg::ref_ptr<osg::StateSet> > StateSetList +

+ + +

otypedef std::map< unsigned int, osg::ref_ptr<Glyph> > GlyphMap +

+ + +

otypedef std::pair< unsigned int, unsigned int > SizePair +

+ + +

otypedef std::map< SizePair, GlyphMap > SizeGlyphMap +

+ + +

oSizeGlyphMap _sizeGlyphMap +

+ + +

oGlyphTextureList _glyphTextureList +

+ + +

oStateSetList _stateSetList +

+ + +

ounsigned int _width +

+ + +

ounsigned int _height +

+ + +

ounsigned int _margin +

+ + +

ounsigned int _textureWidthHint +

+ + +

ounsigned int _textureHeightHint +

+ + +

oosg::Texture::FilterMode _minFilterHint +

+ + +

oosg::Texture::FilterMode _magFilterHint +

+ + +

oosg::ref_ptr<FontImplementation> _implementation +

+ +
This class has no child classes.
+ +
Friends:
class FontImplementation

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/FontImplementation.html b/doc/doc++/osgText/FontImplementation.html new file mode 100644 index 000000000..e6f971ddc --- /dev/null +++ b/doc/doc++/osgText/FontImplementation.html @@ -0,0 +1,105 @@ + + + + + class osgText::Font::FontImplementation + + + + +

class FontImplementation

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]Font* _facade +

+ +

+

Public Methods

+[more]virtual std::string getFileName() const = 0 +
+[more]virtual void setSize(unsigned int width, unsigned int height) = 0 +
Set the pixel width and height hint +
+[more]virtual Glyph* getGlyph(unsigned int charcode) = 0 +
Get a Glyph for specified charcode, and the font size nearest to the current font size hint +
+[more]virtual osg::Vec2 getKerning(unsigned int leftcharcode, unsigned int rightcharcode) = 0 +
Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, wrt the current font size hint +
+[more]virtual bool hasVertical() const = 0 +
Return true if this font provides vertical alignments and spacing or glyphs +
+[more]void setWidth(unsigned int width) +
+[more]void setHeight(unsigned int height) +
+[more]void addGlyph(unsigned int width, unsigned int height, unsigned int charcode, Glyph* glyph) +

+ +
+ + +
+

Documentation

+
+ + + +
ovirtual std::string getFileName() const = 0 +

+ + +

ovirtual void setSize(unsigned int width, unsigned int height) = 0 +
Set the pixel width and height hint +

+ + +

ovirtual Glyph* getGlyph(unsigned int charcode) = 0 +
Get a Glyph for specified charcode, and the font size nearest to the current font size hint +

+ + +

ovirtual osg::Vec2 getKerning(unsigned int leftcharcode, unsigned int rightcharcode) = 0 +
Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, wrt the current font size hint +

+ + +

ovirtual bool hasVertical() const = 0 +
Return true if this font provides vertical alignments and spacing or glyphs +

+ + +

ovoid setWidth(unsigned int width) +

+ + +

ovoid setHeight(unsigned int height) +

+ + +

ovoid addGlyph(unsigned int width, unsigned int height, unsigned int charcode, Glyph* glyph) +

+ + +

oFont* _facade +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/General.html b/doc/doc++/osgText/General.html new file mode 100644 index 000000000..e36a56393 --- /dev/null +++ b/doc/doc++/osgText/General.html @@ -0,0 +1,40 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGTEXT_EXPORT_
+ +o#define +OSGTEXT_EXPORT(dllexport)
+ +o#define +OSGTEXT_EXPORT(dllimport)
+ +o#define +OSGTEXT_EXPORT
+ +o#define +OSGTEXT_FONT
+ +o#define +OSGTEXT_STRING
+ +o#define +OSGTEXT_TEXT
+ +o#define +OSGTEXT_VERSION
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/Glyph.html b/doc/doc++/osgText/Glyph.html new file mode 100644 index 000000000..067b9a798 --- /dev/null +++ b/doc/doc++/osgText/Glyph.html @@ -0,0 +1,253 @@ + + + + + class OSGTEXT_EXPORT osgText::Font::Glyph + + + + +

class OSGTEXT_EXPORT Glyph

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Glyph() +
+[more]virtual ~Glyph() +
+[more]unsigned int getGlyphCode() const +
+[more]void setHorizontalBearing(const osg::Vec2& bearing) +
+[more]const osg::Vec2& getHorizontalBearing() const +
+[more]void setHorizontalAdvance(float advance) +
+[more]float getHorizontalAdvance() const +
+[more]void setVerticalBearing(const osg::Vec2& bearing) +
+[more]const osg::Vec2& getVerticalBearing() const +
+[more]void setVerticalAdvance(float advance) +
+[more]float getVerticalAdvance() const +
+[more]void setTexture(GlyphTexture* texture) +
+[more]GlyphTexture* getTexture() +
+[more]const GlyphTexture* getTexture() const +
+[more]osg::StateSet* getStateSet() +
+[more]const osg::StateSet* getStateSet() const +
+[more]void setTexturePosition(int posX, int posY) +
+[more]int getTexturePositionX() const +
+[more]int getTexturePositionY() const +
+[more]void setMinTexCoord(const osg::Vec2& coord) +
+[more]const osg::Vec2& getMinTexCoord() const +
+[more]void setMaxTexCoord(const osg::Vec2& coord) +
+[more]const osg::Vec2& getMaxTexCoord() const +
+[more]void subload() const +

+ +

+

Protected Fields

+[more]Font* _font +
+[more]unsigned int _glyphCode +
+[more]osg::Vec2 _horizontalBearing +
+[more]float _horizontalAdvance +
+[more]osg::Vec2 _verticalBearing +
+[more]float _verticalAdvance +
+[more]GlyphTexture* _texture +
+[more]int _texturePosX +
+[more]int _texturePosY +
+[more]osg::Vec2 _minTexCoord +
+[more]osg::Vec2 _maxTexCoord +

+ +
+ + +
+

Documentation

+
+ + + +
o Glyph() +

+ + +

ovirtual ~Glyph() +

+ + +

ounsigned int getGlyphCode() const +

+ + +

ovoid setHorizontalBearing(const osg::Vec2& bearing) +

+ + +

oconst osg::Vec2& getHorizontalBearing() const +

+ + +

ovoid setHorizontalAdvance(float advance) +

+ + +

ofloat getHorizontalAdvance() const +

+ + +

ovoid setVerticalBearing(const osg::Vec2& bearing) +

+ + +

oconst osg::Vec2& getVerticalBearing() const +

+ + +

ovoid setVerticalAdvance(float advance) +

+ + +

ofloat getVerticalAdvance() const +

+ + +

ovoid setTexture(GlyphTexture* texture) +

+ + +

oGlyphTexture* getTexture() +

+ + +

oconst GlyphTexture* getTexture() const +

+ + +

oosg::StateSet* getStateSet() +

+ + +

oconst osg::StateSet* getStateSet() const +

+ + +

ovoid setTexturePosition(int posX, int posY) +

+ + +

oint getTexturePositionX() const +

+ + +

oint getTexturePositionY() const +

+ + +

ovoid setMinTexCoord(const osg::Vec2& coord) +

+ + +

oconst osg::Vec2& getMinTexCoord() const +

+ + +

ovoid setMaxTexCoord(const osg::Vec2& coord) +

+ + +

oconst osg::Vec2& getMaxTexCoord() const +

+ + +

ovoid subload() const +

+ + +

oFont* _font +

+ + +

ounsigned int _glyphCode +

+ + +

oosg::Vec2 _horizontalBearing +

+ + +

ofloat _horizontalAdvance +

+ + +

oosg::Vec2 _verticalBearing +

+ + +

ofloat _verticalAdvance +

+ + +

oGlyphTexture* _texture +

+ + +

oint _texturePosX +

+ + +

oint _texturePosY +

+ + +

oosg::Vec2 _minTexCoord +

+ + +

oosg::Vec2 _maxTexCoord +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/GlyphTexture.html b/doc/doc++/osgText/GlyphTexture.html new file mode 100644 index 000000000..9294ff293 --- /dev/null +++ b/doc/doc++/osgText/GlyphTexture.html @@ -0,0 +1,179 @@ + + + + + class OSGTEXT_EXPORT osgText::Font::GlyphTexture + + + + +

class OSGTEXT_EXPORT GlyphTexture

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] GlyphTexture() +
+[more]virtual int compare(const osg::StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +
+[more]void setStateSet(osg::StateSet* stateset) +
+[more]osg::StateSet* getStateSet() +
+[more]const osg::StateSet* getStateSet() const +
+[more]void setGlyphImageMargin(unsigned int margin) +
Set the margin around each glyph, to ensure that texture filtering doesn't bleed adjacent glyph's into each other +
+[more]unsigned int getGlyphImageMargin() const +
+[more]bool getSpaceForGlyph(Glyph* glyph, int& posX, int& posY) +
+[more]void addGlyph(Glyph* glyph, int posX, int posY) +
+[more]virtual void apply(osg::State& state) const +

+ +

+

Protected Fields

+[more]osg::StateSet* _stateset +
+[more]int _margin +
+[more]int _usedY +
+[more]int _partUsedX +
+[more]int _partUsedY +
+[more]GlyphRefList _glyphs +
+[more]mutable GlyphBuffer _glyphsToSubload +

+ +

+

Protected Methods

+[more]virtual ~GlyphTexture() +

+ +

+

Protected Members

+[more]typedef std::vector< osg::ref_ptr<Glyph> > GlyphRefList +
+[more]typedef std::vector< const Glyph* > GlyphPtrList +
+[more]typedef osg::buffered_object< GlyphPtrList > GlyphBuffer +

+ +
+ + +
+

Documentation

+
+ + + +
o GlyphTexture() +

+ + +

ovirtual int compare(const osg::StateAttribute& rhs) const +
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs +

+ + +

ovoid setStateSet(osg::StateSet* stateset) +

+ + +

oosg::StateSet* getStateSet() +

+ + +

oconst osg::StateSet* getStateSet() const +

+ + +

ovoid setGlyphImageMargin(unsigned int margin) +
Set the margin around each glyph, to ensure that texture filtering doesn't bleed adjacent glyph's into each other +

+ + +

ounsigned int getGlyphImageMargin() const +

+ + +

obool getSpaceForGlyph(Glyph* glyph, int& posX, int& posY) +

+ + +

ovoid addGlyph(Glyph* glyph, int posX, int posY) +

+ + +

ovirtual void apply(osg::State& state) const +

+ + +

ovirtual ~GlyphTexture() +

+ + +

oosg::StateSet* _stateset +

+ + +

oint _margin +

+ + +

oint _usedY +

+ + +

oint _partUsedX +

+ + +

oint _partUsedY +

+ + +

otypedef std::vector< osg::ref_ptr<Glyph> > GlyphRefList +

+ + +

otypedef std::vector< const Glyph* > GlyphPtrList +

+ + +

otypedef osg::buffered_object< GlyphPtrList > GlyphBuffer +

+ + +

oGlyphRefList _glyphs +

+ + +

omutable GlyphBuffer _glyphsToSubload +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/HIER.html b/doc/doc++/osgText/HIER.html new file mode 100644 index 000000000..e45f77e60 --- /dev/null +++ b/doc/doc++/osgText/HIER.html @@ -0,0 +1,22 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/HIERjava.html b/doc/doc++/osgText/HIERjava.html new file mode 100644 index 000000000..5c89e013f --- /dev/null +++ b/doc/doc++/osgText/HIERjava.html @@ -0,0 +1,58 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/NavigatorButton.class b/doc/doc++/osgText/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..fad9c3f2df2c760c687fdc6eda2469ed021768b5 GIT binary patch literal 1816 zcma)7S#ujj5dPMZHPU*^hiv&sNH8Q3_S%lZeK-lkik*mv*oBFMU0kE}N?xv1xibqn#kD}+gU5_!BX#;D;n`B(a^uM+`-V z`wW{5pD=vM;4)MhJO-bk#_$zGz))upI#O8BF)oRLMJbt*ETy1hIR%ClNv`S`K~757 zBzakqS0s5gg$cZ-lk)3Q0_&1&7~ptl zz{1A{_OWBY#!Uldd}g462L>D|9m?A#b`2a!1INf4IKeFgU*mlP-$=c0@vedIuxH?V z+}5DaJN5a3C+wiiEnCCH!ea4|H+ha9iQI6RyBUt`liffH>*$yb+ z0rkj8lx<&TUG+@A^^Q7)H**GFD9FIq&bSHV_H2=R@L@5k0#PCEt(-gHMMz_8Z#Q=os1>mTio5@fx}C#O+k&_=S`==g&(Xngz!CzdE0LU zmc8M)lz>K~l;D=kKnk^*?d?;xC6!&gdDXjM=wniy z2a87EokG>zcDqMy=%L}nYMA~n6b|^H?nzzPRVu3I2UYHdeq(B6SWULdrMj|ur&hX> z0-H+KkcBqt2maA*-)dA<0>ky1+9gThcY=sD0vblvl=HS(258l#i0bsCWkwWoCn-)_ zN^#n1iqncyycBU-bm~l-P;uIMiZ>LGk$evYXxJj@XC!FH0*}n4Q>4wza0?gAl@{jA zq%Gm~iHvYBBmJZJuj*=LwEpTgKp$KvD0DW+POCHP_w9**FP1Yh_Om&_-a zY2(Ewc>XEIcb9&{OQ)DjYi&%oaixuUQp-NWh$*eK@dB~SKZVCxI{u=9*KmOMqM);g zlLVZLET)IZp4rB^HZq~b&YRD%7QMNKA^LBF${_m}rpd{i^!qz54N(>1595zxk4cwd Q3NsibO%0zC9l{6y0?tduvj6}9 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/String.html b/doc/doc++/osgText/String.html new file mode 100644 index 000000000..5d90a58dc --- /dev/null +++ b/doc/doc++/osgText/String.html @@ -0,0 +1,159 @@ + + + + + class OSGTEXT_EXPORT osgText::String + + + + +

class OSGTEXT_EXPORT osgText::String

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] String() +
+[more] String(const String& str) +
+[more]virtual ~String() +
+[more]String& operator = (const String& str) +
+[more]void set(const std::string& str) +
+[more]void set(const wchar_t* text) +
Set the text using a wchar_t string, which is converted to an internal TextString +
+[more]void set(const std::string& text, Encoding encoding) +
Set the text using a Unicode encoded std::string, which is converted to an internal TextString. +
+[more]std::string createUTF8EncodedString() const +
returns a UTF8 encoded version of this osgText::String +

+ +

+

Public Members

+[more]enum Encoding +
Types of string encodings supported +

+ +
+ + +
+

Documentation

+
+ + + +
o String() +

+ + +

o String(const String& str) +

+ + +

ovirtual ~String() +

+ + +

oString& operator = (const String& str) +

+ + +

ovoid set(const std::string& str) +

+ + +

ovoid set(const wchar_t* text) +
Set the text using a wchar_t string, +which is converted to an internal TextString +

+ + +

oenum Encoding +
+Types of string encodings supported +

+ + + +
o ENCODING_UNDEFINED +

+ + +

o ENCODING_ASCII +
not using Unicode +

+ + +

o ENCODING_UTF8 +
unsigned char ASCII +

+ + +

o ENCODING_UTF16 +
8-bit unicode transformation format +

+ + +

o ENCODING_UTF16_BE +
16-bit signature +

+ + +

o ENCODING_UTF16_LE +
16-bit big-endian +

+ + +

o ENCODING_UTF32 +
16-bit little-endian +

+ + +

o ENCODING_UTF32_BE +
32-bit signature +

+ + +

o ENCODING_UTF32_LE +
32-bit big-endian +

+ + +

o ENCODING_SIGNATURE +
32-bit little-endian +

+ + + +
ovoid set(const std::string& text, Encoding encoding) +
Set the text using a Unicode encoded std::string, which is converted to an internal TextString. +The encoding parameter specificies which Unicode encodeding is used in the std::string. +

+ + +

ostd::string createUTF8EncodedString() const +
returns a UTF8 encoded version of this osgText::String +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/Text.html b/doc/doc++/osgText/Text.html new file mode 100644 index 000000000..17e3130c7 --- /dev/null +++ b/doc/doc++/osgText/Text.html @@ -0,0 +1,692 @@ + + + + + class OSGTEXT_EXPORT osgText::Text + + + + +

class OSGTEXT_EXPORT osgText::Text

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] Text() +
+[more] Text(const Text& text, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* className() const +
+[more]virtual const char* libraryName() const +
+[more]void setFont(Font* font=0) +
Set the Font to use to render the text. +
+[more]void setFont(const std::string& fontfile) +
Set the font, loaded from the specified front file, to use to render the text, setFont("") sets the use of the default font +
+[more]const Font* getFont() const +
Get the font. +
+[more]void setFontSize(unsigned int width, unsigned int height) +
Set the Font reference width and height resolution in texels. +
+[more]unsigned int getFontWidth() const +
+[more]unsigned int getFontHeight() const +
+[more]void setText(const String& text) +
Set the text using a osgText::String +
+[more]void setText(const std::string& text) +
Set the text using a std::string, which is converted to an internal TextString +
+[more]void setText(const std::string& text, String::Encoding encoding) +
Set the text using a Unicode encoded std::string, which is converted to an internal TextString. +
+[more]void setText(const wchar_t* text) +
Set the text using a wchar_t string, which is converted to an internal TextString +
+[more]String& getText() +
Get the text string. +
+[more]const String& getText() const +
Get the const text string +
+[more]void update() +
update internal glyph respresnetation used for rendering, and bounding volume +
+[more]void setCharacterSize(float height, float aspectRatio=1.0f) +
Set the rendered character size in object coordinates +
+[more]float getCharacterHeight() const +
+[more]float getCharacterAspectRatio() const +
+[more]void setMaximumWidth(float maximumWidth) +
Set the maximum width of the text box. +
+[more]float getMaximumWidth() const +
Get the maximim width of the text box +
+[more]void setMaximumHeight(float maximumHeight) +
Set the maximum height of the text box. +
+[more]float getMaximumHeight() const +
Get the maximum height of the text box +
+[more]void setPosition(const osg::Vec3& pos) +
Set the position of text +
+[more]const osg::Vec3& getPosition() const +
Get the position of text +
+[more]void setAlignment(AlignmentType alignment) +
+[more]AlignmentType getAlignment() const +
+[more]void setAxisAlignment(AxisAlignment axis) +
+[more]AxisAlignment getAxisAlignment() const +
+[more]void setRotation(const osg::Quat& quat) +
+[more]const osg::Quat& getRotation() const +
+[more]void setLayout(Layout layout) +
+[more]Layout getLayout() const +
+[more]void setColor(const osg::Vec4& color) +
+[more]const osg::Vec4& getColor() const +
+[more]void setDrawMode(unsigned int mode) +
+[more]unsigned int getDrawMode() const +
+[more]virtual void drawImplementation(osg::State& state) const +
Draw the text +
+[more]virtual bool supports(osg::Drawable::AttributeFunctor&) const +
return false, osgText::Text does not support accept(AttributeFunctor&) +
+[more]virtual bool supports(osg::Drawable::ConstAttributeFunctor&) const +
return true, osgText::Text does support accept(ConstAttributeFunctor&) +
+[more]virtual void accept(osg::Drawable::ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +
+[more]virtual bool supports(osg::Drawable::PrimitiveFunctor&) const +
return true, osgText::Text does support accept(PrimitiveFunctor&) +
+[more]virtual void accept(osg::Drawable::PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ +

+

Public Members

+[more]enum AlignmentType +
+[more]enum AxisAlignment +
+[more]enum Layout +
+[more]enum DrawModeMask +

+ +

+

Protected Fields

+[more]osg::ref_ptr<Font> _font +
+[more]unsigned int _fontWidth +
+[more]unsigned int _fontHeight +
+[more]float _characterHeight +
+[more]float _characterAspectRatio +
+[more]float _maximumWidth +
+[more]float _maximumHeight +
+[more]String _text +
+[more]osg::Vec3 _position +
+[more]AlignmentType _alignment +
+[more]AxisAlignment _axisAlignment +
+[more]osg::Quat _rotation +
+[more]Layout _layout +
+[more]osg::Vec4 _color +
+[more]unsigned int _drawMode +
+[more]TextureGlyphQuadMap _textureGlyphQuadMap +
+[more]osg::Matrix _matrix +
+[more]osg::Vec3 _offset +
+[more]mutable osg::BoundingBox _textBB +

+ +

+

Protected Methods

+[more]virtual ~Text() +
+[more]virtual bool computeBound() const +
+[more]Font* getActiveFont() +
+[more]const Font* getActiveFont() const +
+[more]void computeGlyphRepresentation() +
+[more]void computePositions() +

+ +

+

Protected Members

+[more]struct GlyphQuads +
+[more]typedef std::map<osg::ref_ptr<osg::StateSet>,GlyphQuads> TextureGlyphQuadMap +

+ +
+ + +
+

Documentation

+
+ + + +
o Text() +

+ + +

o Text(const Text& text, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovoid setFont(Font* font=0) +
Set the Font to use to render the text. +setFont(0) sets the use of the default font. +

+ + +

ovoid setFont(const std::string& fontfile) +
Set the font, loaded from the specified front file, to use to render the text, +setFont("") sets the use of the default font +

+ + +

oconst Font* getFont() const +
Get the font. Return 0 if default is being used. +

+ + +

ovoid setFontSize(unsigned int width, unsigned int height) +
Set the Font reference width and height resolution in texels. +Note, the size may not be supported by current font, +the closest supported font size will be selected. +

+ + +

ounsigned int getFontWidth() const +

+ + +

ounsigned int getFontHeight() const +

+ + +

ovoid setText(const String& text) +
Set the text using a osgText::String +

+ + +

ovoid setText(const std::string& text) +
Set the text using a std::string, +which is converted to an internal TextString +

+ + +

ovoid setText(const std::string& text, String::Encoding encoding) +
Set the text using a Unicode encoded std::string, which is converted to an internal TextString. +The encoding parameter specificies which Unicode encodeding is used in the std::string. +

+ + +

ovoid setText(const wchar_t* text) +
Set the text using a wchar_t string, +which is converted to an internal TextString +

+ + +

oString& getText() +
Get the text string. +Note, if you modify the string you must call Text::update() for +the internal glyph reprentation to be updated. +

+ + +

oconst String& getText() const +
Get the const text string +

+ + +

ovoid update() +
update internal glyph respresnetation used for rendering, +and bounding volume +

+ + +

ovoid setCharacterSize(float height, float aspectRatio=1.0f) +
Set the rendered character size in object coordinates +

+ + +

ofloat getCharacterHeight() const +

+ + +

ofloat getCharacterAspectRatio() const +

+ + +

ovoid setMaximumWidth(float maximumWidth) +
Set the maximum width of the text box. +With horizontal layouts any characters which do not fit are wrapped around. +0 or negative values indicate that no maximum width is set, lines can be as long as +they need be to fit thre required text +

+ + +

ofloat getMaximumWidth() const +
Get the maximim width of the text box +

+ + +

ovoid setMaximumHeight(float maximumHeight) +
Set the maximum height of the text box. +With horizontal layouts any characters which do not fit are wrapped around. +0 or negative values indicate that no maximum height is set, lines can be as long as +they need be to fit thre required text +

+ + +

ofloat getMaximumHeight() const +
Get the maximum height of the text box +

+ + +

ovoid setPosition(const osg::Vec3& pos) +
Set the position of text +

+ + +

oconst osg::Vec3& getPosition() const +
Get the position of text +

+ + +

oenum AlignmentType +

+ + + +
o LEFT_TOP +

+ + +

o LEFT_CENTER +

+ + +

o LEFT_BOTTOM +

+ + +

o CENTER_TOP +

+ + +

o CENTER_CENTER +

+ + +

o CENTER_BOTTOM +

+ + +

o RIGHT_TOP +

+ + +

o RIGHT_CENTER +

+ + +

o RIGHT_BOTTOM +

+ + +

o BASE_LINE +

+ + + +
ovoid setAlignment(AlignmentType alignment) +

+ + +

oAlignmentType getAlignment() const +

+ + +

oenum AxisAlignment +

+ + + +
o XY_PLANE +

+ + +

o XZ_PLANE +

+ + +

o YZ_PLANE +

+ + +

o SCREEN +

+ + + +
ovoid setAxisAlignment(AxisAlignment axis) +

+ + +

oAxisAlignment getAxisAlignment() const +

+ + +

ovoid setRotation(const osg::Quat& quat) +

+ + +

oconst osg::Quat& getRotation() const +

+ + +

oenum Layout +

+ + + +
o LEFT_TO_RIGHT +

+ + +

o RIGHT_TO_LEFT +
default +

+ + +

o VERTICAL +

+ + + +
ovoid setLayout(Layout layout) +

+ + +

oLayout getLayout() const +

+ + +

ovoid setColor(const osg::Vec4& color) +

+ + +

oconst osg::Vec4& getColor() const +

+ + +

oenum DrawModeMask +

+ + + +
o TEXT +

+ + +

o BOUNDINGBOX +
default +

+ + +

o ALIGNMENT +

+ + + +
ovoid setDrawMode(unsigned int mode) +

+ + +

ounsigned int getDrawMode() const +

+ + +

ovirtual void drawImplementation(osg::State& state) const +
Draw the text +

+ + +

ovirtual bool supports(osg::Drawable::AttributeFunctor&) const +
return false, osgText::Text does not support accept(AttributeFunctor&) +

+ + +

ovirtual bool supports(osg::Drawable::ConstAttributeFunctor&) const +
return true, osgText::Text does support accept(ConstAttributeFunctor&) +

+ + +

ovirtual void accept(osg::Drawable::ConstAttributeFunctor& af) const +
accept an ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has +

+ + +

ovirtual bool supports(osg::Drawable::PrimitiveFunctor&) const +
return true, osgText::Text does support accept(PrimitiveFunctor&) +

+ + +

ovirtual void accept(osg::Drawable::PrimitiveFunctor& pf) const +
accept a PrimtiveFunctor and call its methods to tell it about the interal primtives that this Drawable has +

+ + +

ovirtual ~Text() +

+ + +

ovirtual bool computeBound() const +

+ + +

oFont* getActiveFont() +

+ + +

oconst Font* getActiveFont() const +

+ + +

oosg::ref_ptr<Font> _font +

+ + +

ounsigned int _fontWidth +

+ + +

ounsigned int _fontHeight +

+ + +

ofloat _characterHeight +

+ + +

ofloat _characterAspectRatio +

+ + +

ofloat _maximumWidth +

+ + +

ofloat _maximumHeight +

+ + +

oString _text +

+ + +

oosg::Vec3 _position +

+ + +

oAlignmentType _alignment +

+ + +

oAxisAlignment _axisAlignment +

+ + +

oosg::Quat _rotation +

+ + +

oLayout _layout +

+ + +

oosg::Vec4 _color +

+ + +

ounsigned int _drawMode +

+ + +

ostruct GlyphQuads +

+ + + +
otypedef std::vector<osg::Vec2> Coords +

+ + +

otypedef std::vector<osg::Vec2> TexCoords +

+ + +

oCoords _coords +

+ + +

oTexCoords _texcoords +

+ + + +
otypedef std::map<osg::ref_ptr<osg::StateSet>,GlyphQuads> TextureGlyphQuadMap +

+ + +

oTextureGlyphQuadMap _textureGlyphQuadMap +

+ + +

ovoid computeGlyphRepresentation() +

+ + +

oosg::Matrix _matrix +

+ + +

oosg::Vec3 _offset +

+ + +

omutable osg::BoundingBox _textBB +

+ + +

ovoid computePositions() +

+ +
This class has no child classes.
+ +
Friends:
class Font

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/icon1.gif b/doc/doc++/osgText/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/icon2.gif b/doc/doc++/osgText/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgText/index.html b/doc/doc++/osgText/index.html new file mode 100644 index 000000000..12e922a15 --- /dev/null +++ b/doc/doc++/osgText/index.html @@ -0,0 +1,38 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/osgText.html b/doc/doc++/osgText/osgText.html new file mode 100644 index 000000000..ddfac6aa7 --- /dev/null +++ b/doc/doc++/osgText/osgText.html @@ -0,0 +1,35 @@ + + + + + namespace osgText + + + + +

namespace osgText

+
+

+
+extern OSGTEXT_EXPORT Font* readFontFile(const std::string& filename) +
read a font from specified file +
+class OSGTEXT_EXPORT Font: public osg::Object +
Pure virtual base class for fonts. +
+class OSGTEXT_EXPORT String: public osg::Referenced, public std::vector<unsigned int> +
+class OSGTEXT_EXPORT Text: public osg::Drawable +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/osgTextGetLibraryName.html b/doc/doc++/osgText/osgTextGetLibraryName.html new file mode 100644 index 000000000..7d91f5c06 --- /dev/null +++ b/doc/doc++/osgText/osgTextGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGTEXT_EXPORT const char* osgTextGetLibraryName + + + + +

extern OSGTEXT_EXPORT const char* osgTextGetLibraryName

()

osgTextGetLibraryName() returns the library name in human friendly form
+ + +
+

Documentation

+
+osgTextGetLibraryName() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/osgTextGetVersion.html b/doc/doc++/osgText/osgTextGetVersion.html new file mode 100644 index 000000000..916098e2e --- /dev/null +++ b/doc/doc++/osgText/osgTextGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGTEXT_EXPORT const char* osgTextGetVersion + + + + +

extern OSGTEXT_EXPORT const char* osgTextGetVersion

()

getVersion_osg() returns the library version number.
+ + +
+

Documentation

+
+getVersion_osg() returns the library version number. +Numbering convention : osg_src-0.8-31 will return 0.8.31 from getVersion_osg. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) library +# +AC_CHECK_LIB(osg, osgTextGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgText/readFontFile.html b/doc/doc++/osgText/readFontFile.html new file mode 100644 index 000000000..24d756082 --- /dev/null +++ b/doc/doc++/osgText/readFontFile.html @@ -0,0 +1,20 @@ + + + + + extern OSGTEXT_EXPORT Font* osgText::readFontFile + + + + +

extern OSGTEXT_EXPORT Font* osgText::readFontFile

(const std::string& filename)

read a font from specified file
+ + +
+

Documentation

+
read a font from specified file
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/ClassGraph.class b/doc/doc++/osgUtil/ClassGraph.class new file mode 100644 index 0000000000000000000000000000000000000000..c6a7b6c79eefb07545a0b85e767db0a34067477d GIT binary patch literal 1237 zcma)6*-{fh6g@+hnS_afK|w^^#V{;!Ux zT+h!a)b2v}DxTm%X4(`QsclfhP)G8~Xw_zCWBVEWk6WrC% z+sJ92m^PjDN?b#NZYz*X$O3b#R&t&NRAdse&V07V8-1gWC{c{gs#ZqSPrp^7-UQnZ z?KrFRIdy|VGDj%h1IMLHu6NL0Y^2g$ccS9+UGDq5ly|-mxv0;BhLH$3@hyHT`(9Ph z8e-%(i$Uk6j})Y#zB-aUWUpeHWQM#$#1J9v+E%27i#gj0lUlW{9#U(z6(uzjwyhB9 zZ@6IpLUKD)hgHKU*~a$7aCmacu3?aVLv;-Nz_4w9$8Zhjw_3)f8b&DB+_tnj`fIrS bmF6i%^l#B((N9`2jM#PbwZroS^x)|~2>C-7 literal 0 HcmV?d00001 diff --git a/doc/doc++/osgUtil/ClassGraphPanel.class b/doc/doc++/osgUtil/ClassGraphPanel.class new file mode 100644 index 0000000000000000000000000000000000000000..94b21b47a2a4b19b981fbe8827197a5d71dffc7a GIT binary patch literal 4084 zcmbtWX>eOt75<*}q^IS@c9f{CsBM;#)Rq&Qlwuk?DI`uC3{KL!~;QmGKkLv@kkI~3F3P}{5*)?2JsgIA2je` z10ON)2?OU1e8a$F1}+$Q+`tnCo;2{3fo~f4mVs{@_>O_^8hAR44!k~$D@F9+4PkU* zJdAGa3u7bphtQ4#B5nyGid)0jfP*rf5OJGC91`ttnBqtnSK#(Ax-coWDG^7-<&7c4 z@Ftla3*$w2vuH_)utH2eEfJ|Ou0~qmZHbtX)mag90-BLpj?3x^an6dEm(`p= zv^zq$3I!2G6Zd0T#Ct@%PsIC8d=~F8@i{zf;`1WPc+kWbuxR3oIAh{VIA!9?a7;Xk z(I?{#OhTeL4qxo#UFe27OlXZR}pR;q$NW+(m z=Bq~ek~+lRg0(Q0Nfi~!Rjn4>w2cXBF=Jzw)-2Ur-GDQ0-I*^r`>dQbYrD0^yjAt3 z2d0mc%8@>jbZw*Eqp^{cv7BQIMr+U3l{hUhFZH~9i?y(jwVlCTY8cJ4qGe~q4bRbj z=-{{_a`*G5t$MjJE#ao7T*|NUK$=4u`$M?awrB|K$mBB4jhu{X2#;p1Vo~jphK~AV zK)Slga*LI-vl=4G$K59l`e;6FYgosRE3(C%!&bJ$xwePMH!Y{^1&7C>NCVG`HcrR! zhH&mpr}t$%J#Kqyh+fLChW7D%%E}(L3K?rUYZI_zzqOc|wVZrmcgb<`Il>=g&WU`f zkg{*iWTgmpN!w8-jvlRNalM&&gJ*1Hh%v`_2(5HlgWsBQ>;l=EwrBDM!uhAOR_cTp z@}*pwB^c8xGc`Sx$~mMa#TDna{0ZIygd&J9ogsvt&M&dRkPN#Dh5V9+V7g!}jc0Pi z4cK>-tSkfkGnqn>Fxnh>nzM@gn6?TQn6oppb6gB$a%mn`B4lc8chqj6Di`fFi(-`& zG#I?2-E7P`7OP>gb^Z7;YM<~Zrs(`p93uJ|4ht%lqmqze#L3X3Mmqpw0Xbw@W9gQLjVQ8^5T~xO` zyRo#uwka)mfqJPR`)(}Cp*b+an%NotrA%6C(paE&H^7(lO3DcT`6NeMwq8j-es*&%d8u^l`k&h@xga7yAy~O<}!JmQ2mmS*0#2Q|b=#1^rK8{VMvZdewk#v>ee53f^prM4$lu$liVZikpAINPKwVFp(% z*DFhimh-r|f>#~ThCAZz6>NV98!w=HG9HMxui={EjxzKkzM)RKE7QRp{_N0teJC0?qiq!oK8S#CC`yMuNqGUClks)&j<`S88H>i&)22!pSi{RE5|i}M zldG(rA9~&CXQK%QbWE<{#Z#*os^GQ0p-34wBm^xMVd9q`@zl;9L5f8NIBZr++x^+( zTrASrGgraL$%qz29MM9!OU8YB+zDwF+mKkU5n-*^r%jb9VkFd*N`& z?uPVtN%rP&{_1nXeGjnjLxAr-vb2r=eLm8=YXz@N>$0JK-%z0JOULzCAQsS*(tU?Qx*F@L(I3otzg;z8wi+Gp1NWR3pHH`(pY=$mj|l6tys zywNjy_)^TCa@$i(&ju%HQ+3#;-1JvlSgq~9%2{qZ#soYsOmL{bt6I%vCy-(#p_IV- zbu|-;DtL9dt&P|`nZ(|Inb=K>u+XoW14HSa-L+fR6(g17#U zngzLmo2{2{gTFElZv%2OcbRz_zp(+k+Dr|m7U`ClE}+uQ*ExA^8>@ZeZO~XfZEF6% zw67bu^JJhc7KpPEw(IFL|2pMf5gLAqcY0@h5dr=I$NSIW+6rFd8`8_Tl~oL_;0Ax% zcOJvM?{>y?N;xLda+_m1Px4M`eM;*c_Q(Az7!&cj2nih82>HF?q-+mL1DoFse%e^QYffI4N#SGSZ!&wS_MV3O}6RQWH)X$EyY{w zecz&Z;B=;=pVVmsBQuVl^)K+B5ufMXBu$0P>~p`*{l59@-{1d01bc8X23tizg`;9d z#j`42Qt`5iS5&;J;x!cuDqdIdhKe^;yrtr874PV1$L%^|xI;%L4lqbFxKo3MyL3cx zw+P>yBgt;Cs{VCqXT2?`5_JK@i2pN15-G~;0%MDfhsHplLltt8kj@Yz*#(EV4m4? zs2F$-rwu&M)C(+o5fcX9W9oedAK);2HQ7PaF6Qj~e)#V|>Yquh{rJ zgRdEUgU1bAVCq{uVcUs8^>}l1wf#tZif3PK7Ye8GCZ%l6b>Kc*8=;Vx@3mQ&ZGCNY8nj-K2 zGp|=$k9j?Fv(LYSt0rVo z@V&WVdx|v5wCxn8nQ+AJQVz{EZ#rEotnW{&u(>~!PxE+q8R+UXC1GhJmTMJkpE}f3 zh#Nw8NeI?YN)=zQ!T1>ttxt{>#7y{^Uz84Q>um=M+n3RBI#%%xs0vT zX*rTsmN1brl^V8Z)VNy1?o5o)&Wskx& zph%{YxOnyFB*nXdLhYb0l?`J?uON1+Zy7hymn6?w!h7l4LXNVRu<;j4mVfk@RWD(d z+N+XehO<8$8Cb%ZRDu%z6LKaRk8;j(Ji3fNIWAMS93~shGb&!j&DpfV%EWn?rb5CU zi`bSl6>9bpx`ZUP2u(;*3lS-?{o>WdMu$IYwy}!_#vN9;q+MZ-65eg(C?%-P>uEL{ zM9K9;snJW=oiZs!ku2rM$trP$`j()mf*4qcN@kS8{u4>dOZYowl9jM0L$;^6P+78Q z-;ZdIt0B39eQ`yo7XF)mWhr!`Z%040*vm{02*i<;0KkC}q*6CIis4)QD5 zzXUTLW1~J(3r9sl3P3a7Z-x;$gG62~W^1_RH{5y!ou^FsGWsuJQs_8(Zl|D6Z9j5;Sf~rkj literal 0 HcmV?d00001 diff --git a/doc/doc++/osgUtil/CombineLODsVisitor.html b/doc/doc++/osgUtil/CombineLODsVisitor.html new file mode 100644 index 000000000..977329092 --- /dev/null +++ b/doc/doc++/osgUtil/CombineLODsVisitor.html @@ -0,0 +1,79 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::CombineLODsVisitor + + + + +

class OSGUTIL_EXPORT CombineLODsVisitor

Optimize the LOD groups, by combining adjacent LOD's which have complementary ranges
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]GroupList _groupList +

+ +

+

Public Methods

+[more] CombineLODsVisitor() +
+[more]virtual void apply(osg::LOD& lod) +
+[more]void combineLODs() +

+ +

+

Public Members

+[more]typedef std::set<osg::Group*> GroupList +

+ +
+ + +
+

Documentation

+
Optimize the LOD groups, by combining adjacent LOD's which have +complementary ranges
+
+ + + +
otypedef std::set<osg::Group*> GroupList +

+ + +

oGroupList _groupList +

+ + +

o CombineLODsVisitor() +

+ + +

ovirtual void apply(osg::LOD& lod) +

+ + +

ovoid combineLODs() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/ConvertGeoSetsToGeometryVisitor.html b/doc/doc++/osgUtil/ConvertGeoSetsToGeometryVisitor.html new file mode 100644 index 000000000..aeb85fdba --- /dev/null +++ b/doc/doc++/osgUtil/ConvertGeoSetsToGeometryVisitor.html @@ -0,0 +1,60 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::ConvertGeoSetsToGeometryVisitor + + + + +

class OSGUTIL_EXPORT ConvertGeoSetsToGeometryVisitor

ConvertGeoSetsToGeometryVisitor all the old GeoSet Drawables to the new Geometry Drawables
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] ConvertGeoSetsToGeometryVisitor() +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Node& node) +

+ +
+ + +
+

Documentation

+
ConvertGeoSetsToGeometryVisitor all the old GeoSet Drawables to the new Geometry Drawables
+
+ + + +
o ConvertGeoSetsToGeometryVisitor() +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Node& node) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/CubeMapGenerator.html b/doc/doc++/osgUtil/CubeMapGenerator.html new file mode 100644 index 000000000..115ef23f2 --- /dev/null +++ b/doc/doc++/osgUtil/CubeMapGenerator.html @@ -0,0 +1,125 @@ + + + + + class OSGUTIL_EXPORT osgUtil::CubeMapGenerator + + + + +

class OSGUTIL_EXPORT osgUtil::CubeMapGenerator

This is the base class for cube map generators.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]explicit CubeMapGenerator(int texture_size = 64) +
+[more] CubeMapGenerator(const CubeMapGenerator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]void generateMap(bool use_osg_system = true) +
generate the six cube images. +
+[more]inline osg::Image* getImage(osg::TextureCubeMap::Face face) +
+[more]inline const osg::Image* getImage(osg::TextureCubeMap::Face face) const +
+[more]inline void set_pixel(int index, int c, int r, const osg::Vec4 &color) +
+[more]inline osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +

+

Protected Methods

+[more]virtual ~CubeMapGenerator() +
+[more]CubeMapGenerator& operator=(const CubeMapGenerator &) +
+[more]inline static osg::Vec4 vector_to_color(const osg::Vec3 &vec) +
+[more]virtual osg::Vec4 compute_color(const osg::Vec3 &R) const = 0 +
override this method to define how colors are computed. +

+ +
+ + +
+

Documentation

+
This is the base class for cube map generators. +It exposes the necessary interface to access the six generated images; +descendants should only override the compute_color() method.
+
+ + + +
oexplicit CubeMapGenerator(int texture_size = 64) +

+ + +

o CubeMapGenerator(const CubeMapGenerator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovoid generateMap(bool use_osg_system = true) +
generate the six cube images. +If use_osg_system is true, then the OSG's coordinate system is used instead +of the default OpenGL one. +

+ + +

ovirtual ~CubeMapGenerator() +

+ + +

oCubeMapGenerator& operator=(const CubeMapGenerator &) +

+ + +

oinline static osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ + +

ovirtual osg::Vec4 compute_color(const osg::Vec3 &R) const = 0 +
override this method to define how colors are computed. +The parameter R is the reflection vector, pointing from the center of the cube. +The return value should be the RGBA color associated with that reflection ray. +

+ + +

oinline osg::Image* getImage(osg::TextureCubeMap::Face face) +

+ + +

oinline const osg::Image* getImage(osg::TextureCubeMap::Face face) const +

+ + +

oinline void set_pixel(int index, int c, int r, const osg::Vec4 &color) +

+ + +

oinline osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+
+
Direct child classes: +
ReflectionMapGenerator
+HighlightMapGenerator
+HalfWayMapGenerator
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/CullVisitor.html b/doc/doc++/osgUtil/CullVisitor.html new file mode 100644 index 000000000..a6a543499 --- /dev/null +++ b/doc/doc++/osgUtil/CullVisitor.html @@ -0,0 +1,612 @@ + + + + + class OSGUTIL_EXPORT osgUtil::CullVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::CullVisitor

Basic NodeVisitor implementation for rendering a scene. Basic NodeVisitor implementation for rendering a scene.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] CullVisitor() +
+[more]virtual ~CullVisitor() +
+[more]virtual CullVisitor* cloneType() const +
+[more]virtual void reset() +
+[more]virtual osg::Vec3 getEyePoint() const +
+[more]virtual float getDistanceToEyePoint(const osg::Vec3& pos, bool withLODScale) const +
+[more]virtual float getDistanceFromEyePoint(const osg::Vec3& pos, bool withLODScale) const +
+[more]virtual void apply(osg::Node&) +
+[more]virtual void apply(osg::Geode& node) +
+[more]virtual void apply(osg::Billboard& node) +
+[more]virtual void apply(osg::LightSource& node) +
+[more]virtual void apply(osg::ClipNode& node) +
+[more]virtual void apply(osg::Group& node) +
+[more]virtual void apply(osg::Transform& node) +
+[more]virtual void apply(osg::Projection& node) +
+[more]virtual void apply(osg::Switch& node) +
+[more]virtual void apply(osg::LOD& node) +
+[more]virtual void apply(osg::ClearNode& node) +
+[more]virtual void apply(osg::OccluderNode& node) +
+[more]virtual void apply(osg::Impostor& node) +
+[more]void setClearNode(const osg::ClearNode* earthSky) +
+[more]const osg::ClearNode* getClearNode() const +
+[more]void setImpostorsActive(bool active) +
Switch the creation of Impostors on or off.Switch the creation of Impostors on or off. +
+[more]bool getImpostorsActive() const +
Get whether impostors are active or not.Get whether impostors are active or not. +
+[more]void setImpostorPixelErrorThreshold(float numPixels) +
Set the impostor error threshold.Set the impostor error threshold. +
+[more]float getImpostorPixelErrorThreshold() const +
Get the impostor error thresholdGet the impostor error threshold +
+[more]void setDepthSortImpostorSprites(bool doDepthSort) +
Set whether ImpsotorSprite's should be placed in a depth sorted bin for renderingSet whether ImpsotorSprite's should be placed in a depth sorted bin for rendering +
+[more]bool setDepthSortImpostorSprites() const +
Get whether ImpsotorSprite's are depth sorted bin for renderingGet whether ImpsotorSprite's are depth sorted bin for rendering +
+[more]void setNumberOfFrameToKeepImpostorSprites(int numFrames) +
Set the number of frames that an ImpsotorSprite's is kept whilst not being beyond, before being recycledSet the number of frames that an ImpsotorSprite's is kept whilst not being beyond, before being recycled +
+[more]int getNumberOfFrameToKeepImpostorSprites() const +
Get the number of frames that an ImpsotorSprite's is kept whilst not being beyond, before being recycledGet the number of frames that an ImpsotorSprite's is kept whilst not being beyond, before being recycled +
+[more]void setComputeNearFarMode(ComputeNearFarMode cnfm) +
+[more]ComputeNearFarMode getComputeNearFarMode() const +
+[more]inline void pushStateSet(const osg::StateSet* ss) +
Push state set on the current state group.Push state set on the current state group. +
+[more]inline void popStateSet() +
Pop the top state set and hence associated state group.Pop the top state set and hence associated state group. +
+[more]inline void setRenderGraph(RenderGraph* rg) +
+[more]inline RenderGraph* getRootRenderGraph() +
+[more]inline RenderGraph* getCurrentRenderGraph() +
+[more]inline void setRenderStage(RenderStage* rg) +
+[more]inline RenderStage* getRenderStage() +
+[more]inline RenderBin* getCurrentRenderBin() +
+[more]inline void setCurrentRenderBin(RenderBin* rb) +
+[more]inline float getCalculatedNearPlane() const +
+[more]inline float getCalculatedFarPlane() const +
+[more]void updateCalculatedNearFar(const osg::Matrix& matrix, const osg::Drawable& drawable) +
+[more]void updateCalculatedNearFar(const osg::Matrix& matrix, const osg::BoundingBox& bb) +
+[more]void updateCalculatedNearFar(const osg::Vec3& pos) +
+[more]virtual void popProjectionMatrix() +
reimplement CullStack's popProjectionMatrix() adding clamping of the projection matrix to the computed near and farreimplement CullStack's popProjectionMatrix() adding clamping of the projection matrix to the computed near and far +
+[more]void setState(osg::State* state) +
+[more]osg::State* getState() +
+[more]const osg::State* getState() const +
+[more]inline void addDrawable(osg::Drawable* drawable, osg::RefMatrix* matrix) +
Add a drawable to current render graphAdd a drawable to current render graph +
+[more]inline void addDrawableAndDepth(osg::Drawable* drawable, osg::RefMatrix* matrix, float depth) +
Add a drawable and depth to current render graphAdd a drawable and depth to current render graphAdd a drawable and depth to current render graphAdd a drawable and depth to current render graph +
+[more]inline void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +
Add an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrix +
+[more]inline RenderLeaf* createOrReuseRenderLeaf(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* matrix, float depth) +

+ +

+

Public Members

+[more]enum ComputeNearFarMode +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::StateSet> _localPreRenderState +
+[more]osg::ref_ptr<RenderGraph> _rootRenderGraph +
+[more]RenderGraph* _currentRenderGraph +
+[more]osg::ref_ptr<RenderStage> _rootRenderStage +
+[more]RenderBin* _currentRenderBin +
+[more]ComputeNearFarMode _computeNearFar +
+[more]float _computed_znear +
+[more]float _computed_zfar +
+[more]osg::ref_ptr<const osg::ClearNode> _clearNode +
+[more]bool _impostorActive +
+[more]bool _depthSortImpostorSprites +
+[more]float _impostorPixelErrorThreshold +
+[more]int _numFramesToKeepImpostorSprites +
+[more]RenderLeafList _reuseRenderLeafList +
+[more]unsigned int _currentReuseRenderLeafIndex +
+[more]osg::ref_ptr<osg::ImpostorSpriteManager> _impostorSpriteManager +
+[more]osg::ref_ptr<osg::State> _state +

+ +

+

Protected Methods

+[more] CullVisitor(const CullVisitor&) +
prevent unwanted copy constructionprevent unwanted copy construction +
+[more]CullVisitor& operator = (const CullVisitor&) +
prevent unwanted copy operatorprevent unwanted copy operator +
+[more]inline void handle_cull_callbacks_and_traverse(osg::Node& node) +
+[more]inline void handle_cull_callbacks_and_accept(osg::Node& node, osg::Node* acceptNode) +
+[more]osg::ImpostorSprite* createImpostorSprite(osg::Impostor& node) +
create an impostor sprite by setting up a pre-rendering stage to generate the impostor texture.create an impostor sprite by setting up a pre-rendering stage to generate the impostor texture. +

+ +

+

Protected Members

+[more]typedef std::vector< osg::ref_ptr<RenderLeaf> > RenderLeafList +

+ +
+ + +
+

Documentation

+
+Basic NodeVisitor implementation for rendering a scene. +This visitor traverses the scene graph, collecting transparent and +opaque osg::Drawables into a depth sorted transparent bin and a state +sorted opaque bin. The opaque bin is rendered first, and then the +transparent bin in rendered in order from the furthest osg::Drawable +from the eye to the one nearest the eye. +Basic NodeVisitor implementation for rendering a scene. +This visitor traverses the scene graph, collecting transparent and +opaque osg::Drawables into a depth sorted transparent bin and a state +sorted opaque bin. The opaque bin is rendered first, and then the +transparent bin in rendered in order from the furthest osg::Drawable +from the eye to the one nearest the eye.
+
+ + + +
oosg::ref_ptr<osg::StateSet> _localPreRenderState +

+ + +

o CullVisitor() +

+ + +

ovirtual ~CullVisitor() +

+ + +

ovirtual CullVisitor* cloneType() const +

+ + +

ovirtual void reset() +

+ + +

ovirtual osg::Vec3 getEyePoint() const +

+ + +

ovirtual float getDistanceToEyePoint(const osg::Vec3& pos, bool withLODScale) const +

+ + +

ovirtual float getDistanceFromEyePoint(const osg::Vec3& pos, bool withLODScale) const +

+ + +

ovirtual void apply(osg::Node&) +

+ + +

ovirtual void apply(osg::Geode& node) +

+ + +

ovirtual void apply(osg::Billboard& node) +

+ + +

ovirtual void apply(osg::LightSource& node) +

+ + +

ovirtual void apply(osg::ClipNode& node) +

+ + +

ovirtual void apply(osg::Group& node) +

+ + +

ovirtual void apply(osg::Transform& node) +

+ + +

ovirtual void apply(osg::Projection& node) +

+ + +

ovirtual void apply(osg::Switch& node) +

+ + +

ovirtual void apply(osg::LOD& node) +

+ + +

ovirtual void apply(osg::ClearNode& node) +

+ + +

ovirtual void apply(osg::OccluderNode& node) +

+ + +

ovirtual void apply(osg::Impostor& node) +

+ + +

ovoid setClearNode(const osg::ClearNode* earthSky) +

+ + +

oconst osg::ClearNode* getClearNode() const +

+ + +

ovoid setImpostorsActive(bool active) +
Switch the creation of Impostors on or off. +Setting active to false forces the CullVisitor to use the Impostor +LOD children for rendering. Setting active to true forces the +CullVisitor to create the appropriate pre-rendering stages which +render to the ImpostorSprite's texture.Switch the creation of Impostors on or off. +Setting active to false forces the CullVisitor to use the Impostor +LOD children for rendering. Setting active to true forces the +CullVisitor to create the appropriate pre-rendering stages which +render to the ImpostorSprite's texture. +

+ + +

obool getImpostorsActive() const +
Get whether impostors are active or not. Get whether impostors are active or not. +

+ + +

ovoid setImpostorPixelErrorThreshold(float numPixels) +
Set the impostor error threshold. +Used in calculation of whether impostors remain valid.Set the impostor error threshold. +Used in calculation of whether impostors remain valid. +

+ + +

ofloat getImpostorPixelErrorThreshold() const +
Get the impostor error thresholdGet the impostor error threshold +

+ + +

ovoid setDepthSortImpostorSprites(bool doDepthSort) +
Set whether ImpsotorSprite's should be placed in a depth sorted bin for renderingSet whether ImpsotorSprite's should be placed in a depth sorted bin for rendering +

+ + +

obool setDepthSortImpostorSprites() const +
Get whether ImpsotorSprite's are depth sorted bin for renderingGet whether ImpsotorSprite's are depth sorted bin for rendering +

+ + +

ovoid setNumberOfFrameToKeepImpostorSprites(int numFrames) +
Set the number of frames that an ImpsotorSprite's is kept whilst not being beyond, +before being recycledSet the number of frames that an ImpsotorSprite's is kept whilst not being beyond, +before being recycled +

+ + +

oint getNumberOfFrameToKeepImpostorSprites() const +
Get the number of frames that an ImpsotorSprite's is kept whilst not being beyond, +before being recycledGet the number of frames that an ImpsotorSprite's is kept whilst not being beyond, +before being recycled +

+ + +

oenum ComputeNearFarMode +

+ + + +
o DO_NOT_COMPUTE_NEAR_FAR +

+ + +

o COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES +

+ + +

o COMPUTE_NEAR_FAR_USING_PRIMITIVES +

+ + + +
ovoid setComputeNearFarMode(ComputeNearFarMode cnfm) +

+ + +

oComputeNearFarMode getComputeNearFarMode() const +

+ + +

oinline void pushStateSet(const osg::StateSet* ss) +
Push state set on the current state group. +If the state exists in a child state group of the current +state group then move the current state group to that child. +Otherwise, create a new state group for the state set, add +it to the current state group then move the current state +group pointer to the new state group.Push state set on the current state group. +If the state exists in a child state group of the current +state group then move the current state group to that child. +Otherwise, create a new state group for the state set, add +it to the current state group then move the current state +group pointer to the new state group. +

+ + +

oinline void popStateSet() +
Pop the top state set and hence associated state group. +Move the current state group to the parent of the popped +state group.Pop the top state set and hence associated state group. +Move the current state group to the parent of the popped +state group. +

+ + +

oinline void setRenderGraph(RenderGraph* rg) +

+ + +

oinline RenderGraph* getRootRenderGraph() +

+ + +

oinline RenderGraph* getCurrentRenderGraph() +

+ + +

oinline void setRenderStage(RenderStage* rg) +

+ + +

oinline RenderStage* getRenderStage() +

+ + +

oinline RenderBin* getCurrentRenderBin() +

+ + +

oinline void setCurrentRenderBin(RenderBin* rb) +

+ + +

oinline float getCalculatedNearPlane() const +

+ + +

oinline float getCalculatedFarPlane() const +

+ + +

ovoid updateCalculatedNearFar(const osg::Matrix& matrix, const osg::Drawable& drawable) +

+ + +

ovoid updateCalculatedNearFar(const osg::Matrix& matrix, const osg::BoundingBox& bb) +

+ + +

ovoid updateCalculatedNearFar(const osg::Vec3& pos) +

+ + +

ovirtual void popProjectionMatrix() +
reimplement CullStack's popProjectionMatrix() adding clamping of the projection matrix to the computed near and farreimplement CullStack's popProjectionMatrix() adding clamping of the projection matrix to the computed near and far +

+ + +

ovoid setState(osg::State* state) +

+ + +

oosg::State* getState() +

+ + +

oconst osg::State* getState() const +

+ + +

o CullVisitor(const CullVisitor&) +
prevent unwanted copy constructionprevent unwanted copy construction +

+ + +

oCullVisitor& operator = (const CullVisitor&) +
prevent unwanted copy operatorprevent unwanted copy operator +

+ + +

oinline void handle_cull_callbacks_and_traverse(osg::Node& node) +

+ + +

oinline void handle_cull_callbacks_and_accept(osg::Node& node, osg::Node* acceptNode) +

+ + +

oosg::ImpostorSprite* createImpostorSprite(osg::Impostor& node) +
create an impostor sprite by setting up a pre-rendering stage +to generate the impostor texture. create an impostor sprite by setting up a pre-rendering stage +to generate the impostor texture. +

+ + +

oosg::ref_ptr<RenderGraph> _rootRenderGraph +

+ + +

oRenderGraph* _currentRenderGraph +

+ + +

oosg::ref_ptr<RenderStage> _rootRenderStage +

+ + +

oRenderBin* _currentRenderBin +

+ + +

oComputeNearFarMode _computeNearFar +

+ + +

ofloat _computed_znear +

+ + +

ofloat _computed_zfar +

+ + +

oosg::ref_ptr<const osg::ClearNode> _clearNode +

+ + +

obool _impostorActive +

+ + +

obool _depthSortImpostorSprites +

+ + +

ofloat _impostorPixelErrorThreshold +

+ + +

oint _numFramesToKeepImpostorSprites +

+ + +

otypedef std::vector< osg::ref_ptr<RenderLeaf> > RenderLeafList +

+ + +

oRenderLeafList _reuseRenderLeafList +

+ + +

ounsigned int _currentReuseRenderLeafIndex +

+ + +

oosg::ref_ptr<osg::ImpostorSpriteManager> _impostorSpriteManager +

+ + +

oosg::ref_ptr<osg::State> _state +

+ + +

oinline void addDrawable(osg::Drawable* drawable, osg::RefMatrix* matrix) +
Add a drawable to current render graphAdd a drawable to current render graph +

+ + +

oinline void addDrawableAndDepth(osg::Drawable* drawable, osg::RefMatrix* matrix, float depth) +
Add a drawable and depth to current render graphAdd a drawable and depth to current render graphAdd a drawable and depth to current render graphAdd a drawable and depth to current render graph +

+ + +

oinline void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +
Add an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrixAdd an attribute which is positioned related to the modelview matrix +

+ + +

oinline RenderLeaf* createOrReuseRenderLeaf(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* matrix, float depth) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/DelaunayTriangulator.html b/doc/doc++/osgUtil/DelaunayTriangulator.html new file mode 100644 index 000000000..501810c08 --- /dev/null +++ b/doc/doc++/osgUtil/DelaunayTriangulator.html @@ -0,0 +1,150 @@ + + + + + class OSGUTIL_EXPORT osgUtil::DelaunayTriangulator + + + + +

class OSGUTIL_EXPORT osgUtil::DelaunayTriangulator

Utility class that triangulates an irregolar network of sample points.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DelaunayTriangulator() +
+[more]explicit DelaunayTriangulator(osg::Vec3Array* points, osg::Vec3Array* normals = 0) +
+[more] DelaunayTriangulator(const DelaunayTriangulator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]bool triangulate() +
Start triangulation +
+[more]inline const osg::Vec3Array* getInputPointArray() const +
Get the const input point array +
+[more]inline osg::Vec3Array* getInputPointArray() +
Get the input point array +
+[more]inline void setInputPointArray(osg::Vec3Array* points) +
Set the input point array +
+[more]inline const osg::Vec3Array* getOutputNormalArray() const +
Get the const output normal array (optional) +
+[more]inline osg::Vec3Array* getOutputNormalArray() +
Get the output normal array (optional) +
+[more]inline void setOutputNormalArray(osg::Vec3Array* normals) +
Set the output normal array (optional) +
+[more]inline const osg::DrawElementsUInt* getTriangles() const +
Get the generated primitive (call triangulate() first) +
+[more]inline osg::DrawElementsUInt* getTriangles() +
Get the generated primitive (call triangulate() first) +

+ +

+

Protected Methods

+[more]virtual ~DelaunayTriangulator() +
+[more]DelaunayTriangulator& operator=(const DelaunayTriangulator &) +

+ +
+ + +
+

Documentation

+
Utility class that triangulates an irregolar network of sample points. +Just create a DelaunayTriangulator, assign it the sample point array and call +its triangulate() method to start the triangulation. Then you can obtain the +generated primitive by calling the getTriangles() method.
+
+ + + +
o DelaunayTriangulator() +

+ + +

oexplicit DelaunayTriangulator(osg::Vec3Array* points, osg::Vec3Array* normals = 0) +

+ + +

o DelaunayTriangulator(const DelaunayTriangulator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

obool triangulate() +
Start triangulation +

+ + +

ovirtual ~DelaunayTriangulator() +

+ + +

oDelaunayTriangulator& operator=(const DelaunayTriangulator &) +

+ + +

oinline const osg::Vec3Array* getInputPointArray() const +
Get the const input point array +

+ + +

oinline osg::Vec3Array* getInputPointArray() +
Get the input point array +

+ + +

oinline void setInputPointArray(osg::Vec3Array* points) +
Set the input point array +

+ + +

oinline const osg::Vec3Array* getOutputNormalArray() const +
Get the const output normal array (optional) +

+ + +

oinline osg::Vec3Array* getOutputNormalArray() +
Get the output normal array (optional) +

+ + +

oinline void setOutputNormalArray(osg::Vec3Array* normals) +
Set the output normal array (optional) +

+ + +

oinline const osg::DrawElementsUInt* getTriangles() const +
Get the generated primitive (call triangulate() first) +

+ + +

oinline osg::DrawElementsUInt* getTriangles() +
Get the generated primitive (call triangulate() first) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/DisplayListVisitor.html b/doc/doc++/osgUtil/DisplayListVisitor.html new file mode 100644 index 000000000..f829055da --- /dev/null +++ b/doc/doc++/osgUtil/DisplayListVisitor.html @@ -0,0 +1,151 @@ + + + + + class OSGUTIL_EXPORT osgUtil::DisplayListVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::DisplayListVisitor

Visitor for traversing scene graph and setting each osg::Drawable's _useDisplayList flag, with option to immediately compile osg::Drawable OpenGL Display lists and osg::StateAttribute's
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DisplayListVisitor(Mode mode=COMPILE_DISPLAY_LISTS|COMPILE_STATE_ATTRIBUTES) +
Construct a DisplayListVisior to traverse all child, with set specified display list mode. +
+[more]void setMode(Mode mode) +
Set the operational mode of how the visitor should set up osg::Drawable's +
+[more]Mode getMode() const +
Get the operational mode +
+[more]void setState(osg::State* state) +
Set the State to use during traversal. +
+[more]osg::State* getState() +
+[more]virtual void apply(osg::Node& node) +
Simply traverse using standard NodeVisitor traverse method +
+[more]virtual void apply(osg::Geode& node) +
For each Geode visited set the display list usage according to the _displayListMode +

+ +

+

Public Members

+[more]enum ModeValues +
Operation modes of the +
+[more]typedef unsigned int Mode +

+ +

+

Protected Fields

+[more]Mode _mode +
+[more]osg::ref_ptr<osg::State> _state +

+ +
+ + +
+

Documentation

+
Visitor for traversing scene graph and setting each osg::Drawable's _useDisplayList flag, +with option to immediately compile osg::Drawable OpenGL Display lists and +osg::StateAttribute's
+
+ + + +
oenum ModeValues +
Operation modes of the +

+ + + +
o SWITCH_ON_DISPLAY_LISTS +

+ + +

o SWITCH_OFF_DISPLAY_LISTS +

+ + +

o COMPILE_DISPLAY_LISTS +

+ + +

o COMPILE_STATE_ATTRIBUTES +

+ + + +
otypedef unsigned int Mode +

+ + +

o DisplayListVisitor(Mode mode=COMPILE_DISPLAY_LISTS|COMPILE_STATE_ATTRIBUTES) +
Construct a DisplayListVisior to traverse all child, +with set specified display list mode. Default mode is to +gset->setUseDisplayList(true). +

+ + +

ovoid setMode(Mode mode) +
Set the operational mode of how the visitor should set up osg::Drawable's +

+ + +

oMode getMode() const +
Get the operational mode +

+ + +

ovoid setState(osg::State* state) +
Set the State to use during traversal. +

+ + +

oosg::State* getState() +

+ + +

ovirtual void apply(osg::Node& node) +
Simply traverse using standard NodeVisitor traverse method +

+ + +

ovirtual void apply(osg::Geode& node) +
For each Geode visited set the display list usage according to the +_displayListMode +

+ + +

oMode _mode +

+ + +

oosg::ref_ptr<osg::State> _state +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/DisplayRequirementsVisitor.html b/doc/doc++/osgUtil/DisplayRequirementsVisitor.html new file mode 100644 index 000000000..95da0b89b --- /dev/null +++ b/doc/doc++/osgUtil/DisplayRequirementsVisitor.html @@ -0,0 +1,104 @@ + + + + + class OSGUTIL_EXPORT osgUtil::DisplayRequirementsVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::DisplayRequirementsVisitor

A visitor for traversing a scene graph establishing the OpenGL visuals are required to support rendering of that scene graph.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] DisplayRequirementsVisitor() +
Default to traversing all children, and reqiresDoubleBuffer, requiresRGB and requiresDepthBuffer to true and with alpha and stencil off +
+[more]inline void setDisplaySettings(osg::DisplaySettings* ds) +
Set the DisplaySettings. +
+[more]inline const osg::DisplaySettings* getDisplaySettings() const +
Get the DisplaySettings +
+[more]virtual void applyStateSet(osg::StateSet& stateset) +
+[more]virtual void apply(osg::Node& node) +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Impostor& impostor) +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::DisplaySettings> _ds +

+ +
+ + +
+

Documentation

+
A visitor for traversing a scene graph establishing the OpenGL visuals are required +to support rendering of that scene graph. The results can then be used by +applications to set up there windows with the correct visuals. Have a look at +src/osgGLUT/Viewer.cpp's Viewer::open() method for an example how to use it.
+
+ + + +
o DisplayRequirementsVisitor() +
Default to traversing all children, and reqiresDoubleBuffer, +requiresRGB and requiresDepthBuffer to true and with +alpha and stencil off +

+ + +

oinline void setDisplaySettings(osg::DisplaySettings* ds) +
Set the DisplaySettings. +

+ + +

oinline const osg::DisplaySettings* getDisplaySettings() const +
Get the DisplaySettings +

+ + +

ovirtual void applyStateSet(osg::StateSet& stateset) +

+ + +

ovirtual void apply(osg::Node& node) +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Impostor& impostor) +

+ + +

oosg::ref_ptr<osg::DisplaySettings> _ds +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/FlattenStaticTransformsVisitor.html b/doc/doc++/osgUtil/FlattenStaticTransformsVisitor.html new file mode 100644 index 000000000..34b1519fa --- /dev/null +++ b/doc/doc++/osgUtil/FlattenStaticTransformsVisitor.html @@ -0,0 +1,128 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::FlattenStaticTransformsVisitor + + + + +

class OSGUTIL_EXPORT FlattenStaticTransformsVisitor

Flatten Static Trasform nodes by applying their transform to the geometry on the leaves of the scene graph, then removing the now redundant transforms
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] FlattenStaticTransformsVisitor() +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Billboard& geode) +
+[more]virtual void apply(osg::Transform& transform) +
+[more]bool removeTransforms(osg::Node* nodeWeCannotRemove) +

+ +

+

Protected Fields

+[more]TransformStack _transformStack +
+[more]DrawableSet _drawableSet +
+[more]BillboardSet _billboardSet +
+[more]TransformSet _transformSet +

+ +

+

Protected Members

+[more]typedef std::vector<osg::Transform*> TransformStack +
+[more]typedef std::set<osg::Drawable*> DrawableSet +
+[more]typedef std::set<osg::Billboard*> BillboardSet +
+[more]typedef std::set<osg::Transform*> TransformSet +

+ +
+ + +
+

Documentation

+
Flatten Static Trasform nodes by applying their transform to the +geometry on the leaves of the scene graph, then removing the +now redundant transforms
+
+ + + +
o FlattenStaticTransformsVisitor() +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Billboard& geode) +

+ + +

ovirtual void apply(osg::Transform& transform) +

+ + +

obool removeTransforms(osg::Node* nodeWeCannotRemove) +

+ + +

otypedef std::vector<osg::Transform*> TransformStack +

+ + +

otypedef std::set<osg::Drawable*> DrawableSet +

+ + +

otypedef std::set<osg::Billboard*> BillboardSet +

+ + +

otypedef std::set<osg::Transform*> TransformSet +

+ + +

oTransformStack _transformStack +

+ + +

oDrawableSet _drawableSet +

+ + +

oBillboardSet _billboardSet +

+ + +

oTransformSet _transformSet +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/General.html b/doc/doc++/osgUtil/General.html new file mode 100644 index 000000000..4761d5712 --- /dev/null +++ b/doc/doc++/osgUtil/General.html @@ -0,0 +1,109 @@ + + + + + General Bits + + + + +
+
+ +o#define +OSGUTIL_CUBEMAPGENERATOR_
+ +o#define +OSGUTIL_DELAUNAYTRIANGULATOR_
+ +o#define +OSGUTIL_DISPLAYLISTVISITOR
+ +o#define +OSGUTIL_DISPLAYREQUIREMENTSVISITOR
+ +o#define +OSGUTIL_EXPORT_
+ +o#define +OSGUTIL_EXPORT(dllexport)
+ +o#define +OSGUTIL_EXPORT(dllimport)
+ +o#define +OSGUTIL_EXPORT
+ +o#define +OSGUTIL_HALFWAYMAPGENERATOR_
+ +o#define +OSGUTIL_HIGHLIGHTMAPGENERATOR_
+ +o#define +OSGUTIL_INSERTIMPOSTORSVISITOR
+ +o#define +OSGUTIL_INTERSECTVISITOR
+ +o#define +OSGUTIL_OPTIMIZER
+ +o#define +OSGUTIL_PICKINTERSECTVISITOR
+ +o#define +OSGUTIL_REFLECTIONMAPGENERATOR_
+ +o#define +OSGUTIL_RENDERBIN
+ +onamespace +osg
+ +o#define +OSGUTIL_RENDERGRAPH
+ +o#define +OSGUTIL_RENDERLEAF
+ +o#define +OSGUTIL_RENDERSTAGE
+ +o#define +OSGUTIL_RENDERSTAGELIGHTING
+ +o#define +OSGUTIL_RENDERTOTEXTURESTAGE
+ +o#define +OSGUTIL_SCENEVIEW
+ +o#define +OSGUTIL_SMOOTHINGVISITOR
+ +o#define +OSGUTIL_Tesselator
+ +o#define +CALLBACK
+ +o#define +OSGUTIL_TRANSFORMCALLBACK
+ +o#define +OSGUTIL_TRISTRIPVISITOR
+ +o#define +OSGUTIL_UPDATEVISITOR
+ +o#define +OSGUTIL_VERSION
+ +o#define +OSGUTIL_CULLVISITOR
+

Alphabetic index Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/HIER.html b/doc/doc++/osgUtil/HIER.html new file mode 100644 index 000000000..52ff96184 --- /dev/null +++ b/doc/doc++/osgUtil/HIER.html @@ -0,0 +1,59 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of Classes

+ +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/HIERjava.html b/doc/doc++/osgUtil/HIERjava.html new file mode 100644 index 000000000..ca003e5a5 --- /dev/null +++ b/doc/doc++/osgUtil/HIERjava.html @@ -0,0 +1,219 @@ + + + + + Hierarchy of Classes + + + +

Hierarchy of classes

+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/HalfWayMapGenerator.html b/doc/doc++/osgUtil/HalfWayMapGenerator.html new file mode 100644 index 000000000..4efbfb5f6 --- /dev/null +++ b/doc/doc++/osgUtil/HalfWayMapGenerator.html @@ -0,0 +1,105 @@ + + + + + class OSGUTIL_EXPORT osgUtil::HalfWayMapGenerator + + + + +

class OSGUTIL_EXPORT osgUtil::HalfWayMapGenerator

This cube map generator produces an Half-way vector map, useful for hardware-based specular lighting effects.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] HalfWayMapGenerator(const osg::Vec3 &light_direction, int texture_size = 64) +
+[more] HalfWayMapGenerator(const HalfWayMapGenerator &copy, const osg::CopyOp &copyop) +
+[more]inline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +

+

Protected Methods

+[more]virtual ~HalfWayMapGenerator() +
+[more]HalfWayMapGenerator& operator=(const HalfWayMapGenerator &) +
+[more]inline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
+

Inherited from CubeMapGenerator:

+
+

+

Public Methods

+ovoid generateMap(bool use_osg_system = true) +
+oinline osg::Image* getImage(osg::TextureCubeMap::Face face) +
+oinline const osg::Image* getImage(osg::TextureCubeMap::Face face) const +
+oinline void set_pixel(int index, int c, int r, const osg::Vec4 &color) +
+oinline osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +

+

Protected Methods

+oinline static osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +
+ + +
+

Documentation

+
This cube map generator produces an Half-way vector map, useful for +hardware-based specular lighting effects. +It computes: C = normalize(R - L), where C is the resulting color, +R is the reflection vector and L is the light direction.
+
+ + + +
o HalfWayMapGenerator(const osg::Vec3 &light_direction, int texture_size = 64) +

+ + +

o HalfWayMapGenerator(const HalfWayMapGenerator &copy, const osg::CopyOp &copyop) +

+ + +

ovirtual ~HalfWayMapGenerator() +

+ + +

oHalfWayMapGenerator& operator=(const HalfWayMapGenerator &) +

+ + +

oinline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ + +

oinline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/HighlightMapGenerator.html b/doc/doc++/osgUtil/HighlightMapGenerator.html new file mode 100644 index 000000000..bb044e59f --- /dev/null +++ b/doc/doc++/osgUtil/HighlightMapGenerator.html @@ -0,0 +1,105 @@ + + + + + class OSGUTIL_EXPORT osgUtil::HighlightMapGenerator + + + + +

class OSGUTIL_EXPORT osgUtil::HighlightMapGenerator

This cube map generator produces a specular highlight map.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] HighlightMapGenerator( const osg::Vec3 &light_direction, const osg::Vec4 &light_color, float specular_exponent, int texture_size = 64) +
+[more] HighlightMapGenerator(const HighlightMapGenerator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +
+[more]inline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +

+

Protected Methods

+[more]virtual ~HighlightMapGenerator() +
+[more]HighlightMapGenerator& operator=(const HighlightMapGenerator &) +
+[more]inline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
+

Inherited from CubeMapGenerator:

+
+

+

Public Methods

+ovoid generateMap(bool use_osg_system = true) +
+oinline osg::Image* getImage(osg::TextureCubeMap::Face face) +
+oinline const osg::Image* getImage(osg::TextureCubeMap::Face face) const +
+oinline void set_pixel(int index, int c, int r, const osg::Vec4 &color) +
+oinline osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +

+

Protected Methods

+oinline static osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +
+ + +
+

Documentation

+
This cube map generator produces a specular highlight map. +The vector-color association is: C = (R dot (-L)) ^ n, where C is the +resulting color, R is the reflection vector, L is the light direction +and n is the specular exponent.
+
+ + + +
o HighlightMapGenerator( const osg::Vec3 &light_direction, const osg::Vec4 &light_color, float specular_exponent, int texture_size = 64) +

+ + +

o HighlightMapGenerator(const HighlightMapGenerator &copy, const osg::CopyOp &copyop = osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual ~HighlightMapGenerator() +

+ + +

oHighlightMapGenerator& operator=(const HighlightMapGenerator &) +

+ + +

oinline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ + +

oinline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/Hit.html b/doc/doc++/osgUtil/Hit.html new file mode 100644 index 000000000..fbf8d8cc6 --- /dev/null +++ b/doc/doc++/osgUtil/Hit.html @@ -0,0 +1,168 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Hit + + + + +

class OSGUTIL_EXPORT osgUtil::Hit

+ +
+

+

Public Fields

+[more]float _ratio +
+[more]osg::ref_ptr<osg::LineSegment> _originalLineSegment +
+[more]osg::ref_ptr<osg::LineSegment> _localLineSegment +
+[more]osg::NodePath _nodePath +
+[more]osg::ref_ptr<osg::Geode> _geode +
+[more]osg::ref_ptr<osg::Drawable> _drawable +
+[more]osg::ref_ptr<osg::RefMatrix> _matrix +
+[more]osg::ref_ptr<osg::RefMatrix> _inverse +
+[more]VecIndexList _vecIndexList +
+[more]int _primitiveIndex +
+[more]osg::Vec3 _intersectPoint +
+[more]osg::Vec3 _intersectNormal +

+ +

+

Public Methods

+[more] Hit() +
+[more] Hit(const Hit& hit) +
+[more] ~Hit() +
+[more]Hit& operator = (const Hit& hit) +
+[more]bool operator < (const Hit& hit) const +
+[more]const osg::Vec3& getLocalIntersectPoint() const +
+[more]const osg::Vec3& getLocalIntersectNormal() const +
+[more]const osg::Vec3 getWorldIntersectPoint() const +
+[more]const osg::Vec3 getWorldIntersectNormal() const +

+ +

+

Public Members

+[more]typedef std::vector<int> VecIndexList +

+ +
+ + +
+

Documentation

+
+ + + +
o Hit() +

+ + +

o Hit(const Hit& hit) +

+ + +

o ~Hit() +

+ + +

oHit& operator = (const Hit& hit) +

+ + +

otypedef std::vector<int> VecIndexList +

+ + +

obool operator < (const Hit& hit) const +

+ + +

oconst osg::Vec3& getLocalIntersectPoint() const +

+ + +

oconst osg::Vec3& getLocalIntersectNormal() const +

+ + +

oconst osg::Vec3 getWorldIntersectPoint() const +

+ + +

oconst osg::Vec3 getWorldIntersectNormal() const +

+ + +

ofloat _ratio +

+ + +

oosg::ref_ptr<osg::LineSegment> _originalLineSegment +

+ + +

oosg::ref_ptr<osg::LineSegment> _localLineSegment +

+ + +

oosg::NodePath _nodePath +

+ + +

oosg::ref_ptr<osg::Geode> _geode +

+ + +

oosg::ref_ptr<osg::Drawable> _drawable +

+ + +

oosg::ref_ptr<osg::RefMatrix> _matrix +

+ + +

oosg::ref_ptr<osg::RefMatrix> _inverse +

+ + +

oVecIndexList _vecIndexList +

+ + +

oint _primitiveIndex +

+ + +

oosg::Vec3 _intersectPoint +

+ + +

oosg::Vec3 _intersectNormal +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/InsertImpostorsVisitor.html b/doc/doc++/osgUtil/InsertImpostorsVisitor.html new file mode 100644 index 000000000..5764f9a09 --- /dev/null +++ b/doc/doc++/osgUtil/InsertImpostorsVisitor.html @@ -0,0 +1,161 @@ + + + + + class OSGUTIL_EXPORT osgUtil::InsertImpostorsVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::InsertImpostorsVisitor

Insert impostor nodes into scene graph.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] InsertImpostorsVisitor() +
default to traversing all children +
+[more]void setImpostorThresholdRatio(float ratio) +
+[more]float getImpostorThresholdRatio() const +
+[more]void setMaximumNumberOfNestedImpostors(unsigned int num) +
+[more]unsigned int getMaximumNumberOfNestedImpostors() const +
+[more]void reset() +
empty visitor, make it ready for next traversal +
+[more]virtual void apply(osg::Node& node) +
+[more]virtual void apply(osg::Group& node) +
+[more]virtual void apply(osg::LOD& node) +
+[more]virtual void apply(osg::Impostor& node) +
+[more]void insertImpostors() +

+ +

+

Protected Fields

+[more]GroupList _groupList +
+[more]LODList _lodList +
+[more]float _impostorThresholdRatio +
+[more]unsigned int _maximumNumNestedImpostors +
+[more]unsigned int _numNestedImpostors +

+ +

+

Protected Members

+[more]typedef std::vector< osg::Group* > GroupList +
+[more]typedef std::vector< osg::LOD* > LODList +

+ +
+ + +
+

Documentation

+
Insert impostor nodes into scene graph. +For example of usage see src/Demos/osgimpostor.
+
+ + + +
o InsertImpostorsVisitor() +
default to traversing all children +

+ + +

ovoid setImpostorThresholdRatio(float ratio) +

+ + +

ofloat getImpostorThresholdRatio() const +

+ + +

ovoid setMaximumNumberOfNestedImpostors(unsigned int num) +

+ + +

ounsigned int getMaximumNumberOfNestedImpostors() const +

+ + +

ovoid reset() +
empty visitor, make it ready for next traversal +

+ + +

ovirtual void apply(osg::Node& node) +

+ + +

ovirtual void apply(osg::Group& node) +

+ + +

ovirtual void apply(osg::LOD& node) +

+ + +

ovirtual void apply(osg::Impostor& node) +

+ + +

ovoid insertImpostors() +

+ + +

otypedef std::vector< osg::Group* > GroupList +

+ + +

otypedef std::vector< osg::LOD* > LODList +

+ + +

oGroupList _groupList +

+ + +

oLODList _lodList +

+ + +

ofloat _impostorThresholdRatio +

+ + +

ounsigned int _maximumNumNestedImpostors +

+ + +

ounsigned int _numNestedImpostors +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/IntersectState.html b/doc/doc++/osgUtil/IntersectState.html new file mode 100644 index 000000000..40be11549 --- /dev/null +++ b/doc/doc++/osgUtil/IntersectState.html @@ -0,0 +1,127 @@ + + + + + class osgUtil::IntersectVisitor::IntersectState + + + + +

class IntersectState

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]osg::ref_ptr<osg::RefMatrix> _matrix +
+[more]osg::ref_ptr<osg::RefMatrix> _inverse +
+[more]LineSegmentList _segList +
+[more]LineSegmentMaskStack _segmentMaskStack +

+ +

+

Public Methods

+[more] IntersectState() +
+[more]bool isCulled(const osg::BoundingSphere& bs, LineSegmentMask& segMaskOut) +
+[more]bool isCulled(const osg::BoundingBox& bb, LineSegmentMask& segMaskOut) +
+[more]void addLineSegmentPair(osg::LineSegment* first, osg::LineSegment* second) +

+ +

+

Public Members

+[more]typedef std::pair<osg::ref_ptr<osg::LineSegment>,osg::ref_ptr<osg::LineSegment> > LineSegmentPair +
+[more]typedef std::vector< LineSegmentPair > LineSegmentList +
+[more]typedef unsigned int LineSegmentMask +
+[more]typedef std::vector<LineSegmentMask> LineSegmentMaskStack +

+ +

+

Protected Methods

+[more] ~IntersectState() +

+ +
+ + +
+

Documentation

+
+ + + +
o IntersectState() +

+ + +

oosg::ref_ptr<osg::RefMatrix> _matrix +

+ + +

oosg::ref_ptr<osg::RefMatrix> _inverse +

+ + +

otypedef std::pair<osg::ref_ptr<osg::LineSegment>,osg::ref_ptr<osg::LineSegment> > LineSegmentPair +

+ + +

otypedef std::vector< LineSegmentPair > LineSegmentList +

+ + +

oLineSegmentList _segList +

+ + +

otypedef unsigned int LineSegmentMask +

+ + +

otypedef std::vector<LineSegmentMask> LineSegmentMaskStack +

+ + +

oLineSegmentMaskStack _segmentMaskStack +

+ + +

obool isCulled(const osg::BoundingSphere& bs, LineSegmentMask& segMaskOut) +

+ + +

obool isCulled(const osg::BoundingBox& bb, LineSegmentMask& segMaskOut) +

+ + +

ovoid addLineSegmentPair(osg::LineSegment* first, osg::LineSegment* second) +

+ + +

o ~IntersectState() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/IntersectVisitor.html b/doc/doc++/osgUtil/IntersectVisitor.html new file mode 100644 index 000000000..2fa4b367a --- /dev/null +++ b/doc/doc++/osgUtil/IntersectVisitor.html @@ -0,0 +1,210 @@ + + + + + class OSGUTIL_EXPORT osgUtil::IntersectVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::IntersectVisitor

Basic visitor for ray based collisions of a scene
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] IntersectVisitor() +
+[more]virtual ~IntersectVisitor() +
+[more]void reset() +
+[more]void addLineSegment(osg::LineSegment* seg) +
Add a line segment to use for intersection testing during scene traversal +
+[more]HitList& getHitList(osg::LineSegment* seg) +
+[more]int getNumHits(osg::LineSegment* seg) +
+[more]bool hits() +
+[more]virtual void apply(osg::Node&) +
+[more]virtual void apply(osg::Geode& node) +
+[more]virtual void apply(osg::Billboard& node) +
+[more]virtual void apply(osg::Group& node) +
+[more]virtual void apply(osg::Transform& node) +
+[more]virtual void apply(osg::Switch& node) +
+[more]virtual void apply(osg::LOD& node) +

+ +

+

Public Members

+[more]typedef std::vector<Hit> HitList +
+[more]typedef std::map<osg::LineSegment*,HitList > LineSegmentHitListMap +

+ +

+

Protected Fields

+[more]IntersectStateStack _intersectStateStack +
+[more]osg::NodePath _nodePath +
+[more]LineSegmentHitListMap _segHitList +

+ +

+

Protected Methods

+[more]bool intersect(osg::Drawable& gset) +
+[more]void pushMatrix(const osg::Matrix& matrix) +
+[more]void popMatrix() +
+[more]bool enterNode(osg::Node& node) +
+[more]void leaveNode() +

+ +

+

Protected Members

+class IntersectState: public osg::Referenced +
+[more]typedef std::vector<osg::ref_ptr<IntersectState> > IntersectStateStack +

+ +
+ + +
+

Documentation

+
Basic visitor for ray based collisions of a scene
+
+ + + +
o IntersectVisitor() +

+ + +

ovirtual ~IntersectVisitor() +

+ + +

ovoid reset() +

+ + +

ovoid addLineSegment(osg::LineSegment* seg) +
Add a line segment to use for intersection testing during scene traversal +

+ + +

otypedef std::vector<Hit> HitList +

+ + +

otypedef std::map<osg::LineSegment*,HitList > LineSegmentHitListMap +

+ + +

oHitList& getHitList(osg::LineSegment* seg) +

+ + +

oint getNumHits(osg::LineSegment* seg) +

+ + +

obool hits() +

+ + +

ovirtual void apply(osg::Node&) +

+ + +

ovirtual void apply(osg::Geode& node) +

+ + +

ovirtual void apply(osg::Billboard& node) +

+ + +

ovirtual void apply(osg::Group& node) +

+ + +

ovirtual void apply(osg::Transform& node) +

+ + +

ovirtual void apply(osg::Switch& node) +

+ + +

ovirtual void apply(osg::LOD& node) +

+ + +

obool intersect(osg::Drawable& gset) +

+ + +

ovoid pushMatrix(const osg::Matrix& matrix) +

+ + +

ovoid popMatrix() +

+ + +

obool enterNode(osg::Node& node) +

+ + +

ovoid leaveNode() +

+ + +

otypedef std::vector<osg::ref_ptr<IntersectState> > IntersectStateStack +

+ + +

oIntersectStateStack _intersectStateStack +

+ + +

oosg::NodePath _nodePath +

+ + +

oLineSegmentHitListMap _segHitList +

+
+
Direct child classes: +
PickIntersectVisitor
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/LeafDepthSortFunctor.html b/doc/doc++/osgUtil/LeafDepthSortFunctor.html new file mode 100644 index 000000000..47e6564f5 --- /dev/null +++ b/doc/doc++/osgUtil/LeafDepthSortFunctor.html @@ -0,0 +1,31 @@ + + + + + struct osgUtil::LeafDepthSortFunctor + + + + +

struct osgUtil::LeafDepthSortFunctor

+
+

+
+[more]bool operator() (const osg::ref_ptr<RenderLeaf>& lhs, const osg::ref_ptr<RenderLeaf>& rhs) +

+ + + +
+

Documentation

+
+ + + +
obool operator() (const osg::ref_ptr<RenderLeaf>& lhs, const osg::ref_ptr<RenderLeaf>& rhs) +

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/MergeGeometryVisitor.html b/doc/doc++/osgUtil/MergeGeometryVisitor.html new file mode 100644 index 000000000..ec4942237 --- /dev/null +++ b/doc/doc++/osgUtil/MergeGeometryVisitor.html @@ -0,0 +1,108 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::MergeGeometryVisitor + + + + +

class OSGUTIL_EXPORT MergeGeometryVisitor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] MergeGeometryVisitor() +
default to traversing all children +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Billboard&) +
+[more]static bool mergeGeode(osg::Geode& geode) +
+[more]static bool geometryContainsSharedArrays(osg::Geometry& geom) +
+[more]static bool mergeGeometry(osg::Geometry& lhs, osg::Geometry& rhs) +
+[more]static bool mergePrimitive(osg::DrawArrays& lhs, osg::DrawArrays& rhs) +
+[more]static bool mergePrimitive(osg::DrawArrayLengths& lhs, osg::DrawArrayLengths& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUByte& lhs, osg::DrawElementsUByte& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUShort& lhs, osg::DrawElementsUShort& rhs) +
+[more]static bool mergePrimitive(osg::DrawElementsUInt& lhs, osg::DrawElementsUInt& rhs) +

+ +
+ + +
+

Documentation

+
+ + + +
o MergeGeometryVisitor() +
default to traversing all children +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Billboard&) +

+ + +

ostatic bool mergeGeode(osg::Geode& geode) +

+ + +

ostatic bool geometryContainsSharedArrays(osg::Geometry& geom) +

+ + +

ostatic bool mergeGeometry(osg::Geometry& lhs, osg::Geometry& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawArrays& lhs, osg::DrawArrays& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawArrayLengths& lhs, osg::DrawArrayLengths& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUByte& lhs, osg::DrawElementsUByte& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUShort& lhs, osg::DrawElementsUShort& rhs) +

+ + +

ostatic bool mergePrimitive(osg::DrawElementsUInt& lhs, osg::DrawElementsUInt& rhs) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/NavigatorButton.class b/doc/doc++/osgUtil/NavigatorButton.class new file mode 100644 index 0000000000000000000000000000000000000000..5fa134ee0f22ae5659bc0091d4cc98b3e6a0532a GIT binary patch literal 1816 zcma)7S#ujj5dOxJHIlr(EguO9h9t&b+fld=C4tzn6A=-+FmbSpYrI~`YgW5rHIi-4 z-$D2RyyS%xl7Uq5NUHcz6g{)6i}C{x>hAfbr|)h3{m&nNB8FxBki?B7wvzaWqrh>W zV}s)pjxRY}jxvYG;d4|tzTyZtsvI(n6z0ROx-Zk(Yb`5-w z+YE!VPIWf#NjoSC%VrpzUnm@ky2y$nnO*linPZq}VXp8>*)173UWwq?{K7WF_%P`iZr@g7ia}n61-1WX4!P5UyT&Wd{c0d95 zs7FSkY`ZdRt7p2cx6~=TsWb3=UIo5##!VQvXUpt^4+~KhM5W>qa7(jQDzbenbGy5t zkxnX)xbAq4yvdMWbw#y$ClHkbhT+cPs_Iz}vMD^xc6Ni!s=rnV?kV}?S!m9YYROSs!2aKxT#Q&7YAMcpY0=?5z{DSeM(-tudK zWv@FfCBSHu62ej$D4|lZy?x4dPiGh3^IbY66;pvQa4W1iNhMo`Sh5uOM+Lh`*9phl zr;#NCs_Iljr`q*}q#Y?-#|mG~gx|^;HKCZ>-%%^(p*EsxMC0EDlqXx9{5MMeXCa13G`PhdY2@n-wGmD3uqX5UCrA@5ujCwKO;dq7Wm0rJjIxq>2KhIx!k~v zxzxa%nTa=W-pnK#xNK&41J9YiV)_}z&8IMS#$xdi;}jDOOcQ*u1NTSpMS?Hs!+@!*H1Ptl%a6k2G#!7@!807-y(s88 z#7P3qMHa{U$e!86xh689#nzk8u@b$xhCcdlgU(>?FHDk?8RhqPT~V#~za| R#{{M@M4Akr679nW{{js3#=-yq literal 0 HcmV?d00001 diff --git a/doc/doc++/osgUtil/Optimizer.html b/doc/doc++/osgUtil/Optimizer.html new file mode 100644 index 000000000..39b4c8427 --- /dev/null +++ b/doc/doc++/osgUtil/Optimizer.html @@ -0,0 +1,99 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer + + + + +

class OSGUTIL_EXPORT osgUtil::Optimizer

Insert impostor nodes into scene graph.
+
+ +
+

+

Public Methods

+[more] Optimizer() +
+[more]virtual void optimize(osg::Node* node, unsigned int options = ALL_OPTIMIZATIONS) +
traverse the node and its subgraph with a series of optimization visitors, specificied by the OptizationOptions +

+ +

+

Public Members

+[more]enum OptimizationOptions +
+class OSGUTIL_EXPORT ConvertGeoSetsToGeometryVisitor: public osg::NodeVisitor +
ConvertGeoSetsToGeometryVisitor all the old GeoSet Drawables to the new Geometry Drawables +
+class OSGUTIL_EXPORT FlattenStaticTransformsVisitor: public osg::NodeVisitor +
Flatten Static Trasform nodes by applying their transform to the geometry on the leaves of the scene graph, then removing the now redundant transforms +
+class OSGUTIL_EXPORT RemoveEmptyNodesVisitor: public osg::NodeVisitor +
Remove rendundant nodes, such as groups with one single child +
+class OSGUTIL_EXPORT RemoveRedundantNodesVisitor: public osg::NodeVisitor +
Remove rendundant nodes, such as groups with one single child +
+class OSGUTIL_EXPORT CombineLODsVisitor: public osg::NodeVisitor +
Optimize the LOD groups, by combining adjacent LOD's which have complementary ranges +
+class OSGUTIL_EXPORT StateVisitor: public osg::NodeVisitor +
Optimize State in the scene graph by removing duplicate state, replacing it with shared instances, both for StateAttributes, and whole StateSets +
+class OSGUTIL_EXPORT MergeGeometryVisitor: public osg::NodeVisitor +

+ +
+ + +
+

Documentation

+
Insert impostor nodes into scene graph. +For example of usage see src/Demos/osgimpostor.
+
+ + + +
o Optimizer() +

+ + +

oenum OptimizationOptions +

+ + + +
o FLATTEN_STATIC_TRANSFORMS +

+ + +

o REMOVE_REDUNDANT_NODES +

+ + +

o COMBINE_ADJACENT_LODS +

+ + +

o SHARE_DUPLICATE_STATE +

+ + +

o ALL_OPTIMIZATIONS +

+ + + +
ovirtual void optimize(osg::Node* node, unsigned int options = ALL_OPTIMIZATIONS) +
traverse the node and its subgraph with a series of optimization +visitors, specificied by the OptizationOptions +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/PickIntersectVisitor.html b/doc/doc++/osgUtil/PickIntersectVisitor.html new file mode 100644 index 000000000..ca87b4e24 --- /dev/null +++ b/doc/doc++/osgUtil/PickIntersectVisitor.html @@ -0,0 +1,130 @@ + + + + + class OSGUTIL_EXPORT osgUtil::PickIntersectVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::PickIntersectVisitor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PickIntersectVisitor() +
+[more] ~PickIntersectVisitor() +
+[more]HitList& getHits(osgUtil::SceneView* , int x, int y) +
+[more]HitList& getIntersections(osg::Node* scene, osg::Vec3 nr, osg::Vec3 fr) +

+ +
+

Inherited from IntersectVisitor:

+
+

+

Public Methods

+ovoid reset() +
+ovoid addLineSegment(osg::LineSegment* seg) +
+oHitList& getHitList(osg::LineSegment* seg) +
+oint getNumHits(osg::LineSegment* seg) +
+obool hits() +
+ovirtual void apply(osg::Node&) +
+ovirtual void apply(osg::Geode& node) +
+ovirtual void apply(osg::Billboard& node) +
+ovirtual void apply(osg::Group& node) +
+ovirtual void apply(osg::Transform& node) +
+ovirtual void apply(osg::Switch& node) +
+ovirtual void apply(osg::LOD& node) +

+ +

+

Public Members

+otypedef std::vector<Hit> HitList +
+otypedef std::map<osg::LineSegment*,HitList > LineSegmentHitListMap +

+ +

+

Protected Fields

+oIntersectStateStack _intersectStateStack +
+oosg::NodePath _nodePath +
+oLineSegmentHitListMap _segHitList +

+ +

+

Protected Methods

+obool intersect(osg::Drawable& gset) +
+ovoid pushMatrix(const osg::Matrix& matrix) +
+ovoid popMatrix() +
+obool enterNode(osg::Node& node) +
+ovoid leaveNode() +

+ +

+

Protected Members

+class IntersectState: public osg::Referenced +
+otypedef std::vector<osg::ref_ptr<IntersectState> > IntersectStateStack +

+ +
+ + +
+

Documentation

+
+ + + +
o PickIntersectVisitor() +

+ + +

o ~PickIntersectVisitor() +

+ + +

oHitList& getHits(osgUtil::SceneView* , int x, int y) +

+ + +

oHitList& getIntersections(osg::Node* scene, osg::Vec3 nr, osg::Vec3 fr) +

+ +
This class has no child classes.
+ +
Friends:
class osgUtil::IntersectVisitor

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/PickVisitor.html b/doc/doc++/osgUtil/PickVisitor.html new file mode 100644 index 000000000..be3d61526 --- /dev/null +++ b/doc/doc++/osgUtil/PickVisitor.html @@ -0,0 +1,94 @@ + + + + + class OSGUTIL_EXPORT osgUtil::PickVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::PickVisitor

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] PickVisitor() +
+[more] ~PickVisitor() +
+[more]virtual void apply(osg::Projection& pr) +
+[more]osgUtil::IntersectVisitor::HitList& getHits(osg::Node* nd, const osg::Matrix &projm, const float x, const float y) +
+[more]osgUtil::IntersectVisitor::HitList& getHits(osgUtil::SceneView* , double x, double y) +
+[more]osgUtil::IntersectVisitor::HitList& getHits(osg::Node* nd, const osg::Vec3 near_point, const osg::Vec3 far_point) +
+[more]osgUtil::IntersectVisitor::HitList& getHits(void) +
+[more]inline void setxy(float xpt, float ypt) +
+[more]inline bool hits() +

+ +
+ + +
+

Documentation

+
+ + + +
o PickVisitor() +

+ + +

o ~PickVisitor() +

+ + +

ovirtual void apply(osg::Projection& pr) +

+ + +

oosgUtil::IntersectVisitor::HitList& getHits(osg::Node* nd, const osg::Matrix &projm, const float x, const float y) +

+ + +

oosgUtil::IntersectVisitor::HitList& getHits(osgUtil::SceneView* , double x, double y) +

+ + +

oosgUtil::IntersectVisitor::HitList& getHits(osg::Node* nd, const osg::Vec3 near_point, const osg::Vec3 far_point) +

+ + +

oosgUtil::IntersectVisitor::HitList& getHits(void) +

+ + +

oinline void setxy(float xpt, float ypt) +

+ + +

oinline bool hits() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/ReflectionMapGenerator.html b/doc/doc++/osgUtil/ReflectionMapGenerator.html new file mode 100644 index 000000000..07c486cfb --- /dev/null +++ b/doc/doc++/osgUtil/ReflectionMapGenerator.html @@ -0,0 +1,103 @@ + + + + + class osgUtil::ReflectionMapGenerator + + + + +

class osgUtil::ReflectionMapGenerator

This is the most simple cube map generator.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more]inline ReflectionMapGenerator(int texture_size) +
+[more]inline ReflectionMapGenerator(const ReflectionMapGenerator &copy, const osg::CopyOp &copyop) +
+[more]inline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +

+

Protected Methods

+[more]virtual ~ReflectionMapGenerator() +
+[more]ReflectionMapGenerator& operator=(const ReflectionMapGenerator &) +
+[more]inline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
+

Inherited from CubeMapGenerator:

+
+

+

Public Methods

+ovoid generateMap(bool use_osg_system = true) +
+oinline osg::Image* getImage(osg::TextureCubeMap::Face face) +
+oinline const osg::Image* getImage(osg::TextureCubeMap::Face face) const +
+oinline void set_pixel(int index, int c, int r, const osg::Vec4 &color) +
+oinline osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +

+

Protected Methods

+oinline static osg::Vec4 vector_to_color(const osg::Vec3 &vec) +

+ +
+ + +
+

Documentation

+
This is the most simple cube map generator. It performs a direct association +between reflection vector and RGBA color (C = R).
+
+ + + +
ovirtual ~ReflectionMapGenerator() +

+ + +

oReflectionMapGenerator& operator=(const ReflectionMapGenerator &) +

+ + +

oinline virtual osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ + +

oinline ReflectionMapGenerator(int texture_size) +

+ + +

oinline ReflectionMapGenerator(const ReflectionMapGenerator &copy, const osg::CopyOp &copyop) +

+ + +

oinline osg::Vec4 compute_color(const osg::Vec3 &R) const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RegisterRenderBinProxy.html b/doc/doc++/osgUtil/RegisterRenderBinProxy.html new file mode 100644 index 000000000..ef1c10a52 --- /dev/null +++ b/doc/doc++/osgUtil/RegisterRenderBinProxy.html @@ -0,0 +1,53 @@ + + + + + class osgUtil::RegisterRenderBinProxy + + + + +

class osgUtil::RegisterRenderBinProxy

Proxy class for automatic registration of renderbins with the RenderBin prototypelist
+
+ +
+

+

Public Methods

+[more] RegisterRenderBinProxy(const std::string& binName, RenderBin* proto) +
+[more] ~RegisterRenderBinProxy() +

+ +

+

Protected Fields

+[more]osg::ref_ptr<RenderBin> _rb +

+ +
+ + +
+

Documentation

+
Proxy class for automatic registration of renderbins with the RenderBin prototypelist
+
+ + + +
o RegisterRenderBinProxy(const std::string& binName, RenderBin* proto) +

+ + +

o ~RegisterRenderBinProxy() +

+ + +

oosg::ref_ptr<RenderBin> _rb +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RemoveEmptyNodesVisitor.html b/doc/doc++/osgUtil/RemoveEmptyNodesVisitor.html new file mode 100644 index 000000000..32e20add4 --- /dev/null +++ b/doc/doc++/osgUtil/RemoveEmptyNodesVisitor.html @@ -0,0 +1,84 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::RemoveEmptyNodesVisitor + + + + +

class OSGUTIL_EXPORT RemoveEmptyNodesVisitor

Remove rendundant nodes, such as groups with one single child
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]NodeList _redundantNodeList +

+ +

+

Public Methods

+[more] RemoveEmptyNodesVisitor() +
+[more]virtual void apply(osg::Geode& geode) +
+[more]virtual void apply(osg::Group& group) +
+[more]void removeEmptyNodes() +

+ +

+

Public Members

+[more]typedef std::set<osg::Node*> NodeList +

+ +
+ + +
+

Documentation

+
Remove rendundant nodes, such as groups with one single child
+
+ + + +
otypedef std::set<osg::Node*> NodeList +

+ + +

oNodeList _redundantNodeList +

+ + +

o RemoveEmptyNodesVisitor() +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovirtual void apply(osg::Group& group) +

+ + +

ovoid removeEmptyNodes() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RemoveRedundantNodesVisitor.html b/doc/doc++/osgUtil/RemoveRedundantNodesVisitor.html new file mode 100644 index 000000000..8d9770f02 --- /dev/null +++ b/doc/doc++/osgUtil/RemoveRedundantNodesVisitor.html @@ -0,0 +1,84 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::RemoveRedundantNodesVisitor + + + + +

class OSGUTIL_EXPORT RemoveRedundantNodesVisitor

Remove rendundant nodes, such as groups with one single child
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]NodeList _redundantNodeList +

+ +

+

Public Methods

+[more] RemoveRedundantNodesVisitor() +
+[more]virtual void apply(osg::Group& group) +
+[more]virtual void apply(osg::Transform& transform) +
+[more]void removeRedundantNodes() +

+ +

+

Public Members

+[more]typedef std::set<osg::Node*> NodeList +

+ +
+ + +
+

Documentation

+
Remove rendundant nodes, such as groups with one single child
+
+ + + +
otypedef std::set<osg::Node*> NodeList +

+ + +

oNodeList _redundantNodeList +

+ + +

o RemoveRedundantNodesVisitor() +

+ + +

ovirtual void apply(osg::Group& group) +

+ + +

ovirtual void apply(osg::Transform& transform) +

+ + +

ovoid removeRedundantNodes() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderBin.html b/doc/doc++/osgUtil/RenderBin.html new file mode 100644 index 000000000..9680a164d --- /dev/null +++ b/doc/doc++/osgUtil/RenderBin.html @@ -0,0 +1,390 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderBin + + + + +

class OSGUTIL_EXPORT osgUtil::RenderBin

RenderBin base class
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]int _binNum +
+[more]RenderBin* _parent +
+[more]RenderStage* _stage +
+[more]RenderBinList _bins +
+[more]RenderGraphList _renderGraphList +
+[more]RenderLeafList _renderLeafList +
+[more]SortMode _sortMode +
+[more]osg::ref_ptr<SortCallback> _sortCallback +
+[more]osg::ref_ptr<DrawCallback> _drawCallback +
+[more]static RenderBinPrototypeList s_renderBinPrototypeList +

+ +

+

Public Methods

+[more]static RenderBin* createRenderBin(const std::string& binName) +
+[more]static RenderBin* getRenderBinPrototype(const std::string& binName) +
+[more]static void addRenderBinPrototype(const std::string& binName, RenderBin* proto) +
+[more]static void removeRenderBinPrototype(RenderBin* proto) +
+[more] RenderBin(SortMode mode=SORT_BY_STATE) +
+[more] RenderBin(const RenderBin& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void reset() +
+[more]RenderBin* find_or_insert(int binNum, const std::string& binName) +
+[more]void addRenderGraph(RenderGraph* rg) +
+[more]void sort() +
+[more]virtual void sortImplementation() +
+[more]void setSortMode(SortMode mode) +
+[more]SortMode getSortMode() const +
+[more]virtual void sortByState() +
+[more]virtual void sortFrontToBack() +
+[more]virtual void sortBackToFront() +
+[more]void setSortCallback(SortCallback* sortCallback) +
+[more]SortCallback* getSortCallback() +
+[more]const SortCallback* getSortCallback() const +
+[more]virtual void draw(osg::State& state, RenderLeaf*& previous) +
+[more]virtual void drawImplementation(osg::State& state, RenderLeaf*& previous) +
+[more]void setDrawCallback(DrawCallback* drawCallback) +
+[more]DrawCallback* getDrawCallback() +
+[more]const DrawCallback* getDrawCallback() const +
+[more]bool getStats(osg::Statistics* primStats) +
extract stats for current draw list. +
+[more]void getPrims(osg::Statistics* primStats) +
+[more]bool getPrims(osg::Statistics* primStats, int nbin) +
+[more]void copyLeavesFromRenderGraphListToRenderLeafList() +

+ +

+

Public Members

+[more]typedef std::vector<RenderLeaf*> RenderLeafList +
+[more]typedef std::vector<RenderGraph*> RenderGraphList +
+[more]typedef std::map< int, osg::ref_ptr<RenderBin> > RenderBinList +
+[more]enum SortMode +
+[more]struct SortCallback: public osg::Referenced +
+[more]struct DrawCallback: public osg::Referenced +
+[more]typedef std::map< std::string, osg::ref_ptr<RenderBin> > RenderBinPrototypeList +

+ +

+

Protected Methods

+[more]virtual ~RenderBin() +

+ +
+ + +
+

Documentation

+
+RenderBin base class
+
+ + + +
otypedef std::vector<RenderLeaf*> RenderLeafList +

+ + +

otypedef std::vector<RenderGraph*> RenderGraphList +

+ + +

otypedef std::map< int, osg::ref_ptr<RenderBin> > RenderBinList +

+ + +

ostatic RenderBin* createRenderBin(const std::string& binName) +

+ + +

ostatic RenderBin* getRenderBinPrototype(const std::string& binName) +

+ + +

ostatic void addRenderBinPrototype(const std::string& binName, RenderBin* proto) +

+ + +

ostatic void removeRenderBinPrototype(RenderBin* proto) +

+ + +

oenum SortMode +

+ + + +
o SORT_BY_STATE +

+ + +

o SORT_FRONT_TO_BACK +

+ + +

o SORT_BACK_TO_FRONT +

+ + + +
o RenderBin(SortMode mode=SORT_BY_STATE) +

+ + +

o RenderBin(const RenderBin& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
Copy constructor using CopyOp to manage deep vs shallow copy +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void reset() +

+ + +

oRenderBin* find_or_insert(int binNum, const std::string& binName) +

+ + +

ovoid addRenderGraph(RenderGraph* rg) +

+ + +

ovoid sort() +

+ + +

ovirtual void sortImplementation() +

+ + +

ovoid setSortMode(SortMode mode) +

+ + +

oSortMode getSortMode() const +

+ + +

ovirtual void sortByState() +

+ + +

ovirtual void sortFrontToBack() +

+ + +

ovirtual void sortBackToFront() +

+ + +

ostruct SortCallback: public osg::Referenced +

+ + + +
ovirtual void sortImplementation(RenderBin*) = 0 +

+ + + +
ovoid setSortCallback(SortCallback* sortCallback) +

+ + +

oSortCallback* getSortCallback() +

+ + +

oconst SortCallback* getSortCallback() const +

+ + +

ovirtual void draw(osg::State& state, RenderLeaf*& previous) +

+ + +

ovirtual void drawImplementation(osg::State& state, RenderLeaf*& previous) +

+ + +

ostruct DrawCallback: public osg::Referenced +

+ + + +
ovirtual void drawImplementation(RenderBin* bin, osg::State& state, RenderLeaf*& previous) = 0 +

+ + + +
ovoid setDrawCallback(DrawCallback* drawCallback) +

+ + +

oDrawCallback* getDrawCallback() +

+ + +

oconst DrawCallback* getDrawCallback() const +

+ + +

obool getStats(osg::Statistics* primStats) +
extract stats for current draw list. +

+ + +

ovoid getPrims(osg::Statistics* primStats) +

+ + +

obool getPrims(osg::Statistics* primStats, int nbin) +

+ + +

ovoid copyLeavesFromRenderGraphListToRenderLeafList() +

+ + +

oint _binNum +

+ + +

oRenderBin* _parent +

+ + +

oRenderStage* _stage +

+ + +

oRenderBinList _bins +

+ + +

oRenderGraphList _renderGraphList +

+ + +

oRenderLeafList _renderLeafList +

+ + +

oSortMode _sortMode +

+ + +

oosg::ref_ptr<SortCallback> _sortCallback +

+ + +

oosg::ref_ptr<DrawCallback> _drawCallback +

+ + +

otypedef std::map< std::string, osg::ref_ptr<RenderBin> > RenderBinPrototypeList +

+ + +

ostatic RenderBinPrototypeList s_renderBinPrototypeList +

+ + +

ovirtual ~RenderBin() +

+
+
Direct child classes: +
RenderStage
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderGraph.html b/doc/doc++/osgUtil/RenderGraph.html new file mode 100644 index 000000000..c85377f2a --- /dev/null +++ b/doc/doc++/osgUtil/RenderGraph.html @@ -0,0 +1,231 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderGraph + + + + +

class OSGUTIL_EXPORT osgUtil::RenderGraph

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]RenderGraph* _parent +
+[more]const osg::StateSet* _stateset +
+[more]int _depth +
+[more]ChildList _children +
+[more]LeafList _leaves +
+[more]mutable float _averageDistance +
+[more]mutable float _minimumDistance +
+[more]osg::ref_ptr<osg::Referenced> _userData +

+ +

+

Public Methods

+[more] RenderGraph() +
+[more] RenderGraph(RenderGraph* parent, const osg::StateSet* stateset) +
+[more] ~RenderGraph() +
+[more]RenderGraph* cloneType() const +
+[more]void setUserData(osg::Referenced* obj) +
+[more]osg::Referenced* getUserData() +
+[more]const osg::Referenced* getUserData() const +
+[more]inline bool empty() const +
return true if all of drawables, lights and children are empty +
+[more]inline bool leaves_empty() const +
+[more]inline float getAverageDistance() const +
+[more]inline float getMinimumDistance() const +
+[more]inline void sortFrontToBack() +
+[more]void reset() +
reset the internal contents of a RenderGraph, including deleting all children +
+[more]void clean() +
recursively clean the RenderGraph of all its drawables, lights and depths. +
+[more]void prune() +
recursively prune the RenderGraph of empty children +
+[more]inline RenderGraph* find_or_insert(const osg::StateSet* stateset) +
+[more]inline void addLeaf(RenderLeaf* leaf) +
add a render leaf +
+[more]static inline void moveRenderGraph(osg::State& state, RenderGraph* sg_curr, RenderGraph* sg_new) +
+[more]inline static void moveToRootRenderGraph(osg::State& state, RenderGraph* sg_curr) +

+ +

+

Public Members

+[more]typedef std::map< const osg::StateSet*, osg::ref_ptr<RenderGraph> > ChildList +
+[more]typedef std::vector< osg::ref_ptr<RenderLeaf> > LeafList +

+ +
+ + +
+

Documentation

+
+ + + +
otypedef std::map< const osg::StateSet*, osg::ref_ptr<RenderGraph> > ChildList +

+ + +

otypedef std::vector< osg::ref_ptr<RenderLeaf> > LeafList +

+ + +

oRenderGraph* _parent +

+ + +

oconst osg::StateSet* _stateset +

+ + +

oint _depth +

+ + +

oChildList _children +

+ + +

oLeafList _leaves +

+ + +

omutable float _averageDistance +

+ + +

omutable float _minimumDistance +

+ + +

oosg::ref_ptr<osg::Referenced> _userData +

+ + +

o RenderGraph() +

+ + +

o RenderGraph(RenderGraph* parent, const osg::StateSet* stateset) +

+ + +

o ~RenderGraph() +

+ + +

oRenderGraph* cloneType() const +

+ + +

ovoid setUserData(osg::Referenced* obj) +

+ + +

oosg::Referenced* getUserData() +

+ + +

oconst osg::Referenced* getUserData() const +

+ + +

oinline bool empty() const +
return true if all of drawables, lights and children are empty +

+ + +

oinline bool leaves_empty() const +

+ + +

oinline float getAverageDistance() const +

+ + +

oinline float getMinimumDistance() const +

+ + +

oinline void sortFrontToBack() +

+ + +

ovoid reset() +
reset the internal contents of a RenderGraph, including deleting all children +

+ + +

ovoid clean() +
recursively clean the RenderGraph of all its drawables, lights and depths. +Leaves children intact, and ready to be populated again. +

+ + +

ovoid prune() +
recursively prune the RenderGraph of empty children +

+ + +

oinline RenderGraph* find_or_insert(const osg::StateSet* stateset) +

+ + +

oinline void addLeaf(RenderLeaf* leaf) +
add a render leaf +

+ + +

ostatic inline void moveRenderGraph(osg::State& state, RenderGraph* sg_curr, RenderGraph* sg_new) +

+ + +

oinline static void moveToRootRenderGraph(osg::State& state, RenderGraph* sg_curr) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderLeaf.html b/doc/doc++/osgUtil/RenderLeaf.html new file mode 100644 index 000000000..f3a6dc89e --- /dev/null +++ b/doc/doc++/osgUtil/RenderLeaf.html @@ -0,0 +1,99 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderLeaf + + + + +

class OSGUTIL_EXPORT osgUtil::RenderLeaf

container class for all data required for rendering of drawables
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]RenderGraph* _parent +
+[more]osg::Drawable* _drawable +
+[more]osg::ref_ptr<osg::RefMatrix> _projection +
+[more]osg::ref_ptr<osg::RefMatrix> _modelview +
+[more]float _depth +

+ +

+

Public Methods

+[more]inline RenderLeaf(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* modelview, float depth=0.0f) +
+[more]inline void set(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* modelview, float depth=0.0f) +
+[more]inline void reset() +
+[more]virtual void render(osg::State& state, RenderLeaf* previous) +

+ +
+ + +
+

Documentation

+
container class for all data required for rendering of drawables
+
+ + + +
oinline RenderLeaf(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* modelview, float depth=0.0f) +

+ + +

oinline void set(osg::Drawable* drawable, osg::RefMatrix* projection, osg::RefMatrix* modelview, float depth=0.0f) +

+ + +

oinline void reset() +

+ + +

ovirtual void render(osg::State& state, RenderLeaf* previous) +

+ + +

oRenderGraph* _parent +

+ + +

oosg::Drawable* _drawable +

+ + +

oosg::ref_ptr<osg::RefMatrix> _projection +

+ + +

oosg::ref_ptr<osg::RefMatrix> _modelview +

+ + +

ofloat _depth +

+ +
This class has no child classes.
+ +
Friends:
class osgUtil::RenderGraph

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderStage.html b/doc/doc++/osgUtil/RenderStage.html new file mode 100644 index 000000000..958aa5bd2 --- /dev/null +++ b/doc/doc++/osgUtil/RenderStage.html @@ -0,0 +1,443 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderStage + + + + +

class OSGUTIL_EXPORT osgUtil::RenderStage

RenderState base class.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]bool _stageDrawnThisFrame +
+[more]DependencyList _dependencyList +
+[more]osg::ref_ptr<osg::Viewport> _viewport +
+[more]GLbitfield _clearMask +
+[more]osg::ref_ptr<osg::ColorMask> _colorMask +
+[more]osg::Vec4 _clearColor +
+[more]osg::Vec4 _clearAccum +
+[more]double _clearDepth +
+[more]int _clearStencil +
+[more]mutable osg::ref_ptr<RenderStageLighting> _renderStageLighting +

+ +

+

Public Methods

+[more] RenderStage(SortMode mode=SORT_BY_STATE) +
+[more] RenderStage(const RenderStage& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp& copyop) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* className() const +
+[more]virtual void reset() +
+[more]void setViewport(osg::Viewport* viewport) +
Set the viewport +
+[more]const osg::Viewport* getViewport() const +
Get the const viewport. +
+[more]osg::Viewport* getViewport() +
Get the viewport. +
+[more]void setClearMask(GLbitfield mask) +
Set the clear mask used in glClear(). +
+[more]GLbitfield getClearMask() const +
Get the clear mask +
+[more]void setColorMask(osg::ColorMask* cm) +
+[more]osg::ColorMask* getColorMask() +
+[more]const osg::ColorMask* getColorMask() const +
+[more]void setClearColor(const osg::Vec4& color) +
Set the clear color used in glClearColor(). +
+[more]const osg::Vec4& getClearColor() const +
Get the clear color +
+[more]void setClearAccum(const osg::Vec4& color) +
Set the clear accum used in glClearAccum(). +
+[more]const osg::Vec4& getClearAccum() const +
Get the clear accum +
+[more]void setClearDepth(double depth) +
Set the clear depth used in glClearDepth(). +
+[more]double getClearDepth() const +
Get the clear depth +
+[more]void setClearStencil(int stencil) +
Set the clear stencil value used in glClearStencil(). +
+[more]int getClearStencil() const +
Get the clear color +
+[more]void setRenderStageLighting(RenderStageLighting* rsl) +
+[more]RenderStageLighting* getRenderStageLighting() const +
+[more]virtual void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +
+[more]virtual void drawPreRenderStages(osg::State& state, RenderLeaf*& previous) +
+[more]virtual void draw(osg::State& state, RenderLeaf*& previous) +
+[more]virtual void drawImplementation(osg::State& state, RenderLeaf*& previous) +
+[more]void addToDependencyList(RenderStage* rs) +
+[more]bool getStats(osg::Statistics* primStats) +
extract stats for current draw list. +

+ +

+

Public Members

+[more]typedef std::vector< osg::ref_ptr<RenderStage> > DependencyList +

+ +

+

Protected Methods

+[more]virtual ~RenderStage() +

+ +
+

Inherited from RenderBin:

+
+

+

Public Fields

+oint _binNum +
+oRenderBin* _parent +
+oRenderStage* _stage +
+oRenderBinList _bins +
+oRenderGraphList _renderGraphList +
+oRenderLeafList _renderLeafList +
+oSortMode _sortMode +
+oosg::ref_ptr<SortCallback> _sortCallback +
+oosg::ref_ptr<DrawCallback> _drawCallback +
+ostatic RenderBinPrototypeList s_renderBinPrototypeList +

+ +

+

Public Methods

+ostatic RenderBin* createRenderBin(const std::string& binName) +
+ostatic RenderBin* getRenderBinPrototype(const std::string& binName) +
+ostatic void addRenderBinPrototype(const std::string& binName, RenderBin* proto) +
+ostatic void removeRenderBinPrototype(RenderBin* proto) +
+ovirtual const char* libraryName() const +
+oRenderBin* find_or_insert(int binNum, const std::string& binName) +
+ovoid addRenderGraph(RenderGraph* rg) +
+ovoid sort() +
+ovirtual void sortImplementation() +
+ovoid setSortMode(SortMode mode) +
+oSortMode getSortMode() const +
+ovirtual void sortByState() +
+ovirtual void sortFrontToBack() +
+ovirtual void sortBackToFront() +
+ovoid setSortCallback(SortCallback* sortCallback) +
+oSortCallback* getSortCallback() +
+oconst SortCallback* getSortCallback() const +
+ovoid setDrawCallback(DrawCallback* drawCallback) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ovoid getPrims(osg::Statistics* primStats) +
+obool getPrims(osg::Statistics* primStats, int nbin) +
+ovoid copyLeavesFromRenderGraphListToRenderLeafList() +

+ +

+

Public Members

+otypedef std::vector<RenderLeaf*> RenderLeafList +
+otypedef std::vector<RenderGraph*> RenderGraphList +
+otypedef std::map< int, osg::ref_ptr<RenderBin> > RenderBinList +
+oenum SortMode +
+ostruct SortCallback: public osg::Referenced +
+ostruct DrawCallback: public osg::Referenced +
+otypedef std::map< std::string, osg::ref_ptr<RenderBin> > RenderBinPrototypeList +

+ +
+ + +
+

Documentation

+
+RenderState base class. Used for encapsulate a complete stage in +rendering - setting up of viewport, the projection and model +matrices and rendering the RenderBin's enclosed with this RenderStage. +RenderStage also has a dependency list of other RenderStages, each +of which must be called before the rendering of this stage. These +'pre' rendering stages are used for advanced rendering techniques +like multistage pixel shading or impostors.
+
+ + + +
o RenderStage(SortMode mode=SORT_BY_STATE) +

+ + +

o RenderStage(const RenderStage& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp& copyop) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void reset() +

+ + +

ovoid setViewport(osg::Viewport* viewport) +
Set the viewport +

+ + +

oconst osg::Viewport* getViewport() const +
Get the const viewport. +

+ + +

oosg::Viewport* getViewport() +
Get the viewport. +

+ + +

ovoid setClearMask(GLbitfield mask) +
Set the clear mask used in glClear(). +Defaults to GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT. +

+ + +

oGLbitfield getClearMask() const +
Get the clear mask +

+ + +

ovoid setColorMask(osg::ColorMask* cm) +

+ + +

oosg::ColorMask* getColorMask() +

+ + +

oconst osg::ColorMask* getColorMask() const +

+ + +

ovoid setClearColor(const osg::Vec4& color) +
Set the clear color used in glClearColor(). +glClearColor is only called if mask & GL_COLOR_BUFFER_BIT is true +

+ + +

oconst osg::Vec4& getClearColor() const +
Get the clear color +

+ + +

ovoid setClearAccum(const osg::Vec4& color) +
Set the clear accum used in glClearAccum(). +glClearAcumm is only called if mask & GL_ACCUM_BUFFER_BIT is true +

+ + +

oconst osg::Vec4& getClearAccum() const +
Get the clear accum +

+ + +

ovoid setClearDepth(double depth) +
Set the clear depth used in glClearDepth(). Defaults to 1.0 +glClearDepth is only called if mask & GL_DEPTH_BUFFER_BIT is true +

+ + +

odouble getClearDepth() const +
Get the clear depth +

+ + +

ovoid setClearStencil(int stencil) +
Set the clear stencil value used in glClearStencil(). Defaults to 1.0 +glClearStencil is only called if mask & GL_STENCIL_BUFFER_BIT is true +

+ + +

oint getClearStencil() const +
Get the clear color +

+ + +

ovoid setRenderStageLighting(RenderStageLighting* rsl) +

+ + +

oRenderStageLighting* getRenderStageLighting() const +

+ + +

ovirtual void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +

+ + +

ovirtual void drawPreRenderStages(osg::State& state, RenderLeaf*& previous) +

+ + +

ovirtual void draw(osg::State& state, RenderLeaf*& previous) +

+ + +

ovirtual void drawImplementation(osg::State& state, RenderLeaf*& previous) +

+ + +

ovoid addToDependencyList(RenderStage* rs) +

+ + +

obool getStats(osg::Statistics* primStats) +
extract stats for current draw list. +

+ + +

otypedef std::vector< osg::ref_ptr<RenderStage> > DependencyList +

+ + +

obool _stageDrawnThisFrame +

+ + +

oDependencyList _dependencyList +

+ + +

oosg::ref_ptr<osg::Viewport> _viewport +

+ + +

oGLbitfield _clearMask +

+ + +

oosg::ref_ptr<osg::ColorMask> _colorMask +

+ + +

oosg::Vec4 _clearColor +

+ + +

oosg::Vec4 _clearAccum +

+ + +

odouble _clearDepth +

+ + +

oint _clearStencil +

+ + +

omutable osg::ref_ptr<RenderStageLighting> _renderStageLighting +

+ + +

ovirtual ~RenderStage() +

+
+
Direct child classes: +
RenderToTextureStage
+
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderStageLighting.html b/doc/doc++/osgUtil/RenderStageLighting.html new file mode 100644 index 000000000..127a75628 --- /dev/null +++ b/doc/doc++/osgUtil/RenderStageLighting.html @@ -0,0 +1,130 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderStageLighting + + + + +

class OSGUTIL_EXPORT osgUtil::RenderStageLighting

RenderBin base class
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Fields

+[more]AttrMatrixList _attrList +

+ +

+

Public Methods

+[more] RenderStageLighting() +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp&) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void reset() +
+[more]virtual void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +
+[more]virtual void draw(osg::State& state, RenderLeaf*& previous) +

+ +

+

Public Members

+[more]typedef std::pair< const osg::StateAttribute*, osg::ref_ptr<osg::RefMatrix> > AttrMatrixPair +
+[more]typedef std::vector< AttrMatrixPair > AttrMatrixList +

+ +

+

Protected Methods

+[more]virtual ~RenderStageLighting() +

+ +
+ + +
+

Documentation

+
+RenderBin base class
+
+ + + +
o RenderStageLighting() +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp&) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void reset() +

+ + +

otypedef std::pair< const osg::StateAttribute*, osg::ref_ptr<osg::RefMatrix> > AttrMatrixPair +

+ + +

otypedef std::vector< AttrMatrixPair > AttrMatrixList +

+ + +

ovirtual void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +

+ + +

ovirtual void draw(osg::State& state, RenderLeaf*& previous) +

+ + +

oAttrMatrixList _attrList +

+ + +

ovirtual ~RenderStageLighting() +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/RenderToTextureStage.html b/doc/doc++/osgUtil/RenderToTextureStage.html new file mode 100644 index 000000000..de44c0036 --- /dev/null +++ b/doc/doc++/osgUtil/RenderToTextureStage.html @@ -0,0 +1,310 @@ + + + + + class OSGUTIL_EXPORT osgUtil::RenderToTextureStage + + + + +

class OSGUTIL_EXPORT osgUtil::RenderToTextureStage

RenderStage which copies the final image to an attached texture or image.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] RenderToTextureStage() +
+[more]virtual osg::Object* cloneType() const +
+[more]virtual osg::Object* clone(const osg::CopyOp&) const +
+[more]virtual bool isSameKindAs(const osg::Object* obj) const +
+[more]virtual const char* libraryName() const +
+[more]virtual const char* className() const +
+[more]virtual void reset() +
+[more]void setTexture(osg::Texture2D* texture) +
+[more]osg::Texture2D* getTexture() +
+[more]void setImage(osg::Image* image) +
+[more]osg::Image* getImage() +
+[more]virtual void draw(osg::State& state, RenderLeaf*& previous) +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::Texture2D> _texture +
+[more]osg::ref_ptr<osg::Image> _image +

+ +

+

Protected Methods

+[more]virtual ~RenderToTextureStage() +

+ +
+

Inherited from RenderStage:

+
+

+

Public Fields

+obool _stageDrawnThisFrame +
+oDependencyList _dependencyList +
+oosg::ref_ptr<osg::Viewport> _viewport +
+oGLbitfield _clearMask +
+oosg::ref_ptr<osg::ColorMask> _colorMask +
+oosg::Vec4 _clearColor +
+oosg::Vec4 _clearAccum +
+odouble _clearDepth +
+oint _clearStencil +
+omutable osg::ref_ptr<RenderStageLighting> _renderStageLighting +

+ +

+

Public Methods

+ovoid setViewport(osg::Viewport* viewport) +
+oconst osg::Viewport* getViewport() const +
+oosg::Viewport* getViewport() +
+ovoid setClearMask(GLbitfield mask) +
+oGLbitfield getClearMask() const +
+ovoid setColorMask(osg::ColorMask* cm) +
+oosg::ColorMask* getColorMask() +
+oconst osg::ColorMask* getColorMask() const +
+ovoid setClearColor(const osg::Vec4& color) +
+oconst osg::Vec4& getClearColor() const +
+ovoid setClearAccum(const osg::Vec4& color) +
+oconst osg::Vec4& getClearAccum() const +
+ovoid setClearDepth(double depth) +
+odouble getClearDepth() const +
+ovoid setClearStencil(int stencil) +
+oint getClearStencil() const +
+ovoid setRenderStageLighting(RenderStageLighting* rsl) +
+oRenderStageLighting* getRenderStageLighting() const +
+ovirtual void addPositionedAttribute(osg::RefMatrix* matrix, const osg::StateAttribute* attr) +
+ovirtual void drawPreRenderStages(osg::State& state, RenderLeaf*& previous) +
+ovirtual void drawImplementation(osg::State& state, RenderLeaf*& previous) +
+ovoid addToDependencyList(RenderStage* rs) +
+obool getStats(osg::Statistics* primStats) +

+ +

+

Public Members

+otypedef std::vector< osg::ref_ptr<RenderStage> > DependencyList +

+ +
+

Inherited from RenderBin:

+
+

+

Public Fields

+oint _binNum +
+oRenderBin* _parent +
+oRenderStage* _stage +
+oRenderBinList _bins +
+oRenderGraphList _renderGraphList +
+oRenderLeafList _renderLeafList +
+oSortMode _sortMode +
+oosg::ref_ptr<SortCallback> _sortCallback +
+oosg::ref_ptr<DrawCallback> _drawCallback +
+ostatic RenderBinPrototypeList s_renderBinPrototypeList +

+ +

+

Public Methods

+ostatic RenderBin* createRenderBin(const std::string& binName) +
+ostatic RenderBin* getRenderBinPrototype(const std::string& binName) +
+ostatic void addRenderBinPrototype(const std::string& binName, RenderBin* proto) +
+ostatic void removeRenderBinPrototype(RenderBin* proto) +
+oRenderBin* find_or_insert(int binNum, const std::string& binName) +
+ovoid addRenderGraph(RenderGraph* rg) +
+ovoid sort() +
+ovirtual void sortImplementation() +
+ovoid setSortMode(SortMode mode) +
+oSortMode getSortMode() const +
+ovirtual void sortByState() +
+ovirtual void sortFrontToBack() +
+ovirtual void sortBackToFront() +
+ovoid setSortCallback(SortCallback* sortCallback) +
+oSortCallback* getSortCallback() +
+oconst SortCallback* getSortCallback() const +
+ovoid setDrawCallback(DrawCallback* drawCallback) +
+oDrawCallback* getDrawCallback() +
+oconst DrawCallback* getDrawCallback() const +
+ovoid getPrims(osg::Statistics* primStats) +
+obool getPrims(osg::Statistics* primStats, int nbin) +
+ovoid copyLeavesFromRenderGraphListToRenderLeafList() +

+ +

+

Public Members

+otypedef std::vector<RenderLeaf*> RenderLeafList +
+otypedef std::vector<RenderGraph*> RenderGraphList +
+otypedef std::map< int, osg::ref_ptr<RenderBin> > RenderBinList +
+oenum SortMode +
+ostruct SortCallback: public osg::Referenced +
+ostruct DrawCallback: public osg::Referenced +
+otypedef std::map< std::string, osg::ref_ptr<RenderBin> > RenderBinPrototypeList +

+ +
+ + +
+

Documentation

+
+RenderStage which copies the final image to an attached texture or image. +Generally used as a pre-rendering stage.
+
+ + + +
o RenderToTextureStage() +

+ + +

ovirtual osg::Object* cloneType() const +

+ + +

ovirtual osg::Object* clone(const osg::CopyOp&) const +

+ + +

ovirtual bool isSameKindAs(const osg::Object* obj) const +

+ + +

ovirtual const char* libraryName() const +

+ + +

ovirtual const char* className() const +

+ + +

ovirtual void reset() +

+ + +

ovoid setTexture(osg::Texture2D* texture) +

+ + +

oosg::Texture2D* getTexture() +

+ + +

ovoid setImage(osg::Image* image) +

+ + +

oosg::Image* getImage() +

+ + +

ovirtual void draw(osg::State& state, RenderLeaf*& previous) +

+ + +

ovirtual ~RenderToTextureStage() +

+ + +

oosg::ref_ptr<osg::Texture2D> _texture +

+ + +

oosg::ref_ptr<osg::Image> _image +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/SceneView.html b/doc/doc++/osgUtil/SceneView.html new file mode 100644 index 000000000..ef69c2b29 --- /dev/null +++ b/doc/doc++/osgUtil/SceneView.html @@ -0,0 +1,937 @@ + + + + + class OSGUTIL_EXPORT osgUtil::SceneView + + + + +

class OSGUTIL_EXPORT osgUtil::SceneView

SceneView is literally a view of a scene, encapsulating the camera, global state, lights and the scene itself.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] SceneView(osg::DisplaySettings* ds=NULL) +
Construct a default scene view +
+[more]void setDefaults() +
Set scene view to use default global state, light, camera and render visitor +
+[more]void setSceneData(osg::Node* node) +
Set the data which to view. +
+[more]osg::Node* getSceneData() +
Get the scene data which to view. +
+[more]const osg::Node* getSceneData() const +
Get the const scene data which to view. +
+[more]void setViewport(osg::Viewport* viewport) +
Set the viewport of the scene view to use specfied osg::Viewport. +
+[more]void setViewport(int x, int y, int width, int height) +
Set the viewport of the scene view to specified dimensions. +
+[more]const osg::Viewport* getViewport() const +
Get the const viewport. +
+[more]osg::Viewport* getViewport() +
Get the viewport. +
+[more]void getViewport(int& x, int& y, int& width, int& height) +
Get the viewport of the scene view. +
+[more]inline void setDisplaySettings(osg::DisplaySettings* vs) +
Set the DisplaySettings. +
+[more]inline const osg::DisplaySettings* getDisplaySettings() const +
Get the const DisplaySettings +
+[more]inline osg::DisplaySettings* getDisplaySettings() +
Get the DisplaySettings +
+[more]void setBackgroundColor(const osg::Vec4& color) +
Set the background color used in glClearColor(). +
+[more]const osg::Vec4& getBackgroundColor() const +
Get the background color +
+[more]void setGlobalStateSet(osg::StateSet* state) +
+[more]osg::StateSet* getGlobalStateSet() +
+[more]const osg::StateSet* getGlobalStateSet() const +
+[more]void setLocalStateSet(osg::StateSet* state) +
+[more]osg::StateSet* getLocalStateSet() +
+[more]const osg::StateSet* getLocalStateSet() const +
+[more]void setLightingMode(LightingMode mode) +
+[more]LightingMode getLightingMode() const +
+[more]void setLight(osg::Light* light) +
+[more]osg::Light* getLight() +
+[more]const osg::Light* getLight() const +
+[more]void setState(osg::State* state) +
+[more]osg::State* getState() +
+[more]const osg::State* getState() const +
+[more]void setCamera(osg::Camera* camera) +
set an osg::Camera for the scene view to use for setting projection and modelview matrices internaly. +
+[more]osg::Camera* getCamera() +
+[more]const osg::Camera* getCamera() const +
+[more]void setProjectionMatrix(osg::RefMatrix* matrix) +
set a projection matrix. +
+[more]osg::RefMatrix* getProjectionMatrix() +
+[more]const osg::RefMatrix* getProjectionMatrix() const +
+[more]void setModelViewMatrix(osg::RefMatrix* matrix) +
set a modelview matrix. +
+[more]osg::RefMatrix* getModelViewMatrix() +
+[more]const osg::RefMatrix* getModelViewMatrix() const +
+[more]void setInitVisitor(osg::NodeVisitor* av) +
+[more]osg::NodeVisitor* getInitVisitor() +
+[more]const osg::NodeVisitor* getInitVisitor() const +
+[more]void setUpdateVisitor(osg::NodeVisitor* av) +
+[more]osg::NodeVisitor* getUpdateVisitor() +
+[more]const osg::NodeVisitor* getUpdateVisitor() const +
+[more]void setCullVisitor(osgUtil::CullVisitor* cv) +
+[more]osgUtil::CullVisitor* getCullVisitor() +
+[more]const osgUtil::CullVisitor* getCullVisitor() const +
+[more]void setRenderGraph(osgUtil::RenderGraph* rg) +
+[more]osgUtil::RenderGraph* getRenderGraph() +
+[more]const osgUtil::RenderGraph* getRenderGraph() const +
+[more]void setRenderStage(osgUtil::RenderStage* rs) +
+[more]osgUtil::RenderStage* getRenderStage() +
+[more]const osgUtil::RenderStage* getRenderStage() const +
+[more]void setCullMask(const osg::Node::NodeMask nm) +
+[more]const osg::Node::NodeMask getCullMask() const +
+[more]void setCullMaskLeft(const osg::Node::NodeMask nm) +
+[more]const osg::Node::NodeMask getCullMaskLeft() const +
+[more]void setCullMaskRight(const osg::Node::NodeMask nm) +
+[more]const osg::Node::NodeMask getCullMaskRight() const +
+[more]void setLODScale(float bias) +
Set the LOD bias for the CullVisitor to use +
+[more]float getLODScale() const +
Get the LOD bias +
+[more]void setSmallFeatureCullingPixelSize(float value) +
Set the Small Feature Culling Pixel Size +
+[more]float getSmallFeatureCullingPixelSize() const +
Get the Small Feature Culling Pixel Size +
+[more]void setCullingMode(osg::CullStack::CullingMode mode) +
Set the culling mode for the CullVisitor to use +
+[more]osg::CullStack::CullingMode getCullingMode() const +
Returns the current CullingMode +
+[more]void setComputeNearFarMode(CullVisitor::ComputeNearFarMode cnfm) +
Set the ComputeNearFarMode for the CullVisitor to use +
+[more]CullVisitor::ComputeNearFarMode getComputeNearFarMode() const +
Get the ComputeNearFarMode +
+[more]void setFusionDistance(FusionDistanceMode mode, float value=1.0f) +
Set the FusionDistanceMode and Value. +
+[more]FusionDistanceMode getFusionDistanceMode() const +
Get the FusionDistanceMode +
+[more]float getFusionDistanceValue() const +
Get the FusionDistanceValue. +
+[more]void setPrioritizeTextures(bool pt) +
set whether the draw method should call renderer->prioritizeTexture +
+[more]bool getPrioritizeTextures() const +
get whether the draw method should call renderer->prioritizeTexture +
+[more]bool projectWindowIntoObject(const osg::Vec3& window, osg::Vec3& object) const +
Calculate, via glUnProject, the object coordinates of a window point. +
+[more]bool projectWindowXYIntoObject(int x, int y, osg::Vec3& near_point, osg::Vec3& far_point) const +
Calculate, via glUnProject, the object coordinates of a window x,y when projected onto the near and far planes. +
+[more]bool projectObjectIntoWindow(const osg::Vec3& object, osg::Vec3& window) const +
Calculate, via glProject, the object coordinates of a window. +
+[more]inline void setFrameStamp(osg::FrameStamp* fs) +
Set the frame stamp for the current frame +
+[more]inline const osg::FrameStamp* getFrameStamp() const +
Set the frame stamp for the current frame +
+[more]virtual void init() +
Do init traversal of attached scene graph using Init NodeVisitor. +
+[more]virtual void update() +
Do app traversal of attached scene graph using App NodeVisitor +
+[more]virtual void app() +
+[more]virtual void cull() +
Do cull traversal of attached scene graph using Cull NodeVisitor +
+[more]virtual void draw() +
Do draw traversal of draw bins generated by cull traversal +

+ +

+

Public Members

+[more]enum LightingMode +
+[more]enum FusionDistanceMode +
FusionDistanceMode is used only when working in stereo +

+ +

+

Protected Fields

+[more]osg::ref_ptr<osg::Node> _sceneData +
+[more]osg::ref_ptr<osg::StateSet> _globalStateSet +
+[more]osg::ref_ptr<osg::StateSet> _localStateSet +
+[more]osg::ref_ptr<osg::Light> _light +
+[more]osg::ref_ptr<osg::Camera> _camera +
+[more]osg::ref_ptr<osg::RefMatrix> _projectionMatrix +
+[more]osg::ref_ptr<osg::RefMatrix> _modelviewMatrix +
+[more]osg::ref_ptr<osg::DisplaySettings> _displaySettings +
+[more]osg::ref_ptr<osg::State> _state +
+[more]bool _initCalled +
+[more]osg::ref_ptr<osg::NodeVisitor> _initVisitor +
+[more]osg::ref_ptr<osg::NodeVisitor> _updateVisitor +
+[more]osg::Node::NodeMask _cullMask +
+[more]osg::ref_ptr<osgUtil::CullVisitor> _cullVisitor +
+[more]osg::ref_ptr<osgUtil::RenderGraph> _rendergraph +
+[more]osg::ref_ptr<osgUtil::RenderStage> _renderStage +
+[more]osg::Node::NodeMask _cullMaskLeft +
+[more]osg::ref_ptr<osgUtil::CullVisitor> _cullVisitorLeft +
+[more]osg::ref_ptr<osgUtil::RenderGraph> _rendergraphLeft +
+[more]osg::ref_ptr<osgUtil::RenderStage> _renderStageLeft +
+[more]osg::Node::NodeMask _cullMaskRight +
+[more]osg::ref_ptr<osgUtil::CullVisitor> _cullVisitorRight +
+[more]osg::ref_ptr<osgUtil::RenderGraph> _rendergraphRight +
+[more]osg::ref_ptr<osgUtil::RenderStage> _renderStageRight +
+[more]osg::ref_ptr<osg::FrameStamp> _frameStamp +
+[more]osg::Vec4 _backgroundColor +
+[more]CullVisitor::ComputeNearFarMode _computeNearFar +
+[more]osg::CullStack::CullingMode _cullingMode +
+[more]float _LODScale +
+[more]float _smallFeatureCullingPixelSize +
+[more]FusionDistanceMode _fusionDistanceMode +
+[more]float _fusionDistanceValue +
+[more]osg::ref_ptr<osg::Viewport> _viewport +
+[more]LightingMode _lightingMode +
+[more]bool _prioritizeTextures +

+ +

+

Protected Methods

+[more]virtual ~SceneView() +
+[more]virtual void cullStage(osg::RefMatrix* projection, osg::RefMatrix* modelview, osgUtil::CullVisitor* cullVisitor, osgUtil::RenderGraph* rendergraph, osgUtil::RenderStage* renderStage) +
Do cull traversal of attached scene graph using Cull NodeVisitor +
+[more]const osg::Matrix computeMVPW() const +
+[more]void clearArea(int x, int y, int width, int height, const osg::Vec4& color) +

+ +
+ + +
+

Documentation

+
+SceneView is literally a view of a scene, encapsulating the +camera, global state, lights and the scene itself. Provides +methods for setting up the view and rendering it.
+
+ + + +
o SceneView(osg::DisplaySettings* ds=NULL) +
Construct a default scene view +

+ + +

ovoid setDefaults() +
Set scene view to use default global state, light, camera +and render visitor +

+ + +

ovoid setSceneData(osg::Node* node) +
Set the data which to view. The data will typically be +an osg::Scene but can be any osg::Node type. +

+ + +

oosg::Node* getSceneData() +
Get the scene data which to view. The data will typically be +an osg::Scene but can be any osg::Node type. +

+ + +

oconst osg::Node* getSceneData() const +
Get the const scene data which to view. The data will typically be +an osg::Scene but can be any osg::Node type. +

+ + +

ovoid setViewport(osg::Viewport* viewport) +
Set the viewport of the scene view to use specfied osg::Viewport. +

+ + +

ovoid setViewport(int x, int y, int width, int height) +
Set the viewport of the scene view to specified dimensions. +

+ + +

oconst osg::Viewport* getViewport() const +
Get the const viewport. +

+ + +

oosg::Viewport* getViewport() +
Get the viewport. +

+ + +

ovoid getViewport(int& x, int& y, int& width, int& height) +
Get the viewport of the scene view. +

+ + +

oinline void setDisplaySettings(osg::DisplaySettings* vs) +
Set the DisplaySettings. +

+ + +

oinline const osg::DisplaySettings* getDisplaySettings() const +
Get the const DisplaySettings +

+ + +

oinline osg::DisplaySettings* getDisplaySettings() +
Get the DisplaySettings +

+ + +

ovoid setBackgroundColor(const osg::Vec4& color) +
Set the background color used in glClearColor(). +Defaults to an off blue color. +

+ + +

oconst osg::Vec4& getBackgroundColor() const +
Get the background color +

+ + +

ovoid setGlobalStateSet(osg::StateSet* state) +

+ + +

oosg::StateSet* getGlobalStateSet() +

+ + +

oconst osg::StateSet* getGlobalStateSet() const +

+ + +

ovoid setLocalStateSet(osg::StateSet* state) +

+ + +

oosg::StateSet* getLocalStateSet() +

+ + +

oconst osg::StateSet* getLocalStateSet() const +

+ + +

oenum LightingMode +

+ + + +
o HEADLIGHT +

+ + +

o SKY_LIGHT +

+ + +

o NO_SCENEVIEW_LIGHT +

+ + + +
ovoid setLightingMode(LightingMode mode) +

+ + +

oLightingMode getLightingMode() const +

+ + +

ovoid setLight(osg::Light* light) +

+ + +

oosg::Light* getLight() +

+ + +

oconst osg::Light* getLight() const +

+ + +

ovoid setState(osg::State* state) +

+ + +

oosg::State* getState() +

+ + +

oconst osg::State* getState() const +

+ + +

ovoid setCamera(osg::Camera* camera) +
set an osg::Camera for the scene view to use for setting projection and modelview matrices internaly. +However, the projection matrix from the camera will be overriden by a projection matrix which is set explicitly +via setProjectionMatrix(..), see below. +Also, the model matrix from the camera will be overriden by a modelview matrix which is set explicitly +via setModelViewMatrix(..), see below. +

+ + +

oosg::Camera* getCamera() +

+ + +

oconst osg::Camera* getCamera() const +

+ + +

ovoid setProjectionMatrix(osg::RefMatrix* matrix) +
set a projection matrix. Note, this will override a camera's projection matrix if it is not NULL. +

+ + +

oosg::RefMatrix* getProjectionMatrix() +

+ + +

oconst osg::RefMatrix* getProjectionMatrix() const +

+ + +

ovoid setModelViewMatrix(osg::RefMatrix* matrix) +
set a modelview matrix. Note, this will override a camera's modelview matrix if it is not NULL. +

+ + +

oosg::RefMatrix* getModelViewMatrix() +

+ + +

oconst osg::RefMatrix* getModelViewMatrix() const +

+ + +

ovoid setInitVisitor(osg::NodeVisitor* av) +

+ + +

oosg::NodeVisitor* getInitVisitor() +

+ + +

oconst osg::NodeVisitor* getInitVisitor() const +

+ + +

ovoid setUpdateVisitor(osg::NodeVisitor* av) +

+ + +

oosg::NodeVisitor* getUpdateVisitor() +

+ + +

oconst osg::NodeVisitor* getUpdateVisitor() const +

+ + +

ovoid setCullVisitor(osgUtil::CullVisitor* cv) +

+ + +

oosgUtil::CullVisitor* getCullVisitor() +

+ + +

oconst osgUtil::CullVisitor* getCullVisitor() const +

+ + +

ovoid setRenderGraph(osgUtil::RenderGraph* rg) +

+ + +

oosgUtil::RenderGraph* getRenderGraph() +

+ + +

oconst osgUtil::RenderGraph* getRenderGraph() const +

+ + +

ovoid setRenderStage(osgUtil::RenderStage* rs) +

+ + +

oosgUtil::RenderStage* getRenderStage() +

+ + +

oconst osgUtil::RenderStage* getRenderStage() const +

+ + +

ovoid setCullMask(const osg::Node::NodeMask nm) +

+ + +

oconst osg::Node::NodeMask getCullMask() const +

+ + +

ovoid setCullMaskLeft(const osg::Node::NodeMask nm) +

+ + +

oconst osg::Node::NodeMask getCullMaskLeft() const +

+ + +

ovoid setCullMaskRight(const osg::Node::NodeMask nm) +

+ + +

oconst osg::Node::NodeMask getCullMaskRight() const +

+ + +

ovoid setLODScale(float bias) +
Set the LOD bias for the CullVisitor to use +

+ + +

ofloat getLODScale() const +
Get the LOD bias +

+ + +

ovoid setSmallFeatureCullingPixelSize(float value) +
Set the Small Feature Culling Pixel Size +

+ + +

ofloat getSmallFeatureCullingPixelSize() const +
Get the Small Feature Culling Pixel Size +

+ + +

ovoid setCullingMode(osg::CullStack::CullingMode mode) +
Set the culling mode for the CullVisitor to use +

+ + +

oosg::CullStack::CullingMode getCullingMode() const +
Returns the current CullingMode +

+ + +

ovoid setComputeNearFarMode(CullVisitor::ComputeNearFarMode cnfm) +
Set the ComputeNearFarMode for the CullVisitor to use +

+ + +

oCullVisitor::ComputeNearFarMode getComputeNearFarMode() const +
Get the ComputeNearFarMode +

+ + +

oenum FusionDistanceMode +
FusionDistanceMode is used only when working in stereo +

+ + + +
o USE_CAMERA_FUSION_DISTANCE +
Use fusion distance from the attached camera if one exist +

+ + +

o USE_FUSION_DISTANCE_VALUE +
Use fusion distance from the value set on the SceneView +

+ + +

o PROPORTIONAL_TO_SCREEN_DISTANCE +
Compute the fusion distance by multiplying the screen distance by the fusion distance value +

+ + + +
ovoid setFusionDistance(FusionDistanceMode mode, float value=1.0f) +
Set the FusionDistanceMode and Value. Note, is used only when working in stereo. +

+ + +

oFusionDistanceMode getFusionDistanceMode() const +
Get the FusionDistanceMode +

+ + +

ofloat getFusionDistanceValue() const +
Get the FusionDistanceValue. Note, only used for USE_FUSION_DISTANCE_VALUE & PROPORTIONAL_TO_SCREEN_DISTANCE modes. +

+ + +

ovoid setPrioritizeTextures(bool pt) +
set whether the draw method should call renderer->prioritizeTexture +

+ + +

obool getPrioritizeTextures() const +
get whether the draw method should call renderer->prioritizeTexture +

+ + +

obool projectWindowIntoObject(const osg::Vec3& window, osg::Vec3& object) const +
Calculate, via glUnProject, the object coordinates of a window point. +Note, current implementation requires that SceneView::draw() has been previously called +for projectWindowIntoObject to produce valid values. Consistent with OpenGL +windows coordinates are calculated relative to the bottom left of the window. +Returns true on successful projection. +

+ + +

obool projectWindowXYIntoObject(int x, int y, osg::Vec3& near_point, osg::Vec3& far_point) const +
Calculate, via glUnProject, the object coordinates of a window x,y +when projected onto the near and far planes. +Note, current implementation requires that SceneView::draw() has been previously called +for projectWindowIntoObject to produce valid values. Consistent with OpenGL +windows coordinates are calculated relative to the bottom left of the window. +Returns true on successful projection. +

+ + +

obool projectObjectIntoWindow(const osg::Vec3& object, osg::Vec3& window) const +
Calculate, via glProject, the object coordinates of a window. +Note, current implementation requires that SceneView::draw() has been previously called +for projectWindowIntoObject to produce valid values. Consistent with OpenGL +windows coordinates are calculated relative to the bottom left of the window, +whereas as window API's normally have the top left as the origin, +so you may need to pass in (mouseX,window_height-mouseY,...). +Returns true on successful projection. +

+ + +

oinline void setFrameStamp(osg::FrameStamp* fs) +
Set the frame stamp for the current frame +

+ + +

oinline const osg::FrameStamp* getFrameStamp() const +
Set the frame stamp for the current frame +

+ + +

ovirtual void init() +
Do init traversal of attached scene graph using Init NodeVisitor. +The init traversal is called once for each SceneView, and should +be used to compile display list, texture objects intialize data +not otherwise intializaed during scene graph loading. Note, is +called automatically by update&cull if it hasn't already been called +elsewhere. Also init() should only ever be called within a valid +graphics context. +

+ + +

ovirtual void update() +
Do app traversal of attached scene graph using App NodeVisitor +

+ + +

ovirtual void app() +

+ + +

ovirtual void cull() +
Do cull traversal of attached scene graph using Cull NodeVisitor +

+ + +

ovirtual void draw() +
Do draw traversal of draw bins generated by cull traversal +

+ + +

ovirtual ~SceneView() +

+ + +

ovirtual void cullStage(osg::RefMatrix* projection, osg::RefMatrix* modelview, osgUtil::CullVisitor* cullVisitor, osgUtil::RenderGraph* rendergraph, osgUtil::RenderStage* renderStage) +
Do cull traversal of attached scene graph using Cull NodeVisitor +

+ + +

oconst osg::Matrix computeMVPW() const +

+ + +

ovoid clearArea(int x, int y, int width, int height, const osg::Vec4& color) +

+ + +

oosg::ref_ptr<osg::Node> _sceneData +

+ + +

oosg::ref_ptr<osg::StateSet> _globalStateSet +

+ + +

oosg::ref_ptr<osg::StateSet> _localStateSet +

+ + +

oosg::ref_ptr<osg::Light> _light +

+ + +

oosg::ref_ptr<osg::Camera> _camera +

+ + +

oosg::ref_ptr<osg::RefMatrix> _projectionMatrix +

+ + +

oosg::ref_ptr<osg::RefMatrix> _modelviewMatrix +

+ + +

oosg::ref_ptr<osg::DisplaySettings> _displaySettings +

+ + +

oosg::ref_ptr<osg::State> _state +

+ + +

obool _initCalled +

+ + +

oosg::ref_ptr<osg::NodeVisitor> _initVisitor +

+ + +

oosg::ref_ptr<osg::NodeVisitor> _updateVisitor +

+ + +

oosg::Node::NodeMask _cullMask +

+ + +

oosg::ref_ptr<osgUtil::CullVisitor> _cullVisitor +

+ + +

oosg::ref_ptr<osgUtil::RenderGraph> _rendergraph +

+ + +

oosg::ref_ptr<osgUtil::RenderStage> _renderStage +

+ + +

oosg::Node::NodeMask _cullMaskLeft +

+ + +

oosg::ref_ptr<osgUtil::CullVisitor> _cullVisitorLeft +

+ + +

oosg::ref_ptr<osgUtil::RenderGraph> _rendergraphLeft +

+ + +

oosg::ref_ptr<osgUtil::RenderStage> _renderStageLeft +

+ + +

oosg::Node::NodeMask _cullMaskRight +

+ + +

oosg::ref_ptr<osgUtil::CullVisitor> _cullVisitorRight +

+ + +

oosg::ref_ptr<osgUtil::RenderGraph> _rendergraphRight +

+ + +

oosg::ref_ptr<osgUtil::RenderStage> _renderStageRight +

+ + +

oosg::ref_ptr<osg::FrameStamp> _frameStamp +

+ + +

oosg::Vec4 _backgroundColor +

+ + +

oCullVisitor::ComputeNearFarMode _computeNearFar +

+ + +

oosg::CullStack::CullingMode _cullingMode +

+ + +

ofloat _LODScale +

+ + +

ofloat _smallFeatureCullingPixelSize +

+ + +

oFusionDistanceMode _fusionDistanceMode +

+ + +

ofloat _fusionDistanceValue +

+ + +

oosg::ref_ptr<osg::Viewport> _viewport +

+ + +

oLightingMode _lightingMode +

+ + +

obool _prioritizeTextures +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/SmoothingVisitor.html b/doc/doc++/osgUtil/SmoothingVisitor.html new file mode 100644 index 000000000..9aa8abc1d --- /dev/null +++ b/doc/doc++/osgUtil/SmoothingVisitor.html @@ -0,0 +1,67 @@ + + + + + class OSGUTIL_EXPORT osgUtil::SmoothingVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::SmoothingVisitor

A smoothing visitor for calculating smoothed normals for osg::GeoSet's which contains surface primitives
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] SmoothingVisitor() +
default to traversing all children +
+[more]static void smooth(osg::Geometry& geoset) +
smooth geoset by creating per vertex normals +
+[more]virtual void apply(osg::Geode& geode) +
apply smoothing method to all geode geosets +

+ +
+ + +
+

Documentation

+
A smoothing visitor for calculating smoothed normals for +osg::GeoSet's which contains surface primitives
+
+ + + +
o SmoothingVisitor() +
default to traversing all children +

+ + +

ostatic void smooth(osg::Geometry& geoset) +
smooth geoset by creating per vertex normals +

+ + +

ovirtual void apply(osg::Geode& geode) +
apply smoothing method to all geode geosets +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/StateVisitor.html b/doc/doc++/osgUtil/StateVisitor.html new file mode 100644 index 000000000..dc9b5c54c --- /dev/null +++ b/doc/doc++/osgUtil/StateVisitor.html @@ -0,0 +1,111 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Optimizer::StateVisitor + + + + +

class OSGUTIL_EXPORT StateVisitor

Optimize State in the scene graph by removing duplicate state, replacing it with shared instances, both for StateAttributes, and whole StateSets
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] StateVisitor() +
default to traversing all children +
+[more]virtual void reset() +
empty visitor, make it ready for next traversal +
+[more]virtual void apply(osg::Node& node) +
+[more]virtual void apply(osg::Geode& geode) +
+[more]void optimize() +

+ +

+

Protected Fields

+[more]StateSetMap _statesets +

+ +

+

Protected Methods

+[more]void addStateSet(osg::StateSet* stateset, osg::Object* obj) +

+ +

+

Protected Members

+[more]typedef std::set<osg::Object*> ObjectSet +
+[more]typedef std::map<osg::StateSet*,ObjectSet> StateSetMap +

+ +
+ + +
+

Documentation

+
Optimize State in the scene graph by removing duplicate state, +replacing it with shared instances, both for StateAttributes, +and whole StateSets
+
+ + + +
o StateVisitor() +
default to traversing all children +

+ + +

ovirtual void reset() +
empty visitor, make it ready for next traversal +

+ + +

ovirtual void apply(osg::Node& node) +

+ + +

ovirtual void apply(osg::Geode& geode) +

+ + +

ovoid optimize() +

+ + +

ovoid addStateSet(osg::StateSet* stateset, osg::Object* obj) +

+ + +

otypedef std::set<osg::Object*> ObjectSet +

+ + +

otypedef std::map<osg::StateSet*,ObjectSet> StateSetMap +

+ + +

oStateSetMap _statesets +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/Tesselator.html b/doc/doc++/osgUtil/Tesselator.html new file mode 100644 index 000000000..5738128f3 --- /dev/null +++ b/doc/doc++/osgUtil/Tesselator.html @@ -0,0 +1,325 @@ + + + + + class OSGUTIL_EXPORT osgUtil::Tesselator + + + + +

class OSGUTIL_EXPORT osgUtil::Tesselator

A simple class for tessellating a single polygon boundary.
+
+ +
+

+

Public Methods

+[more] Tesselator() +
+[more] ~Tesselator() +
+[more]void beginTesselation() +
+[more]void beginContour() +
+[more]void addVertex(osg::Vec3* vertex) +
+[more]void endContour() +
+[more]void endTesselation() +
+[more]PrimList& getPrimList() +
+[more]void retesselatePolygons(osg::Geometry& geom) +
+[more]void reset() +

+ +

+

Public Members

+[more]enum InputBoundaryDirection +
+[more]typedef std::vector<osg::Vec3*> VertexPointList +
+[more]struct Prim: public osg::Referenced +
+[more]typedef std::vector< osg::ref_ptr<Prim> > PrimList +

+ +

+

Protected Fields

+[more]GLUtesselator* _tobj +
+[more]PrimList _primList +
+[more]Vec3dList _coordData +
+[more]NewVertexList _newVertexList +
+[more]GLenum _errorCode +

+ +

+

Protected Methods

+[more]void begin(GLenum mode) +
+[more]void vertex(osg::Vec3* vertex) +
+[more]void combine(osg::Vec3* vertex, void* vertex_data[4], GLfloat weight[4]) +
+[more]void end() +
+[more]void error(GLenum errorCode) +
+[more]static void CALLBACK beginCallback(GLenum which, void* userData) +
+[more]static void CALLBACK vertexCallback(GLvoid* data, void* userData) +
+[more]static void CALLBACK combineCallback(GLdouble coords[3], void* vertex_data[4], GLfloat weight[4], void** outData, void* useData) +
+[more]static void CALLBACK endCallback(void* userData) +
+[more]static void CALLBACK errorCallback(GLenum errorCode, void* userData) +

+ +

+

Protected Members

+[more]struct Vec3d +
+[more]struct NewVertex +
+[more]typedef std::map<osg::Vec3*,NewVertex> NewVertexList +
+[more]typedef std::vector<Vec3d*> Vec3dList +

+ +
+ + +
+

Documentation

+
A simple class for tessellating a single polygon boundary. +Currently uses old style glu tessellation functions for portability. +It be nice to use the modern glu tessellation functions or to find +a small set of code for doing this job better.
+
+ + + +
o Tesselator() +

+ + +

o ~Tesselator() +

+ + +

oenum InputBoundaryDirection +

+ + + +
o CLOCK_WISE +

+ + +

o COUNTER_CLOCK_WISE +

+ + + +
otypedef std::vector<osg::Vec3*> VertexPointList +

+ + +

ostruct Prim: public osg::Referenced +

+ + + +
o Prim(GLenum mode) +

+ + +

otypedef std::vector<osg::Vec3*> VecList +

+ + +

oGLenum _mode +

+ + +

oVecList _vertices +

+ + + +
ovoid beginTesselation() +

+ + +

ovoid beginContour() +

+ + +

ovoid addVertex(osg::Vec3* vertex) +

+ + +

ovoid endContour() +

+ + +

ovoid endTesselation() +

+ + +

otypedef std::vector< osg::ref_ptr<Prim> > PrimList +

+ + +

oPrimList& getPrimList() +

+ + +

ovoid retesselatePolygons(osg::Geometry& geom) +

+ + +

ovoid reset() +

+ + +

ovoid begin(GLenum mode) +

+ + +

ovoid vertex(osg::Vec3* vertex) +

+ + +

ovoid combine(osg::Vec3* vertex, void* vertex_data[4], GLfloat weight[4]) +

+ + +

ovoid end() +

+ + +

ovoid error(GLenum errorCode) +

+ + +

ostatic void CALLBACK beginCallback(GLenum which, void* userData) +

+ + +

ostatic void CALLBACK vertexCallback(GLvoid* data, void* userData) +

+ + +

ostatic void CALLBACK combineCallback(GLdouble coords[3], void* vertex_data[4], GLfloat weight[4], void** outData, void* useData) +

+ + +

ostatic void CALLBACK endCallback(void* userData) +

+ + +

ostatic void CALLBACK errorCallback(GLenum errorCode, void* userData) +

+ + +

ostruct Vec3d +

+ + + +
odouble _v[3] +

+ + + +
ostruct NewVertex +

+ + + +
o NewVertex() +

+ + +

o NewVertex(const NewVertex& nv) +

+ + +

o NewVertex(float f1, osg::Vec3* v1, float f2, osg::Vec3* v2, float f3, osg::Vec3* v3, float f4, osg::Vec3* v4) +

+ + +

ofloat _f1 +

+ + +

oosg::Vec3* _v1 +

+ + +

ofloat _f2 +

+ + +

oosg::Vec3* _v2 +

+ + +

ofloat _f3 +

+ + +

oosg::Vec3* _v3 +

+ + +

ofloat _f4 +

+ + +

oosg::Vec3* _v4 +

+ + + +
otypedef std::map<osg::Vec3*,NewVertex> NewVertexList +

+ + +

otypedef std::vector<Vec3d*> Vec3dList +

+ + +

oGLUtesselator* _tobj +

+ + +

oPrimList _primList +

+ + +

oVec3dList _coordData +

+ + +

oNewVertexList _newVertexList +

+ + +

oGLenum _errorCode +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/TransformCallback.html b/doc/doc++/osgUtil/TransformCallback.html new file mode 100644 index 000000000..3fc3643bf --- /dev/null +++ b/doc/doc++/osgUtil/TransformCallback.html @@ -0,0 +1,85 @@ + + + + + class OSGUTIL_EXPORT osgUtil::TransformCallback + + + + +

class OSGUTIL_EXPORT osgUtil::TransformCallback

+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TransformCallback(const osg::Vec3& pivot, const osg::Vec3& axis, float angularVelocity) +
+[more]virtual void operator() (osg::Node* node, osg::NodeVisitor* nv) +

+ +

+

Protected Fields

+[more]float _angular_velocity +
+[more]osg::Vec3 _pivot +
+[more]osg::Vec3 _axis +
+[more]int _previousTraversalNumber +
+[more]double _previousTime +

+ +
+ + +
+

Documentation

+
+ + + +
o TransformCallback(const osg::Vec3& pivot, const osg::Vec3& axis, float angularVelocity) +

+ + +

ovirtual void operator() (osg::Node* node, osg::NodeVisitor* nv) +

+ + +

ofloat _angular_velocity +

+ + +

oosg::Vec3 _pivot +

+ + +

oosg::Vec3 _axis +

+ + +

oint _previousTraversalNumber +

+ + +

odouble _previousTime +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/TriStripVisitor.html b/doc/doc++/osgUtil/TriStripVisitor.html new file mode 100644 index 000000000..630e58262 --- /dev/null +++ b/doc/doc++/osgUtil/TriStripVisitor.html @@ -0,0 +1,105 @@ + + + + + class OSGUTIL_EXPORT osgUtil::TriStripVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::TriStripVisitor

A tri stripping visitor for converting Geometry surface primitives into tri strips.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] TriStripVisitor() +
default to traversing all children +
+[more]void stripify(osg::Geometry& drawable) +
convert mesh primitives in Geometry into Tri Strips using NvTriStrip. +
+[more]virtual void apply(osg::Geode& geode) +
apply stripify method to all geode geometry +
+[more]inline void setCacheSize( unsigned int size ) +
+[more]inline unsigned int getCacheSize() +
+[more]inline const unsigned int getCacheSize() const +
+[more]inline void setMinStripSize( unsigned int size ) +
+[more]inline unsigned int getMinStripSize() +
+[more]inline const unsigned int getMinStripSize() const +

+ +
+ + +
+

Documentation

+
A tri stripping visitor for converting Geometry surface primitives into tri strips. +The current implemention is based up NVidia's NvTriStrip.
+
+ + + +
o TriStripVisitor() +
default to traversing all children +

+ + +

ovoid stripify(osg::Geometry& drawable) +
convert mesh primitives in Geometry into Tri Strips using +NvTriStrip. Converts all primitive types except points +and lines, linestrips which it leaves unchanged. +

+ + +

ovirtual void apply(osg::Geode& geode) +
apply stripify method to all geode geometry +

+ + +

oinline void setCacheSize( unsigned int size ) +

+ + +

oinline unsigned int getCacheSize() +

+ + +

oinline const unsigned int getCacheSize() const +

+ + +

oinline void setMinStripSize( unsigned int size ) +

+ + +

oinline unsigned int getMinStripSize() +

+ + +

oinline const unsigned int getMinStripSize() const +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/UpdateVisitor.html b/doc/doc++/osgUtil/UpdateVisitor.html new file mode 100644 index 000000000..d4a502e31 --- /dev/null +++ b/doc/doc++/osgUtil/UpdateVisitor.html @@ -0,0 +1,166 @@ + + + + + class OSGUTIL_EXPORT osgUtil::UpdateVisitor + + + + +

class OSGUTIL_EXPORT osgUtil::UpdateVisitor

Basic UpdateVisitor implementation for animating a scene.
+
+ +

Inheritance:

+ + + + + + + +
+ +
+

+

Public Methods

+[more] UpdateVisitor() +
+[more]virtual ~UpdateVisitor() +
+[more]virtual void reset() +
+[more]virtual void apply(osg::Node& node) +
+[more]virtual void apply(osg::Geode& node) +
+[more]virtual void apply(osg::Billboard& node) +
+[more]virtual void apply(osg::LightSource& node) +
+[more]virtual void apply(osg::Group& node) +
+[more]virtual void apply(osg::Transform& node) +
+[more]virtual void apply(osg::Projection& node) +
+[more]virtual void apply(osg::Switch& node) +
+[more]virtual void apply(osg::LOD& node) +
+[more]virtual void apply(osg::Impostor& node) +
+[more]virtual void apply(osg::OccluderNode& node) +

+ +

+

Protected Methods

+[more] UpdateVisitor(const UpdateVisitor&) +
prevent unwanted copy construction +
+[more]UpdateVisitor& operator = (const UpdateVisitor&) +
prevent unwanted copy operator +
+[more]inline void handle_callbacks_and_traverse(osg::Node& node) +
+[more]inline void handle_geode_callbacks(osg::Geode& node) +
+[more]inline void traverseGeode(osg::Geode& geode) +

+ +
+ + +
+

Documentation

+
+Basic UpdateVisitor implementation for animating a scene. +This visitor traverses the scene graph, call each nodes appCallback if +it exists.
+
+ + + +
o UpdateVisitor() +

+ + +

ovirtual ~UpdateVisitor() +

+ + +

ovirtual void reset() +

+ + +

ovirtual void apply(osg::Node& node) +

+ + +

ovirtual void apply(osg::Geode& node) +

+ + +

ovirtual void apply(osg::Billboard& node) +

+ + +

ovirtual void apply(osg::LightSource& node) +

+ + +

ovirtual void apply(osg::Group& node) +

+ + +

ovirtual void apply(osg::Transform& node) +

+ + +

ovirtual void apply(osg::Projection& node) +

+ + +

ovirtual void apply(osg::Switch& node) +

+ + +

ovirtual void apply(osg::LOD& node) +

+ + +

ovirtual void apply(osg::Impostor& node) +

+ + +

ovirtual void apply(osg::OccluderNode& node) +

+ + +

o UpdateVisitor(const UpdateVisitor&) +
prevent unwanted copy construction +

+ + +

oUpdateVisitor& operator = (const UpdateVisitor&) +
prevent unwanted copy operator +

+ + +

oinline void handle_callbacks_and_traverse(osg::Node& node) +

+ + +

oinline void handle_geode_callbacks(osg::Geode& node) +

+ + +

oinline void traverseGeode(osg::Geode& geode) +

+ +
This class has no child classes.
+ +

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/icon1.gif b/doc/doc++/osgUtil/icon1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f78f30eb981225beb16035974453af044eaaed3d GIT binary patch literal 326 zcmZ?wbhEHbSJz>XZiWhW+$CxX1K<{@Q;PzA3MW)Hil!>)yLQv z&I+YZWR4Dq0Qrf5 zE!m-=z(Yr>|42iEfdETiOVhyu2Ne$2qlXS;Sjcg9G-()EC{6Ng4B9Bb&hGxWX`zGB ztnbe@Mi#u2t#oD*5s{NGS5Q=P;Sv=Pl~k5hQB-wRQ&*Q#oU7r^r6eV#G~HwQ3KvHP FYXI`hOxged literal 0 HcmV?d00001 diff --git a/doc/doc++/osgUtil/icon2.gif b/doc/doc++/osgUtil/icon2.gif new file mode 100644 index 0000000000000000000000000000000000000000..6cbe01a831d9c27158ef1ade66cc25446fac9018 GIT binary patch literal 326 zcmZ?wbhEHbvUV_sg0vVRlep zUT#ibUH$CLjP97|8hg8t^_%zaId~E%=;f7aZRKxk>swYjH7c^q#Kc`$*&sZ;+`~Ol zL*3NdE7jE{7APVst6^&DtgCA)C##W~TG-k;MN7*vC@7wR8bI+U3nR!J9S{NX69Zea zLqmawj#U4Vh6DovmcEvzg9Q#M9Ii(X9muedZ+!$E~PkE!<|b>N=j+E$MO{}jttfS DX0}r~ literal 0 HcmV?d00001 diff --git a/doc/doc++/osgUtil/index.html b/doc/doc++/osgUtil/index.html new file mode 100644 index 000000000..2a07e8380 --- /dev/null +++ b/doc/doc++/osgUtil/index.html @@ -0,0 +1,61 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

Namespaces

+ +

Functions

+ +

Macros

+ +

Hierarchy of classes

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/osgUtil.html b/doc/doc++/osgUtil/osgUtil.html new file mode 100644 index 000000000..487edc9d1 --- /dev/null +++ b/doc/doc++/osgUtil/osgUtil.html @@ -0,0 +1,103 @@ + + + + + namespace osgUtil + + + + +

namespace osgUtil

+
+

+
+class OSGUTIL_EXPORT CubeMapGenerator: public osg::Referenced +
This is the base class for cube map generators. +
+class OSGUTIL_EXPORT DelaunayTriangulator: public osg::Referenced +
Utility class that triangulates an irregolar network of sample points. +
+class OSGUTIL_EXPORT DisplayListVisitor: public osg::NodeVisitor +
Visitor for traversing scene graph and setting each osg::Drawable's _useDisplayList flag, with option to immediately compile osg::Drawable OpenGL Display lists and osg::StateAttribute's +
+class OSGUTIL_EXPORT DisplayRequirementsVisitor: public osg::NodeVisitor +
A visitor for traversing a scene graph establishing the OpenGL visuals are required to support rendering of that scene graph. +
+class OSGUTIL_EXPORT HalfWayMapGenerator: public CubeMapGenerator +
This cube map generator produces an Half-way vector map, useful for hardware-based specular lighting effects. +
+class OSGUTIL_EXPORT HighlightMapGenerator: public CubeMapGenerator +
This cube map generator produces a specular highlight map. +
+class OSGUTIL_EXPORT InsertImpostorsVisitor: public osg::NodeVisitor +
Insert impostor nodes into scene graph. +
+class OSGUTIL_EXPORT Hit +
+class OSGUTIL_EXPORT IntersectVisitor: public osg::NodeVisitor +
Basic visitor for ray based collisions of a scene +
+class OSGUTIL_EXPORT Optimizer +
Insert impostor nodes into scene graph. +
+class OSGUTIL_EXPORT PickIntersectVisitor: public IntersectVisitor +
+class OSGUTIL_EXPORT PickVisitor: public osg::NodeVisitor +
+class ReflectionMapGenerator: public CubeMapGenerator +
This is the most simple cube map generator. +
+class OSGUTIL_EXPORT RenderBin: public osg::Object +
RenderBin base class +
+class RegisterRenderBinProxy +
Proxy class for automatic registration of renderbins with the RenderBin prototypelist +
+struct LeafDepthSortFunctor +
+class OSGUTIL_EXPORT RenderGraph: public osg::Referenced +
+class OSGUTIL_EXPORT RenderLeaf: public osg::Referenced +
container class for all data required for rendering of drawables +
+class OSGUTIL_EXPORT RenderStage: public RenderBin +
RenderState base class. +
+class OSGUTIL_EXPORT RenderStageLighting: public osg::Object +
RenderBin base class +
+class OSGUTIL_EXPORT RenderToTextureStage: public RenderStage +
RenderStage which copies the final image to an attached texture or image. +
+class OSGUTIL_EXPORT SceneView: public osg::Referenced +
SceneView is literally a view of a scene, encapsulating the camera, global state, lights and the scene itself. +
+class OSGUTIL_EXPORT SmoothingVisitor: public osg::NodeVisitor +
A smoothing visitor for calculating smoothed normals for osg::GeoSet's which contains surface primitives +
+class OSGUTIL_EXPORT Tesselator +
A simple class for tessellating a single polygon boundary. +
+class OSGUTIL_EXPORT TransformCallback: public osg::NodeCallback +
+class OSGUTIL_EXPORT TriStripVisitor: public osg::NodeVisitor +
A tri stripping visitor for converting Geometry surface primitives into tri strips. +
+class OSGUTIL_EXPORT UpdateVisitor: public osg::NodeVisitor +
Basic UpdateVisitor implementation for animating a scene. +
+class OSGUTIL_EXPORT CullVisitor: public osg::NodeVisitor, public osg::CullStack +
Basic NodeVisitor implementation for rendering a scene. Basic NodeVisitor implementation for rendering a scene. +

+ + + +
+

Documentation

+
+
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/osgUtilGetLibraryName.html b/doc/doc++/osgUtil/osgUtilGetLibraryName.html new file mode 100644 index 000000000..939ae4b11 --- /dev/null +++ b/doc/doc++/osgUtil/osgUtilGetLibraryName.html @@ -0,0 +1,21 @@ + + + + + extern OSGUTIL_EXPORT const char* osgUtilGetLibraryName + + + + +

extern OSGUTIL_EXPORT const char* osgUtilGetLibraryName

()

getLibraryName_osgUtil() returns the library name in human friendly form
+ + +
+

Documentation

+
+getLibraryName_osgUtil() returns the library name in human friendly form
+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + + diff --git a/doc/doc++/osgUtil/osgUtilGetVersion.html b/doc/doc++/osgUtil/osgUtilGetVersion.html new file mode 100644 index 000000000..379540873 --- /dev/null +++ b/doc/doc++/osgUtil/osgUtilGetVersion.html @@ -0,0 +1,34 @@ + + + + + extern OSGUTIL_EXPORT const char* osgUtilGetVersion + + + + +

extern OSGUTIL_EXPORT const char* osgUtilGetVersion

()

getVersion_osgUtil() returns the library version number.
+ + +
+

Documentation

+
+getVersion_osgUtil() returns the library version number. +Numbering convention : osg_src-0.8-31 will return 0.8.31 from getVersion_osgUtil. + +

This C function can be also used to check for the existence of the OpenSceneGraph +library using autoconf and its m4 macro AC_CHECK_LIB. + +

Here is the code to add to your configure.in: +\verbatim +# +# Check for the OpenSceneGraph (OSG) utility library +# +AC_CHECK_LIB(osg, osgUtilGetVersion, , +[AC_MSG_ERROR(OpenSceneGraph utility library not found. See http://www.openscenegraph.org)],) +\endverbatim

+

Alphabetic index HTML hierarchy of classes or Java

+
+This page was generated with the help of DOC++. + +