This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World Nodes
Звуковые объекты
Объекты поиска пути
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
Унифицированный язык шейдеров UUSL
Плагины
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials

Unigine::Plugins::IG::View Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <plugins/UnigineIG.h>

This class represents the IG View interface.

Notice
IG plugin must be loaded.

View Class

Enums

MIRROR#

NameDescription
MIRROR_NONE = 0View mirror mode none.
MIRROR_HORIZONTAL = 1View mirror mode horizontal.
MIRROR_VERTICAL = 2View mirror mode vertical.
MIRROR_BOTH = 3View mirror mode horizontal and vertical.

PROJECTION#

NameDescription
PROJECTION_PERSPECTIVE = 0Perspective view projection.
PROJECTION_ORTHOGRAPHIC = 1Orthographic view projection.

REPLICATION#

NameDescription
REPLICATION_1_1 = 0Pixel replication function to be performed on the view: none. This feature is typically used in sensor applications to perform electronic zooming (i.e., pixel and line doubling).
REPLICATION_1_2 = 1Pixel replication function to be performed on the view: 1 x 2. This feature is typically used in sensor applications to perform electronic zooming (i.e., pixel and line doubling).
REPLICATION_2_1 = 2Pixel replication function to be performed on the view: 2 x 1. This feature is typically used in sensor applications to perform electronic zooming (i.e., pixel and line doubling).
REPLICATION_1_1 = 3Pixel replication function to be performed on the view: 2 x 2. This feature is typically used in sensor applications to perform electronic zooming (i.e., pixel and line doubling).

Members


int getID ( ) #

Returns the ID of the view.

Return value

View ID.

void setParentGroup ( ViewGroup * view_group ) #

Attaches the view as a child to the specified parent view group.

Arguments

int getParentGroupID ( ) #

Returns the ID of the parent group for the view.

Return value

Parent view group ID.

void setDefinition ( float near, float far, float left_deg, float right_deg, float top_deg, float bottom_deg ) #

Sets the viewing volume (projection) parameters for the view using the specified values.

Arguments

  • float near - Distance to the near clipping plane, in units.
  • float far - Distance to the far clipping plane, in units.
  • float left_deg - Left half-angle, in degrees.
  • float right_deg - Right half-angle, in degrees.
  • float top_deg - Top half-angle, in degrees.
  • float bottom_deg - Bottom half-angle, in degrees.

void setDefinition ( float near, float far, float fov ) #

Sets the viewing volume (projection) parameters for the view using the specified values.

Arguments

  • float near - Distance to the near clipping plane, in units.
  • float far - Distance to the far clipping plane, in units.
  • float fov - Field of view angle, in degrees.

void copyDefinitionFromPlayer ( const PlayerPtr & player ) #

Sets the viewing volume (projection) parameters for the view by copying them from the specified Player.
Notice
The viewport mask should be copied separately.

Arguments

  • const PlayerPtr & player - Source Player to copy viewing volume parameters (projection) from.

float getNear ( ) #

Returns the current distance to the near clipping plane.

Return value

Distance to the near clipping plane, in units.

float getFar ( ) #

Returns the current distance to the far clipping plane.

Return value

Distance to the far clipping plane, in units.

float getLeftDeg ( ) #

Returns the current left half-angle for the view frustum.

Return value

Left half-angle, in degrees.

float getRightDeg ( ) #

Returns the current right half-angle for the view frustum.

Return value

Right half-angle, in degrees.

float getTopDeg ( ) #

Returns the current top half-angle for the view frustum.

Return value

Top half-angle, in degrees.

float getBottomDeg ( ) #

Returns the current bottom half-angle for the view frustum.

Return value

Bottom half-angle, in degrees.

void setReplicationMode ( View::REPLICATION mode ) #

Sets the replication mode for the view.

Arguments

View::REPLICATION getReplicationMode ( ) #

Returns the current replication mode for the view.

Return value

Replication mode. One of the REPLICATION_* values.

void setMirrorMode ( View::MIRROR mode ) #

Sets the mirror mode for the view.

Arguments

View::MIRROR getMirrorMode ( ) #

Returns the current mirror mode for the view.

Return value

Mirror mode. One of the MIRROR_* values.

void setProjection ( View::PROJECTION type ) #

Sets the projection type for the view.

Arguments

View::PROJECTION getProjection ( ) #

Returns the current projection type for the view.

Return value

Projection type. One of the PROJECTION_* values.

void setViewType ( int type ) #

Sets the type of the view. The value of this parameter specifies an IG-defined type for the view.

Arguments

  • int type - View type to be set.

int getViewType ( ) #

Returns the current view type. IG-defined type for the view.

Return value

View type.

void setEnabled ( bool value ) #

true to enable the view; false - to disable it.

Arguments

  • bool value - true if the view is enabled; otherwise, false.

bool isEnabled ( ) const#

Returns a value indicating if the view is enabled.

Return value

true if the view is enabled; otherwise, false.

void setSynckerProjectionEnable ( bool value ) #

Sets a value indicating if the view is affected by the Syncker's projections.

Arguments

  • bool value - true to make the view affected by the Syncker's projections; false - to make the view ignore them.

bool isSynckerProjectionEnable ( ) const#

Returns a value indicating if the view is affected by the Syncker's projections.

Return value

true if the view is affected by the Syncker's projections; otherwise, false.
Last update: 17.02.2021
Build: ()