[PPRO] Added missing args and types to ComponentParam and TrackItem #133
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Additionally, there are some updateUI arguments that are not documented. I added them in all the places where I know they exist. |
jomonson
suggested changes
Oct 15, 2024
Comment on lines
+2031
to
+2044
| setColorValue(alpha: number, red: number, green: number, blue: number, updateUI: boolean): boolean | ||
| /** | ||
| * interpolationType must be one of the following: | ||
| * 0 KF_Interp_Mode_Linear | ||
| * 1 kfInterpMode_EaseIn_Obsolete | ||
| * 2 kfInterpMode_EaseOut_Obsolete | ||
| * 3 kfInterpMode_EaseInEaseOut_Obsolete | ||
| * 4 KF_Interp_Mode_Hold | ||
| * 5 KF_Interp_Mode_Bezier | ||
| * 6 KF_Interp_Mode_Time | ||
| * 7 kfInterpMode_TimeTransitionStart | ||
| * 8 kfInterpMode_TimeTransitionEnd | ||
| * */ | ||
| setInterpolationTypeAtKey(time: Time, interpolationType: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8, updateUI?: boolean): boolean |
There was a problem hiding this comment.
Instead create an enum conforming to the TIME_FORMAT:
declare enum INTERPOLATION_TYPE {
KFINTERPMODE_Linear,
KFINTERPMODE_EaseIn_Obsolete,
KFINTERPMODE_EaseOut_Obsolete,
KFINTERPMODE_EaseInEaseOut_Obsolete,
KFINTERPMODE_Hold,
KFINTERPMODE_Bezier,
KFINTERPMODE_Time,
KFINTERPMODE_TimeTransitionStart,
KFINTERPMODE_TimeTransitionEnd,
}
And then use it in the parameter type:
setInterpolationTypeAtKey(time: Time, interpolationType: INTERPOLATION_TYPE, updateUI?: boolean): boolean
| @@ -1250,7 +1250,7 @@ declare class TrackItem { | |||
| /** | |||
| * | |||
| */ | |||
| readonly components: any | |||
| readonly components: Component[] | |||
There was a problem hiding this comment.
Suggested change
| readonly components: Component[] | |
| readonly components: ComponentCollection |
jomonson
suggested changes
Oct 15, 2024
| setValue(value: any, updateUI?: boolean): boolean | ||
| setValueAtKey(): boolean | ||
| setValueAtKey(time: Time, value: any, updateUI: boolean): boolean |
There was a problem hiding this comment.
Suggested change
| setValueAtKey(time: Time, value: any, updateUI: boolean): boolean | |
| setValueAtKey(time: Time, value: any, updateUI?: boolean): boolean |
Comment on lines
+2015
to
+2018
| /** | ||
| * threshold in ticks | ||
| */ | ||
| findNearestKey(timeToCheck: Time, threshold: number): object |
There was a problem hiding this comment.
No need for the comment, and ticks usually come as string if I'm not mistaken
Suggested change
| /** | |
| * threshold in ticks | |
| */ | |
| findNearestKey(timeToCheck: Time, threshold: number): object | |
| findNearestKey(timeToCheck: Time, thresholdInTicks: string): object |
| * threshold in ticks | ||
| */ | ||
| findNearestKey(timeToCheck: Time, threshold: number): object | ||
| findNextKey(timeToCheck: Time): object |
There was a problem hiding this comment.
time to check doesn't add much context / explanation. Better to leave it as time
Suggested change
| findNextKey(timeToCheck: Time): object | |
| findNextKey(time: Time): object |
| */ | ||
| findNearestKey(timeToCheck: Time, threshold: number): object | ||
| findNextKey(timeToCheck: Time): object | ||
| findPreviousKey(timeToCheck: Time): object |
There was a problem hiding this comment.
Suggested change
| findPreviousKey(timeToCheck: Time): object | |
| findPreviousKey(time: Time): object |
| getColorValue(): any[] | ||
| getKeys(): any[] | ||
| getValue(): any | ||
| getValueAtKey(): any | ||
| getValueAtTime(): any | ||
| getValueAtKey(timeToCheck: Time): any |
There was a problem hiding this comment.
Suggested change
| getValueAtKey(timeToCheck: Time): any | |
| getValueAtKey(time: Time): any |
|
For both the initial PR and the suggested changes: Did these only get added to the API in PPro 15.0? If not, please make sure these are included in all of the appropriate typedefs, not just the latest. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I fixed the Track item components, replacing any type with the correct Component[] type.
Additionally, I added several missing arguments in the functions of the ComponentParam class.