Plane represents a plane shape, and is usually accessed through a Geometry.
More...
#include <Plane.hh>

 Plane () 
 Constructor. More...


sdf::ElementPtr  Element () const 
 Get a pointer to the SDF element that was used during load. More...


Errors  Load (ElementPtr _sdf) 
 Load the plane geometry based on a element pointer. More...


ignition::math::Vector3d  Normal () const 
 Get the plane normal vector. More...


void  SetNormal (const ignition::math::Vector3d &_normal) 
 Set the plane normal vector. More...


void  SetSize (const ignition::math::Vector2d &_size) 
 Set the plane size in meters. More...


const ignition::math::Planed &  Shape () const 
 Get the Ignition Math representation of this Plane. More...


ignition::math::Planed &  Shape () 
 Get a mutable Ignition Math representation of this Plane. More...


ignition::math::Vector2d  Size () const 
 Get the plane size in meters. More...


Plane represents a plane shape, and is usually accessed through a Geometry.
◆ Plane()
sdf::v11::Plane::Plane 
( 
 ) 

◆ Element()
sdf::ElementPtr sdf::v11::Plane::Element 
( 
 ) 
const 
Get a pointer to the SDF element that was used during load.
 Returns
 SDF element pointer. The value will be nullptr if Load has not been called.
◆ Load()
Load the plane geometry based on a element pointer.
This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.
 Parameters

 Returns
 Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.
◆ Normal()
ignition::math::Vector3d sdf::v11::Plane::Normal 
( 
 ) 
const 
Get the plane normal vector.
When a Plane is used as a geometry for a Visual or Collision object, then the normal is specified in the Visual or Collision frame, respectively.
 Returns
 The plane normal vector.
◆ SetNormal()
void sdf::v11::Plane::SetNormal 
( 
const ignition::math::Vector3d & 
_normal  ) 

Set the plane normal vector.
The _normal vector will be normalized. See ignition::math::Vector3d Normal() for more information about the normal vector, such as the frame in which it is specified.
 Parameters

[in]  _normal  The plane normal vector. 
◆ SetSize()
void sdf::v11::Plane::SetSize 
( 
const ignition::math::Vector2d & 
_size  ) 

Set the plane size in meters.
 Parameters

[in]  _size  The plane size in meters. 
◆ Shape() [1/2]
const ignition::math::Planed& sdf::v11::Plane::Shape 
( 
 ) 
const 
Get the Ignition Math representation of this Plane.
 Returns
 A const reference to an ignition::math::Planed object.
◆ Shape() [2/2]
ignition::math::Planed& sdf::v11::Plane::Shape 
( 
 ) 

Get a mutable Ignition Math representation of this Plane.
 Returns
 A reference to an ignition::math::Planed object.
◆ Size()
ignition::math::Vector2d sdf::v11::Plane::Size 
( 
 ) 
const 
Get the plane size in meters.
 Returns
 The plane size in meters.
The documentation for this class was generated from the following file: