Unigine.DecalProj Class
| Inherits: | 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 int 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));
// release ownership of its pointer and add the node to UnigineEditor
decal_proj.release();
Editor.get().addNode(decal_proj.getNode());
return 1;
}
public override int shutdown()
{
// clear pointer
decal_proj.clearPtr();
return 1;
}
}
}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.
Members
static 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 DecalProj Cast ( Decal base ) #
Casts a DecalProj out of the Decal instance.Arguments
- Decal base - Decal instance.
Return value
DecalProj instance.static DecalProj Cast ( Node node ) #
Casts a DecalProj out of the Node instance.Arguments
- Node node - Node instance.
Return value
DecalProj instance.mat4 GetProjection ( ) #
Returns the projection matrix.Return value
The projection matrix of the decal.static int type ( ) #
Returns the type of the node.Return value
Decal type identifier.Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)