/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 http://mozilla.org/MPL/2.0/. */
/* Utilities for animation of computed style values */
#ifndef mozilla_StyleAnimationValue_h_
#define mozilla_StyleAnimationValue_h_
#include "mozilla/RefPtr.h"
#include "mozilla/ServoBindingTypes.h"
#include "mozilla/ServoStyleConsts.h" // Servo_AnimationValue_Dump
#include "mozilla/AnimatedPropertyID.h"
#include "nsStringFwd.h"
#include "nsColor.h"
#include "nsCSSPropertyID.h"
#include "nsStyleTransformMatrix.h"
class nsIFrame;
namespace mozilla {
namespace css {
class StyleRule;
}
// namespace css
namespace dom {
class Element;
}
// namespace dom
namespace layers {
class Animatable;
}
// namespace layers
enum class PseudoStyleType : uint8_t;
struct PropertyStyleAnimationValuePair;
struct AnimationValue {
explicit AnimationValue(
const RefPtr<StyleAnimationValue>& aValue)
: mServo(aValue) {}
AnimationValue() =
default;
AnimationValue(
const AnimationValue& aOther) =
default;
AnimationValue(AnimationValue&& aOther) =
default;
AnimationValue&
operator=(
const AnimationValue& aOther) =
default;
AnimationValue&
operator=(AnimationValue&& aOther) =
default;
bool operator==(
const AnimationValue& aOther)
const;
bool operator!=(
const AnimationValue& aOther)
const;
bool IsNull()
const {
return !mServo; }
float GetOpacity()
const;
// Returns nscolor value in this AnimationValue.
// Currently only background-color is supported.
nscolor GetColor(nscolor aForegroundColor)
const;
// Returns true if this AnimationValue is current-color.
// Currently only background-color is supported.
bool IsCurrentColor()
const;
// Return a transform list for the transform property.
const mozilla::StyleTransform& GetTransformProperty()
const;
const mozilla::StyleScale& GetScaleProperty()
const;
const mozilla::StyleTranslate& GetTranslateProperty()
const;
const mozilla::StyleRotate& GetRotateProperty()
const;
// Motion path properties.
// Note: This clones the StyleOffsetPath object from its AnimatedValue, so
// this may be expensive if the path is a complex SVG path or polygon. The
// caller should be aware of this performance impact.
void GetOffsetPathProperty(StyleOffsetPath& aOffsetPath)
const;
const mozilla::LengthPercentage& GetOffsetDistanceProperty()
const;
const mozilla::StyleOffsetRotate& GetOffsetRotateProperty()
const;
const mozilla::StylePositionOrAuto& GetOffsetAnchorProperty()
const;
const mozilla::StyleOffsetPosition& GetOffsetPositionProperty()
const;
bool IsOffsetPathUrl()
const;
// Return the scale for mServo, which is calculated with reference to aFrame.
mozilla::gfx::MatrixScales GetScaleValue(
const nsIFrame* aFrame)
const;
// Uncompute this AnimationValue and then serialize it.
void SerializeSpecifiedValue(
const AnimatedPropertyID& aProperty,
const StylePerDocumentStyleData* aRawData,
nsACString& aString)
const;
// Check if |*this| and |aToValue| can be interpolated.
bool IsInterpolableWith(
const AnimatedPropertyID& aProperty,
const AnimationValue& aToValue)
const;
// Compute the distance between *this and aOther.
double ComputeDistance(
const AnimationValue& aOther)
const;
// Create an AnimaitonValue from a string. This method flushes style, so we
// should use this carefully. Now, it is only used by
// nsDOMWindowUtils::ComputeAnimationDistance.
static AnimationValue FromString(AnimatedPropertyID& aProperty,
const nsACString& aValue,
dom::Element* aElement);
// Create an already_AddRefed<StyleAnimationValue> from a
// layers::Animatable. Basically, this function should return AnimationValue,
// but it seems the caller, AnimationHelper, only needs
// StyleAnimationValue, so we return its already_AddRefed<> to avoid
// adding/removing a redundant ref-count.
static already_AddRefed<StyleAnimationValue> FromAnimatable(
nsCSSPropertyID aProperty,
const layers::Animatable& aAnimatable);
RefPtr<StyleAnimationValue> mServo;
};
inline std::ostream&
operator<<(std::ostream& aOut,
const AnimationValue& aValue) {
MOZ_ASSERT(aValue.mServo);
nsAutoCString s;
Servo_AnimationValue_Dump(aValue.mServo, &s);
return aOut << s;
}
struct PropertyStyleAnimationValuePair {
AnimatedPropertyID mProperty;
AnimationValue mValue;
};
}
// namespace mozilla
#endif
