Class InfluenceVolume

An influence volume.

Inheritance

object

InfluenceVolume

Implements

IVersionable<InfluenceVolume.Version>

ISerializationCallbackReceiver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
public class InfluenceVolume : IVersionable<InfluenceVolume.Version>, ISerializationCallbackReceiver

Properties

Name	Description
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.
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.
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).
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).
boxBlendNormalOffset	Offset of sub volume defining fading relative to normal orientation.
boxBlendNormalSize	Size of sub volume defining fading relative to normal orientation.
boxBlendOffset	Offset of sub volume defining fading.
boxBlendSize	Size of sub volume defining fading.
boxSideFadeNegative	Define fading percent of -X, -Y and -Z locally oriented face. (values from 0 to 1)
boxSideFadePositive	Define fading percent of +X, +Y and +Z locally oriented face. (values from 0 to 1)
boxSize	Size of the InfluenceVolume in Box Mode.
extents	Get the extents of the influence.
shape	Shape of this InfluenceVolume.
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).
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).
sphereRadius	Radius of the InfluenceVolume in Sphere Mode.

Methods

Name	Description
ComputeFOVAt(Vector3, Vector3, Matrix4x4)	Compute the minimal FOV required to see the full influence volume from viewerPositionWS while looking at lookAtPositionWS.
ComputeHash()	Compute a hash of the influence properties.
OnAfterDeserialize()	Serialization callback
OnBeforeSerialize()	Serialization callback