DrawNode3D类 参考

#include <DrawNode3D.h>

类 DrawNode3D 继承关系图:

DrawNode3D 的协作图:

类
struct	V3F_C4B

Public 成员函数
void	drawLine (const cocos2d::Vec3 &from, const cocos2d::Vec3 &to, const Color4F &color)
void	drawCube (cocos2d::Vec3 *vertices, const Color4F &color)
void	clear ()
const BlendFunc &	getBlendFunc () const
void	setBlendFunc (const BlendFunc &blendFunc)
void	updateCommand (cocos2d::Renderer *renderer, const cocos2d::Mat4 &transform, uint32_t flags)
virtual void	draw (cocos2d::Renderer *renderer, const cocos2d::Mat4 &transform, uint32_t flags) override
virtual	~DrawNode3D ()
virtual bool	init () override

静态 Public 成员函数
static cocos2d::DrawNode3D *	create ()

Public 属性
CC_CONSTRUCTOR_ACCESS	__pad0__: DrawNode3D()

Protected 成员函数
void	onBeforeDraw ()
void	onAfterDraw ()
void	ensureCapacity (int count)

Protected 属性
BlendFunc	_blendFunc
cocos2d::CustomCommand	_customCommand
backend::ProgramState *	_programStateLine = nullptr
backend::DepthStencilDescriptor *	_depthstencilDescriptor = nullptr
backend::UniformLocation	_locMVPMatrix
std::vector< V3F_C4B >	_bufferLines

Private 成员函数
	CC_DISALLOW_COPY_AND_ASSIGN (DrawNode3D)

Private 属性
bool	_isDirty = true
bool	_rendererDepthTestEnabled = true

详细描述

Copy DrawNode for 3D geometry drawing.

在文件 DrawNode3D.h 第 36 行定义.

构造及析构函数说明

~DrawNode3D()

DrawNode3D::~DrawNode3D ( )

virtual

在文件 DrawNode3D.cpp 第 36 行定义.

{
    CC_SAFE_RELEASE_NULL(_programStateLine);
    CC_SAFE_DELETE(_depthstencilDescriptor);
}

引用了 _depthstencilDescriptor , 以及 _programStateLine.

成员函数说明

CC_DISALLOW_COPY_AND_ASSIGN()

DrawNode3D::CC_DISALLOW_COPY_AND_ASSIGN ( DrawNode3D  )

private

clear()

void DrawNode3D::clear

(

)

Clear the geometry in the node's buffer.

在文件 DrawNode3D.cpp 第 193 行定义.

{
    _bufferLines.clear();
    _isDirty = true;
}

引用了 _bufferLines , 以及 _isDirty.

create()

DrawNode3D * DrawNode3D::create ( )

static

creates and initialize a DrawNode3D node

在文件 DrawNode3D.cpp 第 42 行定义.

{
    DrawNode3D* ret = new (std::nothrow) DrawNode3D();
    if (ret && ret->init())
    {
        ret->autorelease();
    }
    else
    {
        CC_SAFE_DELETE(ret);
    }
    
    return ret;
}

引用了 init().

被这些函数引用 Sprite3DWithOBBPerformanceTest::addNewSpriteWithCoords(), Sprite3DWithOBBPerformanceTest::initDrawBox(), Camera3DTestDemo::onEnter(), CameraCullingDemo::onEnter() , 以及 CameraArcBallDemo::onEnter().

函数调用图:

这是这个函数的调用关系图:

draw()

void DrawNode3D::draw ( cocos2d::Renderer *  renderer, const cocos2d::Mat4 &  transform, uint32_t  flags  )

overridevirtual

在文件 DrawNode3D.cpp 第 122 行定义.

{
    _customCommand.init(_globalZOrder, transform, flags);
 
    updateCommand(renderer, transform, flags);
 
    if (_isDirty && !_bufferLines.empty())
    {
        _customCommand.updateVertexBuffer(_bufferLines.data(), (unsigned int)(_bufferLines.size() * sizeof(_bufferLines[0])));
        _customCommand.setVertexDrawInfo(0, _bufferLines.size());
        _isDirty = false;
    }
 
    if (!_bufferLines.empty())
    {
        renderer->addCommand(&_customCommand);
    }
}

引用了 _bufferLines, _customCommand, _isDirty , 以及 updateCommand().

函数调用图:

drawCube()

void DrawNode3D::drawCube	(	cocos2d::Vec3 *	vertices,
		const Color4F &	color
	)

Draw 3D cube

参数

point	to a vertex array who has 8 element. vertices[0]:Left-top-front, vertices[1]:Left-bottom-front, vertices[2]:Right-bottom-front, vertices[3]:Right-top-front, vertices[4]:Right-top-back, vertices[5]:Right-bottom-back, vertices[6]:Left-bottom-back, vertices[7]:Left-top-back.
color

在文件 DrawNode3D.cpp 第 172 行定义.

{
    // front face
    drawLine(vertices[0], vertices[1], color);
    drawLine(vertices[1], vertices[2], color);
    drawLine(vertices[2], vertices[3], color);
    drawLine(vertices[3], vertices[0], color);
    
    // back face
    drawLine(vertices[4], vertices[5], color);
    drawLine(vertices[5], vertices[6], color);
    drawLine(vertices[6], vertices[7], color);
    drawLine(vertices[7], vertices[4], color);
    
    // edge
    drawLine(vertices[0], vertices[7], color);
    drawLine(vertices[1], vertices[6], color);
    drawLine(vertices[2], vertices[5], color);
    drawLine(vertices[3], vertices[4], color);
}

引用了 drawLine().

函数调用图:

drawLine()

void DrawNode3D::drawLine	(	const cocos2d::Vec3 &	from,
		const cocos2d::Vec3 &	to,
		const Color4F &	color
	)

Draw 3D Line

在文件 DrawNode3D.cpp 第 157 行定义.

{
    unsigned int vertex_count = 2;
    ensureCapacity(vertex_count);
    
    Color4B col = Color4B(color);
    V3F_C4B a = {Vec3(from.x, from.y, from.z), col};
    V3F_C4B b = {Vec3(to.x, to.y, to.z), col, };
 
    _bufferLines.push_back(a);
    _bufferLines.push_back(b);
    
    _isDirty = true;
}

引用了 _bufferLines, _isDirty , 以及 ensureCapacity().

被这些函数引用 drawCube() , 以及 Camera3DTestDemo::onEnter().

函数调用图:

这是这个函数的调用关系图:

ensureCapacity()

void DrawNode3D::ensureCapacity ( int  count )

protected

在文件 DrawNode3D.cpp 第 57 行定义.

{
    CCASSERT(count>=0, "capacity must be >= 0");
    
    auto EXTENDED_SIZE = _bufferLines.size() + count;
 
    _bufferLines.reserve(EXTENDED_SIZE);
 
    if (!_customCommand.getVertexBuffer() || _customCommand.getVertexBuffer()->getSize() < (EXTENDED_SIZE * sizeof(_bufferLines[0])))
    {
        _customCommand.createVertexBuffer(sizeof(V3F_C4B), EXTENDED_SIZE + (EXTENDED_SIZE >> 1), CustomCommand::BufferUsage::DYNAMIC);
    }
 
}

引用了 _bufferLines , 以及 _customCommand.

被这些函数引用 drawLine() , 以及 init().

这是这个函数的调用关系图:

getBlendFunc()

const BlendFunc & DrawNode3D::getBlendFunc

(

)

const

@js NA @lua NA

在文件 DrawNode3D.cpp 第 199 行定义.

{
    return _blendFunc;
}

引用了 _blendFunc.

init()

bool DrawNode3D::init ( )

overridevirtual

在文件 DrawNode3D.cpp 第 72 行定义.

{
    _blendFunc = BlendFunc::ALPHA_PREMULTIPLIED;
    auto &pd = _customCommand.getPipelineDescriptor();
    auto program = backend::Program::getBuiltinProgram(backend::ProgramType::LINE_COLOR_3D);
    _programStateLine = new backend::ProgramState(program);
    pd.programState = _programStateLine;
    
    _locMVPMatrix = _programStateLine->getUniformLocation("u_MVPMatrix");
 
    _customCommand.setBeforeCallback(CC_CALLBACK_0(DrawNode3D::onBeforeDraw, this));
    _customCommand.setAfterCallback(CC_CALLBACK_0(DrawNode3D::onAfterDraw, this));
 
    auto layout = _programStateLine->getVertexLayout();
#define INITIAL_VERTEX_BUFFER_LENGTH 512
 
    ensureCapacity(INITIAL_VERTEX_BUFFER_LENGTH);
 
    _customCommand.setDrawType(CustomCommand::DrawType::ARRAY);
    _customCommand.setPrimitiveType(CustomCommand::PrimitiveType::LINE);
 
    const auto& attributeInfo = _programStateLine->getProgram()->getActiveAttributes();
    auto iter = attributeInfo.find("a_position");
    if(iter != attributeInfo.end())
    {
        layout->setAttribute("a_position", iter->second.location, backend::VertexFormat::FLOAT3, 0, false);
    }
    iter = attributeInfo.find("a_color");
    if(iter != attributeInfo.end())
    {
        layout->setAttribute("a_color", iter->second.location, backend::VertexFormat::UBYTE4, sizeof(Vec3), true);
    }
    layout->setLayout(sizeof(V3F_C4B));
    
    _customCommand.createVertexBuffer(sizeof(V3F_C4B), INITIAL_VERTEX_BUFFER_LENGTH, CustomCommand::BufferUsage::DYNAMIC);
    _isDirty = true;
 
#if CC_ENABLE_CACHE_TEXTURE_DATA
    // Need to listen the event only when not use batchnode, because it will use VBO
    auto listener = EventListenerCustom::create(EVENT_COME_TO_FOREGROUND, [this](EventCustom* event){
        this->init();
    });
 
    _eventDispatcher->addEventListenerWithSceneGraphPriority(listener, this);
#endif
    
    return true;
}

引用了 _blendFunc, _customCommand, _isDirty, _locMVPMatrix, _programStateLine, ensureCapacity(), init(), INITIAL_VERTEX_BUFFER_LENGTH, onAfterDraw() , 以及 onBeforeDraw().

被这些函数引用 create() , 以及 init().

函数调用图:

这是这个函数的调用关系图:

onAfterDraw()

void DrawNode3D::onAfterDraw ( )

protected

在文件 DrawNode3D.cpp 第 217 行定义.

{
    auto *renderer = Director::getInstance()->getRenderer();
    renderer->setDepthTest(_rendererDepthTestEnabled);
}

引用了 _rendererDepthTestEnabled.

被这些函数引用 init().

这是这个函数的调用关系图:

onBeforeDraw()

void DrawNode3D::onBeforeDraw ( )

protected

在文件 DrawNode3D.cpp 第 210 行定义.

{
    auto *renderer = Director::getInstance()->getRenderer();
    _rendererDepthTestEnabled = renderer->getDepthTest();
    renderer->setDepthTest(true);
}

引用了 _rendererDepthTestEnabled.

被这些函数引用 init().

这是这个函数的调用关系图:

setBlendFunc()

void DrawNode3D::setBlendFunc

(

const BlendFunc &

blendFunc

)

When this function bound into js or lua,the parameter will be changed
In js: var setBlendFunc(var src, var dst)

@lua NA

在文件 DrawNode3D.cpp 第 204 行定义.

{
    _blendFunc = blendFunc;
}

引用了 _blendFunc.

updateCommand()

void DrawNode3D::updateCommand	(	cocos2d::Renderer *	renderer,
		const cocos2d::Mat4 &	transform,
		uint32_t	flags
	)

在文件 DrawNode3D.cpp 第 141 行定义.

{
    auto &matrixP = Director::getInstance()->getMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION);
    auto mvp = matrixP * transform;
 
    _programStateLine->setUniform(_locMVPMatrix, mvp.m, sizeof(mvp.m));
 
 
    auto &blend = _customCommand.getPipelineDescriptor().blendDescriptor;
    blend.blendEnabled = true;
    blend.sourceRGBBlendFactor = blend.sourceAlphaBlendFactor = _blendFunc.src;
    blend.destinationRGBBlendFactor = blend.destinationAlphaBlendFactor = _blendFunc.dst;
 
    CC_INCREMENT_GL_DRAWN_BATCHES_AND_VERTICES(1, _bufferLines.size());
}

引用了 _blendFunc, _bufferLines, _customCommand, _locMVPMatrix , 以及 _programStateLine.

被这些函数引用 draw().

这是这个函数的调用关系图:

类成员变量说明

__pad0__

CC_CONSTRUCTOR_ACCESS DrawNode3D::__pad0__

在文件 DrawNode3D.h 第 85 行定义.

_blendFunc

BlendFunc DrawNode3D::_blendFunc

protected

在文件 DrawNode3D.h 第 103 行定义.

被这些函数引用 getBlendFunc(), init(), setBlendFunc() , 以及 updateCommand().

_bufferLines

std::vector<V3F_C4B> DrawNode3D::_bufferLines

protected

在文件 DrawNode3D.h 第 108 行定义.

被这些函数引用 clear(), draw(), drawLine(), ensureCapacity() , 以及 updateCommand().

_customCommand

cocos2d::CustomCommand DrawNode3D::_customCommand

protected

在文件 DrawNode3D.h 第 104 行定义.

被这些函数引用 draw(), ensureCapacity(), init() , 以及 updateCommand().

_depthstencilDescriptor

backend::DepthStencilDescriptor* DrawNode3D::_depthstencilDescriptor = nullptr

protected

在文件 DrawNode3D.h 第 106 行定义.

被这些函数引用 ~DrawNode3D().

_isDirty

bool DrawNode3D::_isDirty = true

private

在文件 DrawNode3D.h 第 114 行定义.

被这些函数引用 clear(), draw(), drawLine() , 以及 init().

_locMVPMatrix

backend::UniformLocation DrawNode3D::_locMVPMatrix

protected

在文件 DrawNode3D.h 第 107 行定义.

被这些函数引用 init() , 以及 updateCommand().

_programStateLine

backend::ProgramState* DrawNode3D::_programStateLine = nullptr

protected

在文件 DrawNode3D.h 第 105 行定义.

被这些函数引用 init(), updateCommand() , 以及 ~DrawNode3D().

_rendererDepthTestEnabled

bool DrawNode3D::_rendererDepthTestEnabled = true

private

在文件 DrawNode3D.h 第 115 行定义.

被这些函数引用 onAfterDraw() , 以及 onBeforeDraw().

---

该类的文档由以下文件生成:

• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/Sprite3DTest/DrawNode3D.h
• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/Sprite3DTest/DrawNode3D.cpp