o3de / o3de.org

The O3DE website
Other
86 stars 159 forks source link

[ISSUE][DOCS] Multiple Camera documentation page issues #909

Closed LB-ArturZieba closed 3 years ago

LB-ArturZieba commented 3 years ago

Describe the issue

There are multiple issues with the Camera documentation page, they will be listed here along with Expected experience wherever appropriate:

  1. Description, in the beginning, references Camera Framework Gem instead of the Camera Gem, but redirects correctly to the Camera Gem page. Expected: Description references Camera Gem instead of Camera Framework Gem.

  2. Camera Component Properties section image is out of date: Page: component-camera-properties Editor: CameraComponentCurrent

  3. Camera Component Properties table does not have separate columns for Valid and Default Values like on e.g. https://o3de.org/docs/user-guide/components/reference/shape/cylinder-shape/ Expected: Camera Component Properties table is adjusted to remain consistent with other similar tables.

  4. Camera Component Properties table - Field of view Valid values listed are 0 to 180 but in engine they are 1e-07 to 180 as per tooltip. Expected: Valid values are adjusted to reflect the ones in the engine.

  5. Camera Component Properties table - Frustum length Name should be bold, and its Valid values are not listed (0.01 to 100 in the engine). Expected: Frustum length Name text is bolded, and Valid values are listed.

  6. Camera Component Properties table does not contain the description for Orthographic property. Expected: Orthographic property entry is in the table with its description, values, and a default value.

  7. EBus Request Bus Interface is inconsistent with other similar sections - e.g. https://o3de.org/docs/user-guide/components/reference/shape/cylinder-shape/ where it's CylinderShapeComponentRequestBus. Expected: EBus Request Bus Interface is renamed to CameraRequestBus.

  8. The documentation references CameraRequestBus and is missing ScriptCanvas nodes on the list that are present in the Editor. Expected: The table contains all currently Camera related nodes. As of now, the nodes are:

    • Camera > Camera:
    • Get FOV
    • Get Far Clip Distance
    • Get Near Clip Distance
    • GetFovDegrees
    • GetFovRadians
    • GetOrthographicHalfWidth
    • IsActiveView
    • IsOrthographic
    • Make Active View
    • Set FOV
    • Set Far Clip Distance
    • Set Near Clip Distance
    • SetFovDegrees
    • SetFovRadians
    • SetOrthographic
    • SetOrthographicHalfWidth
    • Camera > CameraNotificationBus
    • OnActiveViewChanged
    • OnCameraAdded
    • OnCameraRemove
    • Camera > CameraSystemRequestBus
    • GetActiveCamera

      Impacted page(s)

      https://o3de.org/docs/user-guide/components/reference/camera/camera/

LB-ArturZieba commented 2 years ago

Issue verified as fixed, however a typo was found in two of the properties: