Cafu Engine
cf::ClipSys::CollisionModelAnimT Class Reference

This class represents an animated collision model. More...

#include "CollisionModel_anim.hpp"

Inheritance diagram for cf::ClipSys::CollisionModelAnimT:

Public Member Functions

 CollisionModelAnimT ()
 The constructor. More...
 
 ~CollisionModelAnimT ()
 The destructor. More...
 
BoundingBox3dT GetBoundingBox () const override
 Returns the bounding box of this collision model. More...
 
unsigned long GetContents () const override
 Returns the contents of this collision model. More...
 
void SaveToFile (std::ostream &OutFile, SceneGraph::aux::PoolT &Pool) const override
 Saves the model to OutFile. More...
 
void TraceConvexSolid (const TraceSolidT &TraceSolid, const Vector3dT &Start, const Vector3dT &Ray, unsigned long ClipMask, TraceResultT &Result) const override
 Traces the given TraceSolidT instance from Start along Ray (up to the input value of Result.Fraction) through the collision model, and reports the first collision, if any. More...
 
unsigned long GetContents (const Vector3dT &Point, double BoxRadius, unsigned long ContMask) const override
 Determines the volume contents of the model at the given point / in the given box. More...
 
btCollisionShape * GetBulletAdapter () const override
 Returns an adapter class for using CollisionModelT instances also as Bullet btCollisionShape instances. More...
 
- Public Member Functions inherited from cf::ClipSys::CollisionModelT
virtual ~CollisionModelT ()
 The (virtual) destructor. More...
 

Detailed Description

This class represents an animated collision model.

Its main advantage is that it supports collision models that are animated, its main disadvantage is the limitations with which many types of queries can only be answered.

Constructor & Destructor Documentation

cf::ClipSys::CollisionModelAnimT::CollisionModelAnimT ( )

The constructor.

cf::ClipSys::CollisionModelAnimT::~CollisionModelAnimT ( )

The destructor.

Member Function Documentation

BoundingBox3dT cf::ClipSys::CollisionModelAnimT::GetBoundingBox ( ) const
overridevirtual

Returns the bounding box of this collision model.

Implements cf::ClipSys::CollisionModelT.

btCollisionShape* cf::ClipSys::CollisionModelAnimT::GetBulletAdapter ( ) const
overridevirtual

Returns an adapter class for using CollisionModelT instances also as Bullet btCollisionShape instances.

Implements cf::ClipSys::CollisionModelT.

unsigned long cf::ClipSys::CollisionModelAnimT::GetContents ( ) const
overridevirtual

Returns the contents of this collision model.

Implements cf::ClipSys::CollisionModelT.

unsigned long cf::ClipSys::CollisionModelAnimT::GetContents ( const Vector3dT Point,
double  BoxRadius,
unsigned long  ContMask 
) const
overridevirtual

Determines the volume contents of the model at the given point / in the given box.

The function considers all brush volumes in the collision model that contain the given point or intersect the given box, and returns their combined ("or'ed") contents.

Parameters
PointThe point in model space at which the volume contents of this model is to be determined.
BoxRadiusWhen nonzero, this is the radius of an imaginary box around Point.
ContMaskOnly volumes whose contents matches this mask participate in the test. This is for optimization, because it allows the implementation to cull volumes that are not of interest early.
Returns
the combined volume content flags of the intersected volumes in the collision model.

Implements cf::ClipSys::CollisionModelT.

void cf::ClipSys::CollisionModelAnimT::SaveToFile ( std::ostream &  OutFile,
SceneGraph::aux::PoolT Pool 
) const
overridevirtual

Saves the model to OutFile.

TODO: Review serialization/deser. of class hierarchies (e.g. compare to cf::SceneGraph)! Right now this is fixed and works for CollisionModelStaticTs only!!!

Implements cf::ClipSys::CollisionModelT.

void cf::ClipSys::CollisionModelAnimT::TraceConvexSolid ( const TraceSolidT TraceSolid,
const Vector3dT Start,
const Vector3dT Ray,
unsigned long  ClipMask,
TraceResultT Result 
) const
overridevirtual

Traces the given TraceSolidT instance from Start along Ray (up to the input value of Result.Fraction) through the collision model, and reports the first collision, if any.

Parameters
TraceSolidThe TraceSolidT instance that is traced from Start along Ray.
StartThe start point in model space where the trace begins.
RayThe ray along which the trace is performed. Note that with F being the input value of Result.Fraction, the endpoint is at Start+Ray*F.
ClipMaskOnly surfaces whose clip flags match this mask participate in the test. This is for optimization, because it allows the implementation to cull surfaces that are not of interest early.
ResultThe start value of Fraction is input via this reference, and the result of the trace returned. Using an input/output parameter for returning the result, rather than a true return type, suggests itself because it makes cascaded calls to this function natural (i.e. from (possibly many) super-objects and to (possibly many) sub-objects).
See Also
TraceResultT

Implements cf::ClipSys::CollisionModelT.


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