Package com.j3d.gen.settings

package com.j3d.gen.settings
Settings generation logic.

This is a top-level panel, hence it's UI lives within com.j3d.ui.settings

Settings

The way that settings work is a singular Setting, knows how to render itself and update itself whether the code or user updates it. Otherwise there can be "sections" of settings implementing SettingsParent under other sections which can hold any SettingsChild.

The user need only create the SettingsParent frame once and all settings will be shown and editable. The code however needs to go through Settings statically to acces the current value of said setting.

e.g. To access CameraProperties.focalLength, the code would access Settings.cameraProperties and then CameraProperties.focalLength

Structure

Classes

  • SettingsChild, an interface for a singular setting "base"
  • SettingsParent, an implementor of SettingsChild which represents a "folder" of settings be it concrete settings or sub-folders.
  • Setting, the base class for all concrete settings, holding a value and providing mechanisms for UI interaction and persistence.`
  • Settings, the main entry point for all top-level settings, acting as the root container for all other settings and their categories.
  • PrefsGenException, the base exception for anything that went wrong during generation of settings.

Sub-packages

Author:
Lehlogonolo Poole