openscenegraph
Public Types | Public Member Functions | Friends | List of all members
osgSim::SphereSegment Class Reference
Inheritance diagram for osgSim::SphereSegment:
osg::Geode osg::Node osg::Object osg::Referenced

Public Types

enum  DrawMask {
  SURFACE = 0x00000001, SPOKES = 0x00000002, EDGELINE = 0x00000008, SIDES = 0x00000010,
  ALL = 0x7fffffff
}
typedef std::vector
< osg::ref_ptr< osg::Vec3Array > > 
LineList
- Public Types inherited from osg::Geode
typedef std::vector< ref_ptr
< Drawable > > 
DrawableList
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 SphereSegment ()
 SphereSegment (const osg::Vec3 &centre, float radius, float azMin, float azMax, float elevMin, float elevMax, int density)
 SphereSegment (const osg::Vec3 &centre, float radius, const osg::Vec3 &vec, float azRange, float elevRange, int density)
 SphereSegment (const SphereSegment &rhs, const osg::CopyOp &co)
void setCentre (const osg::Vec3 &c)
const osg::Vec3getCentre () const
void setRadius (float r)
float getRadius () const
void setArea (const osg::Vec3 &vec, float azRange, float elevRange)
void getArea (osg::Vec3 &vec, float &azRange, float &elevRange) const
void setArea (float azMin, float azMax, float elevMin, float elevMax)
void getArea (float &azMin, float &azMax, float &elevMin, float &elevMax) const
void setDensity (int d)
int getDensity () const
void setDrawMask (int dm)
int getDrawMask () const
void setSurfaceColor (const osg::Vec4 &c)
const osg::Vec4getSurfaceColor () const
void setSpokeColor (const osg::Vec4 &c)
const osg::Vec4getSpokeColor () const
void setEdgeLineColor (const osg::Vec4 &c)
const osg::Vec4getEdgeLineColor () const
void setSideColor (const osg::Vec4 &c)
const osg::Vec4getSideColor () const
void setAllColors (const osg::Vec4 &c)
 META_Node (osgSim, SphereSegment)
LineList computeIntersection (const osg::Matrixd &matrix, osg::Node *subgraph)
LineList computeIntersection (const osg::Matrixd &matrix, osg::Drawable *drawable)
osg::NodecomputeIntersectionSubgraph (const osg::Matrixd &matrix, osg::Node *subgraph)
osg::NodecomputeIntersectionSubgraph (const osg::Matrixd &matrix, osg::Drawable *drawable)
- Public Member Functions inherited from osg::Geode
 Geode ()
 Geode (const Geode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Geode)
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual bool addDrawable (Drawable *drawable)
virtual bool removeDrawable (Drawable *drawable)
virtual bool removeDrawables (unsigned int i, unsigned int numDrawablesToRemove=1)
virtual bool replaceDrawable (Drawable *origDraw, Drawable *newDraw)
virtual bool setDrawable (unsigned int i, Drawable *drawable)
unsigned int getNumDrawables () const
DrawablegetDrawable (unsigned int i)
const DrawablegetDrawable (unsigned int i) const
bool containsDrawable (const Drawable *gset) const
unsigned int getDrawableIndex (const Drawable *drawable) const
const DrawableListgetDrawableList () const
void compileDrawables (RenderInfo &renderInfo)
const BoundingBoxgetBoundingBox () const
virtual BoundingSphere computeBound () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
virtual void traverse (NodeVisitor &)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Friends

class Surface
class EdgeLine
class Side
class Spoke

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Member Functions inherited from osg::Geode
virtual ~Geode ()
- Protected Attributes inherited from osg::Geode
osg::BoundingBox _bbox
DrawableList _drawables

Detailed Description

A SphereSegment is a Geode to represent an portion of a sphere (potentially the whole sphere). The sphere is aligned such that the line through the sphere's poles is parallel to the z axis. The sphere segment may be rendered various components switched on or off:

- The specified area of the sphere surface.

- An edge line around the boundary of the specified area
  of the sphere surface.

- Four <i>spokes</i>, where a spoke is the line from
  the sphere's centre to a corner of the rendered area.

- Four planar areas, where the planar areas are formed
  between the spokes.

Caveats:

- It's worth noting that the line through the sphere's poles is
  parallel to the z axis. This has implications when specifying the
  area to be rendered, and specifying areas where the centre of
  the rendered area <i>is</i> the Z axis may lead to unexpected
  geometry.

- It's possible to render the whole sphere by specifying elevation
  and azimuth ranges round the full 360 degrees. When doing
  so you may consider switching the planes, spokes, and edge lines
  off, to avoid rendering artefacts, e.g. the upper and lower
  planes will be coincident.

Member Typedef Documentation

A list of vertex arrays representing a list of lines.

Member Enumeration Documentation

DrawMask represents a bit field, the values of which may be OR'ed together to specify which parts of the sphere segment should be drawn. E.g.

Enumerator:
SURFACE 

Draw the specified area on the sphere's surface.

SPOKES 

Draw the spokes from the sphere's centre to the surface's corners.

EDGELINE 

Draw the line round the edge of the area on the sphere's surface.

SIDES 

Draw the planes from the sphere's centre to the edge of the sphere's surface.

ALL 

Draw every part of the sphere segment.

Constructor & Destructor Documentation

osgSim::SphereSegment::SphereSegment ( )
inline

Default constructor.

osgSim::SphereSegment::SphereSegment ( const osg::Vec3 centre,
float  radius,
float  azMin,
float  azMax,
float  elevMin,
float  elevMax,
int  density 
)
inline

Construct by angle ranges. Note that the azimuth 'zero' is the Y axis; specifying an azimuth range from azMin -osg::PI/2.0f to azMax osg::PI/2.0f will cover the 'top half' of the circle in the XY plane. The elev angles are 'out' of the 'zero' XY plane with +ve angles above the plane, and -ve angles below.

Parameters
centresphere centre
radiusradius of sphere
azMinazimuth minimum
azMaxazimuth maximum
elevMinelevation minimum
elevMaxelevation maximum
densitynumber of units to divide the azimuth and elevation ranges into
osgSim::SphereSegment::SphereSegment ( const osg::Vec3 centre,
float  radius,
const osg::Vec3 vec,
float  azRange,
float  elevRange,
int  density 
)

Construct by vector.

Parameters
centresphere centre
radiusradius of sphere
vecvector pointing from sphere centre to centre point of rendered area on sphere surface
azRangeazimuth range in radians (with centre along vec)
elevRangeelevation range in radians (with centre along vec)
densitynumber of units to divide the azimuth and elevation ranges into
osgSim::SphereSegment::SphereSegment ( const SphereSegment rhs,
const osg::CopyOp co 
)
inline

Copy constructor

Member Function Documentation

LineList osgSim::SphereSegment::computeIntersection ( const osg::Matrixd matrix,
osg::Node subgraph 
)

Compute the interesection lines between subgraph and this sphere segment. The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. The resulting intersections are in the coordinate frame of the sphere segment.

LineList osgSim::SphereSegment::computeIntersection ( const osg::Matrixd matrix,
osg::Drawable drawable 
)

Compute the interesection lines between specified drawable and this sphere segment. The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. The resulting intersections are in the coordinate frame of the sphere segment.

osg::Node* osgSim::SphereSegment::computeIntersectionSubgraph ( const osg::Matrixd matrix,
osg::Node subgraph 
)

Compute the interesection lines between subgraph and this sphere segment. The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. The resulting intersections are in the coordinate frame of the sphere segment.

osg::Node* osgSim::SphereSegment::computeIntersectionSubgraph ( const osg::Matrixd matrix,
osg::Drawable drawable 
)

Compute the interesection lines between specified drawable and this sphere segment. The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. The resulting intersections are in the coordinate frame of the sphere segment.

void osgSim::SphereSegment::getArea ( osg::Vec3 vec,
float &  azRange,
float &  elevRange 
) const
Get the area of the sphere segment
Parameters
vecvector pointing from sphere centre to centre point of rendered area on sphere surface (normalized)
azRangeazimuth range in radians (with centre along vec)
elevRangeelevation range in radians (with centre along vec)
void osgSim::SphereSegment::getArea ( float &  azMin,
float &  azMax,
float &  elevMin,
float &  elevMax 
) const
Get the area of the sphere segment
Parameters
azMinazimuth minimum
azMaxazimuth maximum
elevMinelevation minimum
elevMaxelevation maximum
const osg::Vec3& osgSim::SphereSegment::getCentre ( ) const

Get the centre point of the SphereSegment

int osgSim::SphereSegment::getDensity ( ) const

Get the density of the sphere segment

int osgSim::SphereSegment::getDrawMask ( ) const
inline

Get the DrawMask

const osg::Vec4& osgSim::SphereSegment::getEdgeLineColor ( ) const
inline

Get the color of the edge line.

float osgSim::SphereSegment::getRadius ( ) const

Get the radius of the SphereSegment

const osg::Vec4& osgSim::SphereSegment::getSideColor ( ) const
inline

Get the color of the planes.

const osg::Vec4& osgSim::SphereSegment::getSpokeColor ( ) const
inline

Get the color of the spokes.

const osg::Vec4& osgSim::SphereSegment::getSurfaceColor ( ) const
inline

Get the color of the surface.

osgSim::SphereSegment::META_Node ( osgSim  ,
SphereSegment   
)
void osgSim::SphereSegment::setAllColors ( const osg::Vec4 c)

Set color of all components.

void osgSim::SphereSegment::setArea ( const osg::Vec3 vec,
float  azRange,
float  elevRange 
)
Set the area of the sphere segment
Parameters
vecvector pointing from sphere centre to centre point of rendered area on sphere surface
azRangeazimuth range in radians (with centre along vec)
elevRangeelevation range in radians (with centre along vec)
void osgSim::SphereSegment::setArea ( float  azMin,
float  azMax,
float  elevMin,
float  elevMax 
)
Set the area of the sphere segment
Parameters
azMinazimuth minimum
azMaxazimuth maximum
elevMinelevation minimum
elevMaxelevation maximum
void osgSim::SphereSegment::setCentre ( const osg::Vec3 c)

Set the centre point of the SphereSegment

void osgSim::SphereSegment::setDensity ( int  d)

Set the density of the sphere segment

void osgSim::SphereSegment::setDrawMask ( int  dm)

Specify the DrawMask.

Parameters
dmBitmask specifying which parts of the sphere segment should be drawn.
See Also
DrawMask
void osgSim::SphereSegment::setEdgeLineColor ( const osg::Vec4 c)

Set the color of the edge line.

void osgSim::SphereSegment::setRadius ( float  r)

Set the radius of the SphereSegment

void osgSim::SphereSegment::setSideColor ( const osg::Vec4 c)

Set the color of the planes.

void osgSim::SphereSegment::setSpokeColor ( const osg::Vec4 c)

Set the color of the spokes.

void osgSim::SphereSegment::setSurfaceColor ( const osg::Vec4 c)

Set the color of the surface.

Friends And Related Function Documentation

friend class EdgeLine
friend
friend class Side
friend
friend class Spoke
friend
friend class Surface
friend

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