# champ_properties

2次元ベクトルフィールドエンティティプロパティの説明

## 説明

Champエンティティはグラフィックエンティティ階層の葉です. このエンティティは2次元ベクトルフィールドのパラメータを定義します.

visible:

  このプロパティにはエンティティの`visible` プロパティの値が含まれます.この値には, `"on"` または `"off"`を指定します. `"on"` の場合,ベクトルフィールドが描画され, `"off"`の場合,ベクトルフィールドは画面上に 表示されません.

data:

  このフィールドは, 各要素の行および列のインデックスからなる`"champdata"` 型の`tlist`データ構造体を定義します: x および y グリッド座標はそれぞれ `data.x` および `data.y`に 含まれます. `data.fx` および `data.fy`という名前の 相補フィールドは,それぞれ,点`(x(i),y(j))`における ベクトルフィールドの`x` および `y`要素 を定義する行列です.

user_data:

  このフィールドはchampデータ構造体に任意のScilab変数を 保存し,再度取得するために使用することができます.

line_style:

  `line_style` プロパティの値は [1 8]の範囲の整数とする必要があります. 1は実線,その他の値は破線の選択を意味します (getlinestyle参照).

thickness:

  このプロパティは矢印の幅を指定する正の実数です. 表示される幅は,指定された幅を最も近い整数に丸めることにより定義されます. 唯一の例外はベクトルのエキスポートで,この場合 全体の`thickness`の値が考慮されます.

colored:

  このプロパティの値が`"on"`の場合, フィールドの ベクトルがフィールドのインテンシティに比例した色により描画されます.

clip_state:

  このフィールドには champ の`clip_state` プロパティの値が含まれます. 値は以下となります:

  - `"off"` この場合,ベクトルフィールドはクリップされません.

  - `"clipgrf"` この場合,ベクトルフィールドはaxesボックスの外でクリップされます.

  - `"on"` この場合,ベクトルフィールドはclip_boxプロパティで指定された矩形の外で クリップされます.

clip_box:

  このプロパティには `clip_box` プロパティが含まれます. この値はclip_state が "off"の場合には空の行列となります. その他の場合,ベクトル `[x,y,w,h]`(左上の点 幅 高さ) は表示するベクトルフィールドの領域を定義しますが, `clip_state`プロパティの値は変更されます.

parent:

  このプロパティには親(parent)のハンドルが含まれます. 2次元ベクトルフィールドエンティティの親は `"Axes"` または `"Compound"`型のどちらかです.

## 例

    a=get("current_axes");//新規に作成された軸のハンドルを取得
    a.data_bounds=[-10,-10;10,10];
    champ(-5:5,-5:5,rand(11,11),rand(11,11))

    c=a.children

    c.colored="on";
    c.thickness=2;
    c.data // "scichampdata"型のtlistを表示
    a.data_bounds=[-5,-5;5,5];

## 参照

- set
- get
- delete
- champ
- champ1
- graphics_entities

## 履歴

5.4.0
line_style 値 0 は廃止されています. 代わりに 1 を使用してください (両者は共に SOLIDを意味します). Scilab 5.4.1 以降, 値0を使用するとエラーとなります.