Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Graphics

Graphics component.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

Protected _assembler

_assembler: IAssembler | null = null

Protected _color

_color: Color = Color.WHITE.clone()

Protected _delegateSrc

_delegateSrc: Node | null = null

Protected _dstBlendFactor

_dstBlendFactor: GFXBlendFactor = GFXBlendFactor.ONE_MINUS_SRC_ALPHA

Private _enabled

_enabled: boolean = true

Protected _fillColor

_fillColor: Color = Color.WHITE.clone()

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _instanceMaterialType

_instanceMaterialType: InstanceMaterialType = InstanceMaterialType.ADD_COLOR_AND_TEXTURE

Protected _lastParent

_lastParent: Node | null = null

Protected _lineCap

_lineCap: LineCap = LineCap.BUTT

Protected _lineJoin

_lineJoin: LineJoin = LineJoin.MITER

Protected _lineWidth

_lineWidth: number = 1

Protected _materialInstances

_materialInstances: (null | MaterialInstance)[] = []

Protected _materials

_materials: (null | Material)[] = []

Protected _miterLimit

_miterLimit: number = 10

Protected _models

_models: Model[] = []

Protected _name

_name: string

_objFlags

_objFlags: number

Protected _postAssembler

_postAssembler: IAssembler | null = null

Protected _renderData

_renderData: RenderData | null = null

Protected _renderDataFlag

_renderDataFlag: boolean = true

Protected _renderFlag

_renderFlag: boolean = true

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

Protected _srcBlendFactor

_srcBlendFactor: GFXBlendFactor = GFXBlendFactor.SRC_ALPHA

Protected _strokeColor

_strokeColor: Color = Color.BLACK.clone()

Protected _uiMatInsDirty

_uiMatInsDirty: boolean = false

Protected _uiMaterial

_uiMaterial: Material | null = null

Protected _uiMaterialDirty

_uiMaterialDirty: boolean = false

Protected _uiMaterialIns

_uiMaterialIns: MaterialInstance | null = null

Protected _visFlags

_visFlags: number = Layers.Enum.NONE

impl

impl: Impl | null = null

model

model: Model | null = null

node

node: Node = NullNode

The node this component is attached to. A component is always attached to a node.

example
import { log } from 'cc';
log(comp.node);

Static Assembler

Assembler: IAssemblerManager | null = null

The render data assembler

Static BlendState

BlendState: GFXBlendFactor = GFXBlendFactor

The blend factor enums

see

GFXBlendFactor

Static LineCap

LineCap: LineCap = LineCap

Static LineJoin

LineJoin: LineJoin = LineJoin

Static PostAssembler

PostAssembler: IAssemblerManager | null = null

The post render data assembler

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

color

  • get color(): Color
  • set color(value: Color): void

delegateSrc

  • set delegateSrc(value: Node): void

dstBlendFactor

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

fillColor

  • get fillColor(): Readonly<Color>
  • set fillColor(value: {}): void

isValid

  • get isValid(): boolean
  • Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
    When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
    const node = new Node();
    log(node.isValid);    // true
    node.destroy();
    log(node.isValid);    // true, still valid in this frame
    // after a frame...
    log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

lineCap

  • get lineCap(): LineCap
  • set lineCap(value: LineCap): void

lineJoin

  • get lineJoin(): LineJoin
  • set lineJoin(value: LineJoin): void
  • Determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together.

    Returns LineJoin

  • Determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together.

    Parameters

    • value: LineJoin

    Returns void

lineWidth

  • get lineWidth(): number
  • set lineWidth(value: number): void

material

materials

miterLimit

  • get miterLimit(): number
  • set miterLimit(value: number): void

name

  • get name(): string
  • set name(value: string): void

renderData

  • get renderData(): null | RenderData

sharedMaterial

sharedMaterials

  • get sharedMaterials(): (null | Material)[]
  • set sharedMaterials(val: (null | Material)[]): void

srcBlendFactor

strokeColor

  • get strokeColor(): Readonly<Color>
  • set strokeColor(value: {}): void

uiMaterial

uuid

  • get uuid(): string

visibility

  • get visibility(): number
  • set visibility(val: number): void

Methods

preload

  • __preload(): void

Protected attachToScene

  • _attachToScene(): void

Protected canRender

  • _canRender(): boolean

Protected checkAndUpdateRenderData

  • _checkAndUpdateRenderData(): void

Protected clearMaterials

  • _clearMaterials(): void

collectModels

  • _collectModels(): Model[]

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected detachFromScene

  • _detachFromScene(): void

Protected flushAssembler

  • _flushAssembler(): void

Optional Private getLocalBounds

  • getLocalBounds(out_rect: Rect): void
  • If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

Protected nodeStateChange

Protected onMaterialModified

  • onMaterialModified(index: number, material: Material | null): void

onPreDestroy

  • _onPreDestroy(): void

Protected onRebuildPSO

  • onRebuildPSO(index: number, material: Material | null): void

Protected onVisibilityChange

  • onVisibilityChange(val: any): void

Protected postCanRender

  • _postCanRender(): void

Protected postRender

  • postRender(render: UI): void

Protected render

  • render(render: UI): void

updateBlendFunc

updateBuiltinMaterial

Protected updateColor

  • _updateColor(): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

arc

  • arc(cx: number, cy: number, r: number, startAngle: number, endAngle: number, counterclockwise: boolean): void
  • Adds an arc to the path which is centered at (cx, cy) position with radius r starting at startAngle and ending at endAngle going in the given direction by counterclockwise (defaulting to false).

    Parameters

    • cx: number

      中心控制点的坐标 x 轴。

    • cy: number

      中心控制点的坐标 y 轴。

    • r: number

      圆弧弧度。

    • startAngle: number

      开始弧度,从正 x 轴顺时针方向测量。

    • endAngle: number

      结束弧度,从正 x 轴顺时针方向测量。

    • counterclockwise: boolean

      如果为真,在两个角度之间逆时针绘制。默认顺时针。

    Returns void

bezierCurveTo

  • bezierCurveTo(c1x: number, c1y: number, c2x: number, c2y: number, x: number, y: number): void
  • Adds a cubic Bézier curve to the path.

    Parameters

    • c1x: number

      第一个控制点的坐标 x 轴。

    • c1y: number

      第一个控制点的坐标 y 轴。

    • c2x: number

      第二个控制点的坐标 x 轴。

    • c2y: number

      第二个控制点的坐标 y 轴。

    • x: number

      最后一个控制点的坐标 x 轴。

    • y: number

      最后一个控制点的坐标 y 轴。

    Returns void

circle

  • circle(cx: number, cy: number, r: number): void
  • Adds a circle to the path.

    Parameters

    • cx: number

      中心点的坐标 x 轴。

    • cy: number

      中心点的坐标 y 轴。

    • r: number

      圆半径。

    Returns void

clear

  • clear(clean?: boolean): void

close

  • close(): void
  • Causes the point of the pen to move back to the start of the current path. It tries to add a straight line from the current point to the start.

    Returns void

destroy

  • destroy(): boolean

destroyRenderData

  • destroyRenderData(): void

ellipse

  • ellipse(cx: number, cy: number, rx: number, ry: number): void
  • Adds an ellipse to the path.

    Parameters

    • cx: number

      中心点的坐标 x 轴。

    • cy: number

      中心点的坐标 y 轴。

    • rx: number

      椭圆 x 轴半径。

    • ry: number

      椭圆 y 轴半径。

    Returns void

fill

  • fill(): void

fillRect

  • fillRect(x: any, y: any, w: any, h: any): void
  • Draws a filled rectangle.

    Parameters

    • x: any

      矩形起始坐标 x 轴。

    • y: any

      矩形起始坐标 y 轴。

    • w: any

      矩形宽度。

    • h: any

      矩形高度。

    Returns void

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • Returns the component of supplied type if the node has one attached, null if it doesn't.
    You can also get component in the node by passing in the name of the script.

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

  • Returns the component of supplied type if the node has one attached, null if it doesn't.
    You can also get component in the node by passing in the name of the script.

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

getMaterial

  • getMaterial(idx: number): Material | null

getMaterialInstance

  • getMaterialInstance(idx: number): Material | null

getRenderMaterial

  • getRenderMaterial(index: number): Material | null

getUIMaterialInstance

Protected getUIRenderMaterial

helpInstanceMaterial

  • helpInstanceMaterial(): void

Protected Optional lateUpdate

  • lateUpdate(dt: number): void
  • LateUpdate is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

lineTo

  • lineTo(x: number, y: number): void
  • Adds a straight line to the path.

    Parameters

    • x: number

      绘制路径坐标 x 轴。

    • y: number

      绘制路径坐标 y 轴。

    Returns void

markForUpdateRenderData

  • markForUpdateRenderData(enable?: boolean): void

moveTo

  • moveTo(x: number, y: number): void

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

onLoad

  • onLoad(): void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

onRestore

  • onRestore(): void

postUpdateAssembler

  • postUpdateAssembler(render: UI): void

quadraticCurveTo

  • quadraticCurveTo(cx: number, cy: number, x: number, y: number): void
  • Adds a quadratic Bézier curve to the path.

    Parameters

    • cx: number

      起始控制点的坐标 x 轴。

    • cy: number

      起始控制点的坐标 y 轴。

    • x: number

      终点控制点的坐标 x 轴。

    • y: number

      终点控制点的坐标 x 轴。

    Returns void

rect

  • rect(x: number, y: number, w: number, h: number): void
  • Adds a rectangle to the path.

    Parameters

    • x: number

      矩形起始坐标 x 轴。

    • y: number

      矩形起始坐标 y 轴。

    • w: number

      矩形宽度。

    • h: number

      矩形高度。

    Returns void

requestRenderData

  • requestRenderData(): RenderData

Optional resetInEditor

  • resetInEditor(): void

roundRect

  • roundRect(x: number, y: number, w: number, h: number, r: number): void
  • Adds a round corner rectangle to the path.

    Parameters

    • x: number

      矩形起始坐标 x 轴。

    • y: number

      矩形起始坐标 y 轴。

    • w: number

      矩形宽度。

    • h: number

      矩形高度。

    • r: number

      矩形圆角半径。

    Returns void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • Schedules a custom task.
    If the task is already scheduled, then the interval parameter will be updated without scheduling it again.

    example
    import { log } from 'cc';
    this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • Schedules a task that runs only once, with a delay of 0 or larger.

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
    this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation

    Returns void

setMaterial

  • setMaterial(material: Material | null, index: number): void

setMaterialInstance

  • setMaterialInstance(index: number, matInst: Material | null): void

Protected Optional start

  • start(): void
  • Called before all scripts' update if the Component is enabled the first time.
    Usually used to initialize some logic which need to be called after all components' onload methods called.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

stroke

  • stroke(): void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

Protected Optional update

  • update(dt: number): void
  • Update is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

updateAssembler

  • updateAssembler(render: UI): void
  • Render data submission procedure, it update and assemble the render data to 2D data buffers before all children submission process. Usually called each frame when the ui flow assemble all render data to geometry buffers. Don't call it unless you know what you are doing.

    Parameters

    • render: UI

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Object literals

Protected blendTemplate

blendTemplate: object

blendState

blendState: object

targets

targets: { blendDst: GFXBlendFactor; blendSrc: GFXBlendFactor }[] = [{blendSrc: GFXBlendFactor.SRC_ALPHA,blendDst: GFXBlendFactor.ONE_MINUS_SRC_ALPHA,},]

Generated using TypeDoc