UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
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
Rendering-Related Classes

IG::View Class

Header: #include <UnigineIG.h>
Inherits: ViewBase

This class represents the IG View interface.

Notice
IG plugin must be loaded.

View Class

Members


int getID ( ) #

Returns the ID of the view.

Return value

View ID.

void setParentGroup ( ViewGroup * entity ) #

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

Arguments

  • ViewGroup * entity - Parent view group.

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 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.

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 ( int id ) #

Sets the replication mode for the view.

Arguments

  • int id - Replication mode to be set. One of the REPLICATION_* values.

int getReplicationMode ( ) #

Returns the current replication mode for the view.

Return value

Replication mode. One of the REPLICATION_* values.

void setMirrorMode ( int id ) #

Sets the mirror mode for the view.

Arguments

  • int id - Mirror mode to be set. One of the MIRROR_* values.

int getMirrorMode ( ) #

Returns the current mirror mode for the view.

Return value

Mirror mode. One of the MIRROR_* values.

void setProjection ( int id ) #

Sets the projection type for the view.

Arguments

  • int id - Projection type to be set. One of the PROJECTION_* values.

int getProjection ( ) #

Returns the current projection type for the view.

Return value

Projection type. One of the PROJECTION_* values.

void setViewType ( int id ) #

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

Arguments

  • int id - View type to be set.

int getViewType ( ) #

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

Return value

View type.

Component * getComponent ( int id ) #

Returns the interface of the specified component.

Arguments

  • int id - ID of the component.

Return value

Component interface.
Last update: 2019-11-28