fx3d Class Reference

3D特效类 More...

Inheritance diagram for fx3d:

List of all members.

Public Member Functions
def	__init__
	初始化
def	destroy
	把该对象从场景中销毁
def	get_state
	返回特效当前状态
def	register_event
	特效播放完的回调
def	unregister_event
	取消注册特效回调 需要注意，register_event中的参数multiple为True时才需要调用
def	restart
	从头播放特效
def	set_state
	设置特效状态
def	shutdown
	关闭特效
Properties
	cur_time = property(_get_cur_time, _set_cur_time)
	特效的当前播放时间 .
	frame_rate = property(_get_frame_rate, _set_frame_rate)
	特效的播放速率 .
	life_span = property(_get_life_span, None)
	特效的时间长度 .
	pause = property(_get_pause, _set_pause)
	特效暂停 .
	render_level = property(_get_render_level, _set_render_level)
	渲染等级 ([-8, 7]) .
	idx = property(_get_idx)
	用于场景查询的索引标识.

---

Detailed Description

3D特效类

---

Constructor & Destructor Documentation

def __init__	(		self,
			source,
			loop = 2,
			def_shutdown = False,
			init_visible = True,
			shutdown_visible = False,
			layer_id = None,
			async_callback = None,
			async_args = ()
	)

初始化

Parameters:

source	: str 特效的文件路径，创建一个新特效
loop	: int 是否循环播放：0-不循环 1-循环 2-按特效自身定义
def_shutdown	: bool 创建的特效初始状态为FX_STATE_SHUTDOWN,如为True,则创建后的特效必须要restart()才能播放
init_visible	: bool 初始状态是否可见
shutdown_visible	: bool 停止后是否可见。只对模型子特效有效
layer_id	: int 所在的layer层，None代表用默认的层；如果是全3D场景，则请使用NO_2D_LAYER。如果是在 UI 中，则使用 scene3d_ui.get_ui_id()。

---

Member Function Documentation

def get_state

(

self )

返回特效当前状态

Return values:

int	状态值: FX_STATE_INACTIVE : 未激活(未到播放时间) FX_STATE_ACTIVE : 正在播放 FX_STATE_SHUTTINGDOWN : 正在关闭(针对粒子系统) FX_STATE_SHUTDOWN : 已经关闭

def register_event	(		self,
			callback,
			data,
			multiple
	)

特效播放完的回调

Parameters:

callback	: func(neox_ref, [data]) 特效shutdown时回调函数 其中neox_ref为引擎内部参数，请误使用。 提示:回调函数中对self进行操作，可将self传入data中.
data	: object 回调函数的数据
multiple	: bool 是否多次响应，如果为True，则需要显示调用unregister_event释放引用；如果为False，则不需要调用unregister_event

def unregister_event	(		self,
			callback
	)

取消注册特效回调
需要注意，register_event中的参数multiple为True时才需要调用

Parameters:

callback

: func register_event时候的callback

def set_state	(		self,
			state
	)

设置特效状态

Parameters:

state

: int 状态值: FX_STATE_INACTIVE : 未激活(未到播放时间) FX_STATE_ACTIVE : 正在播放 FX_STATE_SHUTTINGDOWN : 正在关闭(针对粒子系统) FX_STATE_SHUTDOWN : 已经关闭

---

Property Documentation

cur_time = property(_get_cur_time, _set_cur_time) [static]

特效的当前播放时间 .

float 读写.

frame_rate = property(_get_frame_rate, _set_frame_rate) [static]

特效的播放速率 .

float 读写.

life_span = property(_get_life_span, None) [static]

特效的时间长度 .

float 只读.

pause = property(_get_pause, _set_pause) [static]

特效暂停 .

bool 读写.

render_level = property(_get_render_level, _set_render_level) [static]

渲染等级 ([-8, 7]) .

int 读写.

idx = property(_get_idx) [static]

用于场景查询的索引标识.

str 只读.