DecalOrtho 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 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 (UnigineScript)
#include <core/unigine.h>
int init() {
DecalOrtho decal_ortho;
// 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(vec3(0.0f, 0.0f, 5.0f));
return 1;
}DecalOrtho Class
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.
void setHeight ( float height ) #
Sets a new length of the projection box along the Y axis.Arguments
- float height - The length of the projection box along the Y axis, in units. If a negative value is provided, 0 will be used instead.
float getHeight ( ) #
Returns the current length of the projection box along the Y axis.Return value
The length of the projection box along the Y axis, in units.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 box along the Z axis.Arguments
- float radius - The height of the projection box along the Z axis, in units.
float getRadius ( ) #
Returns the current height of the projection box along the Z axis.Return value
The height of the projection box along the Z axis, in units.void setWidth ( float width ) #
Sets the new length of the projection box along the X axis.Arguments
- float width - The length of the projection box along the X axis, in units.
float getWidth ( ) #
Returns the current length of the projection box along the X axis, in units.Return value
The length of the projection box along the X axis, in units.void setZNear ( float znear ) #
Sets the new value of the near clipping plane.Arguments
- float znear - The value of the near clipping plane, ranging from 0 to 1.
float getZNear ( ) #
Returns the value of the near clipping plane.Return value
The value of the near clipping plane, ranging from 0 to 1.static int type ( ) #
Returns a type identifier.Return value
Type identifier.Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)