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 SpatialMaterial.BillboardMode Billboard { get; set; }

    public bool Centered { get; set; }

If true, texture will be centered.

    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.

    public bool FlipH { get; set; }

If true, texture is flipped horizontally.

    public bool FlipV { get; set; }

If true, texture is flipped vertically.

    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.

    public bool Transparent { get; set; }

If true, the texture’s transparency and the opacity are used to make those parts of the sprite invisible.

Methods

    public TriangleMesh GenerateTriangleMesh()

    [Obsolete("GetAlphaCutMode is deprecated. Use the AlphaCut property instead.")]
    public AlphaCutMode GetAlphaCutMode()

Getter for AlphaCut

    [Obsolete("GetAxis is deprecated. Use the Axis property instead.")]
    public Vector3.Axis GetAxis()

Getter for Axis

    [Obsolete("GetBillboardMode is deprecated. Use the Billboard property instead.")]
    public SpatialMaterial.BillboardMode GetBillboardMode()

Getter for Billboard

    [Obsolete("GetDrawFlag is deprecated. Use the DoubleSided property instead.")]
    public bool GetDrawFlag(DrawFlags flag)

    public Rect2 GetItemRect()

    [Obsolete("GetModulate is deprecated. Use the Modulate property instead.")]
    public Color GetModulate()

Getter for Modulate

    [Obsolete("GetOffset is deprecated. Use the Offset property instead.")]
    public Vector2 GetOffset()

Getter for Offset

    [Obsolete("GetOpacity is deprecated. Use the Opacity property instead.")]
    public float GetOpacity()

Getter for Opacity

    [Obsolete("GetPixelSize is deprecated. Use the PixelSize property instead.")]
    public float GetPixelSize()

Getter for PixelSize

    [Obsolete("IsCentered is deprecated. Use the Centered property instead.")]
    public bool IsCentered()

Getter for Centered

    [Obsolete("IsFlippedH is deprecated. Use the FlipH property instead.")]
    public bool IsFlippedH()

Getter for FlipH

    [Obsolete("IsFlippedV is deprecated. Use the FlipV property instead.")]
    public bool IsFlippedV()

Getter for FlipV

    [Obsolete("SetAlphaCutMode is deprecated. Use the AlphaCut property instead.")]
    public void SetAlphaCutMode(AlphaCutMode mode)

Setter for AlphaCut

    [Obsolete("SetAxis is deprecated. Use the Axis property instead.")]
    public void SetAxis(Vector3.Axis axis)

Setter for Axis

    [Obsolete("SetBillboardMode is deprecated. Use the Billboard property instead.")]
    public void SetBillboardMode(SpatialMaterial.BillboardMode mode)

Setter for Billboard

    [Obsolete("SetCentered is deprecated. Use the Centered property instead.")]
    public void SetCentered(bool centered)

Setter for Centered

    [Obsolete("SetDrawFlag is deprecated. Use the DoubleSided property instead.")]
    public void SetDrawFlag(DrawFlags flag, bool enabled)

    [Obsolete("SetFlipH is deprecated. Use the FlipH property instead.")]
    public void SetFlipH(bool flipH)

Setter for FlipH

    [Obsolete("SetFlipV is deprecated. Use the FlipV property instead.")]
    public void SetFlipV(bool flipV)

Setter for FlipV

    [Obsolete("SetModulate is deprecated. Use the Modulate property instead.")]
    public void SetModulate(Color modulate)

Setter for Modulate

    [Obsolete("SetOffset is deprecated. Use the Offset property instead.")]
    public void SetOffset(Vector2 offset)

Setter for Offset

    [Obsolete("SetOpacity is deprecated. Use the Opacity property instead.")]
    public void SetOpacity(float opacity)

Setter for Opacity

    [Obsolete("SetPixelSize is deprecated. Use the PixelSize property instead.")]
    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, lights in the environment affect 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 Represents the size of the [enum DrawFlags] enum.
Tags: