CMS 3D CMS Logo

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

BoundDisk Class Reference

#include <BoundDisk.h>

Inheritance diagram for BoundDisk:
BoundPlane Plane BoundSurface Surface Surface GloballyPositioned< float > BasicReferenceCounted GloballyPositioned< float > BasicReferenceCounted

List of all members.

Public Types

typedef
ReferenceCountingPointer
< BoundDisk
BoundDiskPointer
typedef
ConstReferenceCountingPointer
< BoundDisk
ConstBoundDiskPointer

Public Member Functions

 BoundDisk (const PositionType &pos, const RotationType &rot, Bounds *bounds)
 BoundDisk (const PositionType &pos, const RotationType &rot, const Bounds &bounds)
float innerRadius () const
 The inner radius of the disk.
float outerRadius () const
 The outer radius of the disk.
virtual ~BoundDisk ()

Static Public Member Functions

static BoundDiskPointer build (const PositionType &pos, const RotationType &rot, Bounds *bounds, MediumProperties *mp=0)
static BoundDiskPointer build (const PositionType &pos, const RotationType &rot, Bounds &bounds, MediumProperties *mp=0)

Protected Member Functions

 BoundDisk (const PositionType &pos, const RotationType &rot, Bounds *bounds, MediumProperties *mp=0)

Detailed Description

A BoundDisk is a special BoundPlane that is additionally limited by an inner and outer radius.

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).
Date:
2012/01/02 17:04:36
Revision:
1.3

Definition at line 21 of file BoundDisk.h.


Member Typedef Documentation

Definition at line 24 of file BoundDisk.h.

Definition at line 25 of file BoundDisk.h.


Constructor & Destructor Documentation

virtual BoundDisk::~BoundDisk ( ) [inline, virtual]

Definition at line 47 of file BoundDisk.h.

{}
BoundDisk::BoundDisk ( const PositionType pos,
const RotationType rot,
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 55 of file BoundDisk.h.

Referenced by build().

                            :
    Surface(pos,rot), BoundPlane( pos, rot, bounds) {}
BoundDisk::BoundDisk ( 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 63 of file BoundDisk.h.

                                  :
    Surface(pos,rot), BoundPlane( pos, rot, bounds) {}
BoundDisk::BoundDisk ( const PositionType pos,
const RotationType rot,
Bounds bounds,
MediumProperties mp = 0 
) [inline, protected]

Definition at line 79 of file BoundDisk.h.

                                    :
    Surface(pos, rot, mp), BoundPlane(pos, rot, bounds, mp) {}

Member Function Documentation

static BoundDiskPointer BoundDisk::build ( const PositionType pos,
const RotationType rot,
Bounds bounds,
MediumProperties mp = 0 
) [inline, static]

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

Definition at line 30 of file BoundDisk.h.

References BoundDisk().

                                                        {
    return BoundDiskPointer(new BoundDisk(pos, rot, bounds, mp));
  }
static BoundDiskPointer BoundDisk::build ( const PositionType pos,
const RotationType rot,
Bounds bounds,
MediumProperties mp = 0 
) [inline, static]

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

Definition at line 40 of file BoundDisk.h.

References BoundDisk().

                                                        {
    return BoundDiskPointer(new BoundDisk(pos, rot, &bounds, mp));
  }
float BoundDisk::innerRadius ( ) const [inline]
float BoundDisk::outerRadius ( ) const [inline]