Skip to content

Commit 082f534

Browse files
committed
Update Camera.md
1 parent e416f5b commit 082f534

File tree

1 file changed

+45
-7
lines changed
  • docs/VirtualAnatomy/ExplorerLevel/Camera

1 file changed

+45
-7
lines changed

docs/VirtualAnatomy/ExplorerLevel/Camera/Camera.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,38 @@ This class handles camera movement and positioning in the scene. It uses a spher
1919

2020
## Definitions
2121

22-
### `ANATOM_PI`
22+
### `ANATOM_PI`
2323

24-
**Description**
24+
**Description**:
2525

26-
Unreal Engine`s definition of PI is depricated so we fuck em. This makes calculating stuff much easier
26+
Defines a custom PI value to replace Unreal Engine’s deprecated PI definition. This ensures more reliable and consistent calculations within the application.
2727

2828
----
2929

3030
## Public Methods
3131

32-
### `void Init(FVector LookAtPos, float maxRadius = 40.0f, float minRadius = 1.0f)`
32+
### `void Init(FVector LookAtPos, float maxRadius = 700.0f, float minRadius = 1.0f)`
3333

3434
**Description**:
3535
Initializes the orbit camera controls, defining the target point to orbit around and setting the radius limits.
3636

3737
**Parameters**:
3838
- `LookAtPos`: The position in the world around which the camera should orbit.
39-
- `maxRadius`: The maximum distance the camera can be from the target. Default is `40.0f`.
39+
- `maxRadius`: The maximum distance the camera can be from the target. Default is `700.0f`.
4040
- `minRadius`: The minimum distance the camera can be from the target. Default is `1.0f`.
4141

4242
---
4343

44+
### `void SetThresholds(FVector MinThreshold, FVector MaxThreshold)`
45+
46+
**Description**:
47+
48+
49+
**Parameters**:
50+
-
51+
52+
---
53+
4454
### `void RotatePolar(float by)`
4555

4656
**Description**:
@@ -138,8 +148,8 @@ A reference to the `FRotator` representing the camera’s rotation.
138148
**Description**:
139149
Recalculates the camera’s position in Cartesian coordinates based on the spherical coordinates:
140150

141-
x = R * Cos(Phi) * Cos(Theta);
142-
y = R * Cos(Phi) * Sin(Theta);
151+
x = R * Cos(Phi) * Cos(Theta); \
152+
y = R * Cos(Phi) * Sin(Theta); \
143153
z = R * Sin(Phi);
144154

145155
**Returns**:
@@ -219,6 +229,34 @@ Represents a full circle in radians (\(2\pi\)). Defined as `ANATOMY_PI * 2.F`.
219229

220230
---
221231

232+
### `float MinThresholdX`
233+
234+
**Description**:
235+
The minimum allowed threshold value for the X-axis. This defines the lower boundary beyond which values are considered out of range.
236+
237+
---
238+
239+
### `float MaxThresholdX`
240+
241+
**Description**:
242+
The maximum allowed threshold value for the X-axis. This defines the upper boundary beyond which values are considered out of range.
243+
244+
---
245+
246+
### `float MinThresholdZ`
247+
248+
**Description**:
249+
The minimum allowed threshold value for the Z-axis. This defines the lower boundary beyond which values are considered out of range.
250+
251+
---
252+
253+
### `float MaxThresholdZ`
254+
255+
**Description**:
256+
The maximum allowed threshold value for the Z-axis. This defines the upper boundary beyond which values are considered out of range.
257+
258+
---
259+
222260
## Notes
223261

224262
- The spherical coordinate system provides precise control over camera movement, allowing dynamic manipulation of angles and distance.

0 commit comments

Comments
 (0)