2D Sprite node in 3D environment.
    public abstract class SpriteBase3D : GeometryInstance

A node that displays 2D texture information in a 3D environment.

Inheritance Chain

Derived Classes

Properties

    public AlphaCutMode AlphaCut { get; set; }

    public Vector3.Axis Axis { get; set; }

The direction in which the front of the texture faces.

    public bool Centered { get; set; }

If true texture will be centered. Default value: true.

    public bool DoubleSided { get; set; }

If true texture can be seen from the back as well, if false, it is invisible when looking at it from behind. Default value: true.

    public bool FlipH { get; set; }

If true texture is flipped horizontally. Default value: false.

    public bool FlipV { get; set; }

If true texture is flipped vertically. Default value: false.

    public Color Modulate { get; set; }

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

    public Vector2 Offset { get; set; }

The texture’s drawing offset.

    public float Opacity { get; set; }

The objects visibility on a scale from 0 fully invisible to 1 fully visible.

    public float PixelSize { get; set; }

The size of one pixel’s width on the Sprite to scale it in 3D.

    public bool Shaded { get; set; }

If true the Light in the Environment has effects on the Sprite. Default value: false.

    public bool Transparent { get; set; }

If true the texture’s transparency and the opacity are used to make those parts of the Sprite invisible. Default value: true.

Methods

    public AlphaCutMode GetAlphaCutMode()

Getter for AlphaCut

    public Vector3.Axis GetAxis()

Getter for Axis

    public bool GetDrawFlag(DrawFlags flag)

    public Rect2 GetItemRect()

    public Color GetModulate()

Getter for Modulate

    public Vector2 GetOffset()

Getter for Offset

    public float GetOpacity()

Getter for Opacity

    public float GetPixelSize()

Getter for PixelSize

    public bool IsCentered()

Getter for Centered

    public bool IsFlippedH()

Getter for FlipH

    public bool IsFlippedV()

Getter for FlipV

    public void SetAlphaCutMode(AlphaCutMode mode)

Setter for AlphaCut

    public void SetAxis(Vector3.Axis axis)

Setter for Axis

    public void SetCentered(bool centered)

Setter for Centered

    public void SetDrawFlag(DrawFlags flag, bool enabled)

    public void SetFlipH(bool flipH)

Setter for FlipH

    public void SetFlipV(bool flipV)

Setter for FlipV

    public void SetModulate(Color modulate)

Setter for Modulate

    public void SetOffset(Vector2 offset)

Setter for Offset

    public void SetOpacity(float opacity)

Setter for Opacity

    public void SetPixelSize(float pixelSize)

Setter for PixelSize

Inner Types

AlphaCutMode

Name Value Description
Disabled 0  
Discard 1  
OpaquePrepass 2  

DrawFlags

Name Value Description
Transparent 0 If set, the texture’s transparency and the opacity are used to make those parts of the Sprite invisible.
Shaded 1 If set, the Light in the Environment has effects on the Sprite.
DoubleSided 2 If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
Max 3 Used internally to mark the end of the Flags section.
Tags: