Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Unigine::DecalProj Class

Interface for projected decals handling.

To use this class, include the UnigineDecalProj.h file.

Unigine::DecalProj Class

Members


static int type ()

DecalProj type.

Return value

DecalProj type identifier.

static Ptr< DecalProj > create (const NodePtr & node)

DecalProj constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< DecalProj > create (const DecalPtr & decal)

DecalProj constructor.

Arguments

  • const DecalPtr & decal - Decal smart pointer.

static Ptr< DecalProj > create (float radius, float fov, float aspect, const char * name)

DecalProj constructor.

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.
  • const char * name - The decal material name.

virtual void setInitTime (float time) const =0

Sets a render initialization time value.

Arguments

  • float time - A new initialization time value.

virtual float getInitTime () const =0

Returns the render initialization time value.

Return value

The initialization time value.

virtual void setRadius (float radius) const =0

Sets a new height of the projection pyramid along the Z axis, in units.

Arguments

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

virtual float getRadius () const =0

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.

virtual void setFov (float fov) const =0

Sets a new field of view of the decal's projector.

Arguments

  • float fov - A field of view of the decal's projector, in degrees. The provided value will be clamped in the range [1;90].

virtual float getFov () const =0

Returns the current field of view of the decal's projector.

Return value

The field of view of the decal's projector, in degrees.

virtual void setAspect (float aspect) const =0

Sets the new aspect ratio of the decal, in units.

Arguments

  • float aspect - The aspect ratio of the decal, in units. If a negative value is provided, 0 will be used instead.

virtual float getAspect () const =0

Returns the current aspect ratio of the decal.

Return value

The aspect ratio of the decal, in units.

virtual void setZNear (float znear) const =0

Sets a distance to the near clipping plane of the decal.

Arguments

  • float znear - A new distance to the near clipping plane, in units. If a negative value is provided, 0 will be used instead.

virtual float getZNear () const =0

Returns the distance to the near clipping plane of the decal.

Return value

The distance to the near clipping plane, in units.
Last update: 2017-07-03