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
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Unigine::DecalOrtho Class

I Interface for orthographic decals handling.

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

Unigine::DecalOrtho Class

Members


static int type ()

DecalOrtho type.

Return value

DecalOrtho type identifier.

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

DecalOrtho constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

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

DecalOrtho constructor.

Arguments

  • const DecalPtr & decal - Decal smart pointer.

static Ptr< DecalOrtho > create (float radius, float width, float height, const char * name)

DecalOrtho constructor.

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 * 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 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.

virtual float getRadius () const =0

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.

virtual void setWidth (float width) const =0

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.

virtual float getWidth () const =0

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.

virtual void setHeight (float height) const =0

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.

virtual float getHeight () const =0

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.

virtual void setZNear (float znear) const =0

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.

virtual float getZNear () const =0

Returns the value of the near clipping plane.

Return value

The value of the near clipping plane, ranging from 0 to 1.
Last update: 2017-07-03