RaTweening 1.0.0
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234]
 NRaTweening
 NCore
 NElements
 CRaTweenEasingUtil class that handles the logics of RaEasingType
 CRaTweeningEngineThis DontDestroyOnLoad - Singleton handles the progressing through all tweens registered to it. Tweens are Registered to the engine by calling their RaTweenUtilExtensions.Play<TweenT>(TweenT) method. This class does its work automatically by the internal systems and is not required to be manually called by the user.

‍Note: By Default, a tween runs in RealTime. To change it to GameTime, call RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT) on that tween.

 CRaTweeningProcessorThe Processor can be used to manually handle the states of tweens which have been registered to it. It completely handles all the state related logics such as handling their delays, lifetime, evaluations and all other state related aspects. This system is used by RaTweeningEngine and RaTweenSequence to handle their internal tweens.

‍Note: By Default, a tween runs in RealTime. To change it to GameTime, call RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT) on that tween.

 CRaTweenMaterialColorBaseA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Color of a Material
 CRaTweenMaterialFloatBaseA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Float of a Material
 CRaTweenMaterialOffsetBaseA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the TextureOffset of a Material
 CRaTweenMaterialScaleBaseA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the TextureScale of a Material
 CRaTweenMaterialVector4BaseA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Vector4 Property of a Material
 CRaTweenModifierUtil class that handles the logics of RaModifierType
 CRaTweenPunchBaseThis is the base class of the tweens that handle the logics of tweening a Target's Punch Value
 CRaTweenShakeBaseThis is the base class of the tweens that handle the logics of tweening a Target's Shake Value
 NLambda
 CIRaTweenLambda
 CRaTweenLambdaBaseThis class acts as the base class for all Lambda Tweens
This tween type can SetStartDynamic(bool) to live calculate its start value
This tween type can use SetEndIsDelta(bool) to live calculate its end value
This tween type can use SetDynamicSetupStep(RaTweenDynamicSetupStep) to determine when to calculate the SetStartDynamic(bool) and SetEndIsDelta(bool) values
It allows for a Setter and an optional IsValid check method to be passed to it in order to execute the evaluation of a tween.

‍Note: Lambda Tweens are used to create a tween where you can define the setter logics of the tween yourself in code. (for when you try to do custom logics or the tween does not have a clear target)
Note: Dynamic values don't work well together with modified tween evaluations for they rely heavily on the start and end position being in sequence.

 CRaTweenLambdaColorA RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Color

‍Note: RaTweenLambda for all methods

 CRaTweenLambdaFloatA RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Float

‍Note: RaTweenLambda for all methods

 CRaTweenLambdaRectA RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Rect

‍Note: RaTweenLambda for all methods

 CRaTweenLambdaVector2A RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Vector2

‍Note: RaTweenLambda for all methods

 CRaTweenLambdaVector3A RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Vector3

‍Note: RaTweenLambda for all methods

 CRaTweenLambdaVector4A RaTweenLambdaBase<ValueT> tween handles the logics of tweening a Vector4

‍Note: RaTweenLambda for all methods

 NRaAudioSource
 CRaTweenPitchA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Pitch of a AudioSource

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenVolumeA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Volume of a AudioSource

‍Note: RaTweenUtilExtensions for all extension methods

 NRaCamera
 CRaTweenAspectA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Aspect Ratio of a Camera
 CRaTweenColorA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the BackgroundColor of a Camera

‍Note: This can also be used for fading logics
Note: RaTweenUtilExtensions for all extension methods

 CRaTweenFarClipPlaneA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Far Clipping Plane of a Camera
 CRaTweenFieldOfViewA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Perspective FieldOfView of a Camera

‍Note: This tween only affects a camera which is set to Perspective (3D Camera)

 CRaTweenNearClipPlaneA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Near Clipping Plane of a Camera
 CRaTweenOrthoSizeA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Orthographic Size of a Camera

‍Note: This tween only affects a camera which is set to Orthographic (2D Camera)

 CRaTweenRectA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Rect of a Camera

‍Note: You can have it target the Pixel Rect by calling RaTweenRect.SetPixelRect(bool)
Note: RaTweenUtilExtensions for all extension methods

 NRaLight
 CRaTweenAngleA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Angle of a Light
 CRaTweenColorA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Color of a Light

‍Note: This can also be used for fading logics
Note: RaTweenUtilExtensions for all extension methods

 CRaTweenIntensityA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Intensity of a Light
 CRaTweenRangeA RaTweenDynamic<TargetT, ValueT> tween that is the base class that handles the logics of tweening the Range of a Light
 NRaMaterial
 CRaTweenMaterialColorA RaTweenMaterialColorBase<TargetT> tween handles the logics of tweening the Color of a Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialFloatA RaTweenMaterialFloatBase<TargetT> tween handles the logics of tweening the Float of a Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialOffsetA RaTweenMaterialOffsetBase<TargetT> tween handles the logics of tweening the TextureOffset of a Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialScaleA RaTweenMaterialScaleBase<TargetT> tween handles the logics of tweening the TextureScale of a Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialVector4A RaTweenMaterialVector4Base<TargetT> tween handles the logics of tweening the Vector4 Property of a Material

‍Note: RaTweenUtilExtensions for all extension methods

 NRaRenderer
 CRaTweenMaterialColorA RaTweenMaterialColorBase<TargetT> tween handles the logics of tweening the Color of a Renderer's Material

‍Note: By default this targets the Instance Material. Use SetSharedMaterial(bool) to target the Shared Material instead
Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialFloatA RaTweenMaterialFloatBase<TargetT> tween handles the logics of tweening the Float of a Renderer's Material

‍Note: By default this targets the Instance Material. Use SetSharedMaterial(bool) to target the Shared Material instead
Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialOffsetA RaTweenMaterialOffsetBase<TargetT> tween handles the logics of tweening the TextureOffset of a Renderer's Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialScaleA RaTweenMaterialScaleBase<TargetT> tween handles the logics of tweening the TextureScale of a Renderer's Material

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenMaterialVector4A RaTweenMaterialVector4Base<TargetT> tween handles the logics of tweening the Vector4 Property of a Renderer's Material

‍Note: RaTweenUtilExtensions for all extension methods

 NRaSpriteRenderer
 CRaTweenColorA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Color of a SpriteRenderer

‍Note: This can also be used for fading logics
Note: RaTweenUtilExtensions for all extension methods

 CRaTweenSpriteSequenceThis class handles the logics of tweening the Sprite of a SpriteRenderer as a sequence of sprites

‍Note: This can be used for sprite animations
Note: RaTweenUtilExtensions for all extension methods

 NRaTransform
 CRaTweenPositionA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Position of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenPunchPositionA RaTweenPunchBase<TargetT> tween handles the logics of tweening the Punch of the Local Position of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenPunchRotationA RaTweenPunchBase<TargetT> tween handles the logics of tweening the Punch of the Local Rotation of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenPunchScaleA RaTweenPunchBase<TargetT> tween handles the logics of tweening the Punch of a Scale of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenRotationA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Rotation of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenScaleA RaTweenDynamic<TargetT, ValueT> tween handles the logics of tweening the Scale of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenShakePositionA RaTweenShakeBase<TargetT> tween handles the logics of tweening the Shake of the Local Position of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenShakeRotationA RaTweenShakeBase<TargetT> tween handles the logics of tweening the Shake of the Local Rotation of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 CRaTweenShakeScaleA RaTweenShakeBase<TargetT> tween handles the logics of tweening the Shake of a Scale of a Transform

‍Note: RaTweenUtilExtensions for all extension methods

 NTimeScale
 CCustomTimeScaleChannelSOA TimeScaleChannelSO which can be used to manually set the TimeScale of an entire group of tweens and live modify them.

‍Note: To create an instance of this object, go to RaTweening/TimeScaleChannels/Create CustomTimeScaleChannelSO under the Create Context Menu of Unity.

 CGameTimeScaleChannelThis Singleton ITimeScaleChannel represents Unity's Time.timeScale value.

‍Note: For RaTweenerComponent support, see GameTimeScaleChannelSO
Note: For API Support, see RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT)

 CGameTimeScaleChannelSOThe ScriptableObject equivalent of GameTimeScaleChannel, which represents Unity's Time.timeScale value.

‍Note: For API Support, see RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT)

 CITimeScaleChannelRepresents a channel which indicates the Scale at which the Real-Time DeltaTime should be scaled for a Tween.

‍Note: This affects the evaluation speed of all the tweens referring to the channel.

 CTimeScaleChannelSOThe Base Class for ScriptableObjects representing a ITimeScaleChannel

‍Note: This is used to give TimeScaleChannel editability access for a RaTweenerComponent

 NTools
 CMaterialUtils
 NUI
 NRaCanvasGroup
 NRaGraphic
 NRaImage
 NRaRectTransform
 NRaScrollRect
 NRaShadow
 NRaSlider
 CIDynamicTween
 CIRaTweenTarget
 CRaColorOptionsThis Util class hold the tools to exclude various color channels from tweening calculations
 CRaRectOptionsThis Util class hold the tools to exclude various Values of a Rect from tweening calculations
 CRaTweenThis is the base tween class which is used to define all tweens using easings and easing modifiers
 CRaTweenBaseThe base RaTween class from which all tweens inherit from.

‍Note: By Default, a tween runs in RealTime. To change it to GameTime, call RaTweenUtilExtensions.SetToGameTime<TweenT>(TweenT)

 CRaTweenDynamicThis is the base tween class which is used to define all tweens which tween from one value to another affecting a target
This tween type can use a value or reference as start and end value
This tween type can SetStartDynamic(bool) to live calculate its start value
This tween type can use SetEndIsDelta(bool) to live calculate its end value
This tween type can use SetDynamicSetupStep(RaTweenDynamicSetupStep) to determine when to calculate the SetStartDynamic(bool) and SetEndIsDelta(bool) values
This is the main used base class for most of the tweening functionalities

‍Note: Dynamic values don't work well together with modified tween evaluations for they rely heavily on the start and end position being in sequence.

 CRaTweenerComponentThe Component that allows for making Tweens within the editor. This component is used to create tweens without code or have visual designers create tweens which are triggered by code This system uses RaTweening.Core.Elements.RaTweenerElementBase inheritors to serialize the data of tweens
 CRaTweenerElementAttributeThis attribute is used to bind a tween to a RaTweening.Core.Elements.RaTweenerElementBase which will represent their serialization. This should be placed above the class of a RaTweenBase inheritor.
 CRaTweenLambdaThis class contains all the Lambda.RaTweenLambdaBase<ValueT> methods to create / play Lambda tweens.

‍Note: Lambda Tweens are used to create a tween where you can define the setter logics of the tween yourself in code. (for when you try to do custom logics or the tween does not have a clear target)

 CRaTweenSequenceThis class takes control over all appended tweens submitted as sequence entries and evaluates them in sequence. OnComplete is called when all tweens have finished inside of it.

‍Note: A RaTweenSequence is constructed using the RaTweenSequence.Create(EntryData[]) method
Note: Tweens can be converted easily to EntryData using the RaTweenUtilExtensions.ToSequenceEntry(RaTweenBase, float, StaggerType) method

 CEntryDataThis struct represents an entry within a sequence. Holding the data what tween to play and their sequence settings
 CRaTweenUtilExtensionsThis is the class which represents all RaTweenUtilExtensions This class has been made so various utils can be used on a tween without losing the type reference of the original tween which is being modified.
 CRaVector2OptionsThis Util class hold the tools to exclude various axes in 2D space from tweening calculations
 CRaVector3OptionsThis Util class hold the tools to exclude various axes in 3D space from tweening calculations
 CRaVector4OptionsThis Util class hold the tools to exclude various axes in 4D space from tweening calculations