CUGL 2.1
Cornell University Game Library
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
cugl::scene2::RotateBy Class Reference

#include <CURotateAction.h>

Inheritance diagram for cugl::scene2::RotateBy:
cugl::scene2::Action

Public Member Functions

 RotateBy ()
 
 ~RotateBy ()
 
void dispose ()
 
bool init ()
 
bool init (float delta)
 
bool init (float delta, float time)
 
float getDelta () const
 
void setDelta (float delta)
 
virtual std::shared_ptr< Actionclone () override
 
virtual void update (const std::shared_ptr< SceneNode > &target, Uint64 *state, float dt) override
 
virtual std::string toString (bool verbose=false) const override
 
- Public Member Functions inherited from cugl::scene2::Action
 Action ()
 
 ~Action ()
 
float getDuration () const
 
void setDuration (float time)
 
virtual void load (const std::shared_ptr< SceneNode > &target, Uint64 *state)
 
 operator std::string () const
 

Static Public Member Functions

static std::shared_ptr< RotateByalloc ()
 
static std::shared_ptr< RotateByalloc (float delta)
 
static std::shared_ptr< RotateByalloc (float delta, float time)
 

Protected Attributes

float _delta
 
- Protected Attributes inherited from cugl::scene2::Action
float _duration
 

Detailed Description

This action represents a rotation by a given angle amount.

The angle is measured in radians , counter-clockwise from the x-axis.

An action contains only the definition of the animation. This can include information about the transform to use or the duration of the animation. However, it does not contain any attribute of the target. Hence, an action can be reapplied to different targets.

By itself, an action does nothing. It only specifies an action that may take place. To use an action, it must be passed to the ActionManager. The manager will create an action instance and animate that instance. While an action may be reused many times, an action instance corresponds to a single animation.

Constructor & Destructor Documentation

◆ RotateBy()

cugl::scene2::RotateBy::RotateBy ( )
inline

Creates an uninitialized rotation action.

NEVER USE A CONSTRUCTOR WITH NEW. If you want to allocate an object on the heap, use one of the static constructors instead.

◆ ~RotateBy()

cugl::scene2::RotateBy::~RotateBy ( )
inline

Deletes this action instance, disposing all resources

Member Function Documentation

◆ alloc() [1/3]

static std::shared_ptr<RotateBy> cugl::scene2::RotateBy::alloc ( )
inlinestatic

Returns a newly allocated, degenerate rotation action.

The rotation amount is set to 0.0, meaning no rotation takes place.

Returns
a newly allocated, degenerate rotation action.

◆ alloc() [2/3]

static std::shared_ptr<RotateBy> cugl::scene2::RotateBy::alloc ( float  delta)
inlinestatic

Returns a newly allocated rotation action of the given angle.

When animated, this action will rotate its target by the given delta. The angle is measured in radians, counter-clockwise from the x-axis. The animation will be instantaneous.

Parameters
deltaThe amount to rotate the target node
Returns
a newly allocated rotation action of the given angle.

◆ alloc() [3/3]

static std::shared_ptr<RotateBy> cugl::scene2::RotateBy::alloc ( float  delta,
float  time 
)
inlinestatic

Returns a newly allocated rotation action of the given angle.

When animated, this action will rotate its target by the given delta. The angle is measured in radians, counter-clockwise from the x-axis. The animation will take place over the given number of seconds.

Parameters
deltaThe amount to rotate the target node
timeThe animation duration
Returns
a newly allocated rotation action of the given angle.

◆ clone()

virtual std::shared_ptr<Action> cugl::scene2::RotateBy::clone ( )
overridevirtual

Returns a newly allocated copy of this Action.

Returns
a newly allocated copy of this Action.

Reimplemented from cugl::scene2::Action.

◆ dispose()

void cugl::scene2::RotateBy::dispose ( )
inline

Disposes all of the resources used by this action.

A disposed action can be safely reinitialized.

◆ getDelta()

float cugl::scene2::RotateBy::getDelta ( ) const
inline

Returns the rotation delta for this action.

Changing this value for an actively animating action can have undefined effects.

Returns
the rotation delta for this action.

◆ init() [1/3]

bool cugl::scene2::RotateBy::init ( )
inline

Initializes a degenerate rotation action.

The rotation amount is set to 0.0, meaning no rotation takes place.

Returns
true if initialization was successful.

◆ init() [2/3]

bool cugl::scene2::RotateBy::init ( float  delta)
inline

Initializes a rotation action of the given angle.

When animated, this action will rotate its target by the given delta. The angle is measured in radians, counter-clockwise from the x-axis. The animation will be instantaneous.

Parameters
deltaThe amount to rotate the target node
Returns
true if initialization was successful.

◆ init() [3/3]

bool cugl::scene2::RotateBy::init ( float  delta,
float  time 
)

Initializes a rotation action of the given angle.

When animated, this action will rotate its target by the given delta. The angle is measured in radians, counter-clockwise from the x-axis. The animation will take place over the given number of seconds.

Parameters
deltaThe amount to rotate the target node
timeThe animation duration
Returns
true if initialization was successful.

◆ setDelta()

void cugl::scene2::RotateBy::setDelta ( float  delta)
inline

Sets the rotation delta for this action.

Changing this value for an actively animating action can have undefined effects.

Parameters
deltathe rotation delta for this action.

◆ toString()

virtual std::string cugl::scene2::RotateBy::toString ( bool  verbose = false) const
overridevirtual

Returns a string representation of the action for debugging purposes.

If verbose is true, the string will include class information. This allows us to unambiguously identify the class.

Parameters
verboseWhether to include class information
Returns
a string representation of this action for debuggging purposes.

Reimplemented from cugl::scene2::Action.

◆ update()

virtual void cugl::scene2::RotateBy::update ( const std::shared_ptr< SceneNode > &  target,
Uint64 *  state,
float  dt 
)
overridevirtual

Executes an action on the given target node.

The important state of the target is stored in the given state parameter. The semantics of this state is action-dependent.

Parameters
targetThe node to act on
stateThe relevant node state
dtThe elapsed time to animate.

Reimplemented from cugl::scene2::Action.

Member Data Documentation

◆ _delta

float cugl::scene2::RotateBy::_delta
protected

Difference between the final and initial angle in radians


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