CCDrawPrimitives:
源码:
/**
@file
Drawing OpenGL ES primitives.OpenGL 图元绘制
- drawPoint, drawPoints,画点和点数组
- drawLine/// 画线
- drawRect, drawSolidRect/// 画矩形
- drawPoly, drawSolidPoly/// 画多变性
- drawCircle/// 画圆
- drawQuadBezier/// 画贝塞尔曲线
- drawCubicBezier
- drawCatmullRom
- drawCardinalSpline/// 画样条曲线
You can change the color, point size, width by calling:
- drawColor4B(), drawColor4F()
- ccPointSize()
- glLineWidth()
@warning These functions draws the Line, Vec2, Polygon, immediately. They aren't batched. If you are going to make a game that depends on these primitives, I suggest creating a batch. Instead you should use DrawNode
*/
NS_CC_BEGIN
/**
* @addtogroup _2d
* @{
*/
class PointArray;
/**
* @js cc.DrawingPrimitiveCanvas/cc.DrawingPrimitiveWebGL
*/
namespace DrawPrimitives
{
/**
* Initializes the drawing primitives.
* @js NA
*/
/// 初始化
CC_DEPRECATED_ATTRIBUTE void CC_DLL init();
/**
* Frees allocated resources by the drawing primitives.
* @js NA
*/
/// 释放绘制图元的时候申请的资源
CC_DEPRECATED_ATTRIBUTE void CC_DLL free();
/** Draws a point given x and y coordinate measured in points
*
* @param point A Vec2 with a point given x and y coordinate.
*/
/// 画点
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawPoint(const Vec2& point);
/** Draws an array of points.
*
* @param point A point coordinates.
* @param numberOfPoints The number of points.
* @since v0.7.2
*/
/// 画一组点
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawPoints(const Vec2 *points, unsigned int numberOfPoints);
/** Draws a line given the origin and destination point measured in points
*
* @param origin A Vec2 Type point used to the line origin.
* @param destination A Vec2 Type point used to the line destination.
*/
/// 画线
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawLine(const Vec2& origin, const Vec2& destination);
/** Draws a rectangle given the origin and destination point measured in points.
* The origin and the destination can not have the same x and y coordinate.
*
* @param origin The rectangle origin.
* @param destination The rectangle destination.
*/
/// 绘制矩形
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawRect(Vec2 origin, Vec2 destination);
/** Draws a solid rectangle given the origin and destination point measured in points.
* The origin and the destination can not have the same x and y coordinate.
*
* @param origin The rectangle origin.
* @param destination The rectangle destination.
* @param color The rectangle color.
* @since 1.1
*/
/// 绘制实心矩形
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawSolidRect(Vec2 origin, Vec2 destination, Color4F color);
/** Draws a polygon given a pointer to point coordinates and the number of vertices measured in points.
* The polygon can be closed or open.
*
* @param vertices A pointer to point coordinates.
* @param numOfVertices The number of vertices measured in points.
* @param closePolygon The polygon can be closed or open.
*/
/// 绘制多边形
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawPoly(const Vec2 *vertices, unsigned int numOfVertices, bool closePolygon);
/** Draws a solid polygon given a pointer to CGPoint coordinates, the number of vertices measured in points, and a color.
*
* @param poli A solid polygon given a pointer to CGPoint coordinates.
* @param numberOfPoints The number of vertices measured in points.
* @param color The solid polygon color.
*/
/// 绘制实心多边形
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawSolidPoly(const Vec2 *poli, unsigned int numberOfPoints, Color4F color);
/** Draws a circle given the center, radius and number of segments.
*
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param drawLineToCenter Whether or not draw the line from the origin to center.
* @param scaleX The scale value in x.
* @param scaleY The scale value in y.
*/
/// 绘制一个圆
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawCircle(const Vec2& center, float radius, float angle, unsigned int segments, bool drawLineToCenter, float scaleX, float scaleY);
/** Draws a circle given the center, radius and number of segments.
*
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param drawLineToCenter Whether or not draw the line from the origin to center.
*/
/// 绘制一个圆
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawCircle(const Vec2& center, float radius, float angle, unsigned int segments, bool drawLineToCenter);
/** Draws a solid circle given the center, radius and number of segments.
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param scaleX The scale value in x.
* @param scaleY The scale value in y.
* @js NA
*/
/// 绘制实心圆
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawSolidCircle(const Vec2& center, float radius, float angle, unsigned int segments, float scaleX, float scaleY);
/** Draws a solid circle given the center, radius and number of segments.
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @js NA
*/
/// 绘制实心圆
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawSolidCircle(const Vec2& center, float radius, float angle, unsigned int segments);
/** Draws a quad bezier path.
*
* @param origin The origin of the bezier path.
* @param control The control of the bezier path.
* @param destination The destination of the bezier path.
* @param segments The The number of segments.
* @warning This function could be pretty slow. Use it only for debugging purposes.
* @since v0.8
*/
/// 绘制贝塞尔曲线
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawQuadBezier(const Vec2& origin, const Vec2& control, const Vec2& destination, unsigned int segments);
/** Draws a cubic bezier path.
*
* @param origin The origin of the bezier path.
* @param control1 The first control of the bezier path.
* @param control2 The second control of the bezier path.
* @param destination The destination of the bezier path.
* @param segments The The number of segments.
* @warning This function could be pretty slow. Use it only for debugging purposes.
* @since v0.8
*/
/// 绘制贝塞尔曲线
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawCubicBezier(const Vec2& origin, const Vec2& control1, const Vec2& control2, const Vec2& destination, unsigned int segments);
/** Draws a Catmull Rom path.
*
* @param arrayOfControlPoints A point array of control point.
* @param segments The The number of segments.
* @warning This function could be pretty slow. Use it only for debugging purposes.
* @since v2.0
*/
/// 绘制一条抗锯齿的路径
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawCatmullRom(PointArray *arrayOfControlPoints, unsigned int segments);
/** Draws a Cardinal Spline path.
*
* @param config A array point.
* @param tension The tension of the spline.
* @param segments The The number of segments.
* @warning This function could be pretty slow. Use it only for debugging purposes.
* @since v2.0
*/
/// 绘制样条曲线
CC_DEPRECATED_ATTRIBUTE void CC_DLL drawCardinalSpline(PointArray *config, float tension, unsigned int segments);
/** Set the drawing color with 4 unsigned bytes.
*
* @param r The red color with a unsigned bytes.
* @param g The green color with a unsigned bytes.
* @param b The blue color with a unsigned bytes.
* @param a Alpha with a unsigned bytes.
* @since v2.0
* @js setDrawColor
*/
/// 设置绘制的颜色
CC_DEPRECATED_ATTRIBUTE void CC_DLL setDrawColor4B(GLubyte r, GLubyte g, GLubyte b, GLubyte a);
/** Set the drawing color with 4 floats.
*
* @param r The red color with an floats.
* @param g The green color with an floats.
* @param b The blue color with an floats.
* @param a Alpha with an floats.
* @since v2.0
* @js setDrawColor
*/
/// 设置绘制的颜色
CC_DEPRECATED_ATTRIBUTE void CC_DLL setDrawColor4F(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
/** Set the point size in points. Default 1.
*
* @param pointSize The point size with an float.
* @since v2.0
*/
/// 设置点的尺寸
CC_DEPRECATED_ATTRIBUTE void CC_DLL setPointSize(GLfloat pointSize);
};
CCDrawNode:
源码:
/** @class DrawNode
* @brief Node that draws dots, segments and polygons.
* Faster than the "drawing primitives" since they draws everything in one single batch.
* @since v2.1
*/
/// 绘制节点
class CC_DLL DrawNode : public Node
{
public:
/** creates and initialize a DrawNode node.
*
* @return Return an autorelease object.
*/
/// 创建一个绘制节点
static DrawNode* create();
/** Draw a point.
*
* @param point A Vec2 used to point.
* @param pointSize The point size.
* @param color The point color.
* @js NA
*/
/// 画一个点,传入点的位置,点的尺寸,点的颜色
void drawPoint(const Vec2& point, const float pointSize, const Color4F &color);
/** Draw a group point.
*
* @param position A Vec2 pointer.
* @param numberOfPoints The number of points.
* @param color The point color.
* @js NA
*/
/// 画一组点
/// 传入一个点的指针,点的数量,点的颜色
void drawPoints(const Vec2 *position, unsigned int numberOfPoints, const Color4F &color);
/** Draw a group point.
*
* @param position A Vec2 pointer.
* @param numberOfPoints The number of points.
* @param pointSize The point size.
* @param color The point color.
* @js NA
*/
/// 画一组点
/// 点的指针,点的数量,点的尺寸,点的颜色
void drawPoints(const Vec2 *position, unsigned int numberOfPoints, const float pointSize, const Color4F &color);
/** Draw an line from origin to destination with color.
*
* @param origin The line origin.
* @param destination The line destination.
* @param color The line color.
* @js NA
*/
/// 画一条线
/// 线的起始位置,线的颜色
void drawLine(const Vec2 &origin, const Vec2 &destination, const Color4F &color);
/** Draws a rectangle given the origin and destination point measured in points.
* The origin and the destination can not have the same x and y coordinate.
*
* @param origin The rectangle origin.
* @param destination The rectangle destination.
* @param color The rectangle color.
*/
/// 画一个矩形
/// 矩形的原点(左下),矩形的终点(右上),矩形的颜色
/// 绘制出的是空心矩形哦
void drawRect(const Vec2 &origin, const Vec2 &destination, const Color4F &color);
/** Draws a polygon given a pointer to point coordinates and the number of vertices measured in points.
* The polygon can be closed or open.
*
* @param poli A pointer to point coordinates.
* @param numberOfPoints The number of vertices measured in points.
* @param closePolygon The polygon can be closed or open.
* @param color The polygon color.
*/
/// 绘制一个多边形
/// 点的指针,点的数量,是否封闭多边形,线的颜色
void drawPoly(const Vec2 *poli, unsigned int numberOfPoints, bool closePolygon, const Color4F &color);
/** Draws a circle given the center, radius and number of segments.
*
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param drawLineToCenter Whether or not draw the line from the origin to center.
* @param scaleX The scale value in x.
* @param scaleY The scale value in y.
* @param color Set the circle color.
*/
/// 绘制一个圆
/// 圆心,半径,角度,分成几部分,是否与中心连线,x,y缩放系数,颜色
void drawCircle( const Vec2& center, float radius, float angle, unsigned int segments, bool drawLineToCenter, float scaleX, float scaleY, const Color4F &color);
/** Draws a circle given the center, radius and number of segments.
*
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param drawLineToCenter Whether or not draw the line from the origin to center.
* @param color Set the circle color.
*/
/// 绘制一个圆
/// 圆心,半径,角度,分成多少部分,颜色
void drawCircle(const Vec2 ¢er, float radius, float angle, unsigned int segments, bool drawLineToCenter, const Color4F &color);
/** Draws a quad bezier path.
*
* @param origin The origin of the bezier path.
* @param control The control of the bezier path.
* @param destination The destination of the bezier path.
* @param segments The The number of segments.
* @param color Set the quad bezier color.
*/
/// 绘制贝塞尔曲线
/// 原点,控制点,终点,分成多少部分,颜色
void drawQuadBezier(const Vec2 &origin, const Vec2 &control, const Vec2 &destination, unsigned int segments, const Color4F &color);
/** Draw a cubic bezier curve with color and number of segments
*
* @param origin The origin of the bezier path.
* @param control1 The first control of the bezier path.
* @param control2 The second control of the bezier path.
* @param destination The destination of the bezier path.
* @param segments The The number of segments.
* @param color Set the cubic bezier color.
*/
/// 画一个三次方的贝塞尔曲线
void drawCubicBezier(const Vec2 &origin, const Vec2 &control1, const Vec2 &control2, const Vec2 &destination, unsigned int segments, const Color4F &color);
/** Draws a Cardinal Spline path.
*
* @param config A array point.
* @param tension The tension of the spline.
* @param segments The The number of segments.
* @param color Set the Spline color.
*/
/// 绘制基数样条曲线路径
void drawCardinalSpline(PointArray *config, float tension, unsigned int segments, const Color4F &color);
/** Draws a Catmull Rom path.
*
* @param points A point array of control point.
* @param segments The The number of segments.
* @param color The Catmull Rom color.
*/
/// 按瑞丽抗锯齿模式绘制一个路径
void drawCatmullRom(PointArray *points, unsigned int segments, const Color4F &color);
/** draw a dot at a position, with a given radius and color.
*
* @param pos The dot center.
* @param radius The dot radius.
* @param color The dot color.
*/
/// 画一个小圆点
void drawDot(const Vec2 &pos, float radius, const Color4F &color);
/** Draws a rectangle with 4 points.
*
* @param p1 The rectangle vertex point.
* @param p2 The rectangle vertex point.
* @param p3 The rectangle vertex point.
* @param p4 The rectangle vertex point.
* @param color The rectangle color.
*/
/// 或一个矩形,传入四个顶点
void drawRect(const Vec2 &p1, const Vec2 &p2, const Vec2 &p3, const Vec2& p4, const Color4F &color);
/** Draws a solid rectangle given the origin and destination point measured in points.
* The origin and the destination can not have the same x and y coordinate.
*
* @param origin The rectangle origin.
* @param destination The rectangle destination.
* @param color The rectangle color.
* @js NA
*/
/// 画一个实心矩形
void drawSolidRect(const Vec2 &origin, const Vec2 &destination, const Color4F &color);
/** Draws a solid polygon given a pointer to CGPoint coordinates, the number of vertices measured in points, and a color.
*
* @param poli A solid polygon given a pointer to CGPoint coordinates.
* @param numberOfPoints The number of vertices measured in points.
* @param color The solid polygon color.
* @js NA
*/
/// 绘制一个实心的多边形
void drawSolidPoly(const Vec2 *poli, unsigned int numberOfPoints, const Color4F &color);
/** Draws a solid circle given the center, radius and number of segments.
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param scaleX The scale value in x.
* @param scaleY The scale value in y.
* @param color The solid circle color.
* @js NA
*/
/// 绘制一个实心的圆
void drawSolidCircle(const Vec2& center, float radius, float angle, unsigned int segments, float scaleX, float scaleY, const Color4F &color);
/** Draws a solid circle given the center, radius and number of segments.
* @param center The circle center point.
* @param radius The circle rotate of radius.
* @param angle The circle angel.
* @param segments The number of segments.
* @param color The solid circle color.
* @js NA
*/
/// 绘制一个实心的圆
void drawSolidCircle(const Vec2& center, float radius, float angle, unsigned int segments, const Color4F& color);
/** draw a segment with a radius and color.
*
* @param from The segment origin.
* @param to The segment destination.
* @param radius The segment radius.
* @param color The segment color.
*/
/// 绘制一个圆环
void drawSegment(const Vec2 &from, const Vec2 &to, float radius, const Color4F &color);
/** draw a polygon with a fill color and line color
* @code
* When this function bound into js or lua,the parameter will be changed
* In js: var drawPolygon(var Arrayofpoints, var fillColor, var width, var borderColor)
* In lua:local drawPolygon(local pointTable,local tableCount,local fillColor,local width,local borderColor)
* @endcode
* @param verts A pointer to point coordinates.
* @param count The number of verts measured in points.
* @param fillColor The color will fill in polygon.
* @param borderWidth The border of line width.
* @param borderColor The border of line color.
* @js NA
*/
/// 绘制多边形
void drawPolygon(const Vec2 *verts, int count, const Color4F &fillColor, float borderWidth, const Color4F &borderColor);
/** draw a triangle with color.
*
* @param p1 The triangle vertex point.
* @param p2 The triangle vertex point.
* @param p3 The triangle vertex point.
* @param color The triangle color.
* @js NA
*/
/// 绘制一个三角形
void drawTriangle(const Vec2 &p1, const Vec2 &p2, const Vec2 &p3, const Color4F &color);
/** draw a quadratic bezier curve with color and number of segments, use drawQuadBezier instead.
*
* @param from The origin of the bezier path.
* @param control The control of the bezier path.
* @param to The destination of the bezier path.
* @param segments The The number of segments.
* @param color The quadratic bezier color.
* @js NA
*/
CC_DEPRECATED_ATTRIBUTE void drawQuadraticBezier(const Vec2& from, const Vec2& control, const Vec2& to, unsigned int segments, const Color4F &color);
/** Clear the geometry in the node's buffer. */
/// 从节点的缓存中清除几何数据
void clear();
/** Get the color mixed mode.
* @lua NA
*/
/// 得到混合函数
const BlendFunc& getBlendFunc() const;
/** Set the color mixed mode.
* @code
* When this function bound into js or lua,the parameter will be changed
* In js: var setBlendFunc(var src, var dst)
* @endcode
* @lua NA
*/
/// 设置混合函数
void setBlendFunc(const BlendFunc &blendFunc);
/**
* @js NA
*/
/// 绘制
void onDraw(const Mat4 &transform, uint32_t flags);
/**
* @js NA
*/
/// 画线
void onDrawGLLine(const Mat4 &transform, uint32_t flags);
/**
* @js NA
*/
/// 绘制GL点
void onDrawGLPoint(const Mat4 &transform, uint32_t flags);
// Overrides
virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
CC_CONSTRUCTOR_ACCESS:
DrawNode();
virtual ~DrawNode();
virtual bool init() override;
protected:
void ensureCapacity(int count);
void ensureCapacityGLPoint(int count);
void ensureCapacityGLLine(int count);
GLuint _vao;
GLuint _vbo;
GLuint _vaoGLPoint;
GLuint _vboGLPoint;
GLuint _vaoGLLine;
GLuint _vboGLLine;
int _bufferCapacity;
GLsizei _bufferCount;
V2F_C4B_T2F *_buffer;
int _bufferCapacityGLPoint;
GLsizei _bufferCountGLPoint;
V2F_C4B_T2F *_bufferGLPoint;
Color4F _pointColor;
int _pointSize;
int _bufferCapacityGLLine;
GLsizei _bufferCountGLLine;
V2F_C4B_T2F *_bufferGLLine;
BlendFunc _blendFunc;
CustomCommand _customCommand;
CustomCommand _customCommandGLPoint;
CustomCommand _customCommandGLLine;
bool _dirty;
bool _dirtyGLPoint;
bool _dirtyGLLine;
private:
CC_DISALLOW_COPY_AND_ASSIGN(DrawNode);
};
/** @} */