Share via

CutPlaneComponent Class

  • Reference

Definition

Namespace:
Microsoft.Azure.RemoteRendering
Assembly:
RemoteRenderingClientCS.dll

Cut planes are used to cut away parts of meshes to be able to peek inside.

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

Remarks

Once a cut plane is part of the scene, all rendered pixels that are on the back side of the plane will be discarded. By moving the cut plane around or changing its orientation, one can adjust which parts of the scene are visible.

The position of the cut plane is specified through the position of the owning Entity. The orientation is specified through the Normal and the rotation of the entity.

Properties

CutPlaneFilterMask

Sets the bit mask that can be used to perform per-object cut plane filtering.
Enabled

Enabled state of this component.

(Inherited from ComponentBase)
FadeColor

The color towards which pixels that are closer than FadeLength will be faded.
FadeLength

The distance over which the cut plane fades the original pixel color towards the FadeColor.
InteropId (Inherited from ObjectBase)
Normal

The main axis of the cut plane when the owning Entity has an identity rotation.
Owner

The Entity that this component is attached to.

(Inherited from ComponentBase)
SolidEdgeSize

The screen-space pixel size of the cutplane's solid edge, rendered right at its intersection with remote objects.
Type

The exact type of this component.

(Inherited from ComponentBase)
Valid

Whether this component is still valid.

(Inherited from ComponentBase)

Methods

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

Destroys the component in the runtime.

(Inherited from ComponentBase)
Equals(Object) (Inherited from ObjectBase)
GetHashCode() (Inherited from ObjectBase)

Applies to

See also