SpriteBase3D

SpriteBase3D

Inherits: GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object

Inherited By: AnimatedSprite3D, Sprite3D

3D 环境中的 2D 精灵节点。

描述

在 3D 环境中显示 2D 纹理信息的节点。

属性

AlphaCutMode	alpha_cut	`0`
Vector3.Axis	axis	`2`
BillboardMode	billboard	`0`
bool	centered	`true`
bool	double_sided	`true`
bool	flip_h	`false`
bool	flip_v	`false`
Color	modulate	`Color( 1, 1, 1, 1 )`
Vector2	offset	`Vector2( 0, 0 )`
float	opacity	`1.0`
float	pixel_size	`0.01`
bool	shaded	`false`
bool	transparent	`true`

方法

TriangleMesh	generate_triangle_mesh ( ) const
bool	get_draw_flag ( DrawFlags flag ) const
Rect2	get_item_rect ( ) const
void	set_draw_flag ( DrawFlags flag, bool enabled )

枚举

enum DrawFlags:

FLAG_TRANSPARENT = 0 —- 如果设置，纹理的透明度和不透明性用于使精灵的这些部分不可见。
FLAG_SHADED = 1 —- 如果设置，环境中的灯光会影响精灵。
FLAG_DOUBLE_SIDED = 2 —- 如果设置，从后面也可以看到纹理，如果没有，从后面看它是不可见的。
FLAG_MAX = 3 —- 代表DrawFlags枚举的大小。

enum AlphaCutMode:

ALPHA_CUT_DISABLED = 0
ALPHA_CUT_DISCARD = 1
ALPHA_CUT_OPAQUE_PREPASS = 2

属性说明

AlphaCutMode alpha_cut

Default	`0`
Setter	set_alpha_cut_mode(value)
Getter	get_alpha_cut_mode()

Vector3.Axis axis

Default	`2`
Setter	set_axis(value)
Getter	get_axis()

纹理正面朝向的方向。

BillboardMode billboard

Default	`0`
Setter	set_billboard_mode(value)
Getter	get_billboard_mode()

bool centered

Default	`true`
Setter	set_centered(value)
Getter	is_centered()

为 true 时纹理将被居中。

bool double_sided

Default	`true`
Setter	set_draw_flag(value)
Getter	get_draw_flag()

如果true，从后面也可以看到纹理，如果false，从后面看它是不可见的。

bool flip_h

Default	`false`
Setter	set_flip_h(value)
Getter	is_flipped_h()

为 true 时纹理将被水平翻转。

bool flip_v

Default	`false`
Setter	set_flip_v(value)
Getter	is_flipped_v()

为 true 时纹理将被垂直翻转。

Color modulate

Default	`Color( 1, 1, 1, 1 )`
Setter	set_modulate(value)
Getter	get_modulate()

乘以颜色值，用于色调调制和模拟光的颜色。

Vector2 offset

Default	`Vector2( 0, 0 )`
Setter	set_offset(value)
Getter	get_offset()

纹理的绘图偏移量。

float opacity

Default	`1.0`
Setter	set_opacity(value)
Getter	get_opacity()

物体的可见度从 0 完全不可见到 1 完全可见。

float pixel_size

Default	`0.01`
Setter	set_pixel_size(value)
Getter	get_pixel_size()

精灵上一个像素宽度的大小，以 3D 缩放。

bool shaded

Default	`false`
Setter	set_draw_flag(value)
Getter	get_draw_flag()

如果 true，则 Environment 中的 Light 对精灵有影响。

bool transparent

Default	`true`
Setter	set_draw_flag(value)
Getter	get_draw_flag()

如果 true，纹理的透明度和不透明度用于使精灵的这些部分不可见。

方法说明

TriangleMesh generate_triangle_mesh ( ) const

bool get_draw_flag ( DrawFlags flag ) const

返回指定标志的值。

Rect2 get_item_rect ( ) const

返回表示此精灵的矩形。

void set_draw_flag ( DrawFlags flag, bool enabled )

如果true，指定的标志将被启用。