Class ProxyAlignmentForce

Inheritance

Object

ProxyAlignmentForce

Namespace: Unity.MARS.Forces

Syntax

[ComponentTooltip("Applies an alignment force relative to another object.")]
[MonoBehaviourComponentMenu(typeof(ProxyAlignmentForce), "Forces/Align To")]
public class ProxyAlignmentForce : MonoBehaviour, ISimulatable, IProxyAlignmentForceSource

Constructors

ProxyAlignmentForce()

Declaration

public ProxyAlignmentForce()

Properties

scaleForces

Strength of the alignment force

Declaration

public ProxyAlignmentForceScaling scaleForces { get; set; }

Property Value

Type	Description
ProxyAlignmentForceScaling

targetProxy

Target of this force should align to

Declaration

public ProxyForces targetProxy { get; set; }

Property Value

Type	Description
ProxyForces

targetRelation

Style of relation to the target

Declaration

public ProxyAlignmentForceType targetRelation { get; set; }

Property Value

Type	Description
ProxyAlignmentForceType

Methods

CheckInitialRelativePose()

Checks that the initial pose has been configured

Declaration

public void CheckInitialRelativePose()

TryGetGoalPose(out Pose, Boolean)

Declaration

public bool TryGetGoalPose(out Pose goalPose, bool ignoreActive)

Parameters

Type	Name	Description
Pose	goalPose
Boolean	ignoreActive

Returns

Type	Description
Boolean

TryGetTargetPose(out Pose, Boolean)

Declaration

public bool TryGetTargetPose(out Pose pose, bool ignoreActive)

Parameters

Type	Name	Description
Pose	pose
Boolean	ignoreActive

Returns

Type	Description
Boolean

UpdateAlignmentDefinitionWithin(ProxyForces)

Declaration

public void UpdateAlignmentDefinitionWithin(ProxyForces into)

Parameters

Type	Name	Description
ProxyForces	into

UpdateInitialRelativePose()

Updates the initial relative pose to it's current alignment

Declaration

public void UpdateInitialRelativePose()