Skip to content

AnimControl: correct javadoc for the no-arg constructor #1233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephengold merged 1 commit into from
Dec 12, 2019
Merged

AnimControl: correct javadoc for the no-arg constructor #1233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions jme3-core/src/main/java/com/jme3/animation/AnimControl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2018 jMonkeyEngine
* Copyright (c) 2009-2019 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -102,7 +102,9 @@ public AnimControl(Skeleton skeleton) {
}

/**
* Serialization only. Do not use.
* Instantiate an animation control with no skeleton, suitable only for
* animations that don't contain any bone tracks. Also used for
* serialization.
*/
public AnimControl() {
}
Expand Down Expand Up @@ -144,6 +146,7 @@ public void setAnimations(HashMap<String, Animation> animations) {

/**
* Retrieve an animation from the list of animations.
*
* @param name The name of the animation to retrieve.
* @return The animation corresponding to the given name, or null, if no
* such named animation exists.
Expand All @@ -155,6 +158,7 @@ public Animation getAnim(String name) {
/**
* Adds an animation to be available for playing to this
* <code>AnimControl</code>.
*
* @param anim The animation to add.
*/
public void addAnim(Animation anim) {
Expand All @@ -163,6 +167,7 @@ public void addAnim(Animation anim) {

/**
* Remove an animation so that it is no longer available for playing.
*
* @param anim The animation to remove.
*/
public void removeAnim(Animation anim) {
Expand Down Expand Up @@ -231,6 +236,7 @@ public Skeleton getSkeleton() {

/**
* Adds a new listener to receive animation related events.
*
* @param listener The listener to add.
*/
public void addListener(AnimEventListener listener) {
Expand All @@ -244,6 +250,7 @@ public void addListener(AnimEventListener listener) {

/**
* Removes the given listener from listening to events.
*
* @param listener
* @see AnimControl#addListener(com.jme3.animation.AnimEventListener)
*/
Expand Down Expand Up @@ -308,6 +315,7 @@ public Collection<String> getAnimationNames() {

/**
* Returns the length of the given named animation.
*
* @param name The name of the animation
* @return The length of time, in seconds, of the named animation.
*/
Expand Down