Interface IDepthClipping

Depth clipping allows clipping objects (i.e hiding objects) if they're either too close or too far from the camera. 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.

Inherited Members

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IDepthClipping : INotifyPropertyChanged

Properties

| Improve this Doc View Source

FarClippingPlane

Gets or sets the far clipping plane (objects behind of the plane will be hidden from the camera). The default is null, meaning no far clipping is taking place.

Declaration

IClippingPlane FarClippingPlane { get; set; }

Property Value

Type	Description
IClippingPlane	The near clipping plane.

| Improve this Doc View Source

NearClippingPlane

Gets or sets the near clipping plane (objects in front of the plane will be hidden from the camera). The default is null, meaning no near clipping is taking place.

Declaration

IClippingPlane NearClippingPlane { get; set; }

Property Value

Type	Description
IClippingPlane	The near clipping plane.

Methods

| Improve this Doc View Source

IsObjectClipped(IObject)

Checkes whether an object is clipped (i.e should be hidden) by one of the clipping planes.

Declaration

bool IsObjectClipped(IObject obj)

Parameters

Type	Name	Description
IObject	obj	Object.

Returns

Type	Description
System.Boolean	`true`, if object should be clipped, `false` otherwise.