BoundPlane Class Reference

#include <BoundPlane.h>

Inheritance diagram for BoundPlane:

List of all members.

Public Types
typedef ReferenceCountingPointer < BoundPlane >	BoundPlanePointer
typedef ConstReferenceCountingPointer < BoundPlane >	ConstBoundPlanePointer
Public Member Functions
	BoundPlane (const PositionType &pos, const RotationType &rot, const Bounds *bounds)
	BoundPlane (const PositionType &pos, const RotationType &rot)
	BoundPlane (const PositionType &pos, const RotationType &rot, const Bounds &bounds, MediumProperties *mp)
	BoundPlane (const PositionType &pos, const RotationType &rot, const Bounds *bounds, MediumProperties *mp)
	BoundPlane (const PositionType &pos, const RotationType &rot, const Bounds &bounds)
virtual	~BoundPlane ()
Static Public Member Functions
static BoundPlanePointer	build (const PositionType &pos, const RotationType &rot, const Bounds *bounds, MediumProperties *mp=0)
static BoundPlanePointer	build (const PositionType &pos, const RotationType &rot, const Bounds &bounds, MediumProperties *mp=0)

---

Detailed Description

A plane in 3D space, with bounds.

Warning:

Surfaces are reference counted, so only ReferenceCountingPointer should be used to point to them. For this reason, they should be using the static build() method. (The normal constructor will become private in the future).

Definition at line 19 of file BoundPlane.h.

---

Member Typedef Documentation

typedef ReferenceCountingPointer<BoundPlane> BoundPlane::BoundPlanePointer

Definition at line 21 of file BoundPlane.h.

typedef ConstReferenceCountingPointer<BoundPlane> BoundPlane::ConstBoundPlanePointer

Definition at line 22 of file BoundPlane.h.

---

Constructor & Destructor Documentation

virtual BoundPlane::~BoundPlane

(

)

[inline, virtual]

Definition at line 43 of file BoundPlane.h.

{}

BoundPlane::BoundPlane	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds *	bounds
	)		[inline]

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 50 of file BoundPlane.h.

Referenced by build().

                                    :
    Surface( pos,rot), Plane( pos, rot), BoundSurface(pos, rot, bounds) {}

BoundPlane::BoundPlane	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds &	bounds
	)		[inline]

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 58 of file BoundPlane.h.

                                    :
    Surface( pos,rot), Plane( pos, rot), BoundSurface(pos, rot, bounds) {}

BoundPlane::BoundPlane	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds *	bounds,
		MediumProperties *	mp
	)		[inline]

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 66 of file BoundPlane.h.

                                    :
    Surface( pos,rot,mp), Plane( pos, rot, mp), BoundSurface(pos, rot, bounds, mp) {}

BoundPlane::BoundPlane	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds &	bounds,
		MediumProperties *	mp
	)		[inline]

Do not use this constructor directly; use the static build method, which returns a ReferenceCountingPointer. This constructor will soon become private

Definition at line 75 of file BoundPlane.h.

                                    :
    Surface( pos,rot,mp), Plane( pos, rot, mp), BoundSurface(pos, rot, bounds, mp) {}

BoundPlane::BoundPlane	(	const PositionType &	pos,
		const RotationType &	rot
	)

Bound Plane with unlimited bounds Do not use this constructor directly; use the static build method, with OpenBounds(), or use a simple Plane instead. This constructor will soon become private

Definition at line 4 of file BoundPlane.cc.

                                                 :
    Surface( pos,rot ),
    Plane( pos, rot ),
    BoundSurface( pos, rot, OpenBounds() )
{ }

---

Member Function Documentation

static BoundPlanePointer BoundPlane::build	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds *	bounds,
		MediumProperties *	mp = 0
	)		[inline, static]

Construct a Plane with origin at pos and with rotation matrix rot, with bounds. The bounds you provide are cloned.

Definition at line 26 of file BoundPlane.h.

References BoundPlane().

Referenced by ReferenceTrajectory::construct().

                                                            {
    return BoundPlanePointer(new BoundPlane(pos, rot, bounds, mp));
  }

static BoundPlanePointer BoundPlane::build	(	const PositionType &	pos,
		const RotationType &	rot,
		const Bounds &	bounds,
		MediumProperties *	mp = 0
	)		[inline, static]

Construct a Plane with origin at pos and with rotation matrix rot, with bounds. The bounds you provide are cloned.

Definition at line 36 of file BoundPlane.h.

References BoundPlane().

                                                            {
    return BoundPlanePointer(new BoundPlane(pos, rot, bounds, mp));
  }