JSDoc: Class: ArtShape

<virtual> new ArtShape

図形クラス(抽象クラス)

ArtRectやArtPathなど、各図形クラスがこのクラスを継承しています。

Members

type :string

図形のタイプ

各図形クラスのタイプを表す文字列です。ArtRectなら'rect'、ArtPathなら'path'などの値を持ちます。

読み取り専用属性です。

userData :Any

任意のユーザデータを持たせることができるプロパティ

図形個別に何か値を持たせたい場合はこのプロパティに自由に値を持たせることができます。

デフォルト値はnullです

Methods

beginDrag

ドラッグセッションの開始

図形のドラッグ操作を行うためのDragSessionオブジェクトを生成して返します。

Returns:

Type: DragSession

getBounds

図形の位置とサイズを取得

Returns:

x,y,width,heightを持つオブジェクト

Type: Object

getElement

図形要素を取得

図形を表現している要素を返します。

Returns:

Type: DOM

hitTest

図形が指定された座標と重なるかどうかを返します

指定された座標と重ならない場合、または描画されていない図形ならfalseを返します

Parameters:

Name	Type	Description
`x`	number	x座標位置
`y`	number	y座標位置

Returns:

図形が指定された座標と重なるかどうか

Type: boolean

isAlone

レイヤ上に描画されていない図形ならisAloneはtrue、そうでないならfalseを返します

Returns:

Type: boolean

isInRect

図形が指定された矩形(x,y,w,h)に含まれるかどうかを返します(交わるだけではなく完全に含まれるかどうかを判定します)

指定された矩形に含まれない場合、または描画されていない図形ならfalseを返します

Parameters:

Name	Type	Description
`x`	number	矩形の左上のx座標位置
`y`	number	矩形の左上のy座標位置
`w`	number	矩形の幅
`h`	number	矩形の高さ

Returns:

図形が指定された矩形に含まれるかどうか

Type: boolean

moveBy

図形の移動を相対座標指定で行います

Parameters:

Name	Type	Description
`x`	number	x座標位置
`y`	number	y座標位置

moveTo

図形の移動を絶対座標指定で行います

Parameters:

Name	Type	Description
`x`	number	x座標位置
`y`	number	y座標位置

serialize

図形をシリアライズ可能なオブジェクトに変換します

このメソッドで生成したオブジェクトはArtShape.deserializeで元の図形クラスに復元することができます

Returns:

図形情報を格納したシリアライズ可能なプレーンオブジェクト

Type: Object

<static> deserialize

シリアライズされた図形からArtShapeクラス(の子クラス)を生成して返します

各図形クラスはserializeメソッドを用意しており、シリアライズ可能なオブジェクトを生成することができます。

以下は、ArtRectクラスの要素をシリアライズして復元するサンプルコードです。


// ArtRectクラスを生成
var rect = new h5.ui.components.artboard.ArtShapeConstructor.ArtRect(element);

// ArtRectクラスをシリアライズ(プレーンオブジェクトに変換)
var obj = rect.serialize();

// デシリアライズ(復元) 戻り値はArtRectクラス
h5.ui.components.artboard.ArtShapeConstructor.ArtShape.deserialize(rect);

Parameters:

Name	Type	Argument	Description
`shapeData`	Object		あるArtShapeについてのセーブデータ。DrawingSaveData#saveData.shapes配列の要素がshapeDataに該当します。
`commandManagerWrapper`	Logic	<optional>	コマンド生成時にappendCommandを行うロジックやクラス

Returns:

復元した図形クラス(ArtShapeを継承する具象クラス)

Type: ArtShape