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.

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

CMCL-1606: TargetPositionCache needs to be public #1023

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

glabute
Copy link
Collaborator

@glabute glabute commented Sep 11, 2024

Purpose of this PR

Custom Cinemachine classes were prevented from supporting CInemachine's Timeline cached scrubbing feature because the necessary API was internal.

Solution was to make public the following two static methods:
TargetPositionCache.GetTargetPosition() and TargetPositionCache.GetTargetRotation()

Testing status

  • Added an automated test
  • Passed all automated tests
  • Manually tested

Documentation status

  • Updated CHANGELOG
  • Updated README (if applicable)
  • Commented all public classes, properties, and methods
  • Updated user documentation

Technical risk

0

Comments to reviewers

Just made 2 static methods public. There is a repro project in the bug report that can be used to test.

Copy link
Collaborator

@sebastienduverne sebastienduverne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions in API docs.

com.unity.cinemachine/Runtime/Core/TargetPositionCache.cs Outdated Show resolved Hide resolved
com.unity.cinemachine/Runtime/Core/TargetPositionCache.cs Outdated Show resolved Hide resolved
com.unity.cinemachine/Runtime/Core/TargetPositionCache.cs Outdated Show resolved Hide resolved
com.unity.cinemachine/Runtime/Core/TargetPositionCache.cs Outdated Show resolved Hide resolved
com.unity.cinemachine/Runtime/Core/TargetPositionCache.cs Outdated Show resolved Hide resolved
Co-authored-by: Sébastien Duverne <55094336+sebastienduverne@users.noreply.github.com>
Copy link
Collaborator

@sebastienduverne sebastienduverne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM on the docs side.

@glabute glabute merged commit dd73664 into main Sep 26, 2024
46 of 48 checks passed
@glabute glabute deleted the dev/targetpositioncache-is-public branch September 26, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants