Unigine.DecalProj Class

This class describes how to create and modify proj decals.

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.

DecalProj cast(Decal base)

Casts a DecalProj out of the Decal instance.

Arguments

• Decal base - Decal instance.

Return value

DecalProj instance.

DecalProj cast(Node node)

Casts a DecalProj out of the Node instance.

Arguments

• Node node - Node instance.

Return value

DecalProj instance.

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 a 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 a 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 the distance to the near clipping plane of the decal.

Return value

The distance to the near clipping plane, in units.

int type()

Returns the type of the node.

Return value

Decal type identifier.