scene

シーンの情報の取得・設定に使用する基本クラス。

xshade
↑
scene

メソッド一覧

active_shape 選択されている形状を返す
adjust_transformation 選択形状の移動以外のマトリクスをリセットする
append 選択されている形状に記憶されている線形状を追加する
append_metacamera メタカメラを追加する
append_point 作成中の線形状にコントロールポイントを追加する
append_polygon_mesh_edge 作成中または現在選択されているポリゴンメッシュに稜線を追加する
append_polygon_mesh_edges ポリゴンメッシュの稜線を持たない面に必要な稜線を生成する
append_polygon_mesh_face 作成中または現在選択されているポリゴンメッシュに面を追加する
append_polygon_mesh_vertex 作成中または現在選択されているポリゴンメッシュにポイントを追加する
append_truetype_point 作成中のTrueType（２次のベジェ曲線）形状にポイントを追加する
apply 選択されている形状に記憶されている線形状を適用する
begin_ball_joint ボールジョイントの作成を開始する
begin_bone_joint ボーンジョイントの作成を開始する
begin_creating 形状の作成を開始する
begin_creating_at 挿入点を指定して形状作成を開始する
begin_custom_joint カスタムジョイントの作成を開始
begin_light_effector 光源ジョイントの作成を開始する
begin_line 線形状の作成を開始する
begin_morph_effector 変形ジョイントの作成を開始する
begin_part パートの作成を開始する
begin_path_joint パスジョイントの作成を開始する
begin_path_replicator パスリプリケータの作成を開始する
begin_polygon_mesh ポリゴンメッシュの作成を開始する
begin_rotator_joint 回転ジョイントの作成を開始する
begin_scale_joint 拡大縮小ジョイントの作成を開始する
begin_slider_joint 直線移動ジョイントの作成を開始する
begin_sound_object サウンド形状の作成を開始する
begin_surface_part 自由曲面パートの作成を開始する
begin_surface_replicator サーフェスリプリケータの作成を開始する
begin_switch_effector スイッチの作成を開始する
begin_truetype TrueType（２次のベジェ曲線）形状の作成を開始する
begin_uniscale_joint 均等拡大縮小ジョイントの作成を開始する
bevel_edge 角の切り落としをを行う
browser_active 現在選択されている形状をブラウザで表示する
cancel_line_object 線形状の作成をキャンセルする
cancel_transformation 変換を相殺する
clear 選択されている形状を削除する
clear_memory ツールの記憶で記憶した情報をクリアする
clear_template テンプレート画像を削除する
clear_transformation 変換を復帰する
close シーンを閉じる
close_scene シーンを閉じる
convert_to_curved_surface 選択されている形状を自由曲面に変換する
convert_to_line_object 選択されている形状を線形状に変換する
convert_to_polygon_mesh 選択されている形状をポリゴンメッシュに変換する
copy 選択されている形状をクリップボードにコピーする
copy_object 形状の複製を行い、回転、拡大縮小、移動を行う
create_ball_joint ボールジョイントを作成する
create_bone_joint ボーンジョイントを作成する
create_camera カメラオブジェクトを作成する
create_custom_joint カスタムジョイントを作成する
create_disk 円を作成する
create_light_effector 光源ジョイントを作成する
create_line 線形状を作成する
create_local_axis 選択形状から座標系（一時使用）を作成する
create_master_image マスターイメージを作成する
create_master_surface マスターサーフェスを作成する
create_morph_effector 変形ジョイントを作成する
create_offset_lines オフセットされた線形状を作成する
create_part パートを作成する
create_path_joint パスジョイントを作成する
create_path_replicator パスリプリケータを作成する
create_point_light 点光源を作成する
create_primitive_box 立方体を作成する
create_primitive_capsule カプセルを作成する
create_primitive_cone 円錐を作成する
create_primitive_cylinder 円柱を作成する
create_primitive_plane 長方形を作成する
create_primitive_pyramid 三角錐を作成する
create_primitive_sphere 球を作成する
create_primitive_text 3Dテキストを作成する
create_primitive_torus トーラスを作成する
create_rotator_joint 回転ジョイントを作成する
create_scale_joint 拡大縮小ジョイントを作成する
create_slider_joint 直線移動ジョイントを作成する
create_sound_object サウンド形状を作成する
create_sphere 球を作成する
create_spotlight スポットライトを作成する
create_surface_part 自由曲面パートを作成する
create_surface_replicator サーフェスリプリケータを作成する
create_switch_effector スイッチを作成する
create_uniscale_joint 均等拡大縮小ジョイントを作成する
cut 選択されている形状をクリップボードに切り取る
degenerate 一点に収束する
deselect_all_key_points すべてのモーションポイントの選択を解除する
draw_figure_window 図形ウインドウを描画する
end_ball_joint ボールジョイントの作成を終了する
end_bone_joint ボーンジョイントの作成を終了する
end_creating 形状の作成を終了する
end_custom_joint カスタムジョイントの作成を終了する
end_light_effector 光源ジョイントの作成を終了する
end_line 線形状の作成を終了する
end_morph_effector 変形ジョイントの作成を終了する
end_part パートの作成を終了する
end_path_joint パスジョイントの作成を終了する
end_path_replicator パスリプリケータの作成を終了する
end_polygon_mesh ポリゴンメッシュの作成を終了する
end_rotator_joint 回転ジョイントの作成を終了する
end_scale_joint 拡大縮小ジョイントの作成を終了する
end_slider_joint 直線移動ジョイントの作成を終了する
end_sound_object サウンド形状の作成を終了する
end_surface_part 自由曲面パートの作成を終了する
end_surface_replicator サーフェスリプリケータの作成を終了する
end_switch_effector スイッチの作成を終了する
end_truetype TrueType（２次のベジェ曲線）の作成を終了する
end_uniscale_joint 均等拡大縮小ジョイントの作成を終了する
enter_create_line_mode 線形状作成モードに入る
enter_modify_mode 形状編集モードに入る
exit_create_line_mode 線形状作成モードから抜ける
exit_modify_mode 形状編集モードから抜ける
export_scene シーンデータをエクスポートする
export_with_uuid uuid付きでファイルを書き出す
fit_to_window 図面に合わせる
flip_hide_faces 形状編集モード時、面の表示/非表示状態を反転させる
force_update 画面描画を強制する
get_grid_shown 指定したビューのグリッドのオン／オフを返す
get_ik IK管理クラスを取得する
get_shape_by_name 指定した名前を持つ形状を返す
get_shape_by_ordinal 序数で指定された形状を返す
get_shape_by_position ブラウザ上の位置から形状を返す
get_shape_by_uuid uuidで指定された形状を返す
get_shapes_by_name 指定された名前を持つ形状のタプルを返す
get_view_rectangle 引数で指定された図面のディスプレイ上の矩形領域を返す
hide_active 選択されている形状を隠す
hide_inactive 選択されていない形状を隠す
hide_select_faces 形状編集モード時、選択形状の選択されている面を非表示にする
hide_unselect_faces 形状編集モード時、選択形状の選択されていない面を非表示にする
iron アイロンを行う
link 選択しているパートを記憶している形状にリンクする
link_object 選択されている形状を参照するリンク形状を作成する
load_3DS 3DSファイルをインポートする
load_BVH BVHファイルをインポートする
load_DXF DXFファイルをインポートする
load_OBJ wavefrontOBJファイルをインポートする
load_pose Shade 3D のポーズファイルをインポートする
load_shape Shade 3D の形状データをインポートする
load_template_image_to_front_view 左下ビューにテンプレートを読み込む
load_template_image_to_pers_view 右上ビューにテンプレートを読み込む
load_template_image_to_side_view 右下ビューにテンプレートを読み込む
load_template_image_to_top_view 左上ビューにテンプレートを読み込む
load_text XMLテキストファイルをインポートする
magnify 図形ウインドウを拡大表示する
memorized_shape 記憶されている形状を返す
memory 選択されている線形状を記憶する
move_object 形状の回転、拡大縮小、移動を行う
paste クリップボードからシーンに形状を貼り付けする
place_brother 選択された形状を下に移動する
place_child 選択された形状を下に位置するパート内に移動する
place_parent 選択された形状を上の階層の先頭に移動する
place_sister 選択された形状を前に移動する
print_ レンダリングイメージを印刷する
read ファイルからシーンを読み込む
repeat リピートを行う
reset_all_transformation 選択したパートに含まれるすべてのパートのマトリックスを単位マトリックスに設定する
reset_transformation 選択したパートのマトリックスを単位マトリックスに設定する
reverse 逆転を行う
revert_to_saved 開いている Shade 3D ファイルを保存した状態に復帰する
round_edge 角の丸めを行う
save シーンを上書き保存する
save_3DS 3DSファイルとしてエクスポートする
save_Animation_Master AnimationMasterのセグメントファイルとしてエクスポートする
save_as シーンをファイルダイアログを表示してファイルに保存する。
save_DXF DXFファイルとしてエクスポートする
save_EPX EPixファイルとしてエクスポートする
save_FBX FBXファイルとしてエクスポートする
save_image レンダリングイメージをファイルに保存する
save_images レンダリングイメージをマルチレイヤー形式でファイルに保存する
save_local_axis 座標系（一時使用）を保存する
save_OBJ wavefrontOBJファイルとしてエクスポートする
save_pose ポーズファイルをエクスポートする
save_RIB RIBファイルとしてエクスポートする
save_shape Shade 3D の形状ファイルとしてエクスポートする
save_text XMLテキストファイルとしてエクスポートする
save_VRML VRMLファイルとしてエクスポートする
save_VRML_2 VRMLファイルとしてファイルダイアログを表示してエクスポートする
scroll 図形ウインドウをスクロールする
select_all ルート形状を選択する
select_brother 選択された形状の次の形状を選択する
select_child 選択された形状の下に位置するパート内の形状を選択する
select_parent 選択されている形状の上の階層を選択する
select_sister 選択された形状の前の形状を選択する
sequence_world_to_device_matrix 指定シーケンスでのワールド座標系からデバイス座標系へ変換するマトリクスを返す
sequence_world_to_perspective_matrix 指定シーケンスでのワールド座標系から透視図座標系へ変換するマトリクスを返す
sequence_world_to_view_matrix 指定シーケンスでのワールド座標系からビュー座標系へ変換するマトリクスを返す
set_grid_shown 指定したビューのグリッドのオン／オフ
show_active 選択されている形状を表示する
show_all すべての形状を表示する
show_all_faces 形状編集モード時、選択形状のすべての面を表示する
shrink 図形ウインドウを縮小表示する
smooth スムーズを行う
solid_clear 掃引体／回転体をもとの状態に戻す
solid_extrude 掃引体を作成する
solid_revolve 回転体を作成する
sweep 掃引を行う
switch 切り換えを行う
unsmooth アンスムーズを行う
update_figure_window 図形ウインドウを更新する
use_global 図形ウインドウの表示をグローバル座標にする
use_local 図形ウインドウの表示を選択されている形状のローカル座標にする
use_local_axis 指定した座標系を使用する
write Shade 3D シーンファイルを保存する

プロパティ一覧

active_shapes 現在選択されている形状のリスト
animation_settings シーンのアニメーション
background シーンの background
camera シーンの現在選択されているカメラ
can_create 新規形状作成に機能制限がかかっているか
can_export_foreign Shade 3D と直接関係無いフォーマットへのエクスポートに機能制限がかかっているか
can_export_native Shade 3D 関係のフォーマットへのエクスポートに機能制限がかかっているか
can_save シーンの保存に機能制限がかかっているか
can_save_rendered_image レンダリングイメージのファイルへの保存に機能制限がかかっているか
center 三面図の中心の座標
color_mode 図形ウインドウ表示のカラーモード
correction シーンの色補正
current_camera 現在選択されているカメラのインデックス値
current_cursor_position 現在の図形ウィンドウの三次元カーソル座標値
cursor_plane 透視図のカーソル面
cursor_position 図形ウインドウ内の三次元カーソル座標値（クリックした位置）
default_bevel_radius 角の丸め・角の切り落としの初期設定値
default_disk_radius 円の半径の初期設定値
default_light_radius 光源の明るさの初期設定値
default_radius 線形状の角の丸め、角の切り落としの半径の初期設定値
default_sphere_radius 球の半径の初期設定値
dirty シーンがダーティかどうか
display シーンの図形ウインドウ
distant_light シーンの無限遠光源
figure_view_mode 図形ウインドウのビューモード
figure_window シーンの図形ウインドウ
file_path 保存されているシーンのファイルパス
fog シーンの無限遠光源のフォグ
fps シーンのfps
grid グリッド表示のオン／オフ
insertion_shape begin_creating()で形状を作成したときに、挿入される位置の形状のshapeクラス
is_create_line_mode 線形状作成モードかどうか
is_locked ロックファイルかどうか
is_modify_mode 形状編集モードかどうか
is_motion_playing モーションウインドウが再生中かどうか
keyframes シーンのキーフレーム
large_cursor ラージカーソル表示のオン／オフ
large_point ラージポイント表示のオン／オフ
lathe_rotation ろくろの回転
light_scale 光源のスケール
local ローカル座標の基準となるパート
local_matrix ローカル座標モードの変換マトリクス
manip_type マニピュレータのタイプ
mapping_modify_mode マッピングモディファイモードかどうか
native_to_user_unit ネイティブ単位（mm）からユーザが設定した単位に変換する係数
number_of_appended_points 作成中の線形状のコントロールポイントの数
number_of_cameras カメラの数
number_of_memorized_shapes 記憶された形状の数
number_of_metacameras メタカメラの数
pers_grid 透視図グリッド表示のオン／オフ
pivot_position ピボット座標
pixel_size 図形ウインドウの拡大、縮小の状態
radiosity シーンのラジオシティ
rendering シーンの rendering
selection_method ツールボックスの選択モード
selection_mode メッシュ編集ツールの選択モード
sequence_mode シーンがシーケンスモードかどうか
sequence_value モーションウインドウのシーケンス値
shape ルートの形状オブジェクト
show_normals 法線を表示するかどうか
snap スナップのオン／オフ
step_frames アニメーション作成のステップフレーム数(float)
template テンプレート表示のオン／オフ
unit 単位の値
user_to_native_unit ユーザが設定した単位からネイティブ単位（mm）に変換する係数
user_to_world_matrix ユーザ座標系からワールド座標系に変換するマトリクス
window_frame 図形ウインドウのフレーム
work_plane 作業平面のオン／オフ
world_to_device_matrix ワールド座標系からデバイス座標系に変換するマトリクス
world_to_perspective_matrix ワールド座標系からアクティブなカメラの透視座標系に変換するマトリクス
world_to_user_matrix ワールド座標系からユーザ座標系に変換するマトリクス
world_to_view_matrix ワールド座標系からアクティブなカメラのビュー座標系に変換するマトリクス



メソッド詳細

active_shape

選択されている形状を返す。
戻り値 :
　　shapeオブジェクト
引数 :
　　int : 選択された形状のインデックス : 選択形状が１つだけの場合や、先頭形状を取得する場合は省略可能。 

#選択形状の名称を出力する
print xshade.scene().active_shape().name

adjust_transformation

選択形状の移動以外のマトリクスをリセットする。
形状にかかっている変換要素はそのまま維持される。 

xshade.scene().adjust_transformation()

append

選択されている形状に記憶されている線形状を追加する。

xshade.scene().append()

append_metacamera

メタカメラを追加する。

xshade.scene().append_metacamera()

append_point

作成中の線形状にコントロールポイントを追加する。
引数 :
　　vec3 : point : アンカーポイントの位置
引数 :
　　vec3 : インハンドルの位置
引数 :
　　vec3 : アウトハンドルの位置
引数 :
　　vec3 : 交差インハンドルの位置
引数 :
　　vec3 : 交差アウトハンドル
形状の作成される階層のローカル座標系が基準となる。
参照 :
　　begin_creating()
　　begin_line()
　　end_line()
　　end_creating() 

#作成中の線形状に２カ所コントロールポイントポイントを追加する
xshade.scene().begin_creating()
xshade.scene().begin_line(None, True)
xshade.scene().append_point([0.0, 0.0, 0.0], None, None, None, None)
xshade.scene().append_point([1000.0, 1000.0, 0.0], None, None, None, None)
xshade.scene().end_line()
xshade.scene().end_creating()

append_polygon_mesh_edge

作成中または現在選択されているポリゴンメッシュに稜線を追加する。
引数 :
　　int : 稜線の頂点のインデックス値
引数 :
　　int : 稜線の他方の頂点のインデックス値
参照 :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating() 

xshade.scene().append_polygon_mesh_edge(0,1)

append_polygon_mesh_edges

ポリゴンメッシュの稜線を持たない面に必要な稜線を生成する。

xshade.scene().append_polygon_mesh_edges()

append_polygon_mesh_face

作成中または現在選択されているポリゴンメッシュに面を追加する。
引数 :
　　int : 頂点のインデックスのリスト／タプル
参照 :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating() 

xshade.scene().append_polygon_mesh_face([0,1,2,3])

append_polygon_mesh_vertex

作成中または現在選択されているポリゴンメッシュにポイントを追加する。
引数 :
　　vec3
作成中または現在選択されている階層のローカル座標系が基準となる。
参照 :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating() 

xshade.scene().append_polygon_mesh_vertex((100,200,0))

append_truetype_point

作成中のTrueType（２次のベジェ曲線）形状にポイントを追加する。
引数 :
　　bool : ONポイントかどうか
引数 :
　　float : X座標値
引数 :
　　float : Y座標値
引数 :
　　float : Z座標値：省略可能（省略時は０）
begin_truetype()からend_truetype()の間に呼び出す。
形状の作成される階層のローカル座標系が基準となる。 

#ポイント３つからなるTrueType形状を作成する
xshade.scene().begin_creating()
xshade.scene().begin_truetype(None, False)
xshade.scene().append_truetype_point(True,0.0, 0.0, 0.0)
xshade.scene().append_truetype_point(False,100.0, 100.0, 0.0)
xshade.scene().append_truetype_point(True,200.0, 0.0, 0.0)
xshade.scene().end_truetype()
xshade.scene().end_creating()

apply

選択されている形状に記憶されている線形状を適用する。

xshade.scene().apply()

begin_ball_joint

ボールジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心位置
引数 :
　　float : 半径
引数 :
　　string : 省略可能　省略時デフォルト名が設定される

end_ball_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。 

#原点に半径100で作成する
xshade.scene().begin_creating()
xshade.scene().begin_ball_joint((0.0,0.0,0.0),100)
xshade.scene().end_ball_joint()
xshade.scene().end_creating()

begin_bone_joint

ボーンジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心位置
引数 :
　　float : 半径
引数 :
　　bool : 自動で軸合わせ
引数 :
　　vec3 : 自動で軸合わせのときの軸方向 : 省略可能 : 省略時デフォルト設定が適用される
引数 :
　　string : 省略可能　省略時デフォルト名が設定される

end_bone_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。

#原点からX方向に800の長さにて半径100のボーンを作成する、Y軸方向で自動で軸あわせを行う
xshade.scene().begin_creating()
b1=xshade.scene().begin_bone_joint([0.0,0.0,0.0],100,True,[0.0,1.0,0.0])
b2=xshade.scene().begin_bone_joint([800.0,0.0,0.0],100,True,[0.0,1.0,0.0])
xshade.scene().end_bone_joint()
xshade.scene().end_bone_joint()
xshade.scene().end_creating()

begin_creating

形状の作成を開始する。
形状の作成を行う関数を呼び出すときに、必ず end_creating()をセットで使用する。
形状の作成位置を指定する場合は begin_creating_at()を使用する。
省略すると Shade 3D 内部でbegin_creating() end_creating()の処理を行うので処理速度が遅くなる。 

#パート作成１回ごとにbegin/endを使用すると、パートは入れ子になる
xshade.scene().begin_creating()
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()
xshade.scene().begin_creating()
xshade.scene().begin_part()
xshade.scene().end_part()

#begin/endを１回だけ使用すると、パートは並列になる
xshade.scene().begin_creating()
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()

begin_creating_at

挿入点を指定して形状作成を開始する。
引数 :
　　insertion_point : shapeオブジェクト : 挿入点の形状の shape クラス
形状の作成を行う関数を呼び出すときに、必ず end_creating()をセットで使用する。

#選択形状の上（姉）の位置にパートを作成する
shape = xshade.scene().active_shape().sis
xshade.scene().begin_creating_at(shape)
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()

begin_custom_joint

カスタムジョイントの作成を開始。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_custom_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。 

#カスタムジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_custom_joint()
xshade.scene().end_custom_joint()
xshade.scene().end_creating()

begin_light_effector

光源ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_light_effector()の呼び出しまでに作成した形状をパートの中に含めることができる。 

#光源ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_light_effector()
xshade.scene().end_light_effector()
xshade.scene().end_creating()

begin_line

線形状の作成を開始する。
戻り値 :
　　lineオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
引数 :
　　bool : True : 閉じた線形状 : False : 開いた線形状
end_line()とセットで使用する。
append_point()を使用してコントロールポイントを作成する。
形状の作成される階層のローカル座標系が基準となる。 

#２点からなる開いた線形状を作成する
xshade.scene().begin_creating()
xshade.scene().begin_line(None, False)
xshade.scene().append_point([0.0, 0.0, 0.0], None, None, None, None)
xshade.scene().append_point([0.0, 500.0, 0.0], None, None, None, None)
xshade.scene().end_line()
xshade.scene().end_creating()

begin_morph_effector

変形ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される

end_morph_effector()の呼び出しまでに作成した形状をパートの中に含めることができる。
#変形ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_morph_effector()
xshade.scene().end_morph_effector()
xshade.scene().end_creating()

begin_part

パートの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_part()の呼び出しまでに作成した形状をパートの中に含めることができる。

#パートを作成する
xshade.scene().begin_creating()
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()

begin_path_joint

パスジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される

end_path_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
#パスジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_path_joint()
xshade.scene().end_path_joint()
xshade.scene().end_creating()

begin_path_replicator

パスリプリケータの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される

end_path_replicator()の呼び出しまでに作成した形状をパートの中に含めることができる。
#パスリプリケータを作成する
xshade.scene().begin_creating()
xshade.scene().begin_path_replicator()
xshade.scene().end_path_replicator()
xshade.scene().end_creating()

begin_polygon_mesh

ポリゴンメッシュの作成を開始する。
戻り値 :
　　polygon_meshオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
end_polygon_mesh()とセットで使用する。
append_polygon_mesh_vertex()で頂点を作成する。
append_polygon_mesh_edg()で稜線を作成する。
あるべき面は自動的に作成される。
形状の作成される階層のローカル座標系が基準となる。 

#３頂点３稜線からなるポリゴンメッシを作成する
xshade.scene().begin_creating()
xshade.scene().begin_polygon_mesh(None)
xshade.scene().append_polygon_mesh_vertex([0.0,0.0,0.0])
xshade.scene().append_polygon_mesh_vertex([100.0,0.0,0.0])
xshade.scene().append_polygon_mesh_vertex([50.0,100.0,0.0])
xshade.scene().append_polygon_mesh_edge(0,1)
xshade.scene().append_polygon_mesh_edge(1,2)
xshade.scene().append_polygon_mesh_edge(2,0)
xshade.scene().end_polygon_mesh()
xshade.scene().end_creating()

begin_rotator_joint

回転ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 軸端点の位置
引数 :
　　vec3 : 他方の軸端点の位置
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_rotator_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。 

#原点からＹ軸に100の回転ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_rotator_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_rotator_joint()
xshade.scene().end_creating()

begin_scale_joint

拡大縮小ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心点
引数 :
　　vec3 : ターゲット点
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_scale_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。 

#原点からY軸に100の拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_scale_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_scale_joint()
xshade.scene().end_creating()

begin_slider_joint

直線移動ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 開始点
引数 :
　　vec3 : 終点
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_slider_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。 

#原点からY軸に100の直線移動ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_slider_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_slider_joint()
xshade.scene().end_creating()

begin_sound_object

サウンド形状の作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　file_path
引数 :
　　vec3 : 中心点
引数 :
　　float : 半径
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_sound_object()とセットで使用する。
形状の作成される階層のローカル座標系が基準となる。 

#aiffのサウンドファイルからサウンド形状を原点に半径100で作成する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.aiff|aiff')
xshade.scene().begin_creating()
xshade.scene().begin_sound_object(file_path,(0.0,0.0,0.0),100)
xshade.scene().end_sound_object()
xshade.scene().end_creating()

begin_surface_part

自由曲面パートの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_surface_part() の呼び出しまでに作成した線形状をパートの中に含めることができる。 

#自由曲面パートを作成する
xshade.scene().begin_creating()
xshade.scene().begin_surface_part()
xshade.scene().end_surface_part()
xshade.scene().end_creating()

begin_surface_replicator

サーフェスリプリケータの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_surface_replicator() の呼び出しまでに作成した形状をパートの中に含めることができる。 

#サーフェスリプリケータを作成する
xshade.scene().begin_creating()
xshade.scene().begin_surface_replicator()
xshade.scene().end_surface_replicator()
xshade.scene().end_creating()

begin_switch_effector

スイッチの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
end_switch_effector() の呼び出しまでに作成した形状をパートの中に含めることができる。 

#スイッチを作成する
xshade.scene().begin_creating()
xshade.scene().begin_switch_effector()
xshade.scene().end_switch_effector()
xshade.scene().end_creating()

begin_truetype

TrueType（２次のベジェ曲線）形状の作成を開始する。
戻り値 :
　　lineオブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　bool : 穴形状かどうか
end_truetype()とセットで使用する。
append_truetype_point()でポイントを作成する。 

#ポイント３つからなるTrueType形状を作成する
xshade.scene().begin_creating()
xshade.scene().begin_truetype(None, False)
xshade.scene().append_truetype_point(True,0.0, 0.0, 0.0)
xshade.scene().append_truetype_point(False,100.0, 100.0, 0.0)
xshade.scene().append_truetype_point(True,200.0, 0.0, 0.0)
xshade.scene().end_truetype()
xshade.scene().end_creating()

begin_uniscale_joint

均等拡大縮小ジョイントの作成を開始する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心点
引数 :
　　float : 半径
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される end_uniscale_joint()の呼び出しまでに作成した形状をパートの中に含めることができる。
形状の作成される階層のローカル座標系が基準となる。 

#原点に半径100で均等拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_uniscale_joint((0.0,0.0,0.0),100)
xshade.scene().end_uniscale_joint()
xshade.scene().end_creating()

bevel_edge

角の切り落としをを行う。
引数 :
　　float : 半径 

#半径20.5で角の切り落としを行う
xshade.scene().bevel_edge(20.5)

browser_active

現在選択されている形状をブラウザで表示する。

xshade.scene().browser_active()

cancel_line_object

線形状の作成をキャンセルする。 

#フラグがTrueの時に線形状の作成をキャンセルする
boolFlag = True
xshade.scene().begin_creating()
xshade.scene().begin_line(None, True)
xshade.scene().append_point([0.0, 0.0, 0.0], None, None, None, None)
xshade.scene().append_point([0.0, 500.0, 0.0], None, None, None, None)
if boolFlag:
	xshade.scene().cancel_line_object()
else:
	xshade.scene().end_line()
xshade.scene().end_creating()

cancel_transformation

変換を相殺する。
上位パートにかかっている変換を相殺する。 

xshade.scene().cancel_transformation()

clear

選択されている形状を削除する。 

xshade.scene().clear()

clear_memory

ツールの記憶で記憶した情報をクリアする。

xshade.scene().clear_memory()

clear_template

テンプレート画像を削除する。 

xshade.scene().clear_template()

clear_transformation

変換を復帰する。
形状にかかっている変換も消える 

xshade.scene().clear_transformation()

close

シーンを閉じる。 

xshade.scene().close()

close_scene

シーンを閉じる。
引数 :
　　bool : シーン変更時の確認 : False : 確認を行わずにシーンを閉じる : (False)と明示する必要がある 

xshade.scene().close_scene(False)

convert_to_curved_surface

選択されている形状を自由曲面に変換する。 

xshade.scene().convert_to_curved_surface()

convert_to_line_object

選択されている形状を線形状に変換する。 

xshade.scene().convert_to_line_object()

convert_to_polygon_mesh

選択されている形状をポリゴンメッシュに変換する。
引数 :
　　int : 交差の分割数
引数 :
　　int : 選択方向の分割数 

#交差4、選択2でポリゴンメッシュに変換する
xshade.scene().convert_to_polygon_mesh(4,2)

copy

選択されている形状をクリップボードにコピーする。 

xshade.scene().copy()

copy_object

形状の複製を行い、回転、拡大縮小、移動を行う。
引数 :
　　vec3 : 中心点
引数 :
　　float3 : スケール
引数 :
　　float3 : 回転
引数 :
　　float3 : 直線移動
参照 :
　　move_object 

#形状を複製し原点から全方向に1.5倍X軸に250移動する
xshade.scene().copy_object([0.0, 0.0, 0.0], [1.5, 1.5, 1.5], None, [250.0, 0.0, 0.0])

create_ball_joint

ボールジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心位置
引数 :
　　float : 半径
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される

形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点に半径100でボールジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_ball_joint([0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

create_bone_joint

ボーンジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心位置
引数 :
　　float : 半径
引数 :
　　bool : 自動で軸合わせ
引数 :
　　vec3 : 自動で軸合わせのときの軸方向 : 省略可能 : 省略時デフォルト設定が適用される
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される

形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。

#原点に半径100でボーンジョイントを作成する、Y軸方向で自動で軸あわせを行う
xshade.scene().begin_creating()
xshade.scene().create_bone_joint([0.0, 0.0, 0.0],100,True,[0.0, 1.0, 0.0])
xshade.scene().end_creating()

create_camera

カメラオブジェクトを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 視点
引数 :
　　vec3 : 注視点
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を視点、[0.0, 100.0, 100.0]を注視点にカメラを作成する
xshade.scene().begin_creating()
xshade.scene().create_camera([0.0, 0.0, 0.0],[0.0, 100.0, 100.0])
xshade.scene().end_creating()

create_custom_joint

カスタムジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_custom_joint()
xshade.scene().end_creating()

create_disk

円を作成する。
戻り値 :
　　diskオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
引数 :
　　vec3 : 位置
引数 :
　　float : 半径
引数 :
　　int :

0X軸
1Y軸
2Z軸
3eye-target軸

形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点X軸に半径100で円を作成する
xshade.scene().begin_creating()
xshade.scene().create_disk(None,[0.0, 0.0, 0.0], 100,0)
xshade.scene().end_creating()

create_light_effector

光源ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_light_effector()
xshade.scene().end_creating()

create_line

線形状を作成する。
戻り値 :
　　lineオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
引数 :
　　vec3のタプル／リスト : コントロールポイント座標の配列
引数 :
　　bool : True:閉じた線形状、False:開いた線形状
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#３つのコントロールポイントからなる閉じた線形状を作成する
xshade.scene().begin_creating()
xshade.scene().create_line(None,[[0,0,0],[100,0,0],[100,100,0]],True)
xshade.scene().end_creating()

create_local_axis

選択形状から座標系（一時使用）を作成する。
戻り値 :
　　part
参照 :
　　save_local_axis 

xshade.scene().create_local_axis()

create_master_image

マスターイメージを作成する。
戻り値 :
　　imageオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
begin_creating()、end_creating()は省略可。
省略した場合、ブラウザを更新しないと結果が反映されない。 

#レンダリングイメージの複製を割り当てたマスターイメージを作成する
xshade.scene().begin_creating()
img_obj = xshade.scene().create_master_image('sample')
img_obj.image = xshade.scene().rendering.image.duplicate()
xshade.scene().end_creating()

create_master_surface

マスターサーフェスを作成する。
戻り値 :
　　master_surfaceオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_master_surface(None)
xshade.scene().end_creating()

create_morph_effector

変形ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_morph_effector()
xshade.scene().end_creating()

create_offset_lines

オフセットされた線形状を作成する。
戻り値 :
　　None
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
引数 :
　　float : 距離
引数 :
　　vec3 : 座標系方向余弦 : [0,1,0] : XZ平面、[0,0,1] : XY平面、[1,0,0] : ZY平面
引数 :
　　int : オフセット方向 : -1 :片側(反時計回り)、0 : 両側、1 : 片側(時計回り)
引数 :
　　int : 角のスタイル : 0 : マイター、1 : ベベル、2 : ラウンド1、3 : ラウンド2
引数 :
　　int : 丸み : -1 ~ 3.0
引数 :
　　int : 反復回数
引数 :
　　int : 距離の傾斜 : -1.0 ~ 1.0
引数 :
　　int : 距離の扱い : 0 : 最近線、1 : 最遠線
引数 :
　　float : 反復時の高さ
引数 :
　　int : 高さの傾斜 : -1.0 ~ 1.0
引数 :
　　int : 高さの扱い : 0 : 最近線、1 : 最遠線
引数 :
　　bool : コントロールポイントの追加を許可する : True :する、False :しない
引数 :
　　bool : 元の形状を削除する : True :する、False :しない
begin_creating()、end_creating()は省略可。 

#YZ平面に距離200、方向:両面、角のスタイル:ラウンド1、丸み:1.5、繰り返し回数:2、勾配:0.3、距離表示:最近線、高さ:40、勾配:50、高さ表示:最近線、頂点の追加:許可、元の形状を削除せずにオフセットされた線形状を作成します。
xshade.scene().begin_creating()
xshade.scene().create_offset_lines(200.0, [0, 1, 0], 0, 2, 1.2, 2, 0.1, 0, 10, 0.3, 0, True, False)
xshade.scene().end_creating()

create_part

パートを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_part()
xshade.scene().end_creating()

create_path_joint

パスジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_path_joint()
xshade.scene().end_creating()

create_path_replicator

パスリプリケータを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_path_replicator()
xshade.scene().end_creating()

create_point_light

点光源を作成する。
戻り値 :
　　lightオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
引数 :
　　vec3 : 位置
引数 :
　　float : 半径
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点に半径100で点光源を作成する
xshade.scene().begin_creating()
xshade.scene().create_point_light(None,[0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

create_primitive_box

立方体を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｘ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｙ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｚ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 長方形を構成する頂点の座標１
引数 :
　　vec3 : 長方形を構成する頂点の座標２
引数 :
　　vec3 : 長方形を構成する頂点の座標３
引数 :
　　vec3 : 長方形を構成する頂点の座標４
引数 :
　　vec3 : 高さのＸＹＺ成分
引数 :
　　bool : 上面
引数 :
　　bool : 底面
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準に一片200、高さ500の立方体をポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_box(None, 3, True, 1, 1, 1, [100, 0, -100], [100, 0, 100], [-100, 0, 100], [-100, 0, -100], [0, 500, 0], True, True)
xshade.scene().end_creating()

create_primitive_capsule

カプセルを作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向（円周）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向（軸）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 下半球の中心座標
引数 :
　　float : カプセルの半径
引数 :
　　int : 作成面 0 : ＹＺ、1 : ＸＺ、2 : ＸＹ
引数 :
　　vec3 : 上半球の中心までのＸＹＺ成分
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数16、半径400、中心から中心までの長さがＹ方向に700のカプセルを、ポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_capsule(None, 3, True, 16, 16, [0, 0, 0], 400, 1, [0, 700, 0])
xshade.scene().end_creating()

create_primitive_cone

円錐を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向（円周）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向（高さ）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 底面の円の中心座標
引数 :
　　float : 円錐の半径
引数 :
　　int : 作成面 0 : ＹＺ、1 : ＸＺ、2 : ＸＹ
引数 :
　　vec3 : 高さのＸＹＺ成分
引数 :
　　bool : 底面
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数16、8、半径300、高さ500、底面ありの円錐を、ポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_cone(None, 3 , True, 16, 8, [0, 0, 0], 300, 1, [0,500, 0], True)
xshade.scene().end_creating()

create_primitive_cylinder

円柱を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向（円周）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向（高さ）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 底面の円の中心座標
引数 :
　　float : 円柱の半径
引数 :
　　int : 作成面 0 : ＹＺ、1 : ＸＺ、2 : ＸＹ
引数 :
　　vec3 : 高さのＸＹＺ成分
引数 :
　　bool : 上面
引数 :
　　bool : 底面
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数16、8、半径300、高さ500、上面、底面ありの円柱を、ポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_cylinder(None, 3, True, 16, 8, [0,0,0],300, 1, [0, 500, 0], True, True)
xshade.scene().end_creating()

create_primitive_plane

長方形を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 長方形を構成する頂点の座標１
引数 :
　　vec3 : 長方形を構成する頂点の座標２
引数 :
　　vec3 : 長方形を構成する頂点の座標３
引数 :
　　vec3 : 長方形を構成する頂点の座標４
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数3、2、一片1000の長方形をポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_plane(None, 3, True, 3, 2,[-500, 0, -500],[500, 0, -500],[500,0,500],[-500,0,500])
xshade.scene().end_creating()

create_primitive_pyramid

三角錐を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｚ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｘ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｙ方向の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 長方形を構成する頂点の座標１
引数 :
　　vec3 : 長方形を構成する頂点の座標２
引数 :
　　vec3 : 長方形を構成する頂点の座標３
引数 :
　　vec3 : 長方形を構成する頂点の座標４
引数 :
　　bool : 底面
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数1、1、1、一片1000の、高さ600、底面ありの三角錐をポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_pyramid(None, 3, True, 1, 1, 1, [-500,0,-500],[500,0,-500],[500,0,500],[-500,0,500],[0,600,0],True)
xshade.scene().end_creating()

create_primitive_sphere

球を作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向（円周）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向（軸）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 中心の座標
引数 :
　　float : 球の半径
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数16、16、半径300の球をポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_sphere(None,3,True,16,16,[0,0,0],300)
xshade.scene().end_creating()

create_primitive_text

3Dテキストを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般 (Shade 3D ver.14では 0 のみ)
引数 :
　　bool : ＵＶ割り当て : True :あり、False :なし ポリゴンメッシュ以外では無効 (Shade 3D ver.14では無効)
引数 :
　　vec3 : 位置 
引数 :
　　int : 作成面 : 0 : YZ平面、1 : XZ平面、2 : XY平面
引数 :
　　int : レイアウト方向の反転 : 0 : 反転無し、1 : 水平反転、2 : 垂直反転、3 : 水平および垂直反転
引数 :
　　vec3 : 高さ方向のベクトル
引数 :
　　strings : 出力文字
引数 :
　　strings : フォント名
引数 :
　　int : フォントサイズ
引数 :
　　float : 文字間隔
引数 :
　　int : フォントの太さ : Windowsのみ有効
引数 :
　　bool : 斜体 : True : あり、False : なし Windowsのみ有効
begin_creating()、end_creating()は省略可。 

#原点を基準に掃引60、文字間隔-1、フォント名'Osaka'、サイズ72、文字「Shade 3D」で作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_text(None, 0, True, [0, 0, 0], 2, 0, [0, 0, -60], "Shade 3D", "Osaka", 72, -10, 0, False)
xshade.scene().end_creating()

create_primitive_torus

トーラスを作成する。
戻り値 :
　　オブジェクト
引数 :
　　string : Noneでデフォルト名が設定される
引数 :
　　int : 形状タイプ : 0 : 一般、1 : 自由曲面、2 : 未使用、3 : ポリゴンメッシュ
引数 :
　　bool : ＵＶ割り当て : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｕ方向（円周）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　int : Ｖ方向（軸）の分割数 : ポリゴンメッシュ以外では無効
引数 :
　　vec3 : 中心の座標１
引数 :
　　float : トーラスの半径
引数 :
　　float : トーラスを構成する円の半径
引数 :
　　int : 作成面 0 : ＹＺ、1 : ＸＺ、2 : ＸＹ
ローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点を基準にUV分割数16、16、半径400、構成円の半径100のトーラスをポリゴンメッシュで作成する
xshade.scene().begin_creating()
xshade.scene().create_primitive_torus(None, 3, True, 16, 16, [0, 0, 0], 400, 100, 1)
xshade.scene().end_creating()

create_rotator_joint

回転ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 軸端点の位置
引数 :
　　vec3 : 他方の軸端点の位置
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点からX軸に回転ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_rotator_joint([0.0, 0.0, 0.0],[100.0, 0.0, 0.0])
xshade.scene().end_creating()

create_scale_joint

拡大縮小ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心点
引数 :
　　vec3 : ターゲット点
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点から100の拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_scale_joint([0.0, 0.0, 0.0],[100.0, 0.0, 0.0])
xshade.scene().end_creating()

create_slider_joint

直線移動ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 開始点
引数 :
　　vec3 : 終点
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点から100の直線移動ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_slider_joint([0.0, 0.0, 0.0],[100.0, 0.0, 0.0])
xshade.scene().end_creating()

create_sound_object

サウンド形状を作成する。
戻り値 :
　　partオブジェクト
引数 :
　　file_path
引数 :
　　vec3 : 中心点
引数 :
　　float : 半径
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点に半径100でsample.aiffのサウンド形状を作成する
xshade.scene().begin_creating()
xshade.scene().create_sound_object('sample.aiff',[0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

create_sphere

球を作成する。
戻り値 :
　　sphereオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
引数 :
　　vec3 : 位置
引数 :
　　float : 半径
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点に半径100で球を作成する
xshade.scene().begin_creating()
xshade.scene().create_sphere(None,[0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

create_spotlight

スポットライトを作成する。
戻り値 :
　　lightオブジェクト
引数 :
　　string : 省略可能 : Noneでデフォルト名が設定される
引数 :
　　vec3 : 光源の位置
引数 :
　　vec3 : ターゲット位置
引数 :
　　float : 明るさ
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点からX方向に明るさ500でスポットライトを作成する
xshade.scene().begin_creating()
xshade.scene().create_spotlight(None,[0.0, 0.0, 0.0],[100.0, 0.0, 0.0],500)
xshade.scene().end_creating()

create_surface_part

自由曲面パートを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_surface_part()
xshade.scene().end_creating()

create_surface_replicator

サーフェスリプリケータを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_surface_replicator()
xshade.scene().end_creating()

create_switch_effector

スイッチを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
begin_creating()、end_creating()は省略可。 

xshade.scene().begin_creating()
xshade.scene().create_switch_effector()
xshade.scene().end_creating()

create_uniscale_joint

均等拡大縮小ジョイントを作成する。
戻り値 :
　　partオブジェクト
引数 :
　　vec3 : 中心点
引数 :
　　float : 半径
引数 :
　　string : 省略可能 : 省略時デフォルト名が設定される
形状の作成される階層のローカル座標系が基準となる。
begin_creating()、end_creating()は省略可。 

#原点に半径100で均等拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_uniscale_joint([0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

cut

選択されている形状をクリップボードに切り取る。 

xshade.scene().cut()

degenerate

一点に収束する。 

xshade.scene().degenerate()

deselect_all_key_points

すべてのモーションポイントの選択を解除する。 

xshade.scene().deselect_all_key_points()

draw_figure_window

図形ウインドウを描画する。 

xshade.scene().draw_figure_window()

end_ball_joint

ボールジョイントの作成を終了する。
begin_ball_joint()の後に使用してボールジョイントの作成を終了する。 必ずセットで使用する。 

xshade.scene().end_ball_joint()

end_bone_joint

ボーンジョイントの作成を終了する。
begin_bone_joint()の後に使用してボーンジョイントの作成を終了する。 必ずセットで使用する。 

xshade.scene().end_bone_joint()

end_creating

形状の作成を終了する。
begin_creating()の後に使用して形状の作成を終了する。
必ずセットで使用する。 

#原点に半径100で均等拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().create_uniscale_joint([0.0, 0.0, 0.0],100)
xshade.scene().end_creating()

end_custom_joint

カスタムジョイントの作成を終了する。
begin_custom_joint()の後に呼び出してカスタムジョイントの作成を終了する。
必ずセットで使用する。 

#カスタムジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_custom_joint()
xshade.scene().end_custom_joint()
xshade.scene().end_creating()

end_light_effector

光源ジョイントの作成を終了する。
begin_light_effector()の後に呼び出して光源ジョイントの作成を終了する。
必ずセットで使用する。 

#光源ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_light_effector()
xshade.scene().end_light_effector()
xshade.scene().end_creating()

end_line

線形状の作成を終了する。
begin_line()の後に呼び出して線形状の作成を終了する。
必ずセットで使用する。 

#２点からなる開いた線形状を作成する
xshade.scene().begin_creating()
xshade.scene().begin_line(None, False)
xshade.scene().append_point([0.0, 0.0, 0.0], None, None, None, None)
xshade.scene().append_point([0.0, 500.0, 0.0], None, None, None, None)
xshade.scene().end_line()
xshade.scene().end_creating()

end_morph_effector

変形ジョイントの作成を終了する。
begin_morph_effector()の後に呼び出して変形ジョイントの作成を終了する。
必ずセットで使用する。 

#変形ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_morph_effector()
xshade.scene().end_morph_effector()
xshade.scene().end_creating()

end_part

パートの作成を終了する。
begin_part()の後に呼び出してパートの作成を終了する。
必ずセットで使用する。 

#パートを作成する
xshade.scene().begin_creating()
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()

end_path_joint

パスジョイントの作成を終了する。
begin_path_joint()の後に呼び出してパスジョイントの作成を終了する。
必ずセットで使用する。 

#パスジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_path_joint()
xshade.scene().end_path_joint()
xshade.scene().end_creating()

end_path_replicator

パスリプリケータの作成を終了する。
begin_path_replicator()の後に呼び出してパスリプリケータの作成を終了する。
必ずセットで使用する。 

#パスリプリケータを作成する
xshade.scene().begin_creating()
xshade.scene().begin_path_replicator()
xshade.scene().end_path_replicator()
xshade.scene().end_creating()

end_polygon_mesh

ポリゴンメッシュの作成を終了する。
#begin_polygon_mesh｜begin_polygon_mesh()の後に呼び出してポリゴンメッシュの作成を終了する。
必ずセットで使用する。 

#３頂点３稜線からなるポリゴンメッシを作成する
xshade.scene().begin_creating()
xshade.scene().begin_polygon_mesh(None)
xshade.scene().append_polygon_mesh_vertex([0.0,0.0,0.0])
xshade.scene().append_polygon_mesh_vertex([100.0,0.0,0.0])
xshade.scene().append_polygon_mesh_vertex([50.0,100.0,0.0])
xshade.scene().append_polygon_mesh_edge(0,1)
xshade.scene().append_polygon_mesh_edge(1,2)
xshade.scene().append_polygon_mesh_edge(2,0)
xshade.scene().end_polygon_mesh()
xshade.scene().end_creating()

end_rotator_joint

回転ジョイントの作成を終了する。
begin_rotator_joint()の後に呼び出して回転ジョイントの作成を終了する。
必ずセットで使用する。 

#原点からＹ軸に100の回転ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_rotator_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_rotator_joint()
xshade.scene().end_creating()

end_scale_joint

拡大縮小ジョイントの作成を終了する。
begin_scale_joint()の後に呼び出して拡大縮小ジョイントの作成を終了する。
必ずセットで使用する。 

#原点からY軸に100の拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_scale_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_scale_joint()
xshade.scene().end_creating()

end_slider_joint

直線移動ジョイントの作成を終了する。
begin_slider_joint()の後に呼び出して直線移動ジョイントの作成を終了する。
必ずセットで使用する。 

#原点からY軸に100の直線移動ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_slider_joint((0.0,0.0,0.0),(0.0,100.0,0.0))
xshade.scene().end_slider_joint()
xshade.scene().end_creating()

end_sound_object

サウンド形状の作成を終了する。
begin_sound_object()の後に呼び出してサウンド形状の作成を終了する。
必ずセットで使用する。 

#aiffのサウンドファイルからサウンド形状を原点に半径100で作成する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.aiff|aiff')
xshade.scene().begin_creating()
xshade.scene().begin_sound_object(file_path,(0.0,0.0,0.0),100)
xshade.scene().end_sound_object()
xshade.scene().end_creating()

end_surface_part

自由曲面パートの作成を終了する。
begin_surface_part()の後に呼び出して自由曲面パートの作成を終了する。
必ずセットで使用する。 

#自由曲面パートを作成する
xshade.scene().begin_creating()
xshade.scene().begin_surface_part()
xshade.scene().end_surface_part()
xshade.scene().end_creating()

end_surface_replicator

サーフェスリプリケータの作成を終了する。
begin_surface_replicator()の後に呼び出してサーフェスリプリケータパートの作成を終了する。
必ずセットで使用する。 

#サーフェスリプリケータを作成する
xshade.scene().begin_creating()
xshade.scene().begin_surface_replicator()
xshade.scene().end_surface_replicator()
xshade.scene().end_creating()

end_switch_effector

スイッチの作成を終了する。
begin_switch_effector()の後に呼び出してスイッチの作成を終了する。
必ずセットで使用する。 

#スイッチを作成する
xshade.scene().begin_creating()
xshade.scene().begin_switch_effector()
xshade.scene().end_switch_effector()
xshade.scene().end_creating()

end_truetype

TrueType（２次のベジェ曲線）の作成を終了する。
begin_truetype()の後に呼び出してTrueType形状の作成を終了する。
必ずセットで使用する。 

#ポイント３つからなるTrueType形状を作成する
xshade.scene().begin_creating()
xshade.scene().begin_truetype(None, False)
xshade.scene().append_truetype_point(True,0.0, 0.0, 0.0)
xshade.scene().append_truetype_point(False,100.0, 100.0, 0.0)
xshade.scene().append_truetype_point(True,200.0, 0.0, 0.0)
xshade.scene().end_truetype()
xshade.scene().end_creating()

end_uniscale_joint

均等拡大縮小ジョイントの作成を終了する。
begin_uniscale_joint()の後に呼び出してTrueType形状の作成を終了する。
必ずセットで使用する。 

#原点に半径100で均等拡大縮小ジョイントを作成する
xshade.scene().begin_creating()
xshade.scene().begin_uniscale_joint((0.0,0.0,0.0),100)
xshade.scene().end_uniscale_joint()
xshade.scene().end_creating()

enter_create_line_mode

線形状作成モードに入る。
引数 :
　　bool : True : 閉じた線形状、False : 開いた線形状
参照 :
　　is_create_line_mode()　線形状作成モードかどうか
　　exit_create_line_mode()　線形状作成モードから抜ける 

#閉じた線形状の作成モードに入る
xshade.scene().enter_create_line_mode(True)

enter_modify_mode

形状編集モードに入る。
参照 :
　　is_modify_mode()　形状編集モードかどうか
　　exit_modify_mode()　形状編集モードから抜ける 

xshade.scene().enter_modify_mode()

exit_create_line_mode

線形状作成モードから抜ける。
参照 :
　　enter_create_line_mode()　線形状作成モードに入る 

xshade.scene().exit_create_line_mode()

exit_modify_mode

形状編集モードから抜ける。
参照 :
　　is_modify_mode()　形状編集モードかどうか
　　enter_modify_mode()　形状編集モードに入る 

xshade.scene().exit_modify_mode()

export_scene

シーンデータをエクスポートする
引数 :
　　file_path
引数 :
　　int :

0外部参照を維持
1外部参照をシーンに取り込む
2外部参照を同じフォルダにコピーする 
#外部参照を維持してシーンデータをエクスポートする
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().export_scene(file_path, 0)

export_with_uuid

uuid付きでファイルを書き出す。
引数 :
　　uuid: 128ビットの数値
引数 :
　　file_path
参照 :
　　uuid 

#uuidを指定してファイルを書き出す
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().export_with_uuid('583DA72C-F329-469E-BEDE-A0349DEAC74B', file_path)

fit_to_window

図面に合わせる。
型 :
　　key :省略可 : 省略時シーン全体を対象とする、0x01 : 選択形状を対象とする 

xshade.scene().fit_to_window()

flip_hide_faces

形状編集モード時、面の表示/非表示状態を反転させる。

xshade.scene().flip_hide_faces()

force_update

画面描画を強制する。 

xshade.scene().force_update()

get_grid_shown

指定したビューのグリッドのオン／オフを返す。
戻り値 :
　　bool
引数 :
　　int : ビューのインデックス

1左上ビュー3右上ビュー
2左下ビュー0右下ビュー

参照 :
　　set_grid_shown 

#右下ビューのグリッドのオン／オフを出力する
print xshade.scene().get_grid_shown(0)

get_ik

IK管理クラスを取得する。
戻り値 :
　　ikオブジェクト

ik=xshade.scene().get_ik()

get_shape_by_name

指定した名前を持つ形状を返す。
戻り値 :
　　shapeオブジェクト
引数 :
　　string : 形状の名前
引数 :
　　bool : False : ユーザーが付けた名前のみ有効、True : デフォルトの名前も有効 

#デフォルト含め「閉じた線形状」を取得して選択状態にする
obj = xshade.scene().get_shape_by_name('閉じた線形状',True)
obj.activate()

get_shape_by_ordinal

序数で指定された形状を返す。
戻り値 :
　　shapeオブジェクト
引数 :
　　int : 序数
序数はブラウザ上の「ルートパート」を０として順番に決定される。
参照 :
　　shape.ordinal 

#序数1を選択状態にする
xshade.scene().get_shape_by_ordinal(1).activate()

get_shape_by_position

ブラウザ上の位置から形状を返す。
戻り値 :
　　shapeオブジェクト
引数 :
　　intのタプル／リスト : ポジションのリスト
ルートパートを０階層目として、以下をリスト形式で階層化し、その階層リストで形状を取得する。

#パート[1]の名称を出力する
print xshade.scene().get_shape_by_position([1]).name
#自由曲面内の２番目の閉じた線形状の名称を出力する
print xshade.scene().get_shape_by_position([2,2,2]).name

get_shape_by_uuid

uuidで指定された形状を返す。
引数 :
　　uuid : 128ビットの数値
戻り値 :
　　shapeオブジェクト
参照 :
　　uuid 

#uuidがeaf7a92f-160c-492b-9411-07a6efeeea92の形状を選択する
xshade.scene().get_shape_by_uuid('eaf7a92f-160c-492b-9411-07a6efeeea92').activate()

get_shapes_by_name

指定された名前を持つ形状のタプルを返す。
戻り値 :
　　shapeオブジェクトのタプル
引数 :
　　string : 形状の名前
引数 :
　　bool : False : ユーザーが付けた名前のみ有効、True : デフォルトの名前も有効 

#デフォルト含め「円」を取得してすべて選択状態にする
shapes = xshade.scene().get_shapes_by_name('円',True)
xshade.scene().active_shapes = shapes

get_view_rectangle

引数で指定された図面のディスプレイ上の矩形領域を返す。
戻り値 :
　　rectangle
引数 :
　　int : ビューのインデックス

1左上ビュー3右上ビュー
2左下ビュー0右下ビュー
4分割図 
#左下ビューの矩形領域を返す
print xshade.scene().get_view_rectangle(2)

hide_active

選択されている形状を隠す。 

xshade.scene().hide_active()

hide_inactive

選択されていない形状を隠す。 

xshade.scene().hide_inactive()

hide_select_faces

形状編集モード時、選択形状の選択されている面を非表示にする。 

xshade.scene().hide_select_faces()

hide_unselect_faces

形状編集モード時、選択形状の選択されていない面を非表示にする。 

xshade.scene().hide_unselect_faces()

iron

アイロンを行う 

xshade.scene().iron()

link

選択しているパートを記憶している形状にリンクする。 

xshade.scene().link()

link_object

選択されている形状を参照するリンク形状を作成する。
引数 :
　　vec3 : 中心点
引数 :
　　float3 : スケール
引数 :
　　float3 : 回転
引数 :
　　float3 : 直線移動
形状の作成される階層のローカル座標系が基準となる。 

#原点にリンク形状を作成する
xshade.scene().link_object((0.0, 0.0, 0.0),None,None,None)

load_3DS

3DSファイルをインポートする。
引数 :
　　file_path : 拡張子(*.3ds) : Noneでファイルダイアログを開く。
参照 :
　　save_3DS 

#3dsファイルをインポートする
xshade.scene().load_3DS(None)

load_BVH

BVHファイルをインポートする。
引数 :
　　file_path : 拡張子(*.bvh) : Noneでファイルダイアログを開く。 

#bvhファイルをインポートする
xshade.scene().load_BVH(None)

load_DXF

DXFファイルをインポートする。
引数 :
　　file_path : 拡張子(*.dxf) : Noneでファイルダイアログを開く。
参照 :
　　save_DXF 

#dxfファイルをインポートする
xshade.scene().load_DXF(None)

load_OBJ

wavefrontOBJファイルをインポートする。
引数 :
　　file_path : 拡張子(*.obj) : Noneでファイルダイアログを開く。
参照 :
　　save_OBJ 

#objファイルをインポートする
xshade.scene().load_OBJ(None)

load_pose

shadeのポーズファイルをインポートする。
引数 :
　　file_path : 拡張子(*.shdpse) : Noneでファイルダイアログを開く。
参照 :
　　save_pose 

#ポーズファイルをインポートする
xshade.scene().load_pose(None)

load_shape

Shadeの形状データをインポートする。
引数 :
　　file_path : 拡張子(*.shd) : Noneでファイルダイアログを開く。
引数 :
　　bool : 省略可（vec3を指定する場合省略不可）
　　True : インポートするシーンの原点を基準にインポート。option(Mac)、z(Win)を押しながら操作した時と同じ。
　　False : インポートするシーンのカーソル位置を基準にインポート。
引数 :
　　vec3 : インポートの基準となる座標 : 省略可
参照 :
　　save_shape 

#shdの形状データを原点に座標指定してインポートする
xshade.scene().load_shape(None, True, [0.0, 0.0, 0.0])

load_template_image_to_front_view

左下ビューにテンプレートを読み込む。
引数 :
　　file_path 

#jpgファイルを左下ビューに読み込む
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.jpg|jpg')
xshade.scene().load_template_image_to_front_view(file_path)

load_template_image_to_pers_view

右上ビューにテンプレートを読み込む。
引数 :
　　file_path 

#jpgファイルを右上ビューに読み込む
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.jpg|jpg')
xshade.scene().load_template_image_to_pers_view(file_path)

load_template_image_to_side_view

右下ビューにテンプレートを読み込む。
引数 :
　　file_path 

#jpgファイルを右下ビューに読み込む
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.jpg|jpg')
xshade.scene().load_template_image_to_side_view(file_path)

load_template_image_to_top_view

左上ビューにテンプレートを読み込む。
引数 :
　　file_path 

#jpgファイルを左上ビューに読み込む
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.jpg|jpg')
xshade.scene().load_template_image_to_top_view(file_path)

load_text

XMLテキストファイルをインポートする。
引数 :
　　file_path : 拡張子(*.xmlshd) : Noneでファイルダイアログを開く。
参照 :
　　save_text 

#xmlファイルをインポートする
xshade.scene().load_text(None)

magnify

図形ウインドウを拡大表示する。
引数 :
　　vec3 : 中心位置 : 省略可能 : 省略時は原点

#原点を中心に拡大表示する
xshade.scene().magnify((0.0, 0.0, 0.0))

memorized_shape

記憶されている形状を返す。
戻り値 :
　　shapeオブジェクト : 記憶されている形状 

#記憶されている形状を選択する
xshade.scene().memorized_shape().activate()

memory

選択されている線形状を記憶する。 

xshade.scene().memory()

move_object

形状の回転、拡大縮小、移動を行う。
引数 :
　　vec3 : 中心点
引数 :
　　float3 : スケール
引数 :
　　float3 : 回転
引数 :
　　float3 : 直線移動
参照 :
　　copy_object 

#X方向に1.5倍する
xshade.scene().move_object([0.0, 0.0, 0.0], [1.5, 1.0, 1.0], None, None)

paste

クリップボードからシーンに形状を貼り付けする。 

xshade.scene().paste()

place_brother

選択された形状を下に移動する。
引数 :
　　int : 移動する数 

xshade.scene().place_brother(1)

place_child

選択された形状を下に位置するパート内に移動する。
引数 :
　　int : 移動するパート内での数 

xshade.scene().place_child(1)

place_parent

選択された形状を上の階層の先頭に移動する。
引数 :
　　int : 移動する階層の数 

xshade.scene().place_parent(1)

place_sister

選択された形状を前に移動する。
引数 :
　　int : 移動する数 

xshade.scene().place_sister(1)

print_

レンダリングイメージを印刷する。 

xshade.scene().print_()

read

ファイルからシーンを読み込む。
引数 :
　　file_path
インポートではなく、現在のシーンを破棄してシーンを読み込む。 

#シーンファイルを読み込む
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.shd|shd')
xshade.scene().read(file_path)

repeat

リピートを行う。
引数 :
　　int : 回数 : 省略時１
moveとcopy操作にのみ対応。 

xshade.scene().repeat()

reset_all_transformation

選択したパートに含まれるすべてのパートのマトリックスを単位マトリックスに設定する。
形状の変形状態は変更されない。 

xshade.scene().reset_all_transformation()

reset_transformation

選択したパートのマトリックスを単位マトリックスに設定する。
形状の変形状態は変更されない。 

xshade.scene().reset_transformation()

reverse

逆転を行う。 

xshade.scene().reverse()

revert_to_saved

開いているShadeファイルを保存した状態に復帰する。 

xshade.scene().revert_to_saved()

round_edge

角の丸めを行う。
引数 :
　　float : 半径 

#半径50で角の丸めを行う
xshade.scene().round_edge(50)

save

シーンを上書き保存する。
新規形状の場合はファイルダイアログが表示される。
参照 :
　　xshade.open_scene() 

xshade.scene().save()

save_3DS

3DSファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.3ds) : Noneでファイルダイアログを開く。
参照 :
　　load_3DS 

#3dsファイルをエクスポートする
xshade.scene().save_3DS(None)

save_Animation_Master

AnimationMasterのセグメントファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.seg) : Noneでファイルダイアログを開く。 

#AnimationMasterのセグメントファイルをエクスポートする
xshade.scene().save_Animation_Master(None)

save_as

シーンをファイルダイアログを表示してファイルに保存する。 

#シーンを保存する
xshade.scene().save_as()

save_DXF

DXFファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.dxf) : Noneでファイルダイアログを開く。
参照 :
　　load_DXF 

#DXFファイルをエクスポートする
xshade.scene().save_DXF(None)

save_EPX

EPixファイルとしてエクスポートする。
引数 :
　　file_path
あらかじめマルチパスでZ値と形状ID（または表面材質ID）の２つのパスを指定してレンダリングしておく必要がある。
参照 :
　　multipath_rendering　マルチパスを保持するのオン／オフ
　　set_image_layer_enable　レイヤーのオン／オフ 

#epxファイルをエクスポートする
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.epx|epx')
xshade.scene().save_EPX(file_path)

save_FBX

FBXファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.fbx) : Noneでファイルダイアログを開く。

#FBXファイルをエクスポートする
xshade.scene().save_FBX(None)

save_image

レンダリングイメージをファイルに保存する。
引数 :
　　file_path
画像形式は拡張子で指定する。

■MacOSX
PNG *.png
TIFF *.tif, *.tiff
Windows Bitmap *.bmp
JPEG *.jpg, *.jpeg
JPEG 2000 *.jp2
GIF *.gif
OpenEXR *.exr
Targa *.tga
HDR *.hdr
PFM *.pfm
MPO *.mpo
Flash *.swf
Photoshop *.psd


■Windows
BMP *.bmp, *.dib, *.rle
JPEG *.jpg, *.jpeg, *.jpe, *.jfif, *.jif
GIF *.gif
TIFF *.tif, *.tiff
PNG *.png
OpenEXR *.exr
Targa *.tga
TARGA *.targa
HDR *.hdr
PFM *.pfm
MPO *.mpo
Flash *.swf
Photoshop *.psd 
#レンダリングイメージをpsd形式で保存する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.psd|psd')
xshade.scene().save_image(file_path)

save_images

レンダリングイメージをマルチレイヤー形式でファイルに保存する。
引数 :
　　file_path
あらかじめマルチレイヤー形式でレンダリングしておく必要がある。 

#photoshopのレイヤー形式で保存する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.psd|psd')
xshade.scene().save_images(file_path)

save_local_axis

座標系（一時使用）を保存する。
戻り値 :
　　part
参照 :
　　create_local_axis 

xshade.scene().save_local_axis()

save_OBJ

wavefrontOBJファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.obj) : Noneでファイルダイアログを開く。
参照 :
　　load_OBJ 

#wavefrontOBJファイルをエクスポートする
xshade.scene().save_OBJ(None)

save_pose

ポーズファイルをエクスポートする。
引数 :
　　file_path : 拡張子(*.shdpse) : Noneでファイルダイアログを開く。
参照 :
　　load_pose 

#ポーズファイルをエクスポートする
xshade.scene().save_pose(None)

save_RIB

RIBファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.rib) : Noneでファイルダイアログを開く 

#RIBファイルをクスポートする
xshade.scene().save_RIB(None)

save_shape

Shadeの形状ファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.shd) : Noneでファイルダイアログを開く。
参照 :
　　load_shape 

#Shadeの形状ファイルをsample.shdでエクスポートする
xshade.scene().save_shape(None)

save_text

XMLテキストファイルとしてエクスポートする。
引数 :
　　file_path
参照 :
　　load_text 

#XMLテキストファイルをエクスポートする
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.xmlshd|xmlshd')
xshade.scene().save_text(file_path)

save_VRML

VRMLファイルとしてエクスポートする。
引数 :
　　file_path : 拡張子(*.wrl) : Noneでファイルダイアログを開く。 

#VRMLファイルをsample.wrlでエクスポートする
xshade.scene().save_VRML(None)

save_VRML_2

VRMLファイルとしてファイルダイアログを表示してエクスポートする。 

xshade.scene().save_VRML_2()

scroll

図形ウインドウをスクロールする。
引数 :
　　vec3 : 中心位置 

#原点にスクロールする
xshade.scene().scroll([0.0, 0.0, 0.0])

select_all

オブジェクトモードではルート形状を選択する。
形状編集モードでは選択形状のすべてのコントロールポイントを選択する。 

xshade.scene().select_all()

select_brother

選択された形状の次の形状を選択する。
戻り値 :
　　bool
引数 :
　　int : 次の数 : 省略可能 : 省略時１ 

xshade.scene().select_brother()

select_child

選択された形状の下に位置するパート内の形状を選択する。
戻り値 :
　　bool
引数 :

　　int : パート内での数 : 省略可能 : 省略時１
xshade.scene().select_child()

select_parent

選択されている形状の上の階層を選択する。
戻り値 :
　　bool
引数 :
　　int : 階層の数 : 省略可能 : 省略時１ 

xshade.scene().select_parent()

select_sister

選択された形状の前の形状を選択する。
戻り値 :
　　bool
引数 :
　　int : 前の数 : 省略可能 : 省略時１ 

xshade.scene().select_sister()

sequence_world_to_device_matrix

指定シーケンスのワールド座標系からデバイス座標系へ変換するマトリクスを返す。
引数 :
　　int
戻り値 :
　　mat4

print xshade.scene(). sequence_world_to_device_matrix(0)

sequence_world_to_perspective_matrix

指定シーケンスのワールド座標系から透視図座標系へ変換するマトリクスを返す。
引数 :
　　int
戻り値 :
　　mat4

print xshade.scene(). sequence_world_to_perspective_matrix(0)

sequence_world_to_view_matrix

指定シーケンスのワールド座標系からビュー座標系へ変換するマトリクスを返す。
引数 :
　　int
戻り値 :
　　mat4

print xshade.scene(). sequence_world_to_view_matrix(0)

set_grid_shown

指定したビューのグリッドのオン／オフを設定する。
引数 :
　　int : ビューのインデックス

1左上ビュー3右上ビュー
2左下ビュー0右下ビュー

引数 :
　　bool
参照 :
　　get_grid_shown 

#右下ビューのグリッドをオンにする
xshade.scene().set_grid_shown(0, True)

show_active

選択されている形状を表示する。 

xshade.scene().show_active()

show_all

すべての形状を表示する 

xshade.scene().show_all()

show_all_faces

形状編集モード時、選択形状のすべての面を表示する。 

xshade.scene().show_all_faces()

shrink

図形ウインドウを縮小表示する。
引数 :
　　vec3 : 中心位置 : 省略可能 

xshade.scene().shrink()

smooth

スムーズを行う。 

xshade.scene().smooth()

solid_clear

掃引体／回転体をもとの状態に戻す。 

xshade.scene().solid_clear()

solid_extrude

掃引体を作成する。
引数 :
　　float3 : 掃引距離ベクトル 

#Z方向に500の掃引体を作成する
xshade.scene().solid_extrude((0.0, 0.0, 500.0))

solid_revolve

回転体を作成する。
引数 :
　　vec3 : 回転軸の端点
引数 :
　　vec3 : 回転軸の他方の端点 

#原点とY方向10の軸で回転体を作成する
xshade.scene().solid_revolve((0.0, 0.0, 0.0), (0.0, 10.0, 0.0))

sweep

掃引を行う。 

xshade.scene().sweep()

switch

切り換えを行う。 

xshade.scene().switch()

unsmooth

アンスムーズを行う 

xshade.scene().unsmooth()

update_figure_window

図形ウインドウを更新する 

xshade.scene().update_figure_window()

use_global

図形ウインドウの表示をグローバル座標にする 

xshade.scene().use_global()

use_local

図形ウインドウの表示を選択されている形状のローカル座標にする 

xshade.scene().use_local()

use_local_axis

指定した座標系を使用する。
引数 :
　　string

xshade.scene().use_local_axis('座標系[1]')

write

Shadeシーンファイルを保存する。
引数 :
　　file_path : 拡張子(*.shd) : Noneでファイルダイアログを開く。 

#シーンファイルを保存する
xshade.scene().write(None)

write_compatible

Shadeシーンファイルに互換情報を追加して保存する
引数 :
　　file_path 

#互換情報を追加して保存する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().write_compatible(file_path)

write_noncompatible

Shadeシーンファイルに互換情報を追加せずに保存する
引数 :
　　file_path 

#互換情報を追加せずに保存する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().write_noncompatible(file_path)

write_R4compatible

ShadeシーンファイルにR4互換情報を追加して保存する
引数 :
　　file_path 

#R4互換情報を追加して保存する
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().write_R4compatible(file_path)

write_xml

ShadeシーンファイルをXMLとして保存
引数 :
　　file_path 

dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shd|shd')
xshade.scene().write_xml(file_path)


プロパティ詳細

active_shapes

現在選択されている形状のリスト。

  • 取得
  • 設定

型 :
　　shapeオブジェクト 

#選択形状の名称を順に出力する
for i in xshade.scene().active_shapes:
	print i.name

animation_settings

シーンのアニメーション。

  • 取得
  • 設定

型 :
　　animation_settingsオブジェクト
参照 :
　　animation_settings 

#フレームレートを出力する
print xshade.scene().animation_settings.frame_rate

background

シーンの background。

  • 取得
  • 設定

型 :
　　backgroundオブジェクト
参照 :
　　background 

#下半球の色を出力する
print xshade.scene(). background.lower_base_color

camera

シーンの現在選択されているカメラ。

  • 取得
  • 設定

型 :
　　cameraオブジェクト
参照 :
　　camera 

#視点の位置を出力する
print xshade.scene().camera.eye

can_create

新規形状作成に機能制限がかかっているか。

  • 取得
  • 設定

型 :
　　bool : Trueを返すのが正常値。 

print xshade.scene().can_create

can_export_foreign

Shadeと直接関係無いフォーマットへのエクスポートに機能制限がかかっているか。

  • 取得
  • 設定

型 :
　　bool : Trueを返すのが正常値。 

print xshade.scene().can_export_foreign

can_export_native

Shade関係のフォーマットへのエクスポートに機能制限がかかっているか。

  • 取得
  • 設定

型 :
　　bool : Trueを返すのが正常値。 

print xshade.scene().can_export_native

can_save

シーンの保存に機能制限がかかっているか。

  • 取得
  • 設定

型 :
　　bool : Trueを返すのが正常値。 

print xshade.scene().can_save

can_save_rendered_image

レンダリングイメージのファイルへの保存に機能制限がかかっているか。

  • 取得
  • 設定

型 :
　　bool : Trueを返すのが正常値。 

print xshade.scene().can_save_rendered_image

center

三面図の中心の座標。

  • 取得
  • 設定

型 :
　　vec3 

print xshade.scene().center

color_mode

図形ウインドウ表示のカラーモード。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().color_mode

correction

シーンの色補正。

  • 取得
  • 設定

型 :
　　correctionオブジェクト
参照 :
　　correction 

#コントラストを出力する
print xshade.scene().correction.contrast

current_camera

現在選択されているカメラのインデックス値。

  • 取得
  • 設定

型 :
　　int 

print xshade.scene().current_camera

current_cursor_position

現在の図形ウィンドウの三次元カーソル座標値。

  • 取得
  • 設定

型 :
　　vec3 

print xshade.scene().current_cursor_position

cursor_plane

透視図のカーソル面。

  • 取得
  • 設定

型 :
　　int : 0 : YZ、1 : XZ、2 : XY、3 : スクリーン 

print xshade.scene().cursor_plane

cursor_position

図形ウインドウ内の三次元カーソル座標値（クリックした位置）。

  • 取得
  • 設定

型 :
　　vec3 

print xshade.scene().cursor_position

default_bevel_radius

角の丸め・角の切り落としの初期設定値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().default_bevel_radius

default_disk_radius

円の半径の初期設定値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().default_disk_radius

default_light_radius

光源の明るさの初期設定値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().default_light_radius

default_radius

線形状の角の丸め、角の切り落としの半径の初期設定値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().default_radius

default_sphere_radius

球の半径の初期設定値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().default_sphere_radius

dirty

シーンがダーティかどうか。

  • 取得
  • 設定

型 :
　　bool
開いたシーンに何か操作を行うとダーディとなる。
ダーディなシーンを閉じるときは「保存しますか？」のダイアログが表示される。 

print xshade.scene().dirty

display

シーンの図形ウインドウ。

  • 取得
  • 設定

型 :
　　displayオブジェクト
参照 :
　　display 

#すべてのビューのグリッドを表示する
xshade.scene().display.grid = True

distant_light

シーンの無限遠光源。

  • 取得
  • 設定

型 :
　　distant_lightオブジェクト
参照 :
　　distant_light 

#選択されている無限遠光源の番号を出力する
print xshade.scene().distant_light.active_item

figure_view_mode

図形ウインドウのビューモード。

  • 取得
  • 設定

型 :
　　int : ビューのインデックス

1左上ビュー3右上ビュー
2左下ビュー0右下ビュー
4分割図 
print xshade.scene().figure_view_mode

figure_window

シーンの図形ウインドウ。

  • 取得
  • 設定

型 :
　　figure_windowオブジェクト
参照 :
　　figure_window 

#図形ウインドウを隠す
xshade.scene().figure_window.hide()

file_path

保存されているシーンのファイルパス。

  • 取得
  • 設定

型 :
　　file_path 

print xshade.scene().file_path

fog

シーンの無限遠光源のフォグ。

  • 取得
  • 設定

型 :
　　fogオブジェクト
参照 :
　　fog 

#フォグの色を出力する
print xshade.scene().fog.color

fps

シーンのfps。

  • 取得
  • 設定

型 :
　　int 

print xshade.scene().fps

grid

グリッド表示のオン／オフ。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().grid

insertion_shape

begin_creating()で形状を作成したときに、挿入される位置の形状のshapeクラス。

  • 取得
  • 設定

型 :
　　shapeオブジェクト 

#パート作成時に挿入される位置の形状の名前を出力する
xshade.scene().begin_creating()
obj = xshade.scene().insertion_shape
xshade.scene().begin_part()
xshade.scene().end_part()
xshade.scene().end_creating()
print obj.name

is_create_line_mode

線形状作成モードかどうか。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().is_create_line_mode

is_locked

ロックファイルかどか

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().is_locked

is_modify_mode

形状編集モードかどうか。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().is_modify_mode

is_motion_playing

モーションウインドウが再生中かどうか

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().is_motion_playing

keyframes

シーンのキーフレーム。

  • 取得
  • 設定

型 :
　　keyframesオブジェクト
参照 :
　　keyframes 

#選択されているキーフレームを削除する
xshade.scene().keyframes.delete_active_keyframes()

large_cursor

ラージカーソル表示のオン／オフ。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().large_cursor

large_point

ラージポイント表示のオン／オフ

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().large_point

lathe_rotation

ろくろの回転。

  • 取得
  • 設定

型 :
　　quaternion 

print xshade.scene().lathe_rotation

light_scale

光源のスケール。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().light_scale

local

ローカル座標の基準となるパート。

  • 取得
  • 設定

型 :
　　shapeオブジェクト
ローカルモードで取得可能 

#基準パートの名称を出力する
print xshade.scene().local.name

local_matrix

ローカル座標モードの変換マトリクス。

  • 取得
  • 設定

型 :
　　mat4 

print xshade.scene().local_matrix

manip_type

マニピュレータのタイプ。

  • 取得
  • 設定

型 :
　　int : 0:無し、1:統合マニピュレータ、2:直線移動マニピュレータ、3:拡大縮小マニピュレータ、4:回転マニピュレータ 

print xshade.scene().manip_type

mapping_modify_mode

マッピングモディファイモードかどうか。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().mapping_modify_mode

native_to_user_unit

ネイティブ単位（mm）からユーザが設定した単位に変換する係数。

  • 取得
  • 設定

型 :
　　float
参照 :
　　user_to_native_unit 

print xshade.scene().native_to_user_unit

number_of_appended_points

作成中の線形状のコントロールポイントの数。

  • 取得
  • 設定

型 :
　　int 

#線形状を作成しながらコントロールポイント数を出力する
#上から順に０、１、２が出力される
xshade.scene().begin_creating()
xshade.scene().begin_line(None, False)
print xshade.scene().number_of_appended_points
xshade.scene().append_point([0.0, 0.0, 0.0], None, None, None, None)
print xshade.scene().number_of_appended_points
xshade.scene().append_point([0.0, 500.0, 0.0], None, None, None, None)
print xshade.scene().number_of_appended_points
xshade.scene().end_line()
xshade.scene().end_creating()

number_of_cameras

カメラの数。

  • 取得
  • 設定

型 :
　　int 

print xshade.scene().number_of_cameras

number_of_memorized_shapes

記憶された形状の数。

  • 取得
  • 設定

型 :
　　int
記憶された形状があれば１、なければ０を返す。 

print xshade.scene().number_of_memorized_shapes

number_of_metacameras

メタカメラの数。

  • 取得
  • 設定

型 :
　　int 

print xshade.scene().number_of_metacameras

pers_grid

透視図グリッド表示のオン／オフ。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().pers_grid

pivot_position

ピボット座標。

  • 取得
  • 設定

型 :
　　vec3

print xshade.scene().pivot_position

pixel_size

図形ウインドウの拡大、縮小の状態。

  • 取得
  • 設定

型 :
　　int : ドット１で10
ディスプレイ上の1ピクセルのシーン上の大きさが返される。
副グリッドの幅はこの10倍となる 

print xshade.scene().pixel_size

radiosity

シーンのラジオシティ。

  • 取得
  • 設定

型 :
　　radiosityオブジェクト
参照 :
　　radiosity 

#メッシュの最小間隔を出力する
print xshade.scene().radiosity.solution_minimum_mesh_spacing

rendering

シーンの rendering。

  • 取得
  • 設定

型 :
　　renderingオブジェクト
参照 :
　　rendering 

#レンダリングする
xshade.scene().rendering.render()

selection_method

ツールボックスの選択モード。

  • 取得
  • 設定

型 :
　　int :

0ボックス
1ロープ
2トレース

tool_box_view().update()で変更が反映される

#選択モードをロープにする
xshade.scene().selection_method = 1
xshade.tool_box_view().update()

selection_mode

メッシュ編集ツールの選択モード。

  • 取得
  • 設定

型 :
　　int :

0面選択
1稜線選択
2頂点選択 
#選択モードを頂点選択にする
xshade.scene().selection_mode = 2

sequence_mode

シーンがシーケンスモードかどうか。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().sequence_mode

sequence_value

モーションウインドウのシーケンス値。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().sequence_value

shape

ルートの形状オブジェクト。

  • 取得
  • 設定

型 :
　　shapeオブジェクト
参照 :
　　shape 

#ルートパートのuuidを出力する
print xshade.scene().shape.uuid

show_normals

法線を表示するかどうか

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().show_normals

snap

スナップのオン／オフ。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().snap

step_frames

アニメーション作成のステップフレーム数(float)。

  • 取得
  • 設定

型 :
　　float 

print xshade.scene().step_frames

template

テンプレート表示のオン／オフ。

  • 取得
  • 設定

型 :
　　bool 

print xshade.scene().template

unit

単位の値。

  • 取得
  • 設定

型 :
　　int :

0mm (Shadeのネイティブ単位系)
1cm
2m
3km
4inch
5foot
6yard
7mile 
print xshade.scene().unit

user_to_native_unit

ユーザが設定した単位からネイティブ単位（mm）に変換する係数。

  • 取得
  • 設定

型 :
　　float
参照 :
　　native_to_user_unit 

print xshade.scene().user_to_native_unit

user_to_world_matrix

ユーザ座標系からワールド座標系に変換するマトリクス。

  • 取得
  • 設定

型 :
　　mat4
ユーザ座標系はろくろ、ローカル・グローバルモードを考慮した、図形ウインドウで表示されている状態の座標系。
形状の移動をろくろの回転を考慮して行う場合などに使用する。
参照 :
　　world_to_user_matrix 

print xshade.scene().user_to_world_matrix

window_frame

図形ウインドウのフレーム。
型 :
　　rectangle 

print xshade.scene().window_frame

work_plane

作業平面のオン／オフ。

  • 取得
  • 設定

型 :
　　bool

print xshade.scene().work_plane

world_to_device_matrix

ワールド座標系からデバイス座標系に変換するマトリクス。

  • 取得
  • 設定

型 :
　　mat4
カメラの位置や向き、傾きを考慮してワールド座標系を回転、移動、正規化させるマトリクス。
視点が原点に一致し、視線の向きがZ軸となる。
デバイス座標系とは、ここではレンダリングイメージの座標系（左上を原点してピクセル単位）を意味する視野内の座標について、X, Yの座標がレンダリングイメージのX, Yの位置と一致するように正規化する。 

print xshade.scene().world_to_device_matrix

world_to_perspective_matrix

ワールド座標系からアクティブなカメラの透視座標系に変換するマトリクス。

  • 取得
  • 設定

型 :
　　mat4
カメラの位置や向き、傾きを考慮してワールド座標系を回転、移動、正規化させるマトリクス。
視点が原点に一致し、視線の向きがZ軸となる。
視野内の座標について、縦横を-1.0から1.0 、奥行きを0.0から1.0の範囲に収まるよう正規化するこの範囲外の座標は視野外となるため、クリッピングはこの座標系で行う。 

print xshade.scene().world_to_perspective_matrix

world_to_user_matrix

ワールド座標系からユーザ座標系に変換するマトリクス。

  • 取得
  • 設定

型 :
　　mat4
ユーザ座標系は単位系やろくろ、ローカル・グローバルモードを考慮した、図形ウインドウで表示されている状態の座標系 形状の移動をろくろの回転を考慮して行う場合などに使用する。
参照 :
　　user_to_world_matrix 

print xshade.scene().world_to_user_matrix

world_to_view_matrix

ワールド座標系からアクティブなカメラのビュー座標系に変換するマトリクス。

  • 取得
  • 設定

型 :
　　mat4
カメラの位置や向き、傾きを考慮してワールド座標系を回転、移動させるマトリクス視点が原点に一致し、視線の向きがZ軸となる。
透視変換はかからない。 

print xshade.scene().world_to_view_matrix