API Reference

Unit CastleViewport

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

Viewport to display scenes (TCastleViewport).

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class TCastleViewport Viewport displays a tree of scenes and transformations (TCastleTransform and descendants of it, like TCastleScene).
Class TCastleViewportList  
Class TCastleAutoNavigationViewport Automatically create and switch between various navigation classes on a viewport.
Class TCastleSceneManager Deprecated way to manage transformations and scenes.
Class TCastleTouchNavigation Show draggable controls in the corner, to navigate in the viewport comfortably on touch devices.
Class TCastleComponentFactoryHelper Helper methods extending TCastleComponentFactory.

Types

TProjectionEvent = procedure (var Parameters: TProjection) of object;
TInternalDesignNavigationType = (...);
TNavigationType = (...);
TTouchInterface = (...);

Variables

Input_Interact: TInputShortcut;

Description

Types

TProjectionEvent = procedure (var Parameters: TProjection) of object;

Event for TCastleViewport.OnProjection.

TInternalDesignNavigationType = (...);

This item has no description.

Values
  • dnFly
  • dnExamine
  • dn2D
TNavigationType = (...);

Navigation type that determines various navigation properties, used by TCastleAutoNavigationViewport.NavigationType.

Values
  • ntExamine: Examine mode, comfortable to rotate the scene like an item held in your hand. Uses TCastleExamineNavigation.
  • ntTurntable: Turntable mode, similar to examine mode, but with a bit different interpretation of moves. Uses TCastleExamineNavigation.
  • ntWalk: Walk mode, comfortable to walk around the scene with gravity. Uses TCastleWalkNavigation.
  • ntFly: Fly mode, comfortable to move around around the scene without gravity. Uses TCastleWalkNavigation.
  • nt2D: 2D mode, where the camera always looks along with Z axis, and you can pan / zoom in XY.
  • ntNone: Disable user navigation on the scene. Uses TCastleWalkNavigation.
TTouchInterface = (...);

Value for TCastleTouchNavigation.TouchInterface.

Values
  • tiNone
  • tiWalk
  • tiWalkRotate
  • tiFlyWalk
  • tiPan

Variables

Input_Interact: TInputShortcut;

Key/mouse combination to interact with clickable things in TCastleViewport.Items. More precisely, this input will activate pointing device sensors in X3D, which are used to touch (click) or drag things. By default this is left mouse button click.

You can change it to any other mouse button or even to key combination. Simply change properties like TInputShortcut.Key1 or TInputShortcut.MouseButtonUse.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.