sdf::v12::Geometry Class Reference

Geometry provides access to a shape, such as a Box. More...

#include <Geometry.hh>

Public Member Functions
	Geometry ()
	Default constructor. More...
const Box *	BoxShape () const
	Get the box geometry, or nullptr if the contained geometry is not a box. More...
const Capsule *	CapsuleShape () const
	Get the capsule geometry, or nullptr if the contained geometry is not a capsule. More...
const Cylinder *	CylinderShape () const
	Get the cylinder geometry, or nullptr if the contained geometry is not a cylinder. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
const Ellipsoid *	EllipsoidShape () const
	Get the ellipsoid geometry, or nullptr if the contained geometry is not an ellipsoid. More...
const Heightmap *	HeightmapShape () const
	Get the heightmap geometry, or nullptr if the contained geometry is not a heightmap. More...
Errors	Load (ElementPtr _sdf)
	Load the geometry based on a element pointer. More...
const Mesh *	MeshShape () const
	Get the mesh geometry, or nullptr if the contained geometry is not a mesh. More...
const Plane *	PlaneShape () const
	Get the plane geometry, or nullptr if the contained geometry is not a plane. More...
const std::vector< Polyline > &	PolylineShape () const
	Get the polyline geometry. More...
void	SetBoxShape (const Box &_box)
	Set the box shape. More...
void	SetCapsuleShape (const Capsule &_capsule)
	Set the capsule shape. More...
void	SetCylinderShape (const Cylinder &_cylinder)
	Set the cylinder shape. More...
void	SetEllipsoidShape (const Ellipsoid &_ellipsoid)
	Set the ellipsoid shape. More...
void	SetHeightmapShape (const Heightmap &_heightmap)
	Set the heightmap shape. More...
void	SetMeshShape (const Mesh &_mesh)
	Set the mesh shape. More...
void	SetPlaneShape (const Plane &_plane)
	Set the plane shape. More...
void	SetPolylineShape (const std::vector< Polyline > &_polyline)
	Set the polyline shape. More...
void	SetSphereShape (const Sphere &_sphere)
	Set the sphere shape. More...
void	SetType (const GeometryType _type)
	Set the type of geometry. More...
const Sphere *	SphereShape () const
	Get the sphere geometry, or nullptr if the contained geometry is not a sphere. More...
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this geometry. More...
GeometryType	Type () const
	Get the type of geometry. More...

Detailed Description

Geometry provides access to a shape, such as a Box.

Use the Type function to determine the type of shape contained within a Geometry. Access to shape data, such as a box's size, is achieved through the shape accessors, such as const Box *BoxShape() const.

Constructor & Destructor Documentation

Geometry()

sdf::v12::Geometry::Geometry

(

)

Default constructor.

Member Function Documentation

BoxShape()

const Box* sdf::v12::Geometry::BoxShape

(

)

const

Get the box geometry, or nullptr if the contained geometry is not a box.

Returns

Pointer to the visual's box geometry, or nullptr if the geometry is not a box.

See also

GeometryType Type() const

CapsuleShape()

const Capsule* sdf::v12::Geometry::CapsuleShape

(

)

const

Get the capsule geometry, or nullptr if the contained geometry is not a capsule.

Returns

Pointer to the capsule geometry, or nullptr if the geometry is not a capsule.

See also

GeometryType Type() const

CylinderShape()

const Cylinder* sdf::v12::Geometry::CylinderShape

(

)

const

Get the cylinder geometry, or nullptr if the contained geometry is not a cylinder.

Returns

Pointer to the visual's cylinder geometry, or nullptr if the geometry is not a cylinder.

See also

GeometryType Type() const

Element()

sdf::ElementPtr sdf::v12::Geometry::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.

EllipsoidShape()

const Ellipsoid* sdf::v12::Geometry::EllipsoidShape

(

)

const

Get the ellipsoid geometry, or nullptr if the contained geometry is not an ellipsoid.

Returns

Pointer to the ellipsoid geometry, or nullptr if the geometry is not an ellipsoid.

See also

GeometryType Type() const

HeightmapShape()

const Heightmap* sdf::v12::Geometry::HeightmapShape

(

)

const

Get the heightmap geometry, or nullptr if the contained geometry is not a heightmap.

Returns

Pointer to the heightmap geometry, or nullptr if the geometry is not a heightmap.

See also

GeometryType Type() const

Load()

Errors sdf::v12::Geometry::Load

(

ElementPtr

_sdf

)

Load the 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

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

MeshShape()

const Mesh* sdf::v12::Geometry::MeshShape

(

)

const

Get the mesh geometry, or nullptr if the contained geometry is not a mesh.

Returns

Pointer to the visual's mesh geometry, or nullptr if the geometry is not a mesh.

See also

GeometryType Type() const

PlaneShape()

const Plane* sdf::v12::Geometry::PlaneShape

(

)

const

Get the plane geometry, or nullptr if the contained geometry is not a plane.

Returns

Pointer to the visual's plane geometry, or nullptr if the geometry is not a plane.

See also

GeometryType Type() const

PolylineShape()

const std::vector<Polyline>& sdf::v12::Geometry::PolylineShape

(

)

const

Get the polyline geometry.

Vector is empty if the contained geometry is not a polyline.

Returns

The visual's polyline geometries.

See also

GeometryType Type() const

SetBoxShape()

void sdf::v12::Geometry::SetBoxShape

(

const Box &

_box

)

Set the box shape.

Parameters

[in]

_box

The box shape.

SetCapsuleShape()

void sdf::v12::Geometry::SetCapsuleShape

(

const Capsule &

_capsule

)

Set the capsule shape.

Parameters

[in]

_capsule

The capsule shape.

SetCylinderShape()

void sdf::v12::Geometry::SetCylinderShape

(

const Cylinder &

_cylinder

)

Set the cylinder shape.

Parameters

[in]

_cylinder

The cylinder shape.

SetEllipsoidShape()

void sdf::v12::Geometry::SetEllipsoidShape

(

const Ellipsoid &

_ellipsoid

)

Set the ellipsoid shape.

Parameters

[in]

_ellipsoid

The ellipsoid shape.

SetHeightmapShape()

void sdf::v12::Geometry::SetHeightmapShape

(

const Heightmap &

_heightmap

)

Set the heightmap shape.

Parameters

[in]

_heightmap

The heightmap shape.

SetMeshShape()

void sdf::v12::Geometry::SetMeshShape

(

const Mesh &

_mesh

)

Set the mesh shape.

Parameters

[in]

_mesh

The mesh shape.

SetPlaneShape()

void sdf::v12::Geometry::SetPlaneShape

(

const Plane &

_plane

)

Set the plane shape.

Parameters

[in]

_plane

The plane shape.

SetPolylineShape()

void sdf::v12::Geometry::SetPolylineShape

(

const std::vector< Polyline > &

_polyline

)

Set the polyline shape.

Parameters

[in]

_polyline

The polyline shape.

SetSphereShape()

void sdf::v12::Geometry::SetSphereShape

(

const Sphere &

_sphere

)

Set the sphere shape.

Parameters

[in]

_sphere

The sphere shape.

SetType()

void sdf::v12::Geometry::SetType

(

const GeometryType

_type

)

Set the type of geometry.

Parameters

[in]

_type

The geometry type.

SphereShape()

const Sphere* sdf::v12::Geometry::SphereShape

(

)

const

Get the sphere geometry, or nullptr if the contained geometry is not a sphere.

Returns

Pointer to the visual's sphere geometry, or nullptr if the geometry is not a sphere.

See also

GeometryType Type() const

ToElement()

sdf::ElementPtr sdf::v12::Geometry::ToElement

(

)

const

Create and return an SDF element filled with data from this geometry.

Note that parameter passing functionality is not captured with this function.

Returns

SDF element pointer with updated geometry values.

Type()

GeometryType sdf::v12::Geometry::Type

(

)

const

Get the type of geometry.

Returns

The geometry type.

---

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

• Geometry.hh