This page has been translated automatically.
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
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine 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
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.DecalOrtho Class

Inherits: Decal

This class describes how to create and modify orthographic decals.

See Also#

A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/decals/ folder:

  • ortho_01
  • ortho_02
  • ortho_03
  • ortho_05

Creating an Orthographic Decal#

The following code illustrates how to create an orthographic decal, set its parameters and add the node to UnigineEditor.

Source code (C#)
using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
        private DecalOrtho decal_ortho;

        public override bool Init()
        {

			// create an ortho decal and setting its radius to 10, width and height to 2, material to "decal_base"
            decal_ortho = new DecalOrtho(10.0f, 2.0f, 2.0f, "decal_base");

			// set the name and position of the decal
            decal_ortho.setName("Ortho Decal");
            decal_ortho.setWorldPosition(new Vec3(0.0f, 0.0f, 5.0f));

            return true;
        }
    	
		public override bool Shutdown()
		{
			// clear pointer
			decal_ortho.clearPtr();

			return true;
		}
	}
}

DecalOrtho Class

Properties

float ZNear#

The value of the near clipping plane.
set
Sets a new value of the near clipping plane.
set value - The value of the near clipping plane, ranging from 0 to 1.

float Width#

The current length of the projection box along the x axis, in units.
set
Sets the new length of the projection box along the X axis.
set value - The length of the projection box along the X axis, in units.

float Radius#

The current height of the projection box along the z axis.
set
Sets a new height of the projection box along the Z axis.
set value - The height of the projection box along the Z axis, in units.

float Height#

The current length of the projection box along the y axis.
set
Sets a new length of the projection box along the Y axis.
set value - The length of the projection box along the Y axis, in units. If a negative value is provided, 0 will be used instead.

Members


static DecalOrtho ( float radius, float width, float height, string material ) #

Constructor. Creates a new projected decal with the given properties.

Arguments

  • float radius - The height of the projection box along the Z axis, in units.
  • float width - The length of the projection box along the X axis, in units.
  • float height - The length of the projection box along the Y axis, in units.
  • string material - A material of the decal.

mat4 GetProjection ( ) #

Returns the projection matrix.

Return value

The projection matrix of the decal.

static int type ( ) #

Returns a type identifier.

Return value

Type identifier.
Last update: 2020-04-10
Build: ()