Editor APIUI / DrawCanvas
DrawCanvas Class
UI canvas
Hierarchy
↳
DrawCanvas
Table of contents
Properties
click
Properties
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other |
|---|
| Monitor custom attribute synchronization events |
Accessors
click
Accessors
alignPosition(): Readonly<Vector2> other |
|---|
| Get the align position of the widget. When the align method is right align, bottom align, and center align, the value of alignPosition is different from that of position; |
autoSizeHorizontalEnable(): boolean other |
| Get whether to automatically set the size horizontally |
autoSizeVerticalEnable(): boolean other |
| Get whether to set the size automatically vertical |
cachedGeometry(): Geometry other |
| Get the previous Get TickSpaceGeometry |
constraints(): Readonly<UIConstraintAnchors> other |
| Get the layout of the control |
desiredSize(): Vector2 other |
| Obtain expected size |
enable(): boolean other |
| Is it available |
guid(): string other |
| Get the widget GUID |
isHovered(): boolean other |
| Is it hovered |
mouseCursor(): MouseCursor other |
| Get the cursor type on the widget |
name(): string other |
| Get Name |
paintSpaceGeometry(): Geometry other |
| Get the last geometric information used to render the Widget |
parent(): Widget other |
| Get parent node |
pivot(): Vector2 other |
| Get the position of the widget anchor. This property determine the relative position of the widget graph and the anchor; At (0,0), the anchor point is located in the upper left corner of the control; (0.5,0.5), the anchor is at the center of the widget |
position(): Readonly<Vector2> other |
| Get the position of the control |
renderOpacity(): number other |
| Obtain rendering transparency |
renderScale(): Vector2 other |
| Get rendering scaling |
renderShear(): Vector2 other |
| Obtain rendering misalignment deformation |
renderTransformAngle(): number other |
| Obtain the rendering angle |
renderTransformPivot(): Vector2 other |
| Get Render anchor |
size(): Vector2 other |
| Get size |
tickSpaceGeometry(): Geometry other |
| Retrieve the last geometric information used to drive Widget Tick |
transform(): Readonly<UITransform> other |
| Obtain the size and position of the control |
visibility(): SlateVisibility other |
| Get visibility |
visible(): boolean other |
| Is it visible |
zOrder(): number other |
| Get Zorder |
Methods
clearDraws(): void other |
|---|
| Clear all drawings |
drawCubicBezierSpline(p1: Vector2, p2: Vector2, p3: Vector2, p4: Vector2, lineData?: DrawDataBase): number other |
| Draw a third-order Bezier curve |
drawCustom(vertex: UIDrawCustomVertex[], index: number[], assetId?: string, drawLayerId?: number): number other |
| Customize Drawing Elements |
drawLines(points: Vector2[], lineData?: DrawDataBase): number other |
| Draw polylines |
drawSpline(startPoint: Vector2, startDirection: Vector2, endPoint: Vector2, endDirection: Vector2, lineData?: DrawDataBase): number other |
| Draw Hermitian Curve |
drawText(text: string, position: Vector2, fontSize: number, fontColor: any, drawLayerId?: number): number other |
| Draw text |
removeDrawById(Id: number): void other |
| Remove specified drawing elements |
newObject(parent?: Canvas, inName?: string): DrawCanvas other |
| Create a painting control |
click
Methods
addChild(child: Widget): void other |
|---|
| Add child nodes |
clone(position: Vector2, Parent?: any): Widget other |
| Clone the UI widget and its child nodes to the specified parent widget position (default to its parent node) |
destroyObject(): void other |
| Remove and destroy immediately. Cannot be used again |
equal(that: Widget): boolean other |
| Determine if it is the same object |
findChildByPath(inPath: string): Widget other |
| Find nodes by relative path |
getChildAt(index: number): Widget other |
| What is the position node to obtain |
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> other |
| Search for nodes by name |
getChildrenCount(): number other |
| Obtain the number of child nodes |
getCustomProperties(): string[] other |
| Get all customize property |
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType other |
| Get customize property |
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other |
| Event proxy triggered when a given object property is modified |
invalidateLayoutAndVolatility(): void other |
| Immediately trigger re rendering and layout calculation |
removeAllChildren(): void other |
| Clearing all child nodes will destroy the UI and render it unusable |
removeChild(child: Widget): void other |
| Removing a node will destroy the UI and make it unusable |
removeChildAt(index: number): void other |
| Removing the third node will destroy the UI and render it unusable |
removeObject(): void other |
| Immediately remove and add to the root node for reuse |
serialize(): string other |
| Serialize UI widget |
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void other |
| Set custom attributes |
deserialize(Data: string, Parent?: Widget): Widget other |
| Deserialize UI |
Properties
Accessors
Methods
clearDraws
• clearDraws(): void other
Clear all drawings
drawCubicBezierSpline
• drawCubicBezierSpline(p1, p2, p3, p4, lineData?): number other
Draw a third-order Bezier curve
Parameters
p1 Vector2 | The first point |
|---|---|
p2 Vector2 | The second point |
p3 Vector2 | The third point |
p4 Vector2 | The fourth point |
lineData? DrawDataBase | Draw graphic information |
Returns
number | Return drawId |
|---|
drawCustom
• drawCustom(vertex, index, assetId?, drawLayerId?): number other
Customize Drawing Elements
Parameters
vertex UIDrawCustomVertex[] | Vertex primitive data information |
|---|---|
index number[] | Vertex Element Index Information |
assetId? string | - |
drawLayerId? number | - |
Returns
number |
|---|
drawLines
• drawLines(points, lineData?): number other
Draw polylines
Parameters
points Vector2[] | Coordinates of each point on the line |
|---|---|
lineData? DrawDataBase | Draw graphic information |
Returns
number | Return drawId |
|---|
drawSpline
• drawSpline(startPoint, startDirection, endPoint, endDirection, lineData?): number other
Draw Hermitian Curve
Parameters
startPoint Vector2 | Starting line position |
|---|---|
startDirection Vector2 | Starting tangent direction |
endPoint Vector2 | End point position |
endDirection Vector2 | End point tangent direction |
lineData? DrawDataBase | Draw graphic information |
Returns
number | Return drawId |
|---|
drawText
• drawText(text, position, fontSize, fontColor, drawLayerId?): number other
Draw text
Parameters
text string | - |
|---|---|
position Vector2 | position |
fontSize number | font size |
fontColor any | colour |
drawLayerId? number | Draw hierarchy |
Returns
number |
|---|
removeDrawById
• removeDrawById(Id): void other
Remove specified drawing elements
Parameters
Id number | Designated drawing element ID |
|---|
newObject
• Static newObject(parent?, inName?): DrawCanvas other
Create a painting control
Parameters
parent? Canvas | Usage: the parent object of the create widget default: null |
|---|---|
inName? string | Usage: name of the create widget default: null range: set a reasonable name |
Returns
DrawCanvas | Return the created object |
|---|
When the parent and inName are the same as an existing object, the old object will be destroyed