Entity Class

Definition

An entity represents an object in space.

public ref class Entity : Microsoft::Azure::RemoteRendering::ObjectBase
public class Entity : Microsoft.Azure.RemoteRendering.ObjectBase
type Entity = class
    inherit ObjectBase
Public Class Entity
Inherits ObjectBase
Inheritance

Remarks

Entities have a transform, meaning a position, rotation and scale. By themselves entities don't have any observable functionality. Instead behavior is added through components (see ComponentBase), which are attached to entities. For instance attaching a MeshComponent will make a mesh appear at the position of the entity.

The most important aspect of the entity itself is the hierarchy and the resulting hierarchical transform. For example, when multiple entities are attached as children to a shared parent entity, all of these entities can be moved, rotated and scaled in unison by changing the transform of the parent entity.

Properties

Children

Read-only list of all the entities that are attached as children to this one.

Components

Read-only list of all the components that are attached to this entity.

Enabled

Enables or disables the entity and all its components and children.

InteropId (Inherited from ObjectBase)
Name

Optional name property.

Parent

The entity that acts as this entity's parent.

Position

Position, relative to the parent node.

Rotation

Rotation, relative to the parent node.

Scale

Scale, relative to the parent node.

Static

Indicates whether this object originates from a model conversion that used the 'SceneGraphMode=static' parameter for conversion. These objects cannot be transformed individually or re-parented. Calling transform or re-parenting on a static object will return the 'ObjectStatic' error code.

Type

The ObjectType of this object.

Valid

Whether this entity is still valid.

Methods

AsToolingObject<ToolingObject>() (Inherited from ObjectBase)
Destroy()

Destroys the entity.

Equals(Object) (Inherited from ObjectBase)
FindComponentOfType(ObjectType)

Tries to find a component of the given type.

FindComponentOfType<COMPTYPE>()

Find a component of a type on this Entity.

FindFirstEntity(Entity+EntitySearchDelegate)

Find first entity in this entity's hierarchy (inclusive of itself) that fulfills pred. Search is performed in a depth first order.

GetHashCode() (Inherited from ObjectBase)
QueryLocalBoundsAsync()

Queries the local-space bounding box from the server.

QueryMetadataAsync()

Queries for any available metadata on a single entity.

QueryWorldBoundsAsync()

Queries the world-space bounding box from the server.

VisitEntity(Entity+VisitEntityDelegate)

Visit this entity and any children in a depth first traversal until every node is visited or until the visitor returns VisitorResult.ExitVisit

Applies to

See also

  • <xref:https%3a%2f%2fdocs.microsoft.com%2fazure%2fremote-rendering%2fconcepts%2fentities>
  • <xref:https%3a%2f%2fdocs.microsoft.com%2fazure%2fremote-rendering%2fconcepts%2fcomponents>
  • CreateEntity()