SpriteBase3D

SpriteBase3D

Inherits: GeometryInstance < VisualInstance < Spatial < Node < Object

Inherited By: AnimatedSprite3D, Sprite3D

Category: Core

Brief Description

2D Sprite node in 3D environment.

Properties

AlphaCutMode	alpha_cut
Vector3.Axis	axis
bool	centered
bool	double_sided
bool	flip_h
bool	flip_v
Color	modulate
Vector2	offset
float	opacity
float	pixel_size
bool	shaded
bool	transparent

Methods

TriangleMesh	generate_triangle_mesh ( ) const
Rect2	get_item_rect ( ) const

Enumerations

enum DrawFlags:

FLAG_TRANSPARENT = 0 — If set, the texture’s transparency and the opacity are used to make those parts of the Sprite invisible.
FLAG_SHADED = 1 — If set, the Light in the Environment has effects on the Sprite.
FLAG_DOUBLE_SIDED = 2 — If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
FLAG_MAX = 3 — Represents the size of the DrawFlags enum.

enum AlphaCutMode:

ALPHA_CUT_DISABLED = 0
ALPHA_CUT_DISCARD = 1
ALPHA_CUT_OPAQUE_PREPASS = 2

Description

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

Property Descriptions

AlphaCutMode alpha_cut

Setter	set_alpha_cut_mode(value)
Getter	get_alpha_cut_mode()

Vector3.Axis axis

Setter	set_axis(value)
Getter	get_axis()

The direction in which the front of the texture faces.

bool centered

Setter	set_centered(value)
Getter	is_centered()

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

bool double_sided

Setter	set_draw_flag(value)
Getter	get_draw_flag()

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.

bool flip_h

Setter	set_flip_h(value)
Getter	is_flipped_h()

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

bool flip_v

Setter	set_flip_v(value)
Getter	is_flipped_v()

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

Color modulate

Setter	set_modulate(value)
Getter	get_modulate()

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

Vector2 offset

Setter	set_offset(value)
Getter	get_offset()

The texture’s drawing offset.

float opacity

Setter	set_opacity(value)
Getter	get_opacity()

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

float pixel_size

Setter	set_pixel_size(value)
Getter	get_pixel_size()

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

bool shaded

Setter	set_draw_flag(value)
Getter	get_draw_flag()

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

bool transparent

Setter	set_draw_flag(value)
Getter	get_draw_flag()

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

Method Descriptions

TriangleMesh generate_triangle_mesh ( ) const

Rect2 get_item_rect ( ) const