CMS 3D CMS Logo

Public Types | Public Member Functions | Static Public Member Functions

Plane Class Reference

#include <Plane.h>

Inheritance diagram for Plane:
Surface GloballyPositioned< float > BasicReferenceCounted BoundaryPlane BoundPlane TangentPlane BoundDisk BoundDiskSector

List of all members.

Public Types

typedef
ConstReferenceCountingPointer
< Plane
ConstPlanePointer
typedef
ReferenceCountingPointer
< Plane
PlanePointer

Public Member Functions

float localZ (const GlobalPoint &gp) const
 Fast access to distance from plane for a point.
float localZ (const GlobalVector &gv) const
 Fast access to component perpendicular to plane for a vector.
GlobalVector normalVector () const
 Plane (const PositionType &pos, const RotationType &rot, MediumProperties *mp)
 Plane (const PositionType &pos, const RotationType &rot)
virtual SurfaceOrientation::Side side (const GlobalPoint &p, Scalar toler) const
virtual SurfaceOrientation::Side side (const LocalPoint &p, Scalar toler) const
virtual
ReferenceCountingPointer
< TangentPlane
tangentPlane (const GlobalPoint &) const
 tangent plane to surface from global point
virtual
ReferenceCountingPointer
< TangentPlane
tangentPlane (const LocalPoint &) const
 tangent plane to surface from local point

Static Public Member Functions

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

Detailed Description

A plane in 3D space.

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 17 of file Plane.h.


Member Typedef Documentation

Definition at line 20 of file Plane.h.

Definition at line 19 of file Plane.h.


Constructor & Destructor Documentation

Plane::Plane ( const PositionType pos,
const RotationType rot 
) [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 36 of file Plane.h.

Referenced by build().

                                                           :
    Surface( pos, rot) {}
Plane::Plane ( const PositionType pos,
const RotationType rot,
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 42 of file Plane.h.

                                                                                 : 
    Surface( pos, rot, mp) {}

Member Function Documentation

static PlanePointer Plane::build ( const PositionType pos,
const RotationType rot,
MediumProperties mp = 0 
) [inline, static]

Construct a Plane. The reference frame is defined by pos and rot; the plane is orthogonal to the local Z axis.

Definition at line 25 of file Plane.h.

References Plane().

Referenced by TrackExtrapolator::propagateTrackToVolume().

                                                            {
    return PlanePointer(new Plane(pos, rot, mp));
  }
float Plane::localZ ( const GlobalVector gv) const [inline]

Fast access to component perpendicular to plane for a vector.

Definition at line 57 of file Plane.h.

References Vector3DBase< T, FrameTag >::dot(), and normalVector().

                                              {
    return normalVector().dot(gv);
  }
float Plane::localZ ( const GlobalPoint gp) const [inline]
GlobalVector Plane::normalVector ( ) const [inline]
virtual SurfaceOrientation::Side Plane::side ( const LocalPoint p,
Scalar  tolerance 
) const [inline, virtual]

Returns the side of the surface on which the point is. Not defined for 1-sided surfaces (Moebius leaf etc.) For normal 2-sided surfaces the meaning of side is surface type dependent.

Implements Surface.

Definition at line 63 of file Plane.h.

References abs, SurfaceOrientation::negativeSide, SurfaceOrientation::onSurface, SurfaceOrientation::positiveSide, and PV3DBase< T, PVType, FrameType >::z().

Referenced by NavVolume6Faces::computeBounds(), and NavPropagator::destinationCrossed().

virtual SurfaceOrientation::Side Plane::side ( const GlobalPoint p,
Scalar  toler 
) const [inline, virtual]
ReferenceCountingPointer< TangentPlane > Plane::tangentPlane ( const LocalPoint ) const [virtual]

tangent plane to surface from local point

Implements Surface.

Definition at line 17 of file Plane.cc.

References GloballyPositioned< float >::position(), and GloballyPositioned< float >::rotation().

ReferenceCountingPointer< TangentPlane > Plane::tangentPlane ( const GlobalPoint ) const [virtual]

tangent plane to surface from global point

Implements Surface.

Definition at line 9 of file Plane.cc.

References GloballyPositioned< float >::position(), and GloballyPositioned< float >::rotation().