Skip to content
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

Jump to bottom

com.jme3.anim.tween.action.BlendSpace: basic javadoc #2022

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open

com.jme3.anim.tween.action.BlendSpace: basic javadoc #2022

wants to merge 19 commits into from

Conversation

pavly-gerges
Copy link
Contributor

This PR adds a basic javadoc for the BlendSpace class.

@pavly-gerges pavly-gerges marked this pull request as draft May 28, 2023 07:44
@pavly-gerges pavly-gerges marked this pull request as ready for review May 28, 2023 08:52
@pavly-gerges pavly-gerges marked this pull request as draft May 28, 2023 10:23
@pavly-gerges pavly-gerges mentioned this pull request May 28, 2023
Open
@pavly-gerges pavly-gerges marked this pull request as ready for review May 29, 2023 07:58
@stephengold stephengold added the Documentation Issues that affect the Wiki, Javadoc or any other form of documentation label Jun 7, 2023
@stephengold
Copy link
Member

Javadoc is important, and I appreciate the considerable effort that's gone into this PR. Unfortunately, it's still very confusing. @Scrappers-glitch are you willing to continue refining it?

@pavly-gerges
Copy link
Contributor Author

@stephengold For me, this PR is complete, you can point to the confusing and/or missing parts, please don't forget to mention why these parts are confusing and a superior format for describing these confusing parts.

@pavly-gerges
Copy link
Contributor Author

pavly-gerges commented Jul 26, 2023 •
edited
Loading

@stephengold In this PR, I chose to stick to describing the behavior of the pattern used, or maybe the interaction of the API components, if you want to understand more, please use this paradigm designed by Remy (Most of this documentation is based on this paradigm, the talks on forums and my own techdemos):
Monkanim: new animation system in the works

EDIT:
Here are some examples of implementing new BlendSpaces in a user application:
CustomBlendAction and CustomBlendSpaces

@pavly-gerges
Copy link
Contributor Author

Okay I am willing to refine this. @stephengold Do you recommend specific refinements to make it more simple. Maybe code samples? or more mathematical terms? any ideas so far?

@pavly-gerges pavly-gerges marked this pull request as draft January 22, 2024 18:10
@stephengold
Copy link
Member

Figuring out why the javadoc is confusing and writing a clear explanation seems like a lot of effort. I don't want to spend more time on this PR.

@pavly-gerges
Copy link
Contributor Author

pavly-gerges commented Jan 24, 2024 •
edited
Loading

BlendSpace is all about a provider interface. It provides the blend weight value to blend between 2 actions. Blend weight is then used as the value of interpolation. That simple. I like to think of it from a higher perspective as an interface that enables the user to adjust the behavior of blending (a controller interface from an architectural perspective), and that blend weight value is a read-only value. It could be manipulated using the mediator BlendSpace#setValue(...).

@pavly-gerges pavly-gerges marked this pull request as ready for review January 24, 2024 05:28
@pavly-gerges
Copy link
Contributor Author

For me, this PR has completed. Please let me know if there are any changes you want to add, otherwise it's ready for merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pspeed42 pspeed42 pspeed42 left review comments

@Ali-RS Ali-RS Ali-RS left review comments

Assignees
No one assigned
Labels
Documentation Issues that affect the Wiki, Javadoc or any other form of documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@pavly-gerges @stephengold @Ali-RS @pspeed42