CSinusoidalTransitionFromRange Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at CSinusoidalTransitionFromRange Class.

Encapsulates a sinusoidal-range transition that has a given range of oscillation.

Syntax

class CSinusoidalTransitionFromRange : public CBaseTransition;  

Members

Public Constructors

Name Description
CSinusoidalTransitionFromRange::CSinusoidalTransitionFromRange Constructs a transition object.

Public Methods

Name Description
CSinusoidalTransitionFromRange::Create Calls the transition library to create encapsulated transition COM object. (Overrides CBaseTransition::Create.)

Public Data Members

Name Description
CSinusoidalTransitionFromRange::m_dblMaximumValue The value of the animation variable at a peak of the sinusoidal wave.
CSinusoidalTransitionFromRange::m_dblMinimumValue The value of the animation variable at a trough of the sinusoidal wave.
CSinusoidalTransitionFromRange::m_duration The duration of the transition.
CSinusoidalTransitionFromRange::m_period The period of oscillation of the sinusoidal wave in seconds.
CSinusoidalTransitionFromRange::m_slope The slope at the start of the transition.

Remarks

The value of the animation variable fluctuates between the specified minimum and maximum values over the entire duration of a sinusoidal-range transition. The slope parameter is used to disambiguate between the two possible sine waves specified by the other parameters. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Inheritance Hierarchy

CObject

CBaseTransition

CSinusoidalTransitionFromRange

Requirements

Header: afxanimationcontroller.h

CSinusoidalTransitionFromRange::Create

Calls the transition library to create encapsulated transition COM object.

virtual BOOL Create(
    IUIAnimationTransitionLibrary* pLibrary,  
    IUIAnimationTransitionFactory* */);

Parameters

pLibrary
A pointer to transition library, which is responsible for creation of standard transitions.

Return Value

TRUE if transition is created successfully; otherwise FALSE.

CSinusoidalTransitionFromRange::CSinusoidalTransitionFromRange

Constructs a transition object.

CSinusoidalTransitionFromRange(
    UI_ANIMATION_SECONDS duration,  
    DOUBLE dblMinimumValue,  
    DOUBLE dblMaximumValue,  
    UI_ANIMATION_SECONDS period,  
    UI_ANIMATION_SLOPE slope);

Parameters

duration
The duration of the transition.

dblMinimumValue
The value of the animation variable at a trough of the sinusoidal wave.

dblMaximumValue
The value of the animation variable at a peak of the sinusoidal wave.

period
The period of oscillation of the sinusoidal wave in seconds.

slope
The slope at the start of the transition.

CSinusoidalTransitionFromRange::m_dblMaximumValue

The value of the animation variable at a peak of the sinusoidal wave.

DOUBLE m_dblMaximumValue;  

CSinusoidalTransitionFromRange::m_dblMinimumValue

The value of the animation variable at a trough of the sinusoidal wave.

DOUBLE m_dblMinimumValue;  

CSinusoidalTransitionFromRange::m_duration

The duration of the transition.

UI_ANIMATION_SECONDS m_duration;  

CSinusoidalTransitionFromRange::m_period

The period of oscillation of the sinusoidal wave in seconds.

UI_ANIMATION_SECONDS m_period;  

CSinusoidalTransitionFromRange::m_slope

The slope at the start of the transition.

UI_ANIMATION_SLOPE m_slope;  

See Also

Classes