VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
DtDestroyedPredicate Class Reference

Contains the DtDestroyedPredicate class declaration. More...

Inheritance diagram for DtDestroyedPredicate:
Inheritance graph
[legend]

Public Member Functions

 DtDestroyedPredicate (bool negate=false)
 default constructor
virtual ~DtDestroyedPredicate ()
 destructor
 DtDestroyedPredicate (const DtDestroyedPredicate &orig)
 copy constructor
DtDestroyedPredicateoperator= (const DtDestroyedPredicate &orig)
 assignment operator
virtual DtVrfObjectPredicateclone () const
 clone function
- Public Member Functions inherited from DtVrfObjectPredicate
 DtVrfObjectPredicate (bool negate=false)
 constructor
virtual ~DtVrfObjectPredicate ()
 destructor
 DtVrfObjectPredicate (const DtVrfObjectPredicate &orig)
 copy constructor
DtVrfObjectPredicateoperator= (const DtVrfObjectPredicate &orig)
 assignment operator
bool operator== (const DtVrfObjectPredicate &orig) const
 Equality operators used to compare predicates.
bool operator!= (const DtVrfObjectPredicate &orig) const
virtual bool negated () const
virtual void setNegate (bool negate)
bool isTrue (const DtVrfObject *vrfObject)
 This function evaluates the eval function (to be defined in derived classes) given a DtVrfObject and returns the result, negated if indicated.
virtual bool canBeTrue (const DtVrfObject *vrfObject)
virtual bool canBeFalse (const DtVrfObject *vrfObject)
virtual void stringRep (std::ostream &str, int indentLevel=0) const

Protected Member Functions

virtual bool eval (const DtVrfObject *object)
 The actual test this predicate performs.
virtual void typeSpecificStringRep (std::ostream &str, int indentLevel) const
 Override in specific subclasses to print the predicate description to the stream.
- Protected Member Functions inherited from DtVrfObjectPredicate
virtual bool predicateEqual (const DtVrfObjectPredicate &orig) const
 Test if this instance of a predicate is equal to another.
virtual bool canEvalTrue (const DtVrfObject *vrfObject)
virtual bool canEvalFalse (const DtVrfObject *vrfObject)

Additional Inherited Members

- Static Public Member Functions inherited from DtVrfObjectPredicate
static const DtVrfObjectPredicatenullPredicate ()
 Returns an instance of a DtNullVrfObjectPredicate.
- Protected Attributes inherited from DtVrfObjectPredicate
bool myNegated

Detailed Description

Contains the DtDestroyedPredicate class declaration.

Instances of DtDestroyedPredicate can be used to evaluate if an entity's damage appearance is DtDamageDestroyed.

Constructor & Destructor Documentation

DtDestroyedPredicate::DtDestroyedPredicate ( bool  negate = false)

default constructor

virtual DtDestroyedPredicate::~DtDestroyedPredicate ( )
virtual

destructor

DtDestroyedPredicate::DtDestroyedPredicate ( const DtDestroyedPredicate orig)

copy constructor

Member Function Documentation

DtDestroyedPredicate& DtDestroyedPredicate::operator= ( const DtDestroyedPredicate orig)

assignment operator

virtual DtVrfObjectPredicate* DtDestroyedPredicate::clone ( ) const
virtual

clone function

Implements DtVrfObjectPredicate.

virtual bool DtDestroyedPredicate::eval ( const DtVrfObject object)
protectedvirtual

The actual test this predicate performs.

Implements DtVrfObjectPredicate.

virtual void DtDestroyedPredicate::typeSpecificStringRep ( std::ostream &  str,
int  indentLevel 
) const
protectedvirtual

Override in specific subclasses to print the predicate description to the stream.

Reimplemented from DtVrfObjectPredicate.


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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)