Package apple.scenekit.protocol

Interface SCNAnimatable

All Known Implementing Classes:

ARSCNFaceGeometry, ARSCNPlaneGeometry, SCNAccelerationConstraint, SCNAnimationPlayer, SCNAvoidOccluderConstraint, SCNBillboardConstraint, SCNBox, SCNCamera, SCNCapsule, SCNCone, SCNConstraint, SCNCylinder, SCNDistanceConstraint, SCNFloor, SCNGeometry, SCNIKConstraint, SCNLight, SCNLookAtConstraint, SCNMaterial, SCNMaterialProperty, SCNMorpher, SCNNode, SCNParticleSystem, SCNPlane, SCNPyramid, SCNReferenceNode, SCNReplicatorConstraint, SCNShape, SCNSliderConstraint, SCNSphere, SCNTechnique, SCNText, SCNTorus, SCNTransformConstraint, SCNTube

public interface SCNAnimatable

[@protocol] SCNAnimatable The SCNAnimatable protocol defines an animatable property. Objects that implement this protocol can be animated through these methods.

Method Summary

Modifier and Type	Method	Description
void	addAnimationForKey(@NotNull SCNAnimation animation, @Nullable java.lang.String key)	addAnimation:forKey: Adds and runs an animation Only SCNAnimation (preferred), CABasicAnimation, CAKeyframeAnimation and CAAnimationGroup are supported.
void	addAnimationPlayerForKey(@NotNull SCNAnimationPlayer player, @Nullable java.lang.String key)	addAnimationPlayer:forKey: Add an animation player.
@Nullable CAAnimation	animationForKey(@NotNull java.lang.String key)	Deprecated.
@NotNull NSArray<java.lang.String>	animationKeys()	[@property] animationKeys Returns an array containing the keys of all animations currently attached to the receiver.
@Nullable SCNAnimationPlayer	animationPlayerForKey(@NotNull java.lang.String key)	animationPlayerForKey: Returns the animation player with the given identifier This will return nil if no such animation player exists.
boolean	isAnimationForKeyPaused(@NotNull java.lang.String key)	Deprecated.
void	pauseAnimationForKey(@NotNull java.lang.String key)	Deprecated.
void	removeAllAnimations()	removeAllAnimations Remove all animations.
void	removeAllAnimationsWithBlendOutDuration(double duration)	removeAllAnimationsWithBlendOutDuration Smoothly remove all animations.
void	removeAnimationForKey(@NotNull java.lang.String key)	removeAnimationForKey Remove the animation with the given identifier.
void	removeAnimationForKeyBlendOutDuration(@NotNull java.lang.String key, double duration)	removeAnimationForKey:blendOutDuration: Smoothly remove the animation with the given identifier.
void	removeAnimationForKeyFadeOutDuration(@NotNull java.lang.String key, double duration)	Deprecated.
void	resumeAnimationForKey(@NotNull java.lang.String key)	Deprecated.
void	setSpeedForAnimationKey(double speed, @NotNull java.lang.String key)	Deprecated.

Method Detail

addAnimationForKey

void addAnimationForKey(@NotNull
                        @NotNull SCNAnimation animation,
                        @Nullable
                        @Nullable java.lang.String key)

addAnimation:forKey: Adds and runs an animation Only SCNAnimation (preferred), CABasicAnimation, CAKeyframeAnimation and CAAnimationGroup are supported. The animation starts playing right away. The animation is automatically removed on completion unless if removedOnCompletion is explicitly set to NO.

Parameters:

animation - Added animation.

key - May be any string such that only one animation per unique key is added per animatable object.

animationForKey

@Nullable
@Deprecated
@Nullable CAAnimation animationForKey(@NotNull
                                      @NotNull java.lang.String key)

Deprecated.

animationForKey: Returns the animation with the given identifier This will return nil if no such animation exists. Attempting to modify any properties of the returned object will result in undefined behavior. API-Since: 8.0 Deprecated-Since: 11.0

Parameters:

key - The identifier for the animation to retrieve.

animationKeys

@NotNull
@NotNull NSArray<java.lang.String> animationKeys()

[@property] animationKeys Returns an array containing the keys of all animations currently attached to the receiver.

isAnimationForKeyPaused

@Deprecated
boolean isAnimationForKeyPaused(@NotNull
                                @NotNull java.lang.String key)

Deprecated.

isAnimationForKeyPaused: Returns whether the animation for the specified identifier is paused.

Parameters:

key - The identifier for the animation to query. API-Since: 8.0 Deprecated-Since: 11.0 Deprecated-Message: Use -[SCNAnimationPlayer paused] instead

pauseAnimationForKey

@Deprecated
void pauseAnimationForKey(@NotNull
                          @NotNull java.lang.String key)

Deprecated.

pauseAnimationForKey: Pause the animation with the given identifier.

Parameters:

key - The identifier for the animation to pause. API-Since: 8.0 Deprecated-Since: 11.0 Deprecated-Message: Use -[SCNAnimationPlayer setPaused:] instead

removeAllAnimations

void removeAllAnimations()

removeAllAnimations Remove all animations.

removeAnimationForKey

void removeAnimationForKey(@NotNull
                           @NotNull java.lang.String key)

removeAnimationForKey Remove the animation with the given identifier.

Parameters:

key - The identifier for the animation to remove.

removeAnimationForKeyFadeOutDuration

@Deprecated
void removeAnimationForKeyFadeOutDuration(@NotNull
                                          @NotNull java.lang.String key,
                                          double duration)

Deprecated.

removeAnimationForKey:fadeOutDuration: Smoothly remove the animation with the given identifier.

Parameters:

key - The identifier for the animation to remove.

duration - The fade out duration used to remove the animation. API-Since: 8.0 Deprecated-Since: 11.0

resumeAnimationForKey

@Deprecated
void resumeAnimationForKey(@NotNull
                           @NotNull java.lang.String key)

Deprecated.

resumeAnimationForKey: Resume the animation with the given identifier.

Parameters:

key - The identifier for the animation to resume. API-Since: 8.0 Deprecated-Since: 11.0 Deprecated-Message: Use -[SCNAnimationPlayer setPaused:] instead

setSpeedForAnimationKey

@Deprecated
void setSpeedForAnimationKey(double speed,
                             @NotNull
                             @NotNull java.lang.String key)

Deprecated.

setSpeed:forAnimationKey: Update the animation speed of the animation with the given identifier.

Parameters:

speed - The new speed of the animation.

key - The identifier for the animation to update. API-Since: 10.0 Deprecated-Since: 11.0 Deprecated-Message: Use -[SCNAnimationPlayer setSpeed:] instead

addAnimationPlayerForKey

void addAnimationPlayerForKey(@NotNull
                              @NotNull SCNAnimationPlayer player,
                              @Nullable
                              @Nullable java.lang.String key)

addAnimationPlayer:forKey: Add an animation player. The animation player is not removed automatically on completion. The animation doesn't start playing immediatelly. Call "play" on the player to start playing it.

Parameters:

player - Added animation player.

key - May be any string such that only one animation per unique key is added per animatable object.

animationPlayerForKey

@Nullable
@Nullable SCNAnimationPlayer animationPlayerForKey(@NotNull
                                                   @NotNull java.lang.String key)

animationPlayerForKey: Returns the animation player with the given identifier This will return nil if no such animation player exists. API-Since: 11.0

Parameters:

key - The identifier for the animation player to retrieve.

removeAnimationForKeyBlendOutDuration

void removeAnimationForKeyBlendOutDuration(@NotNull
                                           @NotNull java.lang.String key,
                                           double duration)

removeAnimationForKey:blendOutDuration: Smoothly remove the animation with the given identifier.

Parameters:

key - The identifier for the animation to remove.

duration - The blend out duration used to remove the animation. API-Since: 11.0

removeAllAnimationsWithBlendOutDuration

void removeAllAnimationsWithBlendOutDuration(double duration)

removeAllAnimationsWithBlendOutDuration Smoothly remove all animations.

Parameters:

duration - The blend out duration used to remove the animation. API-Since: 15.0