Kanzi Studio コマンドリファレンス

ここでは、コマンドラインインターフェースからスクリプトを実行することで実行できる Kanzi Studio コマンドのリファレンスを見つけることができます。Kanzi Studio タスクの自動化 を参照してください。

基本編集

AddToResourceDictionary

リソース辞書に追加

構文

AddToResourceDictionary resourceId resource resourceDictionaryHost

パラメータ

resourceId	リソースID (ID)。
resource	リソースディクショナリに追加するリソース。
resourceDictionaryHost	リソースディクショナリにリソースを追加するノード。

例

# Add the My Mesh mesh to the resource dictionary of the Screen node
# and set the resource ID of My Mesh to My Mesh ID.
AddToResourceDictionary "My Mesh ID" "/Mesh Data/My Mesh" "/Screens/Screen/RootPage/Viewport 2D/Scene"

CreateBindingItem

バインディングを作成します。

構文

CreateBindingItem parent bindingMode pushTarget targetPropertyTypeName attribute code

パラメータ

parent	バインディングを追加するノードまたはレンダーパス。
bindingMode	バインディングモード。ONE_WAYを使用して一方向バインディングを行います。TO_SOURCEを使用してソースへのバインディングを行います。
pushTarget	ソースへのバインディングでのターゲット。片方向バインディングの場合はNULLを使用します。
targetPropertyTypeName	バインドするプロパティ。
attribute	バインドするプロパティフィールド。プロパティ全体をバインドするには、WHOLE_PROPERTYを使用します。
code	バインディング式。

例

# Add to the My Button node a binding that sets the Layout Width of that node
# to 300 pixels less than the width of its parent node, but always between
# 400 and 1200 pixels.
# To improve readability, this example splits the binding expression into two lines.
# Enclose between triple backticks a binding expression that spans multiple lines.
CreateBindingItem "/Screens/Screen/RootPage/My Button" ONE_WAY NULL Node.Width WHOLE_PROPERTY ```parentWidth = {@../Node.ActualWidth}
clamp(400, 1200, parentWidth - 300)```

ExposePrefabProperty

プレハブのルートにプロパティを公開します。これにより、プレハブの各インスタンスでプロパティをカスタマイズすることができます。

プロパティを公開すると、Kanzi Studio は次のことを行います:

1. プロパティからカスタムプロパティを作成します。

2. そのカスタムプロパティをプレハブに追加し、プレハブの各インスタンスでよく使われるプロパティとしてカスタムプロパティを表示します。

3. このアイテムに##Templateバインディングをプレハブルートのカスタムプロパティに作成します。

構文

ExposePrefabProperty source propertyType

パラメータ

source	プロパティを公開するプレハブアイテム。
propertyType	公開するプロパティ。

例

# In the Prefabs create a Button 2D prefab named My Button.
CreateButton2D "/Prefabs" "My Button" true
# In the My Button prefab create an Image node named Image.
CreateImage2D "/Prefabs/My Button/My Button" Image true
# In the Image node expose the Image2D.Image property to the root of the My Button prefab.
# Let Kanzi Studio automatically generate a name for the exposed custom property.
ExposePrefabProperty "/Prefabs/My Button/My Button/Image" Image2D.Image

構文

ExposePrefabProperty source propertyType propertyName

パラメータ

source	プロパティを公開するプレハブアイテム。
propertyType	公開するプロパティ。
propertyName	公開されたカスタムプロパティの名前。

例

# In the Prefabs create a Button 2D prefab named My Button.
CreateButton2D "/Prefabs" "My Button" true
# In the My Button prefab create an Image node named Image.
CreateImage2D "/Prefabs/My Button/My Button" Image true
# In the Image node expose the Image2D.Image property to the root of the My Button prefab
# and name the exposed custom property MyButton.Icon.
ExposePrefabProperty "/Prefabs/My Button/My Button/Image" Image2D.Image MyButton.Icon

高度な編集

AddProperty

アイテムにプロパティを追加します。

構文

AddProperty propertyCollection propertyName valueAsString

パラメータ

propertyCollection	プロパティを追加するノードまたはリソース。
propertyName	追加するプロパティ。
valueAsString	（オプション）プロパティの値。

例

# In the RootPage node add the Description property.
AddProperty "/Screens/Screen/RootPage" Description

# In the RootPage > Button 2D node add the Background Brush property and set it to the DefaultBackground brush.
AddProperty "/Screens/Screen/RootPage/Button 2D" Node2D.BackgroundBrush "/Brushes/DefaultBackground"

AddPropertyNamespaceToPropertyTypes

すべてのプロパティタイプを現在のプロジェクトプロパティネームスペースに移動します。

構文

AddPropertyNamespaceToPropertyTypes

例

# Add the project property namespace to all property types in the project.
AddPropertyNamespaceToPropertyTypes

BakeTransformation

モデルの頂点バッファ内の頂点をノードの現在の変換に従って変換し、変換を単位変換に設定します。

構文

BakeTransformation node

パラメータ

node	頂点データに変換をベイクしたいノード。

例

# Bake the Layout Transformation of the RootPage > Viewport 2D > Scene > Model node
# into the vertex data of the mesh that the node uses.
BakeTransformation "/Screens/Screen/RootPage/Viewport 2D/Scene/Model"

センターメッシュ

メッシュの頂点を中心に配置し、バウンディングボックスの中心が原点に移動するようにします。

構文

CenterMesh meshes

パラメータ

meshes

頂点を中心にしたいメッシュデータリソース。

例

# Center the vertices of the CarBody mesh so that the center of the bounding box moves to origo.
CenterMesh "/Mesh Data/My Mesh"

FlipMesh

メッシュデータ内のポリゴンと法線の方向を反転します。

構文

FlipMesh meshes flipPolygons flipNormals flipTextureCoordinateU flipTextureCoordinateV

パラメータ

meshes	ポリゴン、法線、テクスチャ座標の方向を反転させるメッシュデータ内のメッシュ。メッシュのリストはセミコロンで区切ります。
flipPolygons	メッシュデータ内のポリゴンの方向を法線を変更せずに反転するかどうか。
flipNormals	メッシュデータ内の法線の方向を反転するかどうか。
flipTextureCoordinateU	テクスチャのU座標の方向を反転するかどうか。
flipTextureCoordinateV	テクスチャのV座標の方向を反転するかどうか。

例

# In the MyMesh mesh invert the direction of polygons and normals.
FlipMesh "/Mesh Data/My Mesh" true true false false

# In the MyMesh mesh invert the direction of the U coordinates of textures.
FlipMesh "/Mesh Data/My Mesh" false false true false

GenerateNormals

メッシュの頂点バッファに法線を生成します。

構文

GenerateNormals meshes smoothingAngle

パラメータ

meshes	法線を生成する頂点バッファへのメッシュ。メッシュのリストはセミコロンで区切ります。
smoothingAngle	スムージング角度（度単位）。

例

# Generate normals to the vertex buffer of the My Mesh mesh with a smoothing angle of 60 degrees.
GenerateNormals "/Mesh Data/My Mesh" 60

GenerateTangents

メッシュの頂点バッファに接線を生成します。

構文

GenerateTangents meshes mode

パラメータ

meshes	頂点バッファに接線を生成するメッシュ。メッシュのリストはセミコロンで区切ります。
mode	接線生成モード: AUTOMATIC、MIKKTSPACE、または LEGACY。

例

# Generate tangents to the vertex buffer of the My Mesh mesh using the MikkTSpace tangent space algorithm.
GenerateTangents "/Mesh Data/My Mesh" MIKKTSPACE

構文

GenerateTangents meshes

パラメータ

meshes

頂点バッファに接線を生成するメッシュ。メッシュのリストはセミコロンで区切ります。

例

# Generate tangents to the vertex buffer of the My Mesh mesh. Let Kanzi choose the tangent generation method based on the material.
GenerateTangents "/Mesh Data/My Mesh"

アニメーションを最適化する

データのないすべてのアニメーションデータリソースを削除し、既存のアニメーションデータアイテムを最適化します。

構文

OptimizeAnimations animations threshold

パラメータ

animations	冗長なキーフレームを削除するアニメーションデータリソース。アニメーションのリストはセミコロンで区切ります。
threshold	キーフレーム削除のためのしきい値。このパラメーターで設定した値よりもアニメーションされた値の変化が小さい場合、Kanzi Studio はキーフレームを削除します。

例

# Remove from the Animation Data resources Animation1 and Animation2
# all keyframes with a delta value smaller than 0.1.
OptimizeAnimations "/Animation Data/Animation1; /Animation Data/Animation2" 0.1

PrintDiagnosticReport

ログに無効なプロジェクトアイテムとそのエラーメッセージを出力します。

構文

PrintDiagnosticReport

例

# Print a list of invalid project items in the main project and loaded referenced projects
# to the Log window and %USERPROFILE%\AppData\Local\Temp\KanziStudioLogs\KanziStudio.log file.
PrintDiagnosticReport

RemovePropertyAndBindingFromItem

アイテムからプロパティと関連するローカルバインディングを削除します。

構文

RemovePropertyAndBindingFromItem host propertyName

パラメータ

host	そのプロパティと、そのプロパティを使用するローカルバインディングを削除するアイテム。
propertyName	削除するプロパティ。

例

# In the RootPage node add a To Source binding that targets the Viewport 2D node.
CreateBindingItem "/Screens/Screen/RootPage" TO_SOURCE "/Screens/Screen/RootPage/Viewport 2D" Node2D.BackgroundBrush WHOLE_PROPERTY ```{@./Node2D.BackgroundBrush}```
# Remove both the property and the To Source binding.
RemovePropertyAndBindingFromItem "/Screens/Screen/RootPage" Node2D.BackgroundBrush

RemovePropertyFromItem

アイテムからプロパティを削除します。

構文

RemovePropertyFromItem host propertyName

パラメータ

host	プロパティを削除するアイテム。
propertyName	削除するプロパティ。

例

# In the RootPage node remove the Background Brush property.
RemovePropertyFromItem "/Screens/Screen/RootPage" Node2D.BackgroundBrush

# In the Library > Rendering > Render Pass Prefabs > Render to Texture Pass prefab root remove the Composition Target property.
RemovePropertyFromItem "/Render Pass Prefabs/Render to Texture Pass/Render to Texture Pass" CompositionTargetRenderPass.CompositionTarget

RenameShaderFiles

すべてのシェーダーファイルを対応するマテリアルタイプ名にリネームします。

構文

RenameShaderFiles materialTypes

パラメータ

materialTypes

シェーダーファイルの名前を変更するマテリアルタイプ。マテリアルタイプのリストはセミコロンで区切ります。

例

# Rename the shader files of My Material Type to My Material Type.frag.glsl and My Material Type.vert.glsl.
RenameShaderFiles "/Material Types/My Material Type"

SetProperty

プロパティ値を設定します。

構文

SetProperty parent propertyName propertyValueAsString

パラメータ

parent	設定したいプロパティを持つノードまたはリソース。
propertyName	プロパティの名前。
propertyValueAsString	プロパティを設定したい値。

例

# In the Screen node set the Metrics Type property to Absolute.
SetProperty "/Screens/Screen" Window.MetricsType Absolute
# In the Screen node set the Width property to 1200.
SetProperty "/Screens/Screen" WindowAbsoluteWidth 1200
# In the Screen node set the Height property to 720.
SetProperty "/Screens/Screen" WindowAbsoluteHeight 720

# In the RootPage node set the Background Brush property to the Color Brush brush.
SetProperty "/Screens/Screen/RootPage" Node2D.BackgroundBrush "/Brushes/Color Brush"

# In the Prefabs > My Stack Layout prefab set the Direction property to Y.
SetProperty "/Prefabs/My Stack Layout/My Stack Layout" StackLayoutConcept.Direction 1

# In the RootPage > My Button node add the Double-Click Enabled property and set it to enabled.
AddProperty "/Screens/Screen/RootPage/My Button" ClickConcept.DoubleClickEnabled true

# In the RootPage node add the Description property and set it to "This is the main page of the application.".
AddProperty "/Screens/Screen/RootPage" Description "This is the main page of the application."

# In the My Text Block node, set the Text property to
# SERVICE
# VEHICLE
# SOON
#
# Enclose between triple backticks a property value that spans multiple lines.
SetProperty "/Screens/Screen/RootPage/My Text Block" TextConcept.Text ```SERVICE
VEHICLE
SOON```
# In the My Text Block node, add the Text Horizontal Alignment property and set it to Center.
AddProperty "/Screens/Screen/RootPage/My Text Block" TextConcept.TextHorizontalAlignment 2

デストロイヤー

DeleteAnimationsWithLessThanTwoEffectiveKeyframes

1つまたは有効なキーフレームがないすべてのアニメーションデータ (Animation Data) アイテムを削除します。同じ値を持つ繰り返しのキーフレームは無効と見なされます。

構文

DeleteAnimationsWithLessThanTwoEffectiveKeyframes animations

パラメータ

animations

削除したいアニメーションは、効果的なキーフレームが1つ以下の場合です。アニメーションのリストはセミコロンで区切ってください。

例

# Delete the Animation1, Animation2, and Animation3 Animation Data items if they have less than two effective keyframes.
DeleteAnimationsWithLessThanTwoEffectiveKeyframes "/Animation Data/Animation1; /Animation Data/Animation2; /Animation Data/Animation3"

DeleteProjectItem

選択したプロジェクトアイテムを削除する

構文

DeleteProjectItem items

パラメータ

items

削除したいノードとリソース。アイテムのリストはセミコロンで区切ります。

例

# Delete the RootPage > Viewport 2D node.
DeleteProjectItem "/Screens/Screen/RootPage/Viewport 2D"

# Delete the RootPage > Button 2D node and Button 2D prefab.
DeleteProjectItem "/Screens/Screen/RootPage/Button 2D; /Prefabs/Button 2D"

# Delete the Library > Materials and Textures > Textures > Default Texture texture.
DeleteProjectItem "/Textures/Default Texture"

# Delete the ColorTextureMaterial material and ColorTexture material type.
DeleteProjectItem "/Materials/ColorTextureMaterial; /Material Types/ColorTexture"

変換

ConvertBindingsToTemplateBindings

テンプレートルートをソースとするバインディングをテンプレートバインディングに変換します。

構文

ConvertBindingsToTemplateBindings targets

パラメータ

targets

バインディングをテンプレートバインディングに変換するノード。

例

# In the Prefabs > Toggle Button 2D > Stack Layout 2D and its child nodes convert
# to template bindings those bindings whose source is the template root.
ConvertBindingsToTemplateBindings "/Prefabs/Toggle Button 2D/Toggle Button 2D/Stack Layout 2D"

ConvertNode2DPrefabPlaceholderToPrefabView2D

このプレハブプレースホルダ2Dノードをプレハブビュー2Dノードに変換します。

プレハブビュー (Prefab View) ノードでプレハブをインスタンス化すると、Kanziはプレハブテンプレートプロパティの値を監視し、そのプロパティが指すプレハブをプレハブビュー (Prefab View) ノードの子ノードとして追加します。これにより、プレハブビュー (Prefab View) がインスタンス化するプレハブを変更し、リソースを読み込んでいる間もアプリケーションの応答性を維持することができます。

構文

ConvertNode2DPrefabPlaceholderToPrefabView2D prefabPlaceholder

パラメータ

prefabPlaceholder

プレハブプレースホルダ2Dノードをプレハブビュー2Dノードに変換します。

例

# Convert the RootPage > Toggle Button 2D Prefab Placeholder 2D node to a Prefab View 2D node.
ConvertNode2DPrefabPlaceholderToPrefabView2D "/Screens/Screen/RootPage/Toggle Button 2D"

ConvertNode3DPrefabPlaceholderToPrefabView3D

このプレハブプレースホルダ3Dノードをプレハブビュー3Dノードに変換します。

プレハブビュー (Prefab View) ノードでプレハブをインスタンス化すると、Kanziはプレハブテンプレートプロパティの値を監視し、そのプロパティが指すプレハブをプレハブビュー (Prefab View) ノードの子ノードとして追加します。これにより、プレハブビュー (Prefab View) がインスタンス化するプレハブを変更し、リソースを読み込んでいる間もアプリケーションの応答性を維持することができます。

構文

ConvertNode3DPrefabPlaceholderToPrefabView3D prefabPlaceholder

パラメータ

prefabPlaceholder

プレハブプレースホルダ3Dノードをプレハブビュー3Dノードに変換します。

例

# Convert the RootPage > Viewport 2D > Scene > Toggle Button 3D Prefab Placeholder 3D node to a Prefab View 3D node.
ConvertNode3DPrefabPlaceholderToPrefabView3D "/Screens/Screen/RootPage/Viewport 2D/Scene/Toggle Button 3D"

ConvertNodesToPrefabs

選択したノードのためにプレハブテンプレートを作成し、作成したテンプレートを指すプレースホルダでノードを置き換えます。

構文

ConvertNodesToPrefabs nodes

パラメータ

nodes

プレハブに変換するノード。ノードのリストはセミコロンで区切ります。

例

# Convert to prefabs the RootPage > Button 2D and RootPage > Toggle Button 2D nodes.
ConvertNodesToPrefabs "/Screens/Screen/RootPage/Button 2D; /Screens/Screen/RootPage/Toggle Button 2D"

ConvertPageHostToPage

このページホストノードをページノードに変換します。

アプリケーションのユーザーインターフェースの構造を作成するには、Page ノードを使用し、Page Host ノードの下で Page ノード間のナビゲーションリクエストとトランジションを管理するには、Page Host ノードを使用します。

構文

ConvertPageHostToPage pageHost

パラメータ

pageHost

ページノードに変換するPage Hostノード。

例

# Convert the Page Host node RootPage > Settings to a Page node.
ConvertPageHostToPage "/Screens/Screen/RootPage/Settings"

ConvertPageToPageHost

このページノードをページホストノードに変換します。

ページホスト (Page Host) ノードの下にあるページ (Page) ノード間のナビゲーションリクエストとトランジションを管理するには、ページホスト (Page Host) ノードを使用します。

構文

ConvertPageToPageHost page

パラメータ

page	ページノードをページホストノードに変換します。

例

# Convert the Page node RootPage > Car to a Page Host node.
ConvertPageToPageHost "/Screens/Screen/RootPage/Car"

ConvertProjectReferenceItemToKzbReferenceItem

このプロジェクトリファレンスをKzbリファレンスに変換します。

構文

ConvertProjectReferenceItemToKzbReferenceItem projectReferenceItem

パラメータ

projectReferenceItem

プロジェクト参照をkzbファイル参照に変換します。

例

# Convert the Resources project reference to a kzb file reference.
ConvertProjectReferenceItemToKzbReferenceItem "/Project References/Resources/"

ブラシ作成

CreateBrush (ブラシを作成)

ブラシの作成

構文

CreateBrush itemName brushTypeName

パラメータ

itemName	ブラシの名前。
brushTypeName	ブラシのタイプ。

例

# Create a Color Brush named My Color Brush in the Library > Materials and Textures > Brushes.
CreateBrush "My Color Brush" Kanzi.ColorBrush

# Create a Content Brush named My Content Brush in the Library > Materials and Textures > Brushes.
CreateBrush "My Content Brush" Kanzi.ContentBrush

# Create a Material Brush named My Material Brush in the Library > Materials and Textures > Brushes.
CreateBrush "My Material Brush" Kanzi.MaterialBrush

# Create a Texture Brush named My Texture Brush in the Library > Materials and Textures > Brushes.
CreateBrush "My Texture Brush" Kanzi.TextureBrush

コンポーネントの作成

CreateComponentNode2D

2Dノードを作成します。

構文

CreateComponentNode2D parent itemName componentTypeName

パラメータ

parent	2Dノードを作成するノード。
itemName	2Dノードの名前。
componentTypeName	2Dノードのタイプ。

例

# Create a Content Layout 2D node named My Content Layout in the RootPage node.
CreateComponentNode2D "/Screens/Screen/RootPage" "My Content Layout" Kanzi.ContentLayout2D

# Create a List Box Item Container 2D prefab named My List Box Item Container in the Prefabs.
CreateComponentNode2D "/Prefabs" "My List Box Item Container" Kanzi.ListBoxItemContainer2D

# Create a Prefab View 2D node named My Prefab View in the RootPage node.
CreateComponentNode2D "/Screens/Screen/RootPage" "My Prefab View" Kanzi.PrefabView2D

CreateComponentNode

3Dノードを作成します。

構文

CreateComponentNode parent itemName componentTypeName

パラメータ

parent	3Dノードを作成するノード。
itemName	3Dノードの名前。
componentTypeName	3Dノードのタイプ。

例

# Create a Content Layout 3D node named My Content Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Content Layout" Kanzi.ContentLayout3D

# Create a Dock Layout 3D node named My Dock Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Dock Layout" Kanzi.DockLayout3D

# Create a Flow Layout 3D node named My Flow Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Flow Layout" Kanzi.FlowLayout3D

# Create a Grid Layout 3D node named My Grid Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Grid Layout" Kanzi.GridLayout3D

# Create a Stack Layout 3D node named My Stack Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Stack Layout" Kanzi.StackLayout3D

# Create a Trajectory Layout 3D node named My Trajectory Layout in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Trajectory Layout" Kanzi.TrajectoryLayout3D

# Create a Grid List Box 3D node named My Grid List Box in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Grid List Box" Kanzi.GridListBox3D

# Create a List Box Item Container 3D prefab named My List Box Item Container in the Prefabs.
CreateComponentNode "/Prefabs" "My List Box Item Container" Kanzi.ListBoxItemContainer3D

# Create a Trajectory List Box 3D node named My Trajectory List Box in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Trajectory List Box" Kanzi.TrajectoryListBox3D

# Create a Text Block 3D node named My Text Block in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Text Block" Kanzi.TextBlock3D

# Create a Button 3D node named My Button in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Button" Kanzi.Button3D

# Create a Button 3D prefab named My Button in the Prefabs.
CreateComponentNode "/Prefabs" "My Button" Kanzi.Button3D

# Create a Scroll View 3D node named My Scroll View in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Scroll View" Kanzi.ScrollView3D

# Create a Slider 3D node named My Slider in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Slider 3D" Kanzi.Slider3D

# Create a Toggle Button 3D node named My Toggle Button in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Toggle Button" Kanzi.ToggleButton3D

# Create a Toggle Button Group 3D node named My Toggle Button Group in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Toggle Button Group" Kanzi.ToggleButtonGroup3D

# Create a Prefab View 3D node named My Prefab View in the Screen > RootPage > Viewport 2D > Scene node.
CreateComponentNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Prefab View" Kanzi.PrefabView3D

エンプティノード (Empty Node)

CreateEmptyNode2D

エンプティノード2Dを使用して2Dオブジェクトをグループ化し、これらのオブジェクトに対してグループとしてプロパティ変更を適用します。

構文

CreateEmptyNode2D parent name selectNewItems

パラメータ

parent	エンプティノード (Empty Node) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	エンプティノード (Empty Node) 2D ノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したエンプティノード (Empty Node) 2D ノードまたはプレハブを選択するかどうか。

例

# Create an Empty Node 2D node named My Empty Node in the Screen > RootPage node
# and select the My Empty Node node.
CreateEmptyNode2D "/Screens/Screen/RootPage" "My Empty Node" true

# Create an Empty Node 2D prefab named My Empty Node in the Prefabs
# and select the My Empty Node prefab.
CreateEmptyNode2D "/Prefabs" "My Empty Node" true

CreateEmptyNode3D

エンプティノード3D (Empty Node 3D) を使用して3Dオブジェクトをグループ化し、これらのオブジェクトに対してグループとしてプロパティ変更を適用します。

構文

CreateEmptyNode3D parent itemName

パラメータ

parent	エンプティノード (Empty Node) 3D ノードまたはプレハブを作成するノードまたはプレハブ。
itemName	エンプティノード3Dノードまたはプレハブの名前。

例

# Create an Empty Node 3D node named My Empty Node 3D in the Screen > RootPage > Viewport 2D > Scene node.
CreateEmptyNode3D "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Empty Node 3D"

# Create an Empty Node 3D prefab named My Empty Node 3D in the Prefabs.
CreateEmptyNode3D "/Prefabs" "My Empty Node 3D"

レイアウト (Layout) ノード

CreateDockLayout2D

ドックレイアウト (Dock Layout) 2D を使用して、2D 空間内でオブジェクトを互いに相対的に分割します。

構文

CreateDockLayout2D parent name selectNewItems

パラメータ

parent	ドックレイアウト (Dock Layout) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	ドックレイアウト (Dock Layout) 2D ノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したドックレイアウト 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Dock Layout 2D node named My Dock Layout in the Screen > RootPage node
# and select the My Dock Layout node.
CreateDockLayout2D "/Screens/Screen/RootPage" "My Dock Layout" true

# Create a Dock Layout 2D prefab named My Dock Layout in the Prefabs
# and select the My Dock Layout prefab.
CreateDockLayout2D "/Prefabs" "My Dock Layout" true

CreateFlowLayout2D

フローレイアウト (Flow Layout) 2D を使用して、2D 空間に 2D オブジェクトを行に配置します。行がいっぱいになると、新しい行にオブジェクトを配置します。

構文

CreateFlowLayout2D parent name selectNewItems

パラメータ

parent	フローレイアウト (Flow Layout) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	フローレイアウト (Flow Layout) 2D ノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したフローレイアウト (Flow Layout) 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Flow Layout 2D node named My Flow Layout in the Screen > RootPage node
# and select the My Flow Layout node.
CreateFlowLayout2D "/Screens/Screen/RootPage" "My Flow Layout" true

# Create a Flow Layout 2D prefab named My Flow Layout in the Prefabs
# and select the My Flow Layout prefab.
CreateFlowLayout2D "/Prefabs" "My Flow Layout" true

CreateGridLayout2D

2D空間で2Dコンテンツを格子状に配置するには、Grid Layout 2Dを使用します。

構文

CreateGridLayout2D parent name selectNewItems

パラメータ

parent	グリッドレイアウト (Grid Layout) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	グリッドレイアウト2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したグリッドレイアウト (Grid Layout) 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Grid Layout 2D node named My Grid Layout in the Screen > RootPage node
# and select the My Grid Layout node.
CreateGridLayout2D "/Screens/Screen/RootPage" "My Grid Layout" true

# Create a Grid Layout 2D prefab named My Grid Layout in the Prefabs
# and select the My Grid Layout prefab.
CreateGridLayout2D "/Prefabs" "My Grid Layout" true

CreateStackLayout2D

スタックレイアウト (Stack Layout) 2D を使用して、2D 空間で選択した軸に沿ってコンテンツを積み重ねて配置します。

構文

CreateStackLayout2D parent name selectNewItems

パラメータ

parent	スタックレイアウト (Stack Layout) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	スタックレイアウト (Stack Layout) 2D ノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成した スタックレイアウト (Stack Layout) 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Stack Layout 2D node named My Stack Layout in the Screen > RootPage node
# and select the My Stack Layout node.
CreateStackLayout2D "/Screens/Screen/RootPage" "My Stack Layout" true

# Create a Stack Layout 2D prefab named My Stack Layout in the Prefabs
# and select the My Stack Layout prefab.
CreateStackLayout2D "/Prefabs" "My Stack Layout" true

CreateTrajectoryLayout2D

2D空間で軌跡に沿ってコンテンツを配置するには、Trajectory Layout 2Dを使用します。

構文

CreateTrajectoryLayout2D parent name selectNewItems

パラメータ

parent	トラジェクトリレイアウト (Trajectory Layout) 2D ノードまたはプレハブを作成するノードまたはプレハブ。
name	トラジェクトリレイアウト2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studioが作成したトラジェクトリレイアウト2Dノードまたはプレハブを選択するかどうか。

例

# Create a Trajectory Layout 2D node named My Trajectory Layout in the Screen > RootPage node
# and select the My Trajectory Layout node.
CreateTrajectoryLayout2D "/Screens/Screen/RootPage" "My Trajectory Layout" true

# Create a Trajectory Layout 2D prefab named My Trajectory Layout in the Prefabs
# and select the My Trajectory Layout prefab.
CreateTrajectoryLayout2D "/Prefabs" "My Trajectory Layout" true

コンテナ (Container) ノード

CreateGridListBox2D

2D空間で2Dコンテンツを格子状に配置するには、Grid List Box 2Dを使用します。

構文

CreateGridListBox2D parent name selectNewItems

パラメータ

parent	グリッドリストボックス2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	グリッドリストボックス2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したグリッドリストボックス 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Grid List Box 2D node named My Grid List Box in the Screen > RootPage node
# and select the My Grid List Box node.
CreateGridListBox2D "/Screens/Screen/RootPage" "My Grid List Box" true

# Create a Grid List Box 2D prefab named My Grid List Box in the Prefabs
# and select the My Grid List Box prefab.
CreateGridListBox2D "/Prefabs" "My Grid List Box" true

コンテンツ (Content) ノード

CreateImage2D

画像を使用して、単一のテクスチャまたはレンダリングターゲットテクスチャを表示します。

構文

CreateImage2D parent name selectNewItems

パラメータ

parent	イメージノードまたはプレハブを作成するノードまたはプレハブ。
name	イメージノードまたはプレハブの名前。
selectNewItems	Kanzi Studioが作成したイメージノードまたはプレハブを選択するかどうか。

例

# Create an Image node named My Image in the Screen > RootPage node
# and select the My Image node.
CreateImage2D "/Screens/Screen/RootPage" "My Image" true

# Create an Image prefab named My Image in the Prefabs
# and select the My Image prefab.
CreateImage2D "/Prefabs" "My Image" true

CreatePage

アプリケーションに階層構造を加えるには、ページ (Page) を使用します。

構文

CreatePage parent name selectNewItems

パラメータ

parent	ページノードまたはプレハブを作成するノードまたはプレハブ。
name	ページノードまたはプレハブの名前。
selectNewItems	Kanzi Studioが作成したページノードまたはプレハブを選択するかどうか。

例

# Create a Page node named Media Page in the Screen > RootPage node
# and select the Media Page node.
CreatePage "/Screens/Screen/RootPage" "Media Page" true

# Create a Page prefab named My Page in the Prefabs and select the My Page prefab.
CreatePage "/Prefabs" "My Page" true

CreatePageHost

ページホスト (Page Host) を使用して、そのサブツリー内のページ (Page) ノード間のナビゲーションを管理します。

構文

CreatePageHost parent name selectNewItems

パラメータ

parent	ページホストノードまたはプレハブを作成するノードまたはプレハブ。
name	ページホストノードまたはプレハブの名前。
selectNewItems	Kanzi Studioが作成したページホストノードまたはプレハブを選択するかどうか。

例

# Create a Page Host node named Main Page Host in the Screen > RootPage node
# and select the Main Page Host node.
CreatePageHost "/Screens/Screen/RootPage" "Main Page Host" true

# Create a Page Host prefab named My Page Host in the Prefabs and select the My Page Host prefab.
CreatePageHost "/Prefabs" "My Page Host" true

CreateProgressiveRenderingNode2D

プログレッシブレンダリングビューポート2Dを使用して、カメラを通して3Dシーンへのビューを表示します。

構文

CreateProgressiveRenderingNode2D parent name selectNewItems

パラメータ

parent	プログレッシブレンダリングビューポート2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	プログレッシブレンダリングビューポート2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studioが、あなたが作成したプログレッシブレンダリングビューポート2Dノードまたはプレハブを選択するかどうか。

例

# Create a Progressive Rendering Viewport 2D node named My Progressive Rendering Viewport
# in the Screen > RootPage node and select the Progressive Rendering Viewport node.
CreateProgressiveRenderingNode2D "/Screens/Screen/RootPage" "My Progressive Rendering Viewport" true

# Create a Progressive Rendering Viewport 2D prefab named My Progressive Rendering Viewport
# in the Prefabs and select the My Progressive Rendering Viewport prefab.
CreateProgressiveRenderingNode2D "/Prefabs" "My Progressive Rendering Viewport" true

CreateTextBlock2D

テキストブロック2Dを使用して、2D空間にテキストを表示します。これはフォントを使用してテキストをレンダリングし、2D空間での位置と向きを持ちます。

構文

CreateTextBlock2D parent name selectNewItems

パラメータ

parent	テキストブロック2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	テキストブロック2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成した Text Block 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Text Block 2D node named My Text Block in the Screen > RootPage node
# and select the My Text Block node.
CreateTextBlock2D "/Screens/Screen/RootPage" "My Text Block" true

# Create a Text Block 2D prefab named My Text Block in the Prefabs
# and select the My Text Block prefab.
CreateTextBlock2D "/Prefabs" "My Text Block" true

CreateViewport2D

カメラを通して3Dシーンを表示するために、ビューポート2Dを使用します。

構文

CreateViewport2D parent name selectNewItems

パラメータ

parent	ビューポート2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	ビューポート2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したビューポート2Dノードまたはプレハブを選択するかどうか。

例

# Create a Viewport 2D node named My Viewport in the Screen > RootPage node
# and select the My Viewport node.
CreateViewport2D "/Screens/Screen/RootPage" "My Viewport" true

# Create a Viewport 2D prefab named My Viewport in the Prefabs
# and select the My Viewport prefab.
CreateViewport2D "/Prefabs" "My Viewport" true

インタラクティビティ (Interactivity) ノード

CreateButton2D

ボタン2Dを使用して、2D空間にボタンを作成します。

構文

CreateButton2D parent name selectNewItems

パラメータ

parent	ボタン2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	ボタン2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成した Button 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Button 2D node named My Button in the Screen > RootPage node
# and select the My Button node.
CreateButton2D "/Screens/Screen/RootPage" "My Button" true

# Create a Button 2D prefab named My Button in the Prefabs
# and select the My Button prefab.
CreateButton2D "/Prefabs" "My Button" true
# In the My Button prefab create an Image node named Image
# but do not select the Image node.
CreateImage2D "/Prefabs/My Button/My Button" Image false

CreateScrollView2D

スクロールビュー2Dを使用して、2D空間でのスクロールジェスチャーからユーザー入力を取得します。

構文

CreateScrollView2D parent name selectNewItems

パラメータ

parent	スクロールビュー2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	スクロールビュー2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したスクロールビュー 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Scroll View 2D node named My Scroll View in the Screen > RootPage node
# and select the My Scroll View node.
CreateScrollView2D "/Screens/Screen/RootPage" "My Scroll View" true

# Create a Scroll View 2D prefab named My Scroll View in the Prefabs
# and select the My Scroll View prefab.
CreateScrollView2D "/Prefabs" "My Scroll View" true

CreateSlider2D

スライダー2Dを使用して、ユーザーが2D空間で最小値と最大値の間の値を設定できるようにします。

構文

CreateSlider2D parent name selectNewItems

パラメータ

parent	スライダー2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	スライダー2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したスライダー2Dノードまたはプレハブを選択するかどうか。

例

# Create a Slider 2D node named My Slider in the Screen > RootPage node
# and select the My Slider node.
CreateSlider2D "/Screens/Screen/RootPage" "My Slider" true

# Create a Slider 2D prefab named My Slider in the Prefabs
# and select the My Slider prefab.
CreateSlider2D "/Prefabs" "My Slider" true

CreateToggleButton2D

2D 空間で複数のトグル状態を持つボタンを作成するには、トグルボタン 2D (Toggle Button 2D) を使用します。

構文

CreateToggleButton2D parent name selectNewItems

パラメータ

parent	トグルボタン2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	トグルボタン2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成したトグルボタン 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Toggle Button 2D node named My Toggle Button in the Screen > RootPage node
# and select the My Toggle Button node.
CreateToggleButton2D "/Screens/Screen/RootPage" "My Toggle Button" true

# Create a Toggle Button 2D prefab named My Toggle Button in the Prefabs
# and select the My Toggle Button prefab.
CreateToggleButton2D "/Prefabs" "My Toggle Button" true
# In the My Toggle Button prefab create an Image node named Image
# but do not select the Image node.
CreateImage2D "/Prefabs/My Toggle Button/My Toggle Button" Image false

CreateToggleButtonGroup2D

トグルボタングループ2Dを使用して、2D空間でトグルボタンをグループ化し、一度に1つだけアクティブにすることができます。グループ内のトグルボタンはラジオボタンのように動作します。

構文

CreateToggleButtonGroup2D parent name selectNewItems

パラメータ

parent	トグルボタングループ2Dノードまたはプレハブを作成するノードまたはプレハブ。
name	トグルボタングループ2Dノードまたはプレハブの名前。
selectNewItems	Kanzi Studio が作成した Toggle Button Group 2D ノードまたはプレハブを選択するかどうか。

例

# Create a Toggle Button Group 2D node named My Toggle Button Group in the Screen > RootPage node
# and select the My Toggle Button Group node.
CreateToggleButtonGroup2D "/Screens/Screen/RootPage" "My Toggle Button Group" true

# Create a Toggle Button Group 2D prefab named My Toggle Button Group in the Prefabs
# and select the My Toggle Button Group prefab.
CreateToggleButtonGroup2D "/Prefabs" "My Toggle Button Group" true

マテリアル作成 (Material Creation)

CreateMaterial

3D ノードおよびマテリアルブラシ (Material Brush) の見た目を設定するには、マテリアルを使用します。

構文

CreateMaterial materialName selectNewItem materialType

パラメータ

materialName	マテリアルの名前。
selectNewItem	Kanzi Studioがマテリアルを選択するかどうか。
materialType	マテリアルが使用するマテリアルタイプ。

例

# Create a material named My Material in the Library > Materials and Textures > Materials,
# select the material, and set the material to use the My Material Type material type.
CreateMaterial "My Material" true "/Material Types/My Material Type"

CreateMaterialType (マテリアルタイプを作成)

マテリアルタイプは、マテリアルのプロパティタイプを定義します。マテリアルタイプによって定義されたマテリアルプロパティ値を調整することで、マテリアルの見た目を設定します。

構文

CreateMaterialType materialTypeName createMaterial

パラメータ

materialTypeName	マテリアルタイプの名前。
createMaterial	（オプション）Kanzi Studioがマテリアルタイプを使用するマテリアルも作成するかどうか。デフォルト値はfalseです。

例

# Create a material type named My Material Type in the Library > Materials and Textures > Material Types,
# and create a material named My Material Type Material which uses My Material Type.
CreateMaterialType "My Material Type" true

プリミティブ作成

CreateBoxNodeを作成

原点に中心を持つキューブメッシュを作成します。

構文

CreateBoxNode parent itemName

パラメータ

parent	ボックスノードまたはプレハブを作成するノードまたはプレハブ。
itemName	ボックスノードまたはプレハブの名前。

例

# Create a Box node named My Box in the Screen > RootPage > Viewport 2D > Scene node.
CreateBoxNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Box"

# Create a Box prefab named My Box in the Prefabs.
CreateBoxNode "/Prefabs" "My Box"

CreateMeshNode

Kanzi アプリケーションにサードパーティツールで作成されたインポートされた3Dモデルを追加するには、モデルを使用します。

構文

CreateMeshNode parent itemName mesh

パラメータ

parent	モデルノードまたはプレハブを作成するノードまたはプレハブ。
itemName	モデルノードまたはプレハブの名前。
mesh	（オプション）モデルが表示するメッシュ。

例

# Create a Model node named My Model in the Screen > RootPage > Viewport 2D > Scene node
# and set the Mesh property of My Model to the My Mesh mesh.
CreateMeshNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Model" "/Mesh Data/My Mesh"

# Create a Model prefab named My Model in the Prefabs.
CreateMeshNode "/Prefabs" "My Model"

CreatePlaneNode の作成

4つの頂点を持つ塗りつぶされた平面メッシュを作成します。

構文

CreatePlaneNode parent itemName

パラメータ

parent	プレーンノードまたはプレハブを作成するノードまたはプレハブ。
itemName	プレーンノードまたはプレハブの名前。

例

# Create a Plane node named My Plane in the Screen > RootPage > Viewport 2D > Scene node.
CreatePlaneNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Plane"

# Create a Plane prefab named My Plane in the Prefabs.
CreatePlaneNode "/Prefabs" "My Plane"

CreateSphereNode

球体メッシュをその原点に中心を置いて作成します。

構文

CreateSphereNode parent itemName

パラメータ

parent	スフィアノードまたはプレハブを作成するノードまたはプレハブ。
itemName	Sphereノードまたはプレハブの名前。

例

# Create a Sphere node named My Sphere in the Screen > RootPage > Viewport 2D > Scene node.
CreateSphereNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Sphere"

# Create a Sphere prefab named My Sphere in the Prefabs.
CreateSphereNode "/Prefabs" "My Sphere"

ノード3D作成

CreateScene

Kanziアプリケーションで3Dコンテンツを表示するには、シーンノードを使用します。シーンノードは、ライトノード、カメラノード、およびその他の3Dノードを含むことができます。

構文

CreateScene parent itemName createCameraAndLight

パラメータ

parent	シーンノードまたはプレハブを作成するノードまたはプレハブ。
itemName	ビューポート2Dノードまたはプレハブの名前。
createCameraAndLight	（オプション）シーンノードにカメラノードとディレクショナルライトを作成するかどうか。デフォルト値はtrueです。

例

# Create a Scene node named My Scene in the RootPage > My Viewport node,
# and in the My Scene node create a Camera node and a Directional Light node.
CreateScene "/Screens/Screen/RootPage/My Viewport" "My Scene"

# Create a Scene prefab named My Scene in the Prefabs.
# Do not create a Camera and a Directional Light node in My Scene prefab.
CreateScene "/Prefabs" "My Scene" false

ヘルパーノード3D作成

CreateCameraNode

Kanzi Studio プロジェクトおよび Kanzi アプリケーションの Scene 内のコンテンツを表示するには、カメラ (Camera) ノードを使用します。

構文

CreateCameraNode parent itemName

パラメータ

parent	カメラノードを作成するノード。
itemName	カメラノードの名前。

例

# Create a Camera node named Camera in the Screen > RootPage > Viewport 2D > Scene node.
CreateCameraNode "/Screens/Screen/RootPage/Viewport 2D/Scene" Camera

構文

CreateCameraNode parent itemName activateAsPreviewCamera setAsDefaultCamera3D setDefaultOrientation

パラメータ

parent	カメラノードを作成するノード。
itemName	カメラノードの名前。
activateAsPreviewCamera	プレビューカメラとしてカメラをアクティブにするかどうか。
setAsDefaultCamera3D	カメラをデフォルトのカメラとして設定するかどうか。
setDefaultOrientation	レイアウト変換をデフォルトの向きに設定するかどうか。

例

# Create a Camera node named Camera in the Screen > RootPage > Viewport 2D > Scene node,
# activate the camera as the Preview camera, set the camera as the default camera,
# and set the Layout Transformation to the default orientation.
CreateCameraNode Camera "/Screens/Screen/RootPage/Viewport 2D/Scene" true true true

CreateDirectionalLightNode

ディレクショナルライトは、光を一方向にのみ放射します。ディレクショナルライトを使用して、太陽光をモデル化することができます。デフォルトで、各シーンノードにはディレクショナルライトが含まれています。

構文

CreateDirectionalLightNode itemName parent

パラメータ

itemName	ライトノードの名前。
parent	ライトノードを作成するノード。

例

# Create a Directional Light node named My Directional Light in the Screen > RootPage > Viewport 2D > Scene node.
CreateDirectionalLightNode "My Directional Light" "/Screens/Screen/RootPage/Viewport 2D/Scene"

CreateInstantiatorNode

インスタンシエーターノードを使用して、ターゲットとするオブジェクトのコピーを作成します。インスタンス化されたノードはインタラクティブではありません。

構文

CreateInstantiatorNode parent itemName target

パラメータ

parent	インスタンシエーターノードを作成するノード。
itemName	インスタンシエーターノードの名前。
target	（オプション）インスタンシエーターノードがインスタンス化するノード。

例

# Create an Instantiator node named My Instantiator in the Screen > RootPage > Viewport 2D > Scene node.
CreateInstantiatorNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Instantiator"

# Instantiate the Screen > RootPage > Viewport 2D > Scene > Directional Light node into
# an Instantiator node named Directional Light Instance in the Screen > RootPage > Viewport 2D > Scene node.
CreateInstantiatorNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "Directional Light Instance" "/Screens/Screen/RootPage/Viewport 2D/Scene/Directional Light"

CreateLevelOfDetailNode

レベルオブディテールノードを使用して、ビューカメラとの関係に基づいてオブジェクトを表示します。レベルオブディテールは、エンプティノード3Dに似ています。

構文

CreateLevelOfDetailNode parent itemName

パラメータ

parent	レベルオブディテールノードまたはプレハブを作成するノードまたはプレハブ。
itemName	レベルオブディテールノードまたはプレハブの名前。

例

# Create a Level of Detail node named My Level of Detail in the Screen > RootPage > Viewport 2D > Scene node.
CreateLevelOfDetailNode "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Level of Detail"

# Create a Level of Detail prefab named My Level of Detail in the Prefabs.
CreateLevelOfDetailNode "/Prefabs" "My Level of Detail"

CreatePointLightNode

ポイントライト (Point Light) は、特定の場所からすべての方向 (360 度) に均一に光を放射します。

構文

CreatePointLightNode itemName parent

パラメータ

itemName	ライトノードの名前。
parent	ライトノードを作成するノード。

例

# Create a Point Light node named My Point Light in the Screen > RootPage > Viewport 2D > Scene node.
CreatePointLightNode "My Point Light" "/Screens/Screen/RootPage/Viewport 2D/Scene"

CreateSpotLightNode

スポットライト (Spot Light) は、特定の位置から特定の方向に向けて円錐形状の光を放射します。

構文

CreateSpotLightNode itemName parent

パラメータ

itemName	ライトノードの名前。
parent	ライトノードを作成するノード。

例

# Create a Spot Light node named My Spot Light in the Screen > RootPage > Viewport 2D > Scene node.
CreateSpotLightNode "My Spot Light" "/Screens/Screen/RootPage/Viewport 2D/Scene"

レンダーパス作成 (Render Pass Creation)

CreateRenderPass (クリエイトレンダーパス)

レンダーパスを作成します。

構文

CreateRenderPass parent itemName renderPassTypeName

パラメータ

parent	（オプション）レンダーパスまたはレンダーパスプレハブのルートを作成するレンダーパス。レンダーパスプレハブを作成するには、このパラメーターを省略します。
itemName	レンダーパスの名前。
renderPassTypeName	レンダーパスタイプの名前。

例

# Create a Group Render Pass render pass prefab named Group in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Group" Kanzi.RenderPass
# Create a Clear Render Pass named Clear in the Library > Rendering > Render Pass Prefabs > Group.
CreateRenderPass "/Render Pass Prefabs/Group/Group" "Clear" Kanzi.ClearRenderPass
# Create a Gather Lights Render Pass named Gather Lights in the Library > Rendering > Render Pass Prefabs > Group.
CreateRenderPass "/Render Pass Prefabs/Group/Group" "Gather Lights" Kanzi.GatherLightsRenderPass
# Create a Draw Objects Render Pass named Draw in the Library > Rendering > Render Pass Prefabs > Group > Gather Lights.
CreateRenderPass "/Render Pass Prefabs/Group/Group/Gather Lights" "Draw" Kanzi.DrawObjectsRenderPass

# This example creates the render passes that you need to render content to a composition target.
# Create a Group Render Pass prefab named Render Composition Target in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Render Composition Target" Kanzi.RenderPass
# In the Render Composition Target create a Composition Target Render Pass named Composition Target Render Pass.
CreateRenderPass "/Render Pass Prefabs/Render Composition Target/Render Composition Target" "Composition Target Render Pass" Kanzi.CompositionTargetRenderPass
# In the Composition Target Render Pass create a Default Render Pass which contains a basic set of render passes that first render opaque nodes and then transparent nodes.
CreateDefaultRenderPassTree "/Render Pass Prefabs/Render Composition Target/Render Composition Target/Composition Target Render Pass" "Default Render Pass"
# In the Render Composition Target create a Blit Render Pass named Blit Render Pass.
CreateRenderPass "/Render Pass Prefabs/Render Composition Target/Render Composition Target" "Blit Render Pass" Kanzi.BlitRenderPass
# In the Blit Render Pass bind the Texture 0 property to the Result Texture 0 property of the Composition Target Render Pass.
CreateBindingItem "/Render Pass Prefabs/Render Composition Target/Render Composition Target/Blit Render Pass" ONE_WAY null BlitRenderPass.Texture0 WHOLE_PROPERTY "{../Composition Target Render Pass/CompositionTargetRenderPass.ResultTexture0}"

# Create a Pipeline State Render Pass named Pipeline State in the Library > Rendering > Render Pass Prefabs > Group Render Pass render pass prefab.
CreateRenderPass "/Render Pass Prefabs/Group Render Pass/Group Render Pass" "Pipeline State" Kanzi.PipelineStateRenderPass

# Create a Draw Objects With Material Render Pass named Draw Objects with Material in the Library > Rendering > Render Pass Prefabs > Group Render Pass render pass prefab.
CreateRenderPass "/Render Pass Prefabs/Group Render Pass/Group Render Pass" "Draw Objects with Material" Kanzi.DrawObjectsWithMaterialRenderPass

# Create a Material Setup Render Pass named Material Setup in the Library > Rendering > Render Pass Prefabs > Group Render Pass render pass prefab.
CreateRenderPass "/Render Pass Prefabs/Group Render Pass/Group Render Pass" "Material Setup" Kanzi.MaterialSetupRenderPass

レンダーパスプリセットの作成

CreateComposeAndBlitRenderPassTree

コンポーズおよびブリットパスレンダーパスプリセットを使用して、特定のマテリアルを使用してコンポジションターゲットレンダーパスをブリットするために必要なレンダーパスを作成します。

構文

CreateComposeAndBlitRenderPassTree parent itemName

パラメータ

parent	（オプション）Compose to Blit Passを作成するレンダーパスプレハブまたはレンダーパス。Compose to Blit Passプレハブを作成するには、このパラメータを省略します。
itemName	Compose to Blit Pass の名前。

例

# Create a Compose and Blit Pass render pass prefab named Compose and Blit
# in the Library > Rendering > Render Pass Prefabs.
CreateComposeAndBlitRenderPassTree "Compose and Blit"

# Create a Group Render Pass render pass prefab named Group in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Group" Kanzi.RenderPass
# Create a Compose and Blit Pass named Compose and Blit in the Group render pass prefab.
CreateComposeAndBlitRenderPassTree "/Render Pass Prefabs/Group/Group" "Compose and Blit"

CreateDefaultRenderPassTree (デフォルトレンダーパスツリーを作成)

デフォルトレンダーパスのレンダーパスプリセットを使用して、開始するために必要な基本的なレンダーパスセットを作成します。デフォルトレンダーパスは、最初に不透明なノードをレンダリングし、その後に透明なノードをレンダリングします。

構文

CreateDefaultRenderPassTree parent itemName

パラメータ

parent	（オプション）デフォルトレンダーパスを作成するレンダーパスプレハブまたはレンダーパス。デフォルトレンダーパスプレハブを作成するには、このパラメーターを省略します。
itemName	デフォルトレンダーパスの名前。

例

# Create a Default Render Pass prefab named Default Rendering in the Library > Rendering > Render Pass Prefabs.
CreateDefaultRenderPassTree "Default Rendering"

# Create a Group Render Pass render pass prefab named Group in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Group" Kanzi.RenderPass
# Create a Default Render Pass named Default Render Pass in the Group render pass prefab.
CreateDefaultRenderPassTree "/Render Pass Prefabs/Group/Group" "Default Render Pass"

CreateImageBasedLightingFilterPassTree

環境マップテクスチャを事前フィルタリングして Environment Ambient Texture と Environment Reflection Texture を生成するレンダーパスを作成するには、Image-Based Lighting Filter Pass プリセットを使用します。これらのテクスチャは、物理ベースレンダリング (Physically-Based Rendering) マテリアルによるイメージベースのライティングに使用できます。

構文

CreateImageBasedLightingFilterPassTree parent itemName

パラメータ

parent	（オプション）Image-Based Lighting Filter Pass を作成するレンダーパス。Image-Based Lighting Filter Pass プレハブを作成するには、このパラメータを省略します。
itemName	Image-Based Lighting Filter Pass の名前。

例

# Create an Image-Based Lighting Filter Pass render pass prefab named Image-Based Lighting Filter
# in the Library > Rendering > Render Pass Prefabs.
CreateImageBasedLightingFilterPassTree "Image-Based Lighting Filter"

# Create a Group Render Pass render pass prefab named Group in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Group" Kanzi.RenderPass
# Create a Image-Based Lighting Filter Pass named Image-Based Lighting Filter in the Group render pass prefab.
CreateImageBasedLightingFilterPassTree "/Render Pass Prefabs/Group/Group" "Image-Based Lighting Filter"

CreateRenderToTexturePassTree

レンダーからテクスチャへのパス (Render to Texture Pass) のレンダーパスプリセット (render pass preset) を使用して、テクスチャにレンダリングするために必要なレンダーパスを作成します。

構文

CreateRenderToTexturePassTree parent itemName

パラメータ

parent	（オプション）Render to Texture Passを作成するレンダーパス。Render to Texture Pass プレハブを作成するには、このパラメータを省略します。
itemName	レンダートゥテクスチャパスの名前。

例

# Create a Render to Texture Pass render pass prefab named Render to Texture
# in the Library > Rendering > Render Pass Prefabs.
CreateRenderToTexturePassTree "Render to Texture"

# Create a Group Render Pass render pass prefab named Group in the Library > Rendering > Render Pass Prefabs.
CreateRenderPass "Group" Kanzi.RenderPass
# Create a Render to Texture Pass named Render to Texture in the Group render pass prefab.
CreateRenderToTexturePassTree "/Render Pass Prefabs/Group/Group" "Render to Texture"

エフェクト作成

CreateNodeEffect2D

エフェクトを使用して、2Dノードにポストプロセッシングエフェクトを適用します。

構文

CreateNodeEffect2D itemName effectTypeName

パラメータ

itemName	エフェクトの名前。
effectTypeName	エフェクトのタイプ。

例

# Create a Shadow Effect 2D in the Library > Effects > 2D Effects.
CreateNodeEffect2D "Shadow" Kanzi.ShadowEffect2D

エフェクトプリセットの作成

CreateDefaultEffectStack

デフォルトで、Default Effect Stack 2D プリセットを使用して、一般的なエフェクトタイプを迅速に作成および適用します。

構文

CreateDefaultEffectStack itemName

パラメータ

itemName

デフォルトエフェクトスタック2Dの名前。

例

# Create a Default Effect Stack 2D prefab named Default Effect in the Library > Effects > 2D Effects.
CreateDefaultEffectStack "Default Effect"

その他の作成

CreateApplicationConfiguration

プロジェクトのビルドパラメータのセットを作成します。

構文

CreateApplicationConfiguration itemName configurationType

パラメータ

itemName	ビルド構成の名前。
configurationType	（オプション）ビルド構成のタイプ: Android、QNX、またはWindows。デフォルトはCommon Build Configurationです。

例

# Create a common build configuration named My Build Configuration in the Library > Build Configurations.
CreateApplicationConfiguration "My Build Configuration"
# In My Build Configuration, set the Application Root Directory to ..\..\..\Application.
SetProperty "/Resource Files/Build Configurations/My Build Configuration" BuildConfigurationApplicationRootDirectory "..\..\..\Application"
# In My Build Configuration, set the Build Profile to Debug.
SetProperty "/Resource Files/Build Configurations/My Build Configuration" BuildConfiguration.BuildProfile Debug

# Create an Android build configuration named My Android Build Configuration in the Library > Build Configurations.
CreateApplicationConfiguration "My Android Build Configuration" Android
# In My Android Build Configuration, set the CPU Architecture to ARM.
SetProperty "/Resource Files/Build Configurations/My Android Build Configuration" BuildConfigurationTargetArchitecture ARM
# In My Android Build Configuration, set the Launch Application property to disabled.
SetProperty "/Resource Files/Build Configurations/My Android Build Configuration" BuildConfigurationRunApplication False
# In My Android Build Configuration, set the APK Path to output\my-directory.
SetProperty "/Resource Files/Build Configurations/My Android Build Configuration" BuildConfigurationAPKPath "output\my-directory"

CreateDataSource

データソースを作成します。

構文

CreateDataSource itemName dataSourceTypeName

パラメータ

itemName	データソースの名前。
dataSourceTypeName	Kanzi Engine データソースプラグインコードで宣言されたデータソースタイプの名前。

例

# Create a data source named Cluster of the type CustomDataSourceType.
CreateDataSource Cluster CustomDataSourceType
# To create data objects from the Cluster data source, update the data source.
UpdateDataSourceContents "/Data Sources/Cluster/"

CreateFontFamily

空のフォントファミリーを作成します。

構文

CreateFontFamily fontFamilyName fontFile

パラメータ

fontFamilyName	フォントファミリーの名前。
fontFile	（オプション）Font Family に使用するフォントファイルリソースを設定します。

例

# Create a single font family named My Font Family in the Library > Font Families.
CreateFontFamily "My Font Family"

CreateLocale

ロケールを作成します。

構文

CreateLocale parent name

パラメータ

parent	ローカライゼーションテーブル (Localization Table) でロケールを作成します。
name	ロケールの名前。

例

# Create a Locale named fi-FI in the Library > Localization > My Localization Table.
CreateLocale "/Localization/My Localization Table" fi-FI

CreateLocalizationTableを作成する

ローカライゼーションテーブルを作成します。

構文

CreateLocalizationTable name selectNewItems

パラメータ

name	ローカライゼーションテーブルの名前。
selectNewItems	（オプション）Kanzi Studioがローカライゼーションテーブルを選択するかどうか。デフォルト値はfalseです。

例

# Create a Localization Table named My Localization Table in the Library > Localization.
CreateLocalizationTable "My Localization Table"

CreateNode3DPrefabPlaceholder

3D プレハブをインスタンス化するには、プレハブプレースホルダ 3D ノードを使用します。

Kanziは、プレハブプレースホルダノードをインスタンス化するプレハブのルートノードに置き換えます。

構文

CreateNode3DPrefabPlaceholder parent itemName prefabTemplate

パラメータ

parent	プレハブプレースホルダ3Dノードを作成するノード。
itemName	プレハブプレースホルダ3Dノードの名前。
prefabTemplate	（オプション）プレハブプレースホルダ3Dノードに使用するように設定したプレハブテンプレート。

例

# Create a Prefab Placeholder 3D node named My Prefab Placeholder 3D in the Screen > RootPage > Viewport 2D > Scene node.
CreateNode3DPrefabPlaceholder "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Prefab Placeholder 3D"

# Create a Prefab Placeholder 3D node named My Prefab Placeholder 3D in the Screen > RootPage > Viewport 2D > Scene node
# and set the Prefab Template property of the My Prefab Placeholder 3D node to the Prefabs > Toggle Button 3D prefab.
CreateNode3DPrefabPlaceholder "/Screens/Screen/RootPage/Viewport 2D/Scene" "My Prefab Placeholder 3D" "/Prefabs/Toggle Button 3D"

CreateResourceDictionary

選択したノードにリソースディクショナリを作成します。リソースディクショナリは、リソースを指すリソース ID のコレクションです。

構文

CreateResourceDictionary parent

パラメータ

parent

リソースディクショナリを追加するノード。

例

# Add a resource dictionary to the RootPage node.
CreateResourceDictionary "/Screens/Screen/RootPage"

CreateState

ステートマネージャーを割り当てたノードの外観と動作を定義するプロパティをまとめるには、ステートを使用します。ステートグループ内では、一度に1つのステートのみがアクティブになります。

構文

CreateState parent name selectNewItems

パラメータ

parent	ステートを作成するステートグループ。
name	ステートの名前。
selectNewItems	Kanzi Studioがステートを選択するかどうか。

例

# Create states named State1 and State 2 in the Library > State Managers > My State Manager > State Group.
# Do not select the states.
CreateState "/State Managers/My State Manager/State Group" "State 1" false
CreateState "/State Managers/My State Manager/State Group" "State 2" false

CreateStateGroup

ステートグループはステートを含み、コントローラプロパティとステート間のトランジションを定義します。

構文

CreateStateGroup parent name selectNewItems

パラメータ

parent	ステートグループを作成するステートマネージャー。
name	ステートグループの名前。
selectNewItems	（オプション）Kanzi Studioがステートグループを選択するかどうか。デフォルト値はtrueです。

例

# Create a state group named State Group in the Library > State Managers > My State Manager.
# Do not select the state group.
CreateStateGroup "/State Managers/My State Manager" "State Group" false

CreateStateManager を作成します。

異なる状態での Kanzi アプリケーションの外観と動作を定義するには、ステートマネージャー (State Manager) を使用します。

構文

CreateStateManager itemName selectNewItems

パラメータ

itemName	ステートマネージャーの名前。
selectNewItems	（オプション）Kanzi Studioがステートマネージャーを選択するかどうか。デフォルト値はtrueです。

例

# Create a state manager named My State Manager in the Library > State Managers and select My State Manager.
CreateStateManager "My State Manager"

# Create a state manager named My State Manager in the Library > State Managers but do not select the state manager.
CreateStateManager "My State Manager" false

構文

CreateStateManager itemName selectNewItems createContent

パラメータ

itemName	ステートマネージャーの名前。
selectNewItems	Kanzi Studio がステートマネージャーを選択するかどうか。
createContent	ステートマネージャーで2つの状態を持つステートグループを作成するかどうか。

例

# Create a state manager named My State Manager in the Library > State Managers,
# select the state manager, and in the state manager create a state group with two states.
CreateStateManager "My State Manager" true true

CreateStateWithTarget

ステートにおけるノードのプロパティを定義するには、ステートオブジェクトを使用します。

構文

CreateStateWithTarget parent name stateObjectPath selectNewItems

パラメータ

parent	ステートオブジェクトを作成するステート。
name	ステートオブジェクトの名前。
stateObjectPath	ステートオブジェクトのターゲットオブジェクトパスプロパティの値。
selectNewItems	Kanzi Studioがステートオブジェクトを選択するかどうか。

例

# Create a state object named Car Object in the Library > State Managers > My State Manager > State Group > State 1 state,
# and set the Target Object Path property to Car. Do not select the Car Object state object.
CreateStateWithTarget "/State Managers/My State Manager/State Group/State 1" "Car Object" "Car" false

構文

CreateStateWithTarget name parent selectNewItems

パラメータ

name	ステートオブジェクトの名前。
parent	ステートオブジェクトを作成するステート。
selectNewItems	Kanzi Studioがステートオブジェクトを選択するかどうか。

例

# Create a state object named State Object in the Library > State Managers > My State Manager > State Group > State 1 state.
# Do not select the state object.
CreateStateWithTarget "State Object" "/State Managers/My State Manager/State Group/State 1" false

CreateTag

プロジェクト内のノードをグループ化、検索、フィルタリングするにはタグを使用します。単一のノードに複数のタグを割り当てることができます。

構文

CreateTag itemName selectNewItems

パラメータ

itemName	タグの名前。
selectNewItems	Kanzi Studioがタグを選択するかどうか。

例

# Create a tag named My Tag in the Library > Tags and select the tag.
CreateTag "My Tag" true

CreateThemeを作成する

アプリケーションの見た目を定義するには、テーマ (Themes) を使用します。

構文

CreateTheme parent name

パラメータ

parent	テーマを作成するテーマグループ。
name	テーマの名前。

例

# Create a Theme named Classic in the Cluster Themes theme group.
CreateTheme "/Themes/Cluster Themes" Classic

Createテーマグループ

アプリケーションの見た目を定義するテーマのコレクションを定義するには、テーマグループ (Theme Group) を使用します。テーマを利用することで、単一の Kanzi Studio プロジェクトを、バリエーションとなる複数の製品に利用することができます。

構文

CreateThemeGroup name selectNewItems

パラメータ

name	テーマグループの名前。
selectNewItems	（オプション）Kanzi Studioがテーマグループを選択するかどうか。デフォルト値はfalseです。

例

# Create a Theme Group named Cluster Theme in the Library > Themes.
CreateThemeGroup "Cluster Theme"

ExportLocalizationTable

ローカライゼーションテーブルテンプレートを.potファイルにエクスポートし、そのローカライゼーションテーブルにあるロケールの数だけ.poファイルを<ProjectName>/Localization/<LocalizationTableName>にエクスポートします。

構文

ExportLocalizationTable localizationTable localizationDirectoryPath

パラメータ

localizationTable	エクスポートするローカライゼーションテーブル。
localizationDirectoryPath	ローカライゼーションテーブルをエクスポートするディレクトリ。

例

# Export the Library > Localization > Localization Table to the C:\Temp directory.
# Kanzi Studio creates the C:\Temp\Localization Table directory, and exports to the directory
# the localization table template to a .pot file, and as many .po files as you have locales
# in that localization table.
ExportLocalizationTable "/Localization/Localization Table" "C:\Temp"

ImportAllLocalizationTables

プロジェクトのLocalizationディレクトリ内のすべてのローカライゼーションテーブルフォルダからすべてのPOファイルをインポートします。

構文

ImportAllLocalizationTables localizationDirectoryPath

パラメータ

localizationDirectoryPath

ローカライゼーションテーブルフォルダを含むディレクトリへのパス。Kanzi Studioはこのディレクトリ内のPOファイルを含むフォルダを探し、そのフォルダ名にちなんでローカライゼーションテーブルを作成します。既にローカライゼーションテーブルが存在する場合、Kanzi Studioはそれを更新します。

例

# Imports all PO files from all directories found in the
# C:\KanziWorkspace\Projects\MyProject\Tool_Project\Localization directory.
# Kanzi Studio imports the files for all localization tables in the Library > Localization.
ImportAllLocalizationTables "C:\KanziWorkspace\Projects\MyProject\Tool_Project\Localization"

ImportEnginePlugin

Kanzi Engine プラグインをインポートします。インポート中に、プラグインに含まれるコンポーネント、プロパティタイプ、メッセージ、およびトリガーがプロジェクトで使用可能になります。

構文

ImportEnginePlugin loadPath existingPlugin

パラメータ

loadPath	既存のKanzi Engineプラグインを更新するには、このパラメータを空のままにしてください。
existingPlugin	Kanzi Engine プラグインを更新します。

例

# Update the XML_data_source Kanzi Engine plugin in the project.
# You leave the first parameter empty because you do not import a new plugin to the project.
ImportEnginePlugin "" "/Kanzi Engine Plugins/XML_data_source"

構文

ImportEnginePlugin existingPluginFile

パラメータ

existingPluginFile

KanziエンジンプラグインDLL。

例

# Import the Kanzi Engine plugin DLL MyPluginProject\Application\lib\Win64\GL_vs2019_Debug_DLL\MyPluginProject.dll.
# Kanzi Studio adds to the Library > Kanzi Engine Plugins a reference to the Kanzi Engine plugin DLL that you import.
ImportEnginePlugin "C:\KanziWorkspace\Projects\MyPluginProject\Application\lib\Win64\GL_vs2019_Debug_DLL\MyPluginProject.dll"

タグアイテム (TagItems)

一連のアイテムにタグを追加します。

構文

TagItems tags itemsToTag

パラメータ

tags	割り当てるタグ。タグのリストはセミコロンで区切ります。
itemsToTag	タグを割り当てるノード。ノードのリストはセミコロンで区切ります。

例

# Create a tag named Lights in the Library > Tags and select the tag.
CreateTag "Lights" true
# Create a Spot Light node named Spot Light in the Screen > RootPage > Viewport 2D > Scene node.
CreateSpotLightNode "Spot Light" "/Screens/Screen/RootPage/Viewport 2D/Scene"
# Tag the Directional Light and Spot Light nodes with the Lights tag.
TagItems "/Tags/Lights" "/Screens/Screen/RootPage/Viewport 2D/Scene/Directional Light; /Screens/Screen/RootPage/Viewport 2D/Scene/Spot Light"

UpdateDataSourceContents

UIでデータバインディングを作成するために、データソースからデータを読み取り、キャッシュします。

構文

UpdateDataSourceContents dataSource

パラメータ

dataSource

更新するデータソース。

例

# Update the Cluster data source.
UpdateDataSourceContents "/Data Sources/Cluster/"

UpdateProjectDataSources

このプロジェクトで定義されたデータソースからデータを読み取り、UIでデータバインディングを作成するためにキャッシュします。

構文

UpdateProjectDataSources

例

# Update all data sources in the project.
UpdateProjectDataSources

UpdateProjectEnginePlugins

このプロジェクトでKanzi Engineプラグインが定義するカスタムノード、プロパティタイプ、トリガー、およびアクションの変更を確認するには、プラグインの最新バージョンをロードしてください。

構文

UpdateProjectEnginePlugins

例

# Update all Kanzi Engine plugins in the project.
UpdateProjectEnginePlugins

UpdateSolutionDataSources

このソリューションで定義されたデータソースからデータを読み取り、UIでデータバインディングを作成するためにキャッシュします。

構文

UpdateSolutionDataSources

例

# Update all data sources in the project and all referenced projects.
UpdateSolutionDataSources

UpdateSolutionEnginePlugins

このソリューションでKanzi Engineプラグインが定義するカスタムノード、プロパティタイプ、トリガー、およびアクションの変更を確認するには、プラグインの最新バージョンをロードしてください。

構文

UpdateSolutionEnginePlugins

例

# Update all Kanzi Engine plugins in the project and all referenced projects.
UpdateProjectEnginePlugins

オブジェクトソース作成 (Object Source Creation)

CreateCombineObjectSource (コンバインオブジェクトソースを作成)

フィルターなど、1 つ以上の入力ソースからノードを収集して組み合わせるには、コンバインオブジェクトソース (Combine Object Source) を使用します。

構文

CreateCombineObjectSource itemName

パラメータ

itemName

Combine Object Source の名前。

例

# Create a Combine Object Source named My Combine Object Source in the Library > Rendering > Object Sources.
CreateCombineObjectSource "My Combine Object Source"
# In My Combine Object Source set the Inputs list to contain the Transparent and My Tag Filter filters.
SetProperty "/Object Sources/My Combine Object Source" CombineObjectSourceInputs "/Object Sources/Transparent#/Object Sources/My Tag Filter"

CreateコンテインプロパティフィルタObjectSource

特定のプロパティを持つノードまたは特定のプロパティを持たないノード を選択するには、コンテインプロパティフィルタ (Contains Property Filter) を使用します。

構文

CreateContainsPropertyFilterObjectSource itemName

パラメータ

itemName

フィルタの名前。

例

# Create a Contains Property Filter named My Contains Property Filter
# in the Library > Rendering > Object Sources.
CreateContainsPropertyFilterObjectSource "My Contains Property Filter"
# In My Contains Property Filter set the Property Type property to Ambient Color (Ambient).
SetProperty "/Object Sources/My Contains Property Filter" ContainsPropertyFilterPropertyTypeName Ambient
# In My Contains Property Filter set the Operation property to EXCLUDE.
SetProperty "/Object Sources/My Contains Property Filter" ContainsPropertyFilterOperation EXCLUDE

CreateFixedSortFilterObjectSource

z 軸の位置に応じてノードを並べる、またはそのマテリアルタイプでグループ化するには、ソートフィルタ (Sorting Filter) を使用します。

構文

CreateFixedSortFilterObjectSource itemName

パラメータ

itemName

フィルタの名前。

例

# Create a Sorting Filter named My Sorting Filter in the Library > Rendering > Object Sources.
CreateFixedSortFilterObjectSource "My Sorting Filter"
# Set the Sorting Type property of My Sorting Filter to Material type.
SetProperty "/Object Sources/My Sorting Filter" FixedSortType MATERIAL_TYPE
# In My Sorting Filter set the Reverse Order property to enabled.
SetProperty "/Object Sources/My Sorting Filter" FixedSortReverse true

CreateObjectTypeFilterObjectSource

タイプに応じたノードを選択するには、オブジェクトタイプフィルタ (Object Type Filter) を使用します。

構文

CreateObjectTypeFilterObjectSource itemName

パラメータ

itemName

フィルタの名前。

例

# Create an Object Type Filter named My Object Type Filter in the Library > Rendering > Object Sources.
CreateObjectTypeFilterObjectSource "My Object Type Filter"
# In My Object Type Filter set the Type property to Light.
SetProperty "/Object Sources/My Object Type Filter" ObjectTypeFilterObjectType LIGHT
# In My Object Type Filter set the Operation property to Exclude.
SetProperty "/Object Sources/My Object Type Filter" ObjectTypeFilterOperation EXCLUDE

CreatePropertyIsEqualObjectSource

特定の値に一致する特定のプロパティを持つノード、または特定の値に一致する特定のプロパティを持たないノードを選択するには、プロパティイズイコールフィルタ (Property Is Equal Filter) を使用します。

構文

CreatePropertyIsEqualObjectSource itemName

パラメータ

itemName

フィルタの名前。

例

# Create a Property Is Equal Filter named My Property Is Equal Filter in the Library > Rendering > Object Sources.
CreatePropertyIsEqualObjectSource "My Property Is Equal Filter"

CreateTagFilter

特定のタグが割り当てられているノードを収集するには、タグフィルタ (Tag Filter) を使用します。

構文

CreateTagFilter itemName

パラメータ

itemName

フィルタの名前。

例

# Create a Tag Filter named My Tag Filter in the Library > Rendering > Object Sources.
CreateTagFilter "My Tag Filter"
# Create a tag named My Tag in the Library > Tags.
CreateTag "My Tag" false
# Create a tag named Lights in the Library > Tags.
CreateTag "Lights" false
# In My Tag Filter set the Included Tags list to contain the My Tag and Lights tags.
SetProperty "/Object Sources/My Tag Filter" TagFilterIncludeList "/Tags/My Tag#/Tags/Lights"
# In My Tag Filter set the Excluded Tags list to contain the Transparent tag.
SetProperty "/Object Sources/My Tag Filter" TagFilterExcludeList "/Tags/Transparent"

テクスチャ作成 (Texture Creation)

CreateEnvironmentCubeMapTexture

環境を表現するために、屋外のシーンなどの環境キューブマップテクスチャを使用します。環境キューブマップテクスチャは、6つの正方形の画像を1つのテクスチャに組み合わせたものです。

構文

CreateEnvironmentCubeMapTexture imageFile size name

パラメータ

imageFile	環境キューブマップテクスチャを生成したいHDR画像。
size	正方形のキューブマップサイド画像の幅と高さ。
name	（オプション）環境キューブマップテクスチャの名前。

例

# Create an environment cubemap texture named My Environment Cubemap Texture
# from the Library > Resource Files > Images > my_skybox_image.exr image and
# set the size of the cubemap side images to 1024x1024 pixels.
CreateEnvironmentCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 1024 "My Environment Cubemap Texture"

# Create an environment cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image. Let Kanzi Studio name the texture
# my_skybox_image_environment and set the size of the cubemap side images to
# 1024x1024 pixels.
CreateEnvironmentCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 1024

構文

CreateEnvironmentCubeMapTexture imageFile

パラメータ

imageFile

環境キューブマップテクスチャを生成したいHDR画像。

例

# Create an environment cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image and let Kanzi Studio name the texture
# my_skybox_image_environment. Kanzi Studio creates cubemap side images whose
# dimensions are one quarter of the width of the input image.
CreateEnvironmentCubeMapTexture "/Resource Files/Images/my_skybox_image.exr"

CreateIrradianceCubeMapTexture

イメージベースのライティングには、イラディアンスキューブマップテクスチャ (irradiance cubemap texture) を使用します。イラディアンスキューブマップテクスチャは、6 つの正方形画像を 1 つのテクスチャに結合し、拡散環境光を表現します。

構文

CreateIrradianceCubeMapTexture sourceImage samples size name

パラメータ

sourceImage	放射照度キューブマップテクスチャを生成したいHDR画像。
samples	キューブマップを生成するために使用するサンプルの数。サンプルの数が多いほど、環境照明をより正確に近似するキューブマップが得られます。
size	正方形のキューブマップサイド画像の幅と高さ。
name	（オプション）イラディアンスキューブマップテクスチャの名前。

例

# Create an irradiance cubemap texture named My Irradiance Cubemap Texture
# from the Library > Resource Files > Images > my_skybox_image.exr image.
# Use 256 samples and set the size of the cubemap side images to 1024x1024
# pixels.
CreateIrradianceCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 256 1024 "My Irradiance Cubemap Texture"

# Create an irradiance cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image and let Kanzi Studio name the texture
# my_skybox_image_irradiance. Use 1024 samples and set the size of the cubemap
# side images to 256x256 pixels.
CreateIrradianceCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 1024 256

構文

CreateIrradianceCubeMapTexture sourceImage

パラメータ

sourceImage

放射照度キューブマップテクスチャを生成したいHDR画像。

例

# Create an irradiance cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image and let Kanzi Studio name the texture
# my_skybox_image_irradiance. Kanzi Studio uses 1024 samples to generate the
# cubemap and creates cubemap side images whose dimensions are one quarter
# of the width of the input image but at most 256 pixels.
CreateIrradianceCubeMapTexture "/Resource Files/Images/my_skybox_image.exr"

CreateRenderTargetTexture (CreateRenderTargetTexture)

レンダーターゲットテクスチャ (Render Target Texture) を使用して、2Dレイアウトからコンテンツを動的にテクスチャにレンダリングします。

構文

CreateRenderTargetTexture textureName

パラメータ

textureName

テクスチャの名前。

例

# Create a render target texture named My Render Target Texture in the Library > Materials and Textures > Textures.
CreateRenderTargetTexture "My Render Target Texture"
# In My Render Target Texture set the Width and Height properties to 256.
SetProperty "/Textures/My Render Target Texture" RenderTargetTextureWidth 256
SetProperty "/Textures/My Render Target Texture" RenderTargetTextureHeight 256

CreateSingleTexture (シングルテクスチャを作成)

単一の画像をテクスチャとして使用したい場合は、シングルテクスチャ (Single Texture) を使用します。

構文

CreateSingleTexture textureName image

パラメータ

textureName	テクスチャの名前。
image	（オプション）テクスチャに使用するように設定した画像リソース。

例

# Create a single texture named My Single Texture in the Library > Materials and Textures > Textures.
CreateSingleTexture "My Single Texture"

# Create a single texture named Image01 Texture in the Library > Materials and Textures > Textures and
# set the texture to use the Library > Resource Files > Images > Image01.png image.
CreateSingleTexture "Image01 Texture" "/Resource Files/Images/Image01.png"

CreateSpecularCubeMapTexture

イメージベースのライティングには、スペキュラキューブマップテクスチャ (specular cubemap texture) を使用します。スペキュラキューブマップテクスチャは、6 つの正方形画像を 1 つのテクスチャに結合し、反射環境ライティングを表現します。

構文

CreateSpecularCubeMapTexture sourceImage samples size name

パラメータ

sourceImage	スペキュラキューブマップテクスチャを生成したいHDR画像。
samples	キューブマップを生成するために使用するサンプルの数。サンプルの数が多いほど、環境照明をより正確に近似するキューブマップが得られます。
size	正方形のキューブマップサイド画像の幅と高さ。
name	（オプション）スペキュラキューブマップテクスチャの名前。

例

# Create a specular cubemap texture named My Specular Cubemap Texture
# from the Library > Resource Files > Images > my_skybox_image.exr image.
# Use 256 samples and set the size of the cubemap side images to 1024x1024 pixels.
CreateSpecularCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 256 1024 "My Specular Cubemap Texture"

# Create a specular cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image and let Kanzi Studio name the texture
# my_skybox_image_specular. Use 1024 samples and set the size of the cubemap
# side images to 256x256 pixels.
CreateSpecularCubeMapTexture "/Resource Files/Images/my_skybox_image.exr" 1024 256

構文

CreateSpecularCubeMapTexture sourceImage

パラメータ

sourceImage

スペキュラキューブマップテクスチャを生成したいHDR画像。

例

# Create a specular cubemap texture from the Library > Resource Files >
# Images > my_skybox_image.exr image and let Kanzi Studio name the texture
# my_skybox_image_specular. Kanzi Studio uses 1024 samples to generate the
# cubemap and creates cubemap side images whose dimensions are one quarter
# of the width of the input image but at most 256 pixels.
CreateSpecularCubeMapTexture "/Resource Files/Images/my_skybox_image.exr"

トラジェクトリ作成 (Trajectory Creation)

CreateAngleTrajectory (アングルトラジェクトリを作成)

3D空間内で V 字の軌跡を作成するには、アングルトラジェクトリ (Angle Trajectory) を使用します。

構文

CreateAngleTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create an Angle Trajectory named My Angle Trajectory in the Library > Trajectories.
CreateAngleTrajectory "My Angle Trajectory"

構文

CreateAngleTrajectory itemName selectNewItems resourceDictionary

パラメータ

itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create an Angle Trajectory named My Angle Trajectory and add it to the resource dictionary of the Screen node.
CreateAngleTrajectory "My Angle Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateArcTrajectory (アークトラジェクトリを作成)

3D 空間内で弧状の軌跡を作成するには、アークトラジェクトリ (Arc Trajectory) を使用します。

構文

CreateArcTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create an Arc Trajectory named My Arc Trajectory in the Library > Trajectories.
CreateArcTrajectory "My Arc Trajectory"

構文

CreateArcTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create an Arc Trajectory named My Arc Trajectory and add it to the resource dictionary of the Screen node.
CreateArcTrajectory "My Arc Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateCircleTrajectory (サークルトラジェクトリを作成)

3D 空間内で円弧状の軌跡を作成するには、サークルトラジェクトリ (Circle Trajectory) を使用します。

構文

CreateCircleTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create a Circle Trajectory named My Circle Trajectory in the Library > Trajectories.
CreateCircleTrajectory "My Circle Trajectory"

構文

CreateCircleTrajectory library itemName resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create a Circle Trajectory named My Circle Trajectory and add it to the resource dictionary of the Screen node.
CreateCircleTrajectory "My Circle Trajectory" "/Screens/Screen/<ResourceDictionaryInNode>"

CreateEllipseTrajectory (エリプストラジェクトリを作成)

3D 空間内で楕円状の軌跡を作成するには、エリプストラジェクトリ (Ellipse Trajectory) を使用します。

構文

CreateEllipseTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create an Ellipse Trajectory named My Ellipse Trajectory in the Library > Trajectories.
CreateEllipseTrajectory "My Ellipse Trajectory"

構文

CreateEllipseTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create an Ellipse Trajectory named My Ellipse Trajectory and add it to the resource dictionary of the Screen node.
CreateEllipseTrajectory "My Ellipse Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateLineTrajectory (ライントラジェクトリを作成)

3D 空間内で単一直線状の軌跡を作成するには、ライントラジェクトリ (Line Trajectory) を使用します。

構文

CreateLineTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create a Line Trajectory named My Line Trajectory in the Library > Trajectories.
CreateLineTrajectory "My Line Trajectory"

構文

CreateLineTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create a Line Trajectory named My Line Trajectory and add it to the resource dictionary of the Screen node.
CreateLineTrajectory "My Line Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateRectangleTrajectory (レクタングルトラジェクトリを作成)

3D 空間内で四角形状の軌跡を作成するには、レクタングルトラジェクトリ (Rectangle Trajectory) を使用します。

構文

CreateRectangleTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create a Rectangle Trajectory named My Rectangle Trajectory in the Library > Trajectories.
CreateRectangleTrajectory "My Rectangle Trajectory"

構文

CreateRectangleTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create a Rectangle Trajectory named My Rectangle Trajectory and add it to the resource dictionary of the Screen node.
CreateRectangleTrajectory "My Rectangle Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateSpiralTrajectory (スパイラルトラジェクトリを作成)

3D 空間内で螺旋状の軌跡を作成するには、スパイラルトラジェクトリ (Spiral Trajectory) を使用します。

構文

CreateSpiralTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create a Spiral Trajectory named My Spiral Trajectory in the Library > Trajectories.
CreateSpiralTrajectory "My Spiral Trajectory"

構文

CreateSpiralTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create a Spiral Trajectory named My Spiral Trajectory and add it to the resource dictionary of the Screen node.
CreateSpiralTrajectory "My Spiral Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

CreateTrapezoidTrajectory (トラペゾイドトラジェクトリ作成)

3D 空間内で台形状の軌跡を作成するには、トラペゾイドトラジェクトリ (Trapezoid Trajectory) を使用します。

構文

CreateTrapezoidTrajectory itemName

パラメータ

itemName

トラジェクトリの名前。

例

# Create a Trapezoid Trajectory named My Trapezoid Trajectory in the Library > Trajectories.
CreateTrapezoidTrajectory "My Trapezoid Trajectory"

構文

CreateTrapezoidTrajectory library itemName selectNewItems resourceDictionary

パラメータ

library	（オプション）トラジェクトリを作成するトラジェクトリライブラリ。
itemName	トラジェクトリの名前。
selectNewItems	Kanzi Studioがあなたが作成したトラジェクトリを選択するかどうか。
resourceDictionary	トラジェクトリを追加するリソースディクショナリ。

例

# Create a Trapezoid Trajectory named My Trapezoid Trajectory and add it to the resource dictionary of the Screen node.
CreateTrapezoidTrajectory "My Trapezoid Trajectory" false "/Screens/Screen/<ResourceDictionaryInNode>"

インポート (Import)

インポート画像

プロジェクトに画像をインポートする

構文

ImportImages filePath createTextures

パラメータ

filePath	インポートする画像へのパス。
createTextures	画像のテクスチャを作成するかどうか。

例

# Import the C:\Temp\Image.png image to the project and create a single texture of the image.
ImportImages "C:\Temp\Image.png" true

ディスク

CleanCachedFiles

プロジェクトを開いたり、kzbファイルをエクスポートしたときにKanzi Studioがプロジェクトディレクトリに作成したキャッシュファイルを削除します。

構文

CleanCachedFiles

例

# Delete the cache files that Kanzi Studio created in the project directory when you opened the project or exported the kzb file.
CleanCachedFiles

CloseSolution

現在開いているプライマリプロジェクトとその参照プロジェクトを閉じます。

構文

CloseSolution

例

# Close all projects.
CloseSolution

CompressImage

選択した画像を前処理します。前処理には、画像圧縮やミップマップの生成が含まれる場合があります。

構文

CompressImage imageFiles

パラメータ

imageFiles

プリプロセスしたい画像ファイル。

例

# Preprocess the images Car.png and Background.png.
CompressImage "/Resource Files/Images/Image01.png; /Resource Files/Images/Image02.png"

CreateKanziApplication

選択したビルド構成用にKanzi Engineアプリケーションを作成します。

構文

CreateKanziApplication buildConfiguration

パラメータ

buildConfiguration

アプリケーションを作成したいビルド構成へのパス。

例

# Create an Android build configuration named MyAndroidProject in the
# Library > Build Configurations.
CreateApplicationConfiguration MyAndroidProject Android
# Create a Kanzi application directory hierarchy for the MyAndroidProject
# build configuration.
CreateKanziApplication "/Resource Files/Build Configurations/MyAndroidProject"

# Create a common build configuration named MyProject in the
# Library > Build Configurations.
CreateApplicationConfiguration MyProject
# Create a Kanzi application directory hierarchy for the MyProject
# build configuration.
CreateKanziApplication "/Resource Files/Build Configurations/MyProject"

DeleteExportedBinaries

プロジェクト > プロパティで設定されたバイナリエクスポートディレクトリプロパティのディレクトリから、すべてのエクスポートされたファイルを削除します。このコマンドは、他のプロジェクトからのファイルを含むすべてのエクスポートされたファイルを削除します。

構文

DeleteExportedBinaries

例

# Delete the kzb files from the location set in the main project properties in the Binary Export Directory property.
DeleteExportedBinaries

構文

DeleteExportedBinaries exportDirectory

パラメータ

exportDirectory

kzbファイルを削除したいディレクトリ。

例

# Delete all kzb files from the C:\Temp directory.
DeleteExportedBinaries "C:\Temp"

ExitApplication

Kanzi Studio を閉じます。

構文

ExitApplication allowCancel silentExit

パラメータ

allowCancel	ユーザーがアクションをキャンセルできるかどうか。
silentExit	Kanzi Studioがダイアログを表示せずに閉じるかどうか。

例

# Close Kanzi Studio but let the user cancel the closing. Show dialogs when closing Kanzi Studio.
ExitApplication true false

構文

ExitApplication

例

# Close Kanzi Studio.
ExitApplication

ExportAllProjectBinaries

メインプロジェクトおよびロードされた参照プロジェクトのkzbファイルをエクスポートします。エクスポートされたkzbファイルを、メインプロジェクトプロパティのBinary Export Directoryプロパティで設定されたディレクトリにコピーします。

構文

ExportAllProjectBinaries

例

# Export the kzb files of the main project and loaded referenced projects to the location set
# in the main project properties in the Binary Export Directory property.
ExportAllProjectBinaries

構文

ExportAllProjectBinaries targetDirectory compressImages exportKzbPlayer

パラメータ

targetDirectory	kzbファイルをエクスポートしたいディレクトリ。
compressImages	プロジェクト内の画像を前処理するかどうか。
exportKzbPlayer	プロジェクトをスタンドアロンのWindowsアプリケーションとしてkzb Playerを使用してエクスポートするかどうか。

例

# Export the kzb files of the main project and loaded referenced projects to the C:\Temp\MyProject\ directory,
# preprocess the images, and export the project as kzb Player for Windows.
ExportAllProjectBinaries "C:\Temp\MyProject\" true true

ExportBakedThemeBinaries

エクスポートベイクド使用プロパティが有効になっているテーマグループとメインローカライゼーションテーブルの各組み合わせに対して、kzbファイルをエクスポートします。

構文

ExportBakedThemeBinaries

例

# Export baked themes.
ExportBakedThemeBinaries

ExportBinary

Kanzi Engine APIで使用するためのkzbファイルと、ロケールおよびテーマの設定に従ったkzbリソースパックをエクスポートします。

構文

ExportBinary exportThemesAndLocaleResourcesSeparately exportXml

パラメータ

exportThemesAndLocaleResourcesSeparately	Kanzi Studioがテーマとロケールリソースを別々のkzbファイルにエクスポートするかどうか。
exportXml	Kanzi Studioがkzaファイルをエクスポートするかどうか、これはkzbファイルのXMLバージョンです。

例

# Export the kzb file, theme and locale resources, and the kza file to the location set in the Project > Properties in the Binary Export Directory property.
ExportBinary true true

構文

ExportBinary fileName

パラメータ

fileName

kzbファイルの名前。

例

# Export the kzb file to the C:\Temp\project.kzb file.
ExportBinary C:\Temp\project.kzb

ExportBinaryWithApplication

kzb Playerとkzbファイルを使用して、プロジェクトをスタンドアロンのWindowsアプリケーションとしてエクスポートします。

構文

ExportBinaryWithApplication

ExportDescriptions

プロジェクト内のすべてのDescriptionプロパティの内容をプレーンテキストファイルにエクスポートします。

構文

ExportDescriptions root outputFile

パラメータ

root	（オプション）エクスポートする説明のノードツリーのルートノード。このパラメーターを設定しない場合、Kanzi Studioはプロジェクト内のすべてのアイテムの説明をエクスポートします。
outputFile	説明をエクスポートするファイル。

例

# Export the project documentation to the plain text file C:\Temp\Descriptions.txt.
# The file includes the name, path, and description of items that have the Description property.
ExportDescriptions "C:\Temp\Descriptions.txt"

# Export the descriptions of the RootPage > Viewport 2D > Scene node and its descendants
# to the plain text file C:\Temp\Descriptions.txt.
ExportDescriptions "/Screens/Screen/RootPage/Viewport 2D/Scene" "C:\Temp\Descriptions.txt"

ImportProject

別の Kanzi Studio プロジェクトをアクティブなプロジェクトにインポートします。

構文

ImportProject importProjectPath

パラメータ

importProjectPath

インポートするKanzi Studioプロジェクトファイルのフルパス名。

例

# Import the Kanzi Studio project C:\KanziWorkspace\Projects\My Project\My Project.kzproj.
ImportProject "C:\KanziWorkspace\Projects\My Project\My Project.kzproj"

LoadMaterialType (マテリアルタイプ)

ロードマテリアルタイプフロムディスク (Load Material Type From Disk)

構文

LoadMaterialType loadPath

パラメータ

loadPath

ロードするkzmatファイルへのパス。

例

# Load the C:\Program Files\Rightware\Kanzi\Studio\Asset Library\MaterialTypes\VertexPhong\Postprocessing\PostprocessingBoxBlur.kzmat file.
# Kanzi Studio adds to the Library > Materials and Textures > Material Types the PostprocessingBoxBlur material type and
# creates the PostprocessingBoxBlurMaterial material which uses the PostprocessingBoxBlur material type.
LoadMaterialType "C:\Program Files\Rightware\Kanzi\Studio\Asset Library\MaterialTypes\VertexPhong\Postprocessing\PostprocessingBoxBlur.kzmat"

LoadProject

ディスクからプロジェクトを開く。

構文

LoadProject path

パラメータ

path

開くプロジェクト。

例

# Open the C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj project.
LoadProject "C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj"

NewProject

Kanzi Studio プロジェクトを作成します。

構文

NewProject newProjectFilePath

パラメータ

newProjectFilePath

あなたが作成するプロジェクトへのパス。

例

# Create a new Kanzi Studio project C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj.
NewProject "C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj"

Saveマテリアルタイプ (Material Type)

セーブマテリアルタイプトゥーディスク (Save Material Type to Disk)

構文

SaveMaterialType savePath materialType

パラメータ

savePath	マテリアルタイプを保存するファイルへのフルパス。
materialType	保存するマテリアルタイプ。

例

# Save the My Material Type material type to the C:\Temp\My Material Type.kzmat file.
SaveMaterialType "C:\Temp\My Material Type.kzmat" "/Material Types/My Material Type"

SaveProject

プロジェクトをディスクに保存します。

構文

SaveProject savePath continueWorkingInOldPath

パラメータ

savePath	プロジェクトを保存する場所。
continueWorkingInOldPath	Kanzi Studioがプロジェクトを開いたディレクトリで作業を続けるかどうか。プロジェクトを別の場所に保存する場合は、このパラメータをfalseに設定してください。

例

# Save the C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj project.
SaveProject "C:\KanziWorkspace\Projects\MyProject\Tool_project\MyProject.kzproj" true

ビルディング (Building)

ExportApk

プロジェクト > プロパティ > ビルド > デフォルトビルド構成で設定されたビルド構成を使用して、Androidパッケージ (APK) をビルドおよびデプロイします。

構文

ExportApk buildConfiguration compressImages

パラメータ

buildConfiguration	Androidパッケージ (APK) をビルドする際に使用するビルド構成。
compressImages	プロジェクト内の画像を前処理するかどうか。

例

# Build the APK file using the Library > Build Configurations > MyProject application configuration.
# If the project contains images that use texture compression, compress these images.
ExportApk "/Resource Files/Build Configurations/MyProject" true

プレビュー (Preview)

StartPreview

プレビューを開始します。

構文

StartPreview

例

# Start the Preview.
StartPreview

ジェネラル (General)

プラグイン

Kanzi Studioプラグインで定義されたコマンドを実行します。

構文

Plugin pluginCommandName projectItem

パラメータ

pluginCommandName	プラグインコマンドの内部名。
projectItem	（オプション）プラグインコマンドを実行したいコンテキストメニューからのプロジェクトアイテム。

例

# Execute the Kanzi Studio plugin command named MyPluginCommand.
Plugin "MyPluginCommand"

# Execute the Kanzi Studio plugin command named MyPluginCommand from the context menu of the RootPage node.
Plugin "MyPluginCommand" "/Screens/Screen/RootPage"