Isis::BulletTargetShape Class Reference

Bullet Target Shape for planetary bodies. More...

#include <BulletTargetShape.h>

Inheritance diagram for Isis::BulletTargetShape:

Collaboration diagram for Isis::BulletTargetShape:

Public Member Functions
	BulletTargetShape ()
	Default empty constructor.
	BulletTargetShape (btCollisionObject *btbody, const QString &name="")
	Constructs a BulletTargetShape for a given a Bullet object.
virtual	~BulletTargetShape ()
	Desctructor.
QString	name () const
	Return name of the target shape.
void	writeBullet (const QString &btName) const
	Write a serialized version of the target shape to a Bullet file.
btCollisionObject *	body () const
	Return a pointer to the Bullet target object/shape.
btScalar	maximumDistance () const

Static Public Member Functions
static BulletTargetShape *	load (const QString &dem, const Pvl *conf=0)
	Load a DEM file into the target shape.
static BulletTargetShape *	loadPC (const QString &dem, const Pvl *conf=0)
	Load a point cloud type DEM in Bullet.
static BulletTargetShape *	loadDSK (const QString &dem, const Pvl *conf=0)
	Load a DSK in Bullet.
static BulletTargetShape *	loadCube (const QString &dem, const Pvl *conf=0)
	Load an ISIS cube type DEM in Bullet.

Protected Member Functions
void	setTargetBody (btCollisionObject *body)
	Set the Bullet shape object to this object instance.
void	setMaximumDistance ()
	Calculate and save the maximum distance across the body.

Static Protected Member Functions
static void	btDelete (btCollisionObject *btbody)

Detailed Description

Bullet Target Shape for planetary bodies.

This class contains the in memory representation of a body for use with the Bullet library. For each type of file that can be used to create a bullet target body, this class should be extended to manage that type of file.

Note this object takes ownership of the btCollisionObject parameter as well as the underlying btCollisionShape pointer (which is also deleted when the object body pointer is deleted.)

Author

2017-03-17 Kris Becker

Constructor & Destructor Documentation

BulletTargetShape() [1/2]

Isis::BulletTargetShape::BulletTargetShape

(

)

Default empty constructor.

The filename defaults to an empty string and the maximum distance defaults to 0.

Referenced by load(), loadCube(), loadDSK(), and loadPC().

BulletTargetShape() [2/2]

Isis::BulletTargetShape::BulletTargetShape	(	btCollisionObject *	btbody,
		const QString &	name = "" )

Constructs a BulletTargetShape for a given a Bullet object.

Parameters

btbody	The Bullet collision object to contain.
name	The name of the object.

References btDelete(), name(), and setMaximumDistance().

~BulletTargetShape()

Isis::BulletTargetShape::~BulletTargetShape ( )

virtual

Desctructor.

Member Function Documentation

body()

btCollisionObject * Isis::BulletTargetShape::body

(

)

const

Return a pointer to the Bullet target object/shape.

Returns

btCollisionObject A target to the Bullet collision object.

Referenced by Isis::BulletWorldManager::addTarget(), and setTargetBody().

btDelete()

void Isis::BulletTargetShape::btDelete ( btCollisionObject * btbody )

staticprotected

Referenced by BulletTargetShape(), and setTargetBody().

load()

BulletTargetShape * Isis::BulletTargetShape::load ( const QString & dem, const Pvl * conf = 0 )

static

Load a DEM file into the target shape.

Parameters

dem	The DEM file to load.
conf	PVL config for the DEM load. Currently unused.

Returns

BulletTargetShape A target shape containing the DEM

References BulletTargetShape(), loadCube(), loadDSK(), and loadPC().

Referenced by Isis::BulletShapeModel::BulletShapeModel(), and Isis::ShapeModelFactory::create().

loadCube()

BulletTargetShape * Isis::BulletTargetShape::loadCube ( const QString & dem, const Pvl * conf = 0 )

static

Load an ISIS cube type DEM in Bullet.

Note

Currently not implemented

Parameters

dem	The DEM file to load.
conf	PVL config for the DEM load. Currently unused.

Returns

BulletTargetShape A target shape containing the DEM

References BulletTargetShape().

Referenced by load().

loadDSK()

BulletTargetShape * Isis::BulletTargetShape::loadDSK ( const QString & dem, const Pvl * conf = 0 )

static

Load a DSK in Bullet.

Parameters

dem	The DEM file to load.
conf	PVL config for the DEM load. Currently unused.

Returns

BulletTargetShape A target shape containing the DEM

References BulletTargetShape().

Referenced by load().

loadPC()

BulletTargetShape * Isis::BulletTargetShape::loadPC ( const QString & dem, const Pvl * conf = 0 )

static

Load a point cloud type DEM in Bullet.

Note

Currently not implemented

Parameters

dem	The DEM file to load.
conf	PVL config for the DEM load. Currently unused.

Returns

BulletTargetShape A target shape containing the DEM

References BulletTargetShape().

Referenced by load().

maximumDistance()

btScalar Isis::BulletTargetShape::maximumDistance

(

)

const

name()

QString Isis::BulletTargetShape::name

(

)

const

Return name of the target shape.

Returns

QString The target name

Referenced by Isis::BulletShapeModel::BulletShapeModel(), BulletTargetShape(), and Isis::BulletWorldManager::getTarget().

setMaximumDistance()

void Isis::BulletTargetShape::setMaximumDistance ( )

protected

Calculate and save the maximum distance across the body.

This is calculated as the distance from the x, y, z minimum to x, y, z maximum.

Referenced by Isis::BulletDskShape::BulletDskShape(), BulletTargetShape(), and setTargetBody().

setTargetBody()

void Isis::BulletTargetShape::setTargetBody ( btCollisionObject * body )

protected

Set the Bullet shape object to this object instance.

References body(), btDelete(), and setMaximumDistance().

writeBullet()

void Isis::BulletTargetShape::writeBullet

(

const QString &

btName

)

const

Write a serialized version of the target shape to a Bullet file.

Parameters

btName

The name of the file to write the target shape to.

Note

Currently not implemented

---

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

• /home/runner/work/ISIS3/ISIS3/isis/src/base/objs/BulletTargetShape/BulletTargetShape.h
• /home/runner/work/ISIS3/ISIS3/isis/src/base/objs/BulletTargetShape/BulletTargetShape.cpp