References
summary | ||
public |
C App App contains the orchestration logic for the entirety of what is being displayed for a given app, including the app chrome like navigation. |
|
public |
AssetLoader receives the URLs of assets to load, fetches them, and then fires an event when they're loaded or failed. |
|
public |
AudioManager manages audio for all Components. |
|
public |
|
|
public |
DataCollection represents an ordered list of DataModel instances |
|
public |
DataModel holds a map of string,value pairs, sometimes fetched from or sent to a back-end server. |
|
public |
The abstract class for DataModel and DataCollection It holds the event mixin and the generic function of fetching data from a remote service |
|
public |
DisplayModeTracker keeps track of which display modes (flat, portal, and immersive) are possible |
|
public |
EventHandler is the base class that implements event distribution |
|
public |
Localizer provides the functionality necessary to: |
|
public |
Translation holds a map of source phrases to translated phrases in a given language |
|
public |
|
|
public |
C Router |
|
public |
A shorthand function for getting a localized date |
|
public |
A shorthand function for getting a localized date or time string using your own options |
|
public |
A shorthand function for getting a localized date and time |
|
public |
A shorthand function for getting a translation |
|
public |
F getScriptContext(err: Error): Object When the browser encounters an error it creates an “Error Stack” which contains within it the location where the error ocurred right down to the file’s URL, line number, and character. |
|
public |
F getScriptPath(err: Error): string A helper function that returns just path See getScriptContext for info on how this works. |
|
public |
F getScriptPathname(err: Error): string A helper function that returns the path and name of the calling script See getScriptContext for info on how this works. |
|
public |
F getScriptURL(err: Error): string A helper function that returns just the URL of the calling script See getScriptContext for info on how this works. |
|
public |
|
|
public |
V dom: {} Functions that generate Document Object Model (DOM) elements like dom.div(...) will live in el |
|
public |
V som: {} |
|
public |
V throttledConsoleLog: * |
display
summary | ||
public |
C Engine Engine wraps up the THREE.Renderer and manages moving into and out of WebXR or WebVR Sessions |
|
public |
FlatDisplay is mostly used during development as an easy way to render a portal or immersive scene to the flat page to check the rendering and layout of Components WebVRDisplay and WebXRDisplay are the displays used in production. |
|
public |
SceneDisplay is an abstract base class used by Engine to render a 3D scene See WebVRDisplay for WebXRDisplay ancestor classes that use different APIs (WebVR and WebXR Device API) |
|
public |
WebVRDisplay uses WebVR 1.1 to render a scene |
|
public |
WebXRDisplay uses the WebXR Device API to render a scene |
|
public |
|
|
public |
|
|
public |
|
|
public |
V BLEND_MODES: undefined[] |
|
public |
V DISPLAY_MODES: undefined[] |
|
public |
|
|
public |
|
|
public |
Constants used to communicate information about displays |
|
public |
|
input
summary | ||
public |
ActivePickFilter activates the action if the input is truthy. |
|
public |
PickingInputSource is used by App to track 3D objects that are:
|
|
public |
TextInputFilter |
|
public |
TextInputReceiver is used by Component to route text input commands from components to the TextInputSource |
|
public |
TextInputSource receives events from TextInputReceiver and makes them available as an InputSource |
style
summary | ||
public |
AssignedStyles tracks programmatically (not via KSS) assigned styles for a node Assigned styles are never overwritten by local (KSS defined) or inherited styles |
|
public |
A class that offers a unified API for attributes on an Object3D. |
|
public |
|
|
public |
ComputedStyles holds the previous and computed declarations for a single Object3D |
|
public |
A KSS declaration with a property, value, and importance. |
|
public |
A list of {Declaration}s |
|
public |
|
|
public |
C Evaluators: Map<string, Evaluator Evaluators match and parse declaration values like |
|
public |
GridLayout implements a subset of the full CSS grid layout. |
|
public |
C Layout Layout is the abstract base class for classes that track and apply layout information. |
|
public |
|
|
public |
NodeStyles is assigned to the |
|
public |
Combinator represents a relationship between two {SelectorElement}s, like descendance or sibling. |
|
public |
SelectorElement holds a parsed version of a single element in a selector. |
|
public |
An abstract class for Selectors and Combinator |
|
public |
SelectorFragmentList is a list of SelectorElements and Combinators (which both extend SelectorFragment) Example strings that represent a selector fragment list: |
|
public |
StyleInfo holds the context for a declaration:
|
|
public |
Stylesheet is initialized with KSS data JSON emitted by postcss-potassium. |
|
public |
C Stylist Stylist takes the KSS derived JSON emitted by postcss-potassium and applies it to a Three.js Scene |
|
public |
F styleInfoComparator(info1: *, info2: *): number A sort comparator that sorts {StyleInfo}s from most to least important/specific/load-order |
|
public |
The name of properties that are inherited during the cascade. |
|
public |
|
|
public |
V RegexTemplates: {"positiveIntegerRegex": *, "integerRegex": *, "positiveFloatRegex": *, "floatRegex": *, "metricDistanceFloatRegex": *, "fractionRegex": *, "percentageFloatRegex": *, "anyDistanceRegex": *, "anyDistanceArrayRegex": *, "gridTemplateRegex": *} |
|
public |
|
|
public |
V SpatialTags: string[] |
three
summary | ||
public |
|
|
public |
F Background(width: number, height: number, radius: number[]) Background extends THREE.Mesh (an Object3D) and is used to render a background panel for a Three node. |
|
public |
F BackgroundGeometry(width: number, height: number, radius: number[]) |
|
public |
F BorderGeometry(lineWidth: number[], width: number, height: number, radius: number[]) |
|
public |
F BorderLine(lineWidth: number[], width: number, height: number, radius: number[]) BorderLine extends THREE.Mesh (an Object3D) and is used to render the box border set by KSS |