AnimationSystem.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_ANIMATIONSYSTEM_H
#define RAMSES_ANIMATIONSYSTEM_H
 
#include "ramses-client-api/AnimationTypes.h"
#include "ramses-client-api/SceneObject.h"
#include "ramses-client-api/AnimatedProperty.h"
 
namespace ramses
{
    class Spline;
    class SplineStepBool;
    class SplineStepInt32;
    class SplineStepFloat;
    class SplineStepVector2f;
    class SplineStepVector3f;
    class SplineStepVector4f;
    class SplineStepVector2i;
    class SplineStepVector3i;
    class SplineStepVector4i;
    class SplineLinearInt32;
    class SplineLinearFloat;
    class SplineLinearVector2f;
    class SplineLinearVector3f;
    class SplineLinearVector4f;
    class SplineLinearVector2i;
    class SplineLinearVector3i;
    class SplineLinearVector4i;
    class SplineBezierInt32;
    class SplineBezierFloat;
    class SplineBezierVector2f;
    class SplineBezierVector3f;
    class SplineBezierVector4f;
    class SplineBezierVector2i;
    class SplineBezierVector3i;
    class SplineBezierVector4i;
    class Animation;
    class AnimationSequence;
    class Node;
    class UniformInput;
    class DataObject;
    class Appearance;
    class AnimationObject;
    class PickableObject;
 
    class RAMSES_API AnimationSystem : public SceneObject
    {
    public:
        status_t setTime(globalTimeStamp_t timeStamp);
 
        globalTimeStamp_t getTime() const;
 
        SplineStepBool* createSplineStepBool(const char* name = nullptr);
 
        SplineStepInt32* createSplineStepInt32(const char* name = nullptr);
 
        SplineStepFloat* createSplineStepFloat(const char* name = nullptr);
 
        SplineStepVector2f* createSplineStepVector2f(const char* name = nullptr);
 
        SplineStepVector3f* createSplineStepVector3f(const char* name = nullptr);
 
        SplineStepVector4f* createSplineStepVector4f(const char* name = nullptr);
 
        SplineStepVector2i* createSplineStepVector2i(const char* name = nullptr);
 
        SplineStepVector3i* createSplineStepVector3i(const char* name = nullptr);
 
        SplineStepVector4i* createSplineStepVector4i(const char* name = nullptr);
 
        SplineLinearInt32* createSplineLinearInt32(const char* name = nullptr);
 
        SplineLinearFloat* createSplineLinearFloat(const char* name = nullptr);
 
        SplineLinearVector2f* createSplineLinearVector2f(const char* name = nullptr);
 
        SplineLinearVector3f* createSplineLinearVector3f(const char* name = nullptr);
 
        SplineLinearVector4f* createSplineLinearVector4f(const char* name = nullptr);
 
        SplineLinearVector2i* createSplineLinearVector2i(const char* name = nullptr);
 
        SplineLinearVector3i* createSplineLinearVector3i(const char* name = nullptr);
 
        SplineLinearVector4i* createSplineLinearVector4i(const char* name = nullptr);
 
        SplineBezierInt32* createSplineBezierInt32(const char* name = nullptr);
 
        SplineBezierFloat* createSplineBezierFloat(const char* name = nullptr);
 
        SplineBezierVector2f* createSplineBezierVector2f(const char* name = nullptr);
 
        SplineBezierVector3f* createSplineBezierVector3f(const char* name = nullptr);
 
        SplineBezierVector4f* createSplineBezierVector4f(const char* name = nullptr);
 
        SplineBezierVector2i* createSplineBezierVector2i(const char* name = nullptr);
 
        SplineBezierVector3i* createSplineBezierVector3i(const char* name = nullptr);
 
        SplineBezierVector4i* createSplineBezierVector4i(const char* name = nullptr);
 
        Animation* createAnimation(const AnimatedProperty& animatedProperty, const Spline& spline, const char* name = nullptr);
 
        AnimationSequence* createAnimationSequence(const char* name = nullptr);
 
        status_t destroy(AnimationObject& animationObject);
 
        AnimatedProperty* createAnimatedProperty(const Node& propertyOwner, EAnimatedProperty property, EAnimatedPropertyComponent propertyComponent = EAnimatedPropertyComponent_All, const char* name = nullptr);
 
        AnimatedProperty* createAnimatedProperty(const UniformInput& propertyOwner, const Appearance& appearance, EAnimatedPropertyComponent propertyComponent = EAnimatedPropertyComponent_All, const char* name = nullptr);
 
        AnimatedProperty* createAnimatedProperty(const DataObject& propertyOwner, EAnimatedPropertyComponent propertyComponent = EAnimatedPropertyComponent_All, const char* name = nullptr);
 
        uint32_t getNumberOfFinishedAnimationsSincePreviousUpdate() const;
 
        const Animation* getFinishedAnimationSincePreviousUpdate(uint32_t index) const;
 
        Animation* getFinishedAnimationSincePreviousUpdate(uint32_t index);
 
        const RamsesObject* findObjectByName(const char* name) const;
 
        RamsesObject* findObjectByName(const char* name);
 
        class AnimationSystemImpl& impl;
 
    protected:
        friend class SceneImpl;
 
        explicit AnimationSystem(AnimationSystemImpl& pimpl);
 
        AnimationSystem(const AnimationSystem& other);
 
        AnimationSystem& operator=(const AnimationSystem& other);
 
        virtual ~AnimationSystem();
    };
}
 
#endif