Struct AnchorSettings

A struct that contains the anchor settings of a virtual camera.

Namespace: Unity.LiveCapture.VirtualCamera

Syntax

[Serializable]
public struct AnchorSettings : IEquatable<AnchorSettings>

Fields

Damping

The settings used to configure the smoothing applied to the anchor's motion.

Declaration

[Tooltip("The settings used to configure the smoothing applied to the anchor's motion.")]
public Damping Damping

Field Value

Type	Description
Damping

Default

The default AnchorSettings.

Declaration

public static readonly AnchorSettings Default

Field Value

Type	Description
AnchorSettings

PositionLock

The position axes to follow when anchored.

Declaration

[Tooltip("The position axes to follow when anchored.")]
[EnumFlagButtonGroup(60F)]
public Axis PositionLock

Field Value

Type	Description
Axis

PositionOffset

Offset local to the target's anchor Transform.

Declaration

[Tooltip("Offset local to the target's anchor Transform.")]
public Vector3 PositionOffset

Field Value

Type	Description
Vector3

RotationLock

The rotation axes to follow when anchored.

Declaration

[Tooltip("The rotation axes to follow when anchored.")]
[EnumFlagButtonGroup(60F)]
public Axis RotationLock

Field Value

Type	Description
Axis

Methods

Equals(Object)

Determines whether the specified object is equal to the current AnchorSettings.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare with the current AnchorSettings.

Returns

Type	Description
Boolean	True if the specified object is equal to the current AnchorSettings; otherwise, false.

Overrides

ValueType.Equals(Object)

Equals(AnchorSettings)

Determines whether the AnchorSettings instances are equal.

Declaration

public bool Equals(AnchorSettings other)

Parameters

Type	Name	Description
AnchorSettings	other	The other AnchorSettings to compare with the current object.

Returns

Type	Description
Boolean	True if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Gets the hash code for the AnchorSettings.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	The hash value generated for these AnchorSettings.

Overrides

ValueType.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
String	A string that represents the current object.

Overrides

ValueType.ToString()

Operators

Equality(AnchorSettings, AnchorSettings)

Determines whether the two specified AnchorSettings are equal.

Declaration

public static bool operator ==(AnchorSettings a, AnchorSettings b)

Parameters

Type	Name	Description
AnchorSettings	a	The first AnchorSettings.
AnchorSettings	b	The second AnchorSettings.

Returns

Type	Description
Boolean	True if the specified AnchorSettings are equal; otherwise, false.

Inequality(AnchorSettings, AnchorSettings)

Determines whether the two specified AnchorSettings are different.

Declaration

public static bool operator !=(AnchorSettings a, AnchorSettings b)

Parameters

Type	Name	Description
AnchorSettings	a	The first AnchorSettings.
AnchorSettings	b	The second AnchorSettings.

Returns

Type	Description
Boolean	True if the specified AnchorSettings are different; otherwise, false.