DecalProj Class
Warning
UnigineScript is deprecated and will be removed in future releases. Please consider using C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt is not guaranteed, as the current level of support assumes only fixing critical issues.
| 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 (UnigineScript)
#include <core/unigine.h>
int init() {
DecalProj decal_proj;
// 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(vec3(0.0f, 0.0f, 5.0f));
return 1;
}DecalProj Class
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.
void setAspect ( float aspect ) #
Sets the new aspect ratio of the decal, in units.Arguments
- float aspect - The aspect ratio of the decal, in units.
float getAspect ( ) #
Returns the current aspect ratio of the decal.Return value
The aspect ratio of the decal, in units.void setFov ( float fov ) #
Sets the new field of view of the decal's projector.Arguments
- float fov - The field of view of the decal's projector, in degrees.
float getFov ( ) #
Returns the current field of view of the decal's projector.Return value
The field of view of the decal's projector, in degrees.mat4 getProjection ( ) #
Returns the projection matrix.Return value
The projection matrix of the decal.void setRadius ( float radius ) #
Sets the new height of the projection pyramid along the Z axis, in units.Arguments
- float radius - The height of the projection pyramid along the Z axis, in units.
float getRadius ( ) #
Returns the current height of the projection pyramid along the Z axis, in units.Return value
The height of the projection pyramid along the Z axis, in units.void setZNear ( float znear ) #
Sets a distance to the near clipping plane of the decal.Arguments
- float znear - Distance to the near clipping plane, units.
float getZNear ( ) #
Returns a distance to the near clipping plane of the decal.Return value
Distance to the near clipping plane, units.static int type ( ) #
Returns the type of the node.Return value
Decal type identifier.Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)