Unigine::DecalOrtho Class

This class describes how to create and modify orthographic decals.

DecalOrtho Class

Members

---

static DecalOrthoPtr create(float radius, float width, float height, const char * 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.
• const char * material - A material of the decal.

Ptr<DecalOrtho> cast(const Ptr<Decal> & base)

Casts a DecalOrtho out of the Decal instance.

Arguments

• const Ptr<Decal> & base - Pointer to Decal.

Return value

Pointer to DecalOrtho.

Ptr<DecalOrtho> cast(const Ptr<Node> & node)

Casts a DecalOrtho out of the Node instance.

Arguments

• const Ptr<Node> & node - Node smart pointer.

Return value

Pointer to the DecalOrtho.

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.

Math::mat4 getProjection()

Returns the projection matrix.

Return value

The projection matrix of the decal.

void setRadius(float radius)

Sets a new height of the projection box along the Z axis.

Arguments

• float radius - A height of the projection box along the Z axis, in units. If a too small value is provided, 1E-6 will be used instead.

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. If a negative value is provided, 0 will be used instead.

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 a new value of the near clipping plane.

Arguments

• float znear - A value of the near clipping plane, ranging from 0 to 1. If a negative value is provided, 0 will be used instead.

float getZNear()

Returns the value of the near clipping plane.

Return value

The value of the near clipping plane, ranging from 0 to 1.

int type()

Returns a type identifier.

Return value

Type identifier.