API Reference

Class List

pc.LayerComposition

Layer Composition is a collection of pc.Layer that is fed to pc.Scene#layers to define rendering order.

Summary

Properties

camerasA read-only array of pc.CameraComponent that can be used during rendering, e.
layerListA read-only array of pc.Layer sorted in the order they will be rendered.
subLayerEnabledA read-only array of boolean values, matching pc.Layer#layerList.
subLayerListA read-only array of boolean values, matching pc.Layer#layerList.

Methods

getLayerByIdFinds a layer inside this composition by its ID.
getLayerByNameFinds a layer inside this composition by its name.
getOpaqueIndexGets index of the opaque part of the supplied layer in the pc.Layer#layerList.
getTransparentIndexGets index of the semi-transparent part of the supplied layer in the pc.Layer#layerList.
insertInserts a layer (both opaque and semi-transparent parts) at the chosen index in the pc.Layer#layerList.
insertOpaqueInserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the pc.Layer#layerList.
insertTransparentInserts a semi-transparent part of the layer at the chosen index in the pc.Layer#layerList.
pushAdds a layer (both opaque and semi-transparent parts) to the end of the pc.Layer#layerList.
pushOpaqueAdds part of the layer with opaque (non semi-transparent) objects to the end of the pc.Layer#layerList.
pushTransparentAdds part of the layer with semi-transparent objects to the end of the pc.Layer#layerList.
removeRemoves a layer (both opaque and semi-transparent parts) from pc.Layer#layerList.
removeOpaqueRemoves an opaque part of the layer (non semi-transparent mesh instances) from pc.Layer#layerList.
removeTransparentRemoves a transparent part of the layer from pc.Layer#layerList.
sortOpaqueLayersUsed to determine which array of layers has any opaque sublayer that is on top of all the opaque sublayers in the other array.
sortTransparentLayersUsed to determine which array of layers has any transparent sublayer that is on top of all the transparent sublayers in the other array.

Details

Constructor

LayerComposition()

Create a new layer composition.

Properties

Arraycameras

A read-only array of pc.CameraComponent that can be used during rendering, e.g. inside pc.Layer#onPreCull, pc.Layer#onPostCull, pc.Layer#onPreRender, pc.Layer#onPostRender.

ArraylayerList

A read-only array of pc.Layer sorted in the order they will be rendered.

ArraysubLayerEnabled

A read-only array of boolean values, matching pc.Layer#layerList. True means the layer is rendered, false means it's skipped.

ArraysubLayerList

A read-only array of boolean values, matching pc.Layer#layerList. True means only semi-transparent objects are rendered, and false means opaque.

Methods

getLayerById(id)

Finds a layer inside this composition by its ID. null is returned, if nothing is found.

Parameters

idNumberAn ID of the layer to find.

Returns

pc.Layer The layer corresponding to the specified ID. Returns null if layer is not found.

getLayerByName(name)

Finds a layer inside this composition by its name. null is returned, if nothing is found.

Parameters

nameStringThe name of the layer to find.

Returns

pc.Layer The layer corresponding to the specified name. Returns null if layer is not found.

getOpaqueIndex(layer)

Gets index of the opaque part of the supplied layer in the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to find index of.

Returns

Number The index of the opaque part of the specified layer.

getTransparentIndex(layer)

Gets index of the semi-transparent part of the supplied layer in the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to find index of.

Returns

Number The index of the semi-transparent part of the specified layer.

insert(layer, index)

Inserts a layer (both opaque and semi-transparent parts) at the chosen index in the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.
indexNumberInsertion position.

insertOpaque(layer, index)

Inserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.
indexNumberInsertion position.

insertTransparent(layer, index)

Inserts a semi-transparent part of the layer at the chosen index in the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.
indexNumberInsertion position.

push(layer)

Adds a layer (both opaque and semi-transparent parts) to the end of the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.

pushOpaque(layer)

Adds part of the layer with opaque (non semi-transparent) objects to the end of the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.

pushTransparent(layer)

Adds part of the layer with semi-transparent objects to the end of the pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to add.

remove(layer)

Removes a layer (both opaque and semi-transparent parts) from pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to remove.

removeOpaque(layer)

Removes an opaque part of the layer (non semi-transparent mesh instances) from pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to remove.

removeTransparent(layer)

Removes a transparent part of the layer from pc.Layer#layerList.

Parameters

layerpc.LayerA pc.Layer to remove.

sortOpaqueLayers(layersA, layersB)

Used to determine which array of layers has any opaque sublayer that is on top of all the opaque sublayers in the other array.

Parameters

layersANumber[]IDs of layers
layersBNumber[]IDs of layers

Returns

Number Returns a negative number if any of the opaque sublayers in layersA is on top of all the opaque sublayers in layersB, or a positive number if any of the opaque sublayers in layersB is on top of all the opaque sublayers in layersA, or 0 otherwise.

sortTransparentLayers(layersA, layersB)

Used to determine which array of layers has any transparent sublayer that is on top of all the transparent sublayers in the other array.

Parameters

layersANumber[]IDs of layers
layersBNumber[]IDs of layers

Returns

Number Returns a negative number if any of the transparent sublayers in layersA is on top of all the transparent sublayers in layersB, or a positive number if any of the transparent sublayers in layersB is on top of all the transparent sublayers in layersA, or 0 otherwise.