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 int 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));
// release ownership of its pointer and add the node to UnigineEditor
decal_ortho.release();
Editor.get().addNode(decal_ortho.getNode());
return 1;
}
public override int shutdown()
{
// clear pointer
decal_ortho.clearPtr();
return 1;
}
}
}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.
static DecalOrtho Cast ( Decal base ) #
Casts a DecalOrtho out of the Decal instance.Arguments
- Decal base - Decal instance.
Return value
DecalOrtho instance.static DecalOrtho Cast ( Node node ) #
Casts a DecalOrtho out of the Node instance.Arguments
- Node node - Node instance.
Return value
DecalOrtho instance.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:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)