RemoteTransform2D — C# API

class RemoteTransform2DReckfellSharpInherits Entity2D

RemoteTransform2D copies selected position, rotation and scale values to the entity at RemotePath. An accessory can follow a hand while remaining elsewhere in the hierarchy.

UseGlobalCoordinates = true copies world values; false copies local values relative to each entity's own parent. Disable UpdateScale to retain the accessory scale. This copies transforms; it is not a physics joint.

Working example.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

RemoteTransform2DConstructor

# RemoteTransform2D

C#
public RemoteTransform2D();

Properties5

RemotePathProperty

# RemotePath

C#
public EntityPath RemotePath { get; set; }

The target Entity2D path relative to the RemoteTransform2D itself. In code use GetPathTo(target). The target must be inside the tree. Do not send transforms back to an ancestor or descendant with a dependent transform.

UpdatePositionProperty

# UpdatePosition

C#
public bool UpdatePosition { get; set; }

If true, the remote node's position is updated.

UpdateRotationProperty

# UpdateRotation

C#
public bool UpdateRotation { get; set; }

If true, the remote node's rotation is updated.

UpdateScaleProperty

# UpdateScale

C#
public bool UpdateScale { get; set; }

Enables copying scale to the target. Disable for an accessory with its own size. Retaining scale is subject to ordinary floating-point rounding; use approximate comparisons in checks.

UseGlobalCoordinatesProperty

# UseGlobalCoordinates

C#
public bool UseGlobalCoordinates { get; set; }

When true, copies world values for the selected transform parts. When false, copies local values; source and target may have different parents, so equal local values need not mean equal world positions.

Methods11

ForceUpdateCachevoid

# ForceUpdateCache

C#
public void ForceUpdateCache();

RemoteTransform2D caches the remote node. It may not notice if the remote node disappears; RemoteTransform2D.ForceUpdateCache forces it to update the cache again.

GetRemoteEntityEntityPath

# GetRemoteEntity

C#
public EntityPath GetRemoteEntity();

Returns EntityPath

GetUpdatePositionbool

# GetUpdatePosition

C#
public bool GetUpdatePosition();

Returns bool

GetUpdateRotationbool

# GetUpdateRotation

C#
public bool GetUpdateRotation();

Returns bool

GetUpdateScalebool

# GetUpdateScale

C#
public bool GetUpdateScale();

Returns bool

GetUseGlobalCoordinatesbool

# GetUseGlobalCoordinates

C#
public bool GetUseGlobalCoordinates();

Returns bool

SetRemoteEntityvoid

# SetRemoteEntity

C#
public void SetRemoteEntity(EntityPath path);

Parameters
Name	Type	Default
`path`	`EntityPath`	—

SetUpdatePositionvoid

# SetUpdatePosition

C#
public void SetUpdatePosition(bool updateRemotePosition);

Parameters
Name	Type	Default
`updateRemotePosition`	`bool`	—

SetUpdateRotationvoid

# SetUpdateRotation

C#
public void SetUpdateRotation(bool updateRemoteRotation);

Parameters
Name	Type	Default
`updateRemoteRotation`	`bool`	—

SetUpdateScalevoid

# SetUpdateScale

C#
public void SetUpdateScale(bool updateRemoteScale);

Parameters
Name	Type	Default
`updateRemoteScale`	`bool`	—

SetUseGlobalCoordinatesvoid

# SetUseGlobalCoordinates

C#
public void SetUseGlobalCoordinates(bool useGlobalCoordinates);

Parameters
Name	Type	Default
`useGlobalCoordinates`	`bool`	—