Castle Game Engine

Introduction

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Object TProjection

DescriptionHierarchyFieldsMethodsProperties

Unit

CastleProjection

Declaration

type TProjection = object(TObject)

Description

Projection determines how does the 3D world map onto 2D. To change the currently displayed projection, you usually want to override the TCastleAbstractViewport.CalculateProjection.

Hierarchy

  • TObject
  • TProjection

Overview

Fields

Public ProjectionType: TProjectionType;
Public PerspectiveAngles: TVector2Single;
Public Dimensions: TFloatRectangle;
Public ProjectionNear: Single;
Public ProjectionFar: Single;
Public ProjectionFarFinite: Single;

Methods

Public function Matrix(const AspectRatio: Single): TMatrix4Single;

Description

Fields

Public ProjectionType: TProjectionType;
 
Public PerspectiveAngles: TVector2Single;

If ProjectionType is ptPerspective, this property specifies angles of view (horizontal and vertical), in degrees.

Note that when overriding the TCastleAbstractViewport.CalculateProjection, you are expected to provide both angles calculated, even though some routines for now will only use the vertical angle (and automatically adjust the other to the aspect ratio). Use the AdjustViewAngleDegToAspectRatio to calculate the angles as necessary.

Public Dimensions: TFloatRectangle;

If ProjectionType is ptOrthographic or ptFrustum, this property specifies dimensions of the visible window.

Public ProjectionNear: Single;

Near clipping distance. Everything closer to this distance is clipped (invisible).

Public ProjectionFar: Single;

Far clipping distance. Everything further than this distance is clipped (invisible). Note that it have a special value ZFarInfinity, which means that no far clipping plane is used. E.g. shadow volumes require this.

Public ProjectionFarFinite: Single;

Far clipping distance to be used in cases when it cannot be infinite. Unlike ProjectionFar, this property cannot have a magical value ZFarInfinity. It should be calculated just like ProjectionFar, except it's never changed to be ZFarInfinity.

Methods

Public function Matrix(const AspectRatio: Single): TMatrix4Single;

Projection matrix, adjusted to given viewport aspect ratio (width/height).

Generated by PasDoc 0.14.0.