Class InfluenceVolume

Inheritance
Object
InfluenceVolume
Namespace: UnityEngine.Experimental.Rendering.HDPipeline
Syntax
[Serializable]
public class InfluenceVolume : IVersionable<InfluenceVolume.Version>, ISerializationCallbackReceiver

Properties

boxBlendDistanceNegative

Position of fade sub volume minOffset point relative to InfluenceVolume min corner. Values between 0 (on InfluenceVolume hull) to half of boxSize corresponding axis.

Declaration
public Vector3 boxBlendDistanceNegative { get; set; }
Property Value
Type Description
Vector3

boxBlendDistancePositive

Position of fade sub volume maxOffset point relative to InfluenceVolume max corner. Values between 0 (on InfluenceVolume hull) to half of boxSize corresponding axis.

Declaration
public Vector3 boxBlendDistancePositive { get; set; }
Property Value
Type Description
Vector3

boxBlendNormalDistanceNegative

Position of normal fade sub volume minOffset point relative to InfluenceVolume min corner. Values between 0 (on InfluenceVolume hull) to half of boxSize corresponding axis (on origin for this axis).

Declaration
public Vector3 boxBlendNormalDistanceNegative { get; set; }
Property Value
Type Description
Vector3

boxBlendNormalDistancePositive

Position of normal fade sub volume maxOffset point relative to InfluenceVolume max corner. Values between 0 (on InfluenceVolume hull) to half of boxSize corresponding axis (on origin for this axis).

Declaration
public Vector3 boxBlendNormalDistancePositive { get; set; }
Property Value
Type Description
Vector3

boxBlendNormalOffset

Offset of sub volume defining fading relative to normal orientation.

Declaration
public Vector3 boxBlendNormalOffset { get; }
Property Value
Type Description
Vector3

boxBlendNormalSize

Size of sub volume defining fading relative to normal orientation.

Declaration
public Vector3 boxBlendNormalSize { get; }
Property Value
Type Description
Vector3

boxBlendOffset

Offset of sub volume defining fading.

Declaration
public Vector3 boxBlendOffset { get; }
Property Value
Type Description
Vector3

boxBlendSize

Size of sub volume defining fading.

Declaration
public Vector3 boxBlendSize { get; }
Property Value
Type Description
Vector3

boxSideFadeNegative

Define fading percent of -X, -Y and -Z locally oriented face. (values from 0 to 1)

Declaration
public Vector3 boxSideFadeNegative { get; set; }
Property Value
Type Description
Vector3

boxSideFadePositive

Define fading percent of +X, +Y and +Z locally oriented face. (values from 0 to 1)

Declaration
public Vector3 boxSideFadePositive { get; set; }
Property Value
Type Description
Vector3

boxSize

Size of the InfluenceVolume in Box Mode.

Declaration
public Vector3 boxSize { get; set; }
Property Value
Type Description
Vector3

extents

Get the extents of the influence.

Declaration
public Vector3 extents { get; }
Property Value
Type Description
Vector3

shape

Shape of this InfluenceVolume.

Declaration
public InfluenceShape shape { get; set; }
Property Value
Type Description
InfluenceShape

sphereBlendDistance

Offset of the fade sub volume from InfluenceVolume hull. Value between 0 (on InfluenceVolume hull) and sphereRadius (fade sub volume reduced to a point).

Declaration
public float sphereBlendDistance { get; set; }
Property Value
Type Description
Single

sphereBlendNormalDistance

Offset of the normal fade sub volume from InfluenceVolume hull. Value between 0 (on InfluenceVolume hull) and sphereRadius (fade sub volume reduced to a point).

Declaration
public float sphereBlendNormalDistance { get; set; }
Property Value
Type Description
Single

sphereRadius

Radius of the InfluenceVolume in Sphere Mode.

Declaration
public float sphereRadius { get; set; }
Property Value
Type Description
Single

Methods

ComputeHash()

Compute a hash of the influence properties.

Declaration
public Hash128 ComputeHash()
Returns
Type Description
Hash128

OnAfterDeserialize()

Declaration
public void OnAfterDeserialize()

OnBeforeSerialize()

Declaration
public void OnBeforeSerialize()

Explicit Interface Implementations

IVersionable<InfluenceVolume.Version>.version

Declaration
InfluenceVolume.Version IVersionable<InfluenceVolume.Version>.version { get; set; }
Returns
Type Description
UnityEngine.Experimental.Rendering.HDPipeline.InfluenceVolume.Version
Implements