Interface IClippingPlane

A clipping plane allows clipping objects (i.e hiding objects) if they're on the wrong side of the plane. A near clipping plane is for clipping objects which are too close to the camera, and a far clipping plane is for clipping objects which are too far from the camera.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IClippingPlane

Properties

| Improve this Doc View Source

IsPlaneObjectClipped

Gets a value indicating whether the PlaneObject (i.e the object representing the plane) should be clipped or not.

Declaration

bool IsPlaneObjectClipped { get; }

Property Value

Type	Description
System.Boolean	`true` if is plane object clipped; otherwise, `false`.

| Improve this Doc View Source

LayersToClip

Gets a list of layers on which to check clipping against this plane. If this is null, all layers will be checked.

Declaration

IReadOnlyList<IRenderLayer> LayersToClip { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<IRenderLayer>	The layers to clip.

| Improve this Doc View Source

PlaneObject

Gets an object to which the plane will be bound. All objects that are to be rendered behind the object will not be shown if the clipping plane in question is a far clipping plane, and all objects that are to be rendered in front of the object will not be shown if the clipping plane in question is a near clipping plane.

Declaration

IObject PlaneObject { get; }

Property Value

Type	Description
IObject	The plane object.