Abstract Class: HorizonLayer<P>
Defined in: src/sdk/components/horizon/HorizonLayer.ts:23
A base component for horizon layers.
Extends
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
P extends HorizonLayerProps | HorizonLayerProps |
Constructors
Constructor
new HorizonLayer<
P
>(props
):HorizonLayer
<P
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
HorizonLayer
<P
>
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
props
props:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | Type | Description |
---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
isAttached()
protected
isAttached():boolean
Defined in: src/sdk/components/horizon/HorizonLayer.ts:31
Checks whether this layer is attached to a horizon component.
Returns
boolean
Whether this layer is attached to a horizon component.
isVisible()
isVisible():
boolean
Defined in: src/sdk/components/horizon/HorizonLayer.ts:39
Checks whether this layer is visible.
Returns
boolean
whether this layer is visible.
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent
.onAfterRender
onAttached()
onAttached():
void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:70
This method is called when this layer is attached to its parent horizon component.
Returns
void
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent
.onBeforeRender
onDetached()
onDetached():
void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:115
This method is called when this layer is detached from its parent horizon component.
Returns
void
onProjectionChanged()
onProjectionChanged(
projection
,changeFlags
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:98
This method is called when this layer's horizon projection changes.
Parameters
Parameter | Type | Description |
---|---|---|
projection | HorizonProjection | This layer's horizon projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
onSleep()
onSleep():
void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:88
This method is called when this layer's parent horizon component is put to sleep.
Returns
void
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:108
This method is called once every update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current time as a UNIX timestamp in milliseconds. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
onVisibilityChanged()
protected
onVisibilityChanged(isVisible
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:63
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
onWake()
onWake():
void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:81
This method is called when this layer's parent horizon component is awakened.
Returns
void
render()
abstract
render():null
|VNode
Defined in: src/sdk/components/FSComponent.ts:93
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Inherited from
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:47
Sets this layer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void