RemoteTransform3D — C# API

RemoteTransform3D pushes its own Transform3D to another Entity3D derived Entity in the scene.

class RemoteTransform3DReckfellSharpInherits Entity3D

RemoteTransform3D pushes its own Transform3D to another Entity3D derived Entity in the scene.

RemoteTransform3D pushes its own Transform3D to another Entity3D derived Entity (called the remote node) in the scene. It can be set to update another Entity's position, rotation and/or scale. It can use either global or local coordinates.

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

Constructors1

RemoteTransform3DConstructor

# RemoteTransform3D

C#
public RemoteTransform3D();

Properties5

RemotePathProperty

# RemotePath

C#
public EntityPath RemotePath { get; set; }

The EntityPath to the remote node, relative to the RemoteTransform3D's position in the scene.

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; }

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

UseGlobalCoordinatesProperty

# UseGlobalCoordinates

C#
public bool UseGlobalCoordinates { get; set; }

If true, global coordinates are used. If false, local coordinates are used.

Methods11

ForceUpdateCachevoid

# ForceUpdateCache

C#
public void ForceUpdateCache();

RemoteTransform3D caches the remote node. It may not notice if the remote node disappears; RemoteTransform3D.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`	—