SurgSim::Graphics::OsgPlane Class Reference

OSG plane geode to be used as a primitive shape The plane is the XZ plane, with normal +Y. More...

`#include <SurgSim/Graphics/OsgPlane.h>`

## Public Member Functions

| OsgPlane (float length=1000.0f, float width=1000.0f)
| Constructor. More...
osg::ref_ptr< osg::Node > | getNode () const
| Returns the root OSG node for the plane to be inserted into the scene-graph. More...

## Private Attributes

osg::ref_ptr< osg::Geode > | m_geode
| Root OSG node of the plane. More...

## Detailed Description

OSG plane geode to be used as a primitive shape The plane is the XZ plane, with normal +Y.

The plane is drawn with a Quad at (0.0, 0.0, 0.0) with length and width specified in the constructor (or default of 1000 for each). Add the plane geode to a transform node to position it.

## Constructor & Destructor Documentation

## OsgPlane()

SurgSim::Graphics::OsgPlane::OsgPlane | ( | float | length = `1000.0f`,
|  | float | width = `1000.0f`
| ) |  |

inline explicit

Constructor.

Parameters

  length | Length of the plane in X (default is 1000)
  width | Width of the plane in Z (default is 1000)

Normal is X^-Z = Y

## Member Function Documentation

## getNode()

osg::ref_ptr<osg::Node> SurgSim::Graphics::OsgPlane::getNode | ( |  | ) | const

inline

Returns the root OSG node for the plane to be inserted into the scene-graph.

## Member Data Documentation

## m_geode

osg::ref_ptr<osg::Geode> SurgSim::Graphics::OsgPlane::m_geode

private

Root OSG node of the plane.

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

- SurgSim/Graphics/OsgPlane.h