This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
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
Content Creation
Content Optimization
Materials
Art Samples
Tutorials
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.DecalProj Class

Inherits from: Decal

This class describes how to create and modify projected decals.

See also#

A UnigineScript API sample <UnigineSDK>/data/samples/decals/proj_02

Creating a Projected Decal#

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

Source code (C#)
using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
        private DecalProj decal_proj;

        public override bool Init()
        {

			// create an proj decal and setting its radius to 10, fov to 60, aspect to 1.0f, material to "decal_base"
            decal_proj = new DecalProj(10.0f, 60.0f, 1.0f, "decal_base");

			// set the name and position of the decal
            decal_proj.setName("Proj Decal");
            decal_proj.setWorldPosition(new Vec3(0.0f, 0.0f, 5.0f));
					
            return true;
        }
    	
		public override bool Shutdown()
		{
			// clear pointer
			decal_proj.clearPtr();

			return true;
		}
	}
}

DecalProj Class

Properties

float ZNear#

The distance to the near clipping plane of the decal.
set
Sets a distance to the near clipping plane of the decal.
set value - Distance to the near clipping plane, units.

float Radius#

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

float Fov#

The current field of view of the decal's projector.
set
Sets a new field of view of the decal's projector.
set value - The field of view of the decal's projector, in degrees.

float Aspect#

The current aspect ratio of the decal.
set
Sets the new aspect ratio of the decal, in units.
set value - The aspect ratio of the decal, in units.

mat4 Projection#

The projection matrix.

Members


DecalProj ( float radius, float fov, float aspect, string name ) #

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

Arguments

  • float radius - The height of the projection pyramid along the Z axis, in units.
  • float fov - The field of view of the decal's projector, in degrees.
  • float aspect - The aspect ratio of the decal, in units.
  • string name - A material of the decal.

static int type ( ) #

Returns the type of the node.

Return value

Decal type identifier.
Last update: 2021-04-29
Build: ()