.. _stdlib_hd_sky_origin_component:

===========
HDSkyOrigin
===========

.. das:module:: hd_sky_origin_component




++++++++++++
Type aliases
++++++++++++

.. _alias-HDSkyOriginTargets:

.. das:attribute:: bitfield HDSkyOriginTargets : uint8

Specifies sky components affected by the origin.

:Fields: * **Panorama** (0x1) - Makes panorama be centered around the origin.

         * **BaseClouds** (0x2) - Tells an offset for base (volumetric) clouds within XZ plane. Can be used for simulating wind or selecting needed position.

         * **StrataClouds** (0x4) - Tells an offset for strata (high-altitude) clouds within XZ plane. Can be used for simulating wind or selecting needed position.




+++++++
Classes
+++++++

.. _struct-hd_sky_origin_component-HDSkyOrigin:

.. das:attribute:: HDSkyOrigin : NativeComponent

This is an auxiliary component needed to set an origin for different parts of :ref:`HDSky <stdlib_hd_sky_component>`.

It may serve as a sky panorama center, as a clouds hole target or as an offset for clouds.
You can have multiple nodes with HDSkyOrigin component to setup different positions for different targets,
but for each target only one node will have an effect.
If multiple nodes affect the same target the one added the last will take precedence.
By default the origin for all targets is at (0, 0, 0).

To use this component, add the following line to your project file::

    require engine.core_components.hd_sky_origin_component // or require engine.core

Usage example::

    let skyOrigin = create_node(NodeData(position = float3(0, 5, 10)))
    add_component(skyOrigin, new HDSkyOrigin(targets = HDSkyOriginTargets.BaseClouds | HDSkyOriginTargets.StrataClouds))



:Properties:

.. _function-hd_sky_origin_component__dot__rq_targets_HDSkyOrigin:

.. das:operator:: HDSkyOrigin.targets() : HDSkyOriginTargets




.. _function-hd_sky_origin_component__dot__rq_targets_rq_clone_HDSkyOrigin_HDSkyOriginTargets:

.. das:operator:: HDSkyOrigin.targets =(value: HDSkyOriginTargets)

Specifies which sky components will be affected by the origin.


:Arguments: * **value** :  :ref:`HDSkyOriginTargets <alias-HDSkyOriginTargets>`