Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
Particle3DRender Class Referenceabstract

Particle3DRender is a base class, define interfaces. More...

Inherits Ref.

Inherited by Particle3DModelRender, Particle3DQuadRender, and PURender.

Public Member Functions

virtual void render (Renderer *renderer, const Mat4 &transform, ParticleSystem3D *particleSystem)=0
 Render particles(internal method). More...
 
local render ( local renderer, local transform, local particleSystem)
 Render particles(internal method). More...
 
virtual void notifyStart ()
 Perform activities when a Renderer is started(internal method).
 
virtual void notifyStop ()
 Perform activities when a Renderer is stopped(internal method).
 
virtual void notifyRescaled (const Vec3 &scale)
 Notify that the Particle System is rescaled(internal method).
 
var notifyRescaled ( var scale)
 Notify that the Particle System is rescaled(internal method).
 
local notifyRescaled ( local scale)
 Notify that the Particle System is rescaled(internal method).
 
void setVisible (bool isVisible)
 Set the render visible or invisible. More...
 
bool isVisible () const
 Checks the render visible. More...
 
void setDepthTest (bool isDepthTest)
 Set the depth test enable or disable, default is enabled. More...
 
void setDepthWrite (bool isDepthWrite)
 Set the depth write enable or disable, default is disable. More...
 
void setBlendFunc (const BlendFunc &blendFunc)
 Set the blend function. More...
 
void copyAttributesTo (Particle3DRender *render)
 Copy one renderer's attributes to another's(internal method). More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 

Detailed Description

Particle3DRender is a base class, define interfaces.

Different renderers can have their own implementation Renderer mainly determines how particles are rendered, such as billboard rendering, model rendering, etc. One particle system must have a renderer.

Member Function Documentation

virtual void render ( Renderer *  renderer,
const Mat4 transform,
ParticleSystem3D particleSystem 
)
pure virtual

Render particles(internal method).

The pointer of cocos renderer. The model-view matrix. The pointer of particle system.

Implemented in PUSphereRender, PUParticle3DBoxRender, PUParticle3DModelRender, PUParticle3DQuadRender, Particle3DModelRender, and Particle3DQuadRender.

var render ( var  renderer,
var  transform,
var  particleSystem 
)
pure virtual

Render particles(internal method).

The pointer of cocos renderer. The model-view matrix. The pointer of particle system.

Implemented in PUSphereRender, PUParticle3DBoxRender, PUParticle3DModelRender, PUParticle3DQuadRender, Particle3DModelRender, and Particle3DQuadRender.

local render ( local  renderer,
local  transform,
local  particleSystem 
)
pure virtual

Render particles(internal method).

The pointer of cocos renderer. The model-view matrix. The pointer of particle system.

Implemented in PUSphereRender, PUParticle3DBoxRender, PUParticle3DModelRender, PUParticle3DQuadRender, Particle3DModelRender, and Particle3DQuadRender.

void setVisible ( bool  isVisible)
inline

Set the render visible or invisible.

Whether the render is visible.

var setVisible ( var  isVisible)
inline

Set the render visible or invisible.

Whether the render is visible.

local setVisible ( local  isVisible)
inline

Set the render visible or invisible.

Whether the render is visible.

bool isVisible ( ) const
inline

Checks the render visible.

Whether the render is visible.

var isVisible ( )
inline

Checks the render visible.

Whether the render is visible.

local isVisible ( )
inline

Checks the render visible.

Whether the render is visible.

void setDepthTest ( bool  isDepthTest)

Set the depth test enable or disable, default is enabled.

Whether the depth test enabled.

var setDepthTest ( var  isDepthTest)

Set the depth test enable or disable, default is enabled.

Whether the depth test enabled.

local setDepthTest ( local  isDepthTest)

Set the depth test enable or disable, default is enabled.

Whether the depth test enabled.

void setDepthWrite ( bool  isDepthWrite)

Set the depth write enable or disable, default is disable.

Whether the depth write enabled.

var setDepthWrite ( var  isDepthWrite)

Set the depth write enable or disable, default is disable.

Whether the depth write enabled.

local setDepthWrite ( local  isDepthWrite)

Set the depth write enable or disable, default is disable.

Whether the depth write enabled.

void setBlendFunc ( const BlendFunc blendFunc)

Set the blend function.

The parameter of blend.

var setBlendFunc ( var  blendFunc)

Set the blend function.

The parameter of blend.

local setBlendFunc ( local  blendFunc)

Set the blend function.

The parameter of blend.

void copyAttributesTo ( Particle3DRender render)

Copy one renderer's attributes to another's(internal method).

the renderer which need be copied.

var copyAttributesTo ( var  render)

Copy one renderer's attributes to another's(internal method).

the renderer which need be copied.

local copyAttributesTo ( local  render)

Copy one renderer's attributes to another's(internal method).

the renderer which need be copied.


The documentation for this class was generated from the following file: