RenderableObject类 参考

#include <renderable_object.h>

类 RenderableObject 继承关系图:

RenderableObject 的协作图:

Public 成员函数
	RenderableObject (int vertex_count=1, int vertex_element_count=3, const std::shared_ptr< QOpenGLShaderProgram > &shaderProgram=NullRenderableObj)
virtual	~RenderableObject (void)
virtual GLenum	GetPrimitiveType (void) const =0
virtual void	SetupExtraUniforms (void)
bool	is_renderable (void) const
void	set_is_renderable (bool b)
int	vertex_count (void) const
void	set_vertex_count (int vertexCount)
int	vertex_element_count (void) const
void	set_vertex_element_count (int vertexElementCount)
int	VertexBufferSize (void) const
void	set_shader_program (const std::shared_ptr< QOpenGLShaderProgram > &shaderProgram)
bool	haveShaderProgram (void)
bool	Init (std::shared_ptr< QOpenGLShaderProgram > &shaderProgram=NullRenderableObj)
void	Destroy (void)
void	Render (const QMatrix4x4 *mvp=nullptr)

静态 Public 成员函数
static std::shared_ptr< QOpenGLShaderProgram >	CreateShaderProgram (const QString &vertexShaderFileName, const QString &fragShaderFileName)

静态 Public 属性
static std::shared_ptr< QOpenGLShaderProgram >	NullRenderableObj

Protected 成员函数
virtual bool	FillVertexBuffer (GLfloat *pBuffer)=0
virtual void	Draw (void)
virtual void	SetupAllAttrPointer (void)

Protected 属性
bool	is_init_
bool	is_renderable_
int	vertex_count_
int	vertex_element_count_
std::shared_ptr< QOpenGLShaderProgram >	shader_program_
QOpenGLVertexArrayObject	vao_
QOpenGLBuffer	vbo_

详细描述

在文件 renderable_object.h 第 25 行定义.

构造及析构函数说明

RenderableObject()

RenderableObject::RenderableObject ( int  vertex_count = 1, int  vertex_element_count = 3, const std::shared_ptr< QOpenGLShaderProgram > &  shaderProgram = NullRenderableObj  )

explicit

在文件 renderable_object.cc 第 41 行定义.

    : QOpenGLFunctions(),
      is_init_(false),
      is_renderable_(true),
      vertex_count_(vertexCount),
      vertex_element_count_(vertexElementCount),
      shader_program_(shaderProgram),
      vao_(),
      vbo_(QOpenGLBuffer::VertexBuffer) {}

~RenderableObject()

RenderableObject::~RenderableObject ( void  )

virtual

在文件 renderable_object.cc 第 53 行定义.

{ Destroy(); }

成员函数说明

CreateShaderProgram()

std::shared_ptr< QOpenGLShaderProgram > RenderableObject::CreateShaderProgram ( const QString &  vertexShaderFileName, const QString &  fragShaderFileName  )

static

在文件 renderable_object.cc 第 23 行定义.

                                                                            {
  std::shared_ptr<QOpenGLShaderProgram> shaderProg(new QOpenGLShaderProgram());
  if (shaderProg != nullptr) {
    shaderProg->addShaderFromSourceFile(QOpenGLShader::Vertex,
                                        vertexShaderFileName);
    shaderProg->addShaderFromSourceFile(QOpenGLShader::Fragment,
                                        fragShaderFileName);
    if (!shaderProg->link()) {
      std::cerr << "----cannot link shader programm, log:("
                << shaderProg->log().toStdString() << ")\n";
 
      shaderProg.reset();
    }
  }
  return shaderProg;
}

Destroy()

void RenderableObject::Destroy

(

void

)

在文件 renderable_object.cc 第 55 行定义.

                                   {
  if (is_init_) {
    is_renderable_ = false;
    is_init_ = false;
    shader_program_.reset();
    vbo_.destroy();
    vao_.destroy();
  }
}

Draw()

virtual void RenderableObject::Draw ( void  )

inlineprotectedvirtual

被 Plane 重载.

在文件 renderable_object.h 第 71 行定义.

                          {
    glDrawArrays(GetPrimitiveType(), 0, vertex_count());
  }

FillVertexBuffer()

virtual bool RenderableObject::FillVertexBuffer ( GLfloat *  pBuffer )

protectedpure virtual

在 Grid, Plane , 以及 RadarPoints 内被实现.

GetPrimitiveType()

virtual GLenum RenderableObject::GetPrimitiveType ( void  ) const

pure virtual

在 Grid, PointCloud, RadarPoints , 以及 Plane 内被实现.

haveShaderProgram()

bool RenderableObject::haveShaderProgram ( void  )

inline

在文件 renderable_object.h 第 60 行定义.

{ return shader_program_ != nullptr; }

Init()

bool RenderableObject::Init

(

std::shared_ptr< QOpenGLShaderProgram > &

shaderProgram = NullRenderableObj

)

在文件 renderable_object.cc 第 65 行定义.

                                                        {
  if (is_init_) {
    return true;
  }
 
  if (vertex_count() < 1) {
    return false;
  }
  if (vertex_element_count() < 1) {
    return false;
  }
 
  if (shaderProgram != nullptr) {
    shader_program_ = shaderProgram;
  }
 
  if (shader_program_ == nullptr) {
    return false;
  }
 
  initializeOpenGLFunctions();
 
  if (!vao_.create()) {
    return false;
  }
  vao_.bind();
 
  if (!vbo_.create()) {
    vao_.destroy();
    return false;
  }
  vbo_.setUsagePattern(QOpenGLBuffer::StaticDraw);
  vbo_.bind();
 
  vbo_.allocate(VertexBufferSize());
  GLfloat* pBuffer = static_cast<GLfloat*>(vbo_.map(QOpenGLBuffer::WriteOnly));
  bool ret = FillVertexBuffer(pBuffer);
  vbo_.unmap();
 
  if (!ret) {
    return ret;
  }
 
  SetupAllAttrPointer();
 
  vbo_.release();
  vao_.release();
  is_init_ = true;
 
  return true;
}

is_renderable()

bool RenderableObject::is_renderable ( void  ) const

inline

在文件 renderable_object.h 第 39 行定义.

{ return is_renderable_; }

Render()

void RenderableObject::Render

(

const QMatrix4x4 *

mvp = nullptr

)

在文件 renderable_object.cc 第 118 行定义.

                                                   {
  if (is_init_) {
    if (is_renderable()) {
      shader_program_->bind();
      if (mvp) {
        shader_program_->setUniformValue("mvp", *mvp);
      }
      SetupExtraUniforms();
      vao_.bind();
      Draw();
      vao_.release();
      shader_program_->release();
    }
  } else {
    std::cerr << "Please initialize the object" << std::endl;
  }
}

set_is_renderable()

void RenderableObject::set_is_renderable ( bool  b )

inline

在文件 renderable_object.h 第 40 行定义.

{ is_renderable_ = b; }

set_shader_program()

void RenderableObject::set_shader_program ( const std::shared_ptr< QOpenGLShaderProgram > &  shaderProgram )

inline

在文件 renderable_object.h 第 55 行定义.

                                                                {
    shader_program_ = shaderProgram;
  }

set_vertex_count()

void RenderableObject::set_vertex_count ( int  vertexCount )

inline

在文件 renderable_object.h 第 43 行定义.

{ vertex_count_ = vertexCount; }

set_vertex_element_count()

void RenderableObject::set_vertex_element_count ( int  vertexElementCount )

inline

在文件 renderable_object.h 第 46 行定义.

                                                        {
    vertex_element_count_ = vertexElementCount;
  }

SetupAllAttrPointer()

virtual void RenderableObject::SetupAllAttrPointer ( void  )

inlineprotectedvirtual

被 Plane 重载.

在文件 renderable_object.h 第 75 行定义.

                                         {
    glEnableVertexAttribArray(0);
    glVertexAttribPointer(
        0, vertex_element_count(), GL_FLOAT, GL_FALSE,
        static_cast<int>(sizeof(GLfloat)) * vertex_element_count(), 0);
  }

SetupExtraUniforms()

virtual void RenderableObject::SetupExtraUniforms ( void  )

inlinevirtual

被 Grid , 以及 RadarPoints 重载.

在文件 renderable_object.h 第 37 行定义.

{}

vertex_count()

int RenderableObject::vertex_count ( void  ) const

inline

在文件 renderable_object.h 第 42 行定义.

{ return vertex_count_; }

vertex_element_count()

int RenderableObject::vertex_element_count ( void  ) const

inline

在文件 renderable_object.h 第 45 行定义.

{ return vertex_element_count_; }

VertexBufferSize()

int RenderableObject::VertexBufferSize ( void  ) const

inline

在文件 renderable_object.h 第 50 行定义.

                                   {
    return vertex_count() * vertex_element_count() *
           static_cast<int>(sizeof(GLfloat));
  }

类成员变量说明

is_init_

bool RenderableObject::is_init_

protected

在文件 renderable_object.h 第 82 行定义.

is_renderable_

bool RenderableObject::is_renderable_

protected

在文件 renderable_object.h 第 83 行定义.

NullRenderableObj

std::shared_ptr< QOpenGLShaderProgram > RenderableObject::NullRenderableObj

static

在文件 renderable_object.h 第 27 行定义.

shader_program_

std::shared_ptr<QOpenGLShaderProgram> RenderableObject::shader_program_

protected

在文件 renderable_object.h 第 88 行定义.

vao_

QOpenGLVertexArrayObject RenderableObject::vao_

protected

在文件 renderable_object.h 第 89 行定义.

vbo_

QOpenGLBuffer RenderableObject::vbo_

protected

在文件 renderable_object.h 第 90 行定义.

vertex_count_

int RenderableObject::vertex_count_

protected

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

vertex_element_count_

int RenderableObject::vertex_element_count_

protected

在文件 renderable_object.h 第 86 行定义.

---

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

• modules/tools/visualizer/renderable_object.h
• modules/tools/visualizer/renderable_object.cc