Animator Rule Visitor Identify. More...
#include <deEffectVisitorIdentify.h>
Public Types | |
| enum | eEffects { eetUnknown, eetFilterKernel, eetOverlayImage, eetColorMatrix, eetDistortImage } |
Public Member Functions | |
Constructors and Destructors | |
| deEffectVisitorIdentify () | |
| Creates a new animator effect visitor identify object. | |
| virtual | ~deEffectVisitorIdentify () |
| Cleans up the animator effect visitor identify. | |
Management | |
| int | GetType () const |
| Retrieves the effect type. | |
| bool | IsUnknown () const |
| Determines if this is an unknown effect. | |
| bool | IsFilterKernel () const |
| Determines if this is a filter kernel effect. | |
| bool | IsOverlayImage () const |
| Determines if this is a overlay image effect. | |
| bool | IsColorMatrix () const |
| Determines if this is a color matrix effect. | |
| bool | IsDistortImage () const |
| Determines if this is a pixel matrix effect. | |
| deEffectFilterKernel * | CastToFilterKernel () const |
| Cast to a filter kernel effect. | |
| deEffectOverlayImage * | CastToOverlayImage () const |
| Cast to a overlay image effect. | |
| deEffectColorMatrix * | CastToColorMatrix () const |
| Cast to a color matrix effect. | |
| deEffectDistortImage * | CastToDistortImage () const |
| Cast to a distort image effect. | |
| void | Reset () |
| Resets the visitor. | |
Visiting | |
| virtual void | VisitEffect (deEffect *effect) |
| Visits an effect. | |
| virtual void | VisitFilterKernel (deEffectFilterKernel *effect) |
| Visits an effect filter kernel. | |
| virtual void | VisitOverlayImage (deEffectOverlayImage *effect) |
| Visits an overlay image effect. | |
| virtual void | VisitColorMatrix (deEffectColorMatrix *effect) |
| Visits a color matrix effect. | |
| virtual void | VisitDistortImage (deEffectDistortImage *effect) |
| Visits a pixel matrix effect. | |
Detailed Description
Animator Rule Visitor Identify.
Animation effect visitor providing effect identification. After visiting a effect the visitor can be asked what kind of effect has been visited. Useful to identify effects and to carry out actions only for certain effect types. Furthermore save casting is provided. If the cast is not valid an exception is raised.
- Version:
- 1.0
- Date:
- 2008
Member Enumeration Documentation
Constructor & Destructor Documentation
| deEffectVisitorIdentify::deEffectVisitorIdentify | ( | ) |
Creates a new animator effect visitor identify object.
| virtual deEffectVisitorIdentify::~deEffectVisitorIdentify | ( | ) | [virtual] |
Cleans up the animator effect visitor identify.
Member Function Documentation
| deEffectColorMatrix* deEffectVisitorIdentify::CastToColorMatrix | ( | ) | const |
Cast to a color matrix effect.
| deEffectDistortImage* deEffectVisitorIdentify::CastToDistortImage | ( | ) | const |
Cast to a distort image effect.
| deEffectFilterKernel* deEffectVisitorIdentify::CastToFilterKernel | ( | ) | const |
Cast to a filter kernel effect.
| deEffectOverlayImage* deEffectVisitorIdentify::CastToOverlayImage | ( | ) | const |
Cast to a overlay image effect.
| int deEffectVisitorIdentify::GetType | ( | ) | const [inline] |
Retrieves the effect type.
| bool deEffectVisitorIdentify::IsColorMatrix | ( | ) | const [inline] |
Determines if this is a color matrix effect.
| bool deEffectVisitorIdentify::IsDistortImage | ( | ) | const [inline] |
Determines if this is a pixel matrix effect.
| bool deEffectVisitorIdentify::IsFilterKernel | ( | ) | const [inline] |
Determines if this is a filter kernel effect.
| bool deEffectVisitorIdentify::IsOverlayImage | ( | ) | const [inline] |
Determines if this is a overlay image effect.
| bool deEffectVisitorIdentify::IsUnknown | ( | ) | const [inline] |
Determines if this is an unknown effect.
| void deEffectVisitorIdentify::Reset | ( | ) |
Resets the visitor.
| virtual void deEffectVisitorIdentify::VisitColorMatrix | ( | deEffectColorMatrix * | effect ) | [virtual] |
Visits a color matrix effect.
Reimplemented from deEffectVisitor.
| virtual void deEffectVisitorIdentify::VisitDistortImage | ( | deEffectDistortImage * | effect ) | [virtual] |
Visits a pixel matrix effect.
Reimplemented from deEffectVisitor.
| virtual void deEffectVisitorIdentify::VisitEffect | ( | deEffect * | effect ) | [virtual] |
Visits an effect.
Reimplemented from deEffectVisitor.
| virtual void deEffectVisitorIdentify::VisitFilterKernel | ( | deEffectFilterKernel * | effect ) | [virtual] |
Visits an effect filter kernel.
Reimplemented from deEffectVisitor.
| virtual void deEffectVisitorIdentify::VisitOverlayImage | ( | deEffectOverlayImage * | effect ) | [virtual] |
Visits an overlay image effect.
Reimplemented from deEffectVisitor.
The documentation for this class was generated from the following file:
