Unigine::WidgetSpriteNode Class

WidgetSpriteNode Class

Members

---

static WidgetSpriteNodePtr create(const Ptr<Gui> & gui, int width, int height)

Constructor. Creates a new sprite with given properties.

Arguments

• const Ptr<Gui> & gui - GUI, to which the new sprite will belong.
• int width - Width of the sprite.
• int height - Height of the sprite.

Ptr<WidgetSpriteNode> cast(const Ptr<Widget> & widget)

Arguments

• const Ptr<Widget> & widget

void setAspectCorrection(int correction)

Sets the aspect correction for the WidgetSpriteNode. 1 enables correction, 0 disables.

Arguments

• int correction - 1 to enable aspect correction, 0 to disable.

int getAspectCorrection()

Returns the value indicating if the aspect correction enabled for WidgetSpriteNode.

Return value

1 if the aspect correction enabled, otherwise 0.

void setCamera(const Ptr<Camera> & camera)

Copies parameters of the given Camera instance.

Arguments

• const Ptr<Camera> & camera - Camera to be copied.

Ptr<Camera> getCamera()

Copies the instance of camera.

Return value

Camera instance.

void setEnvironmentTextureName(const char * name)

Sets the given name for Environment texture.

Arguments

• const char * name - Texture name to be set.

const char * getEnvironmentTextureName()

Returns the name of the Environment texture.

Return value

Texture name.

void setIFps(float ifps)

Sets a constant frame duration used to render WidgetSpriteNode viewport. For example, it can be used to decrease the frame rate to get higher performance.

Arguments

• float ifps - Frame duration in seconds (1/FPS). If a too small value is provided, 1E-6 will be used instead.

float getIFps()

Returns the current frame duration used to render WidgetSpriteNode viewport.

Return value

Frame duration in seconds (1/FPS).

void setLightUsage(int usage)

Sets the type of the lighting for the WidgetSpriteNode.

Arguments

• int usage - The lighting type. Can be one of the following:
  • USAGE_WORLD_LIGHT
  • USAGE_AUX_LIGHT
  • USAGE_NODE_LIGHT

int getLightUsage()

Returns the type of lighting for the WidgetSpriteNode.

Return value

The lighting type. Can be one of the following:

• USAGE_WORLD_LIGHT
• USAGE_AUX_LIGHT
• USAGE_NODE_LIGHT

void setModelview(const Math::Mat4 & modelview)

Sets a model-view matrix.

Arguments

• const Math::Mat4 & modelview - Model-view matrix.

Math::Mat4 getModelview()

Returns the current model-view matrix.

Return value

Model-view matrix.

void setNode(const Ptr<Node> & node)

Sets a node to be displayed.

Arguments

• const Ptr<Node> & node - Node.

Ptr<Node> getNode()

Returns the current node set for displaying.

Return value

The node.

void setPostMaterials(const char * materials)

Sets post postprocess materials that are applied after all other postprocess are rendered. They are used after engine.render.setPostMaterials(), if any.

Arguments

• const char * materials - Comma-separated names of postprocess materials.

const char * getPostMaterials()

Returns names of the current post postprocess materials that are applied after all other postprocess are rendered. They are used after engine.render.getPostMaterials(), if any.

Return value

Name of the current post postprocess materials.

void setProjection(const Math::mat4 & projection)

Sets a projection matrix.

Arguments

• const Math::mat4 & projection - Projection matrix.

Math::mat4 getProjection()

Returns the current projection matrix.

Return value

Projection matrix.

void setReflectionMask(int mask)

Sets a bit mask for rendering reflections into the viewport. Reflections are rendered in the sprite viewport if masks of reflective materials match this one.

Arguments

• int mask - Integer, each bit of which is a mask.

int getReflectionMask()

Returns the current bit mask for rendering reflections into the viewport. Reflections are rendered in the sprite viewport if masks of reflective materials match this one.

Return value

Integer, each bit of which is a mask.

void setSkipFlags(int flags)

Sets the skip flag for the WidgetSpriteViewport viewport.

Arguments

• int flags - A skip flag. Available flags:
  • SKIP_SHADOWS
  • SKIP_VISUALIZER
  • SKIP_POSTEFFECTS
  • SKIP_DYNAMIC_REFLECTIONS
  • SKIP_VELOCITY_BUFFER
  • SKIP_SRGB

int getSkipFlags()

Returns the skip flag set for the current viewport.

Return value

A skip flag. Available flags:

• SKIP_SHADOWS
• SKIP_VISUALIZER
• SKIP_POSTEFFECTS
• SKIP_DYNAMIC_REFLECTIONS
• SKIP_VELOCITY_BUFFER
• SKIP_SRGB

void setTextureHeight(int height)

Sets the height of the texture buffer used for a widget. This affects the widget size accordingly.

Arguments

• int height - Height of the texture buffer size.

int getTextureHeight()

Returns the height of the texture buffer used for a widget that affects the widget size.

Return value

Height of the texture buffer size.

void setTextureWidth(int width)

Sets the width of the texture buffer used for a widget. This affects the widget size accordingly.

Arguments

• int width - Width of the texture buffer size.

int getTextureWidth()

Returns the width of the texture buffer used for a widget that affects the widget size.

Return value

Width of the texture buffer size.

void setViewportMask(int mask)

Sets a bit mask for rendering into the viewport. Node is rendered in the sprite viewport if its mask matches this one.

Arguments

• int mask - Integer, each bit of which is a mask.

int getViewportMask()

Returns the current bit mask for rendering into the viewport. Node is rendered in the sprite viewport if its mask matches this one.

Return value

Integer, each bit of which is a mask.

void appendSkipFlags(int flags)

Appends a new skip flag without rewriting already set.

Arguments

• int flags - A skip flag. Available flags:
  • SKIP_SHADOWS
  • SKIP_VISUALIZER
  • SKIP_POSTEFFECTS
  • SKIP_DYNAMIC_REFLECTIONS
  • SKIP_VELOCITY_BUFFER
  • SKIP_SRGB

int checkSkipFlags(int flags)

Checks if given flags are already set.

Arguments

• int flags - A skip flag. Available flags:
  • SKIP_SHADOWS
  • SKIP_VISUALIZER
  • SKIP_POSTEFFECTS
  • SKIP_DYNAMIC_REFLECTIONS
  • SKIP_VELOCITY_BUFFER
  • SKIP_SRGB

Return value

1 if flag/flags already set, otherwise 0.

void removeSkipFlags(int flags)

Removes the given skip flag without affecting other set flags.

Arguments

• int flags - A skip flag to be removed. Available flags:
  • SKIP_SHADOWS
  • SKIP_VISUALIZER
  • SKIP_POSTEFFECTS
  • SKIP_DYNAMIC_REFLECTIONS
  • SKIP_VELOCITY_BUFFER
  • SKIP_SRGB

void renderImage(const Ptr<Image> & image)

Renders the viewport into an image.

Arguments

• const Ptr<Image> & image - Reference to a target image.