TransformationModifier Class Reference

#include <TransformationModifier.h>

Inherited by ApplyAngularVelocityModifier, ApplyCursorTransformationModifier, ApplyForceModifier, ApplyNavigationModifier, ApplyUserTransformationModifier, AssociatedEntityInterrupter, AvatarAnimationWriter, AvatarTransformationWriter, CameraTransformationWriter, CheckCollisionModifier, CursorTransformationWriter, EntityTransformationWriter, HeightMapModifier, ManipulationOffsetModifier, MultiPipeInterrupter, PhysicsEntityTransformationWriterModifier, RunAtPhysicsServerModifier, TargetPipeTransformationWriter, TrackingDataWriter, TrackingOffsetModifier, TransformationDistributionModifier, TransformationLoggerModifier, and UserTransformationWriter.

Collaboration diagram for TransformationModifier:

[legend]

List of all members.

Classes
struct	ManagerPrivateData
Public Types
enum	OUTPUT { OUTPUT_PASSTHROUGH, OUTPUT_RESULT }
Public Member Functions
	TransformationModifier ()
virtual	~TransformationModifier ()
virtual void	setFactory (TransformationModifierFactory *factory)
void	setOutputMode (OUTPUT mode)
virtual TransformationModifierFactory *	getFactory ()
virtual std::string	getClassName ()
virtual TransformationData	execute (TransformationData *resultLastStage, TransformationPipe *currentPipe)
Protected Member Functions
TransformationData	executeInternal (TransformationData *resultLastStage, TransformationPipe *currentPipe)
virtual bool	interrupt (TransformationData *resultLastStage, TransformationPipe *currentPipe)
Protected Attributes
ManagerPrivateData	managerPrivateData
OUTPUT	outputMode
TransformationModifierFactory *	factory
Friends
class	TransformationManager
class	TransformationPipe

---

Member Enumeration Documentation

enum TransformationModifier::OUTPUT

Possible behaviours, when executeInternal() is called by the TransformationPipe.

Enumerator:

OUTPUT_PASSTHROUGH	Call execute(), but ignore its return value (and use the result of the last stage instead).
OUTPUT_RESULT	Use the return value of execute().

---

Constructor & Destructor Documentation

TransformationModifier::TransformationModifier

(

)

Constructor. TransformationModifiers are only created by their respective factories.

TransformationModifier::~TransformationModifier

(

)

[virtual]

---

Member Function Documentation

TransformationData TransformationModifier::execute	(	TransformationData *	resultLastStage,
		TransformationPipe *	currentPipe
	)			[virtual]

Calculate the new transformation.

Parameters:

	resultLastStage	the result of the previous TransformationModifier
	currentPipe	the Pipe, by which we are executed.

Reimplemented in ApplyAngularVelocityModifier, ApplyForceModifier, RunAtPhysicsServerModifier, PhysicsEntityTransformationWriterModifier, ManipulationOffsetModifier, ApplyCursorTransformationModifier, ApplyNavigationModifier, ApplyUserTransformationModifier, AvatarTransformationWriter, CameraTransformationWriter, CursorTransformationWriter, EntityTransformationWriter, MultiPipeInterrupter, TargetPipeTransformationWriter, TrackingDataWriter, TrackingOffsetModifier, TransformationDistributionModifier, TransformationLoggerModifier, UserTransformationWriter, AvatarAnimationWriter, CheckCollisionModifier, and HeightMapModifier.

TransformationData TransformationModifier::executeInternal	(	TransformationData *	resultLastStage,
		TransformationPipe *	currentPipe
	)			[protected]

std::string TransformationModifier::getClassName

(

)

[virtual]

The class-name of the TransformationModifier.

Reimplemented in RunAtPhysicsServerModifier, and TrackingDataWriter.

TransformationModifierFactory * TransformationModifier::getFactory

(

)

[virtual]

The TransformationModifierFactory which created this instance.

bool TransformationModifier::interrupt	(	TransformationData *	resultLastStage,
		TransformationPipe *	currentPipe
	)			[protected, virtual]

Reimplemented in AssociatedEntityInterrupter, and MultiPipeInterrupter.

void TransformationModifier::setFactory

(

TransformationModifierFactory *

factory

)

[virtual]

This method is called by the TransformationModifierFactory upon creation of the TransformationModifier.

Todo:

make this protected and make the factory class a friend?

void TransformationModifier::setOutputMode

(

OUTPUT

mode

)

Set the output mode to either passthrough or result.

---

Friends And Related Function Documentation

friend class TransformationManager [friend]

friend class TransformationPipe [friend]

---

Member Data Documentation

TransformationModifierFactory* TransformationModifier::factory [protected]

ManagerPrivateData TransformationModifier::managerPrivateData [protected]

OUTPUT TransformationModifier::outputMode [protected]

---

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

• src/inVRs/SystemCore/TransformationManager/TransformationModifier.h
• src/inVRs/SystemCore/TransformationManager/TransformationModifier.cpp