EditParameterDefinition

導入

v1.5

詳細

カスタム パラメータの定義を編集します。 スキップされた引数は、変更されないままで残ります。

プロキシ パラメータについては、このコマンドを使用してパラメータ名と推奨範囲を調整できますが、マスタ パラメータは影響されません。 ただし、プロキシ パラメータの Min および Max 属性は、マスタ パラメータの Min 値および Max 値と同じである必要があります。

スクリプト構文

EditParameterDefinition( [InputObj], [ParamName], [VarType], [MinValue], [MaxValue], [SuggMin], [SuggMax], [ScriptName], [Description] );

パラメータ

パラメータ タイプ 説明
InputObj 文字列 カスタム パラメータのリスト

デフォルト値: マーク パラメータ

ParamName 文字列 カスタム パラメータの名前。 カスタム パラメータ名は、シーン Explorer に表示されます("Show script names"が有効でない場合)。
VarType siVariantType (旧バージョンのコマンド)この引数を指定しても無視されます。

デフォルト値: 0

MinValue Double パラメータの最小値
MaxValue Double パラメータの最大値
SuggMin Double パラメータの推奨最小値(UI コントロール用)
SuggMax Double パラメータの推奨最大値(UI コントロール用)
ScriptName 文字列 パラメータ名のスクリプト バージョン。 文字列の中にスペースを含むことはできません。
詳細 文字列 より長い、パラメータ名の説明的バージョン。 この名前は、オブジェクトの確認時にプロパティ ページに表示されます。

VBScript の例

'

' This example creates a new custom property set and a new

' parameter on a dummy null and then changes its definition.

' The parameter information is logged to the Script Editor

' History Pane so you can see what has changed.

'

' Create a null to hold the new custom property set

set oDummy = GetPrim( "Null" )

' Add custom property set called Emotions to the dummy

AddProp "Custom_parameter_list", , , "Emotions"

' Add custom parameter Happiness to the Emotions property set

SIAddCustomParameter "null.Emotions", "Happiness", _

			siDouble, 0.000, 0.000, 1.000, , 5, 0.000, 1.000

' What does it look like before editing the definition?

printParamInfo oDummy.Properties( "Emotions" ).Parameters(0)

' Update the minimum and maximum values of Happiness

EditParameterDefinition oDummy & ".Emotions.Happiness", , , _

			-100, 100, -100, 100

' What does it look like afterwards?

printParamInfo oDummy.Properties( "Emotions" ).Parameters(0)

' Convenience function--saves time and typing

function printParamInfo( in_parameter )

	LogMessage in_parameter & " information:"

	LogMessage "-------------------------------------"

	LogMessage vbTab & "Default value: " & vbTab & vbTab & in_parameter.Default

	LogMessage vbTab & "Description: " & vbTab & vbTab & in_parameter.Description

	LogMessage vbTab & "Is " & in_parameter.ScriptName & " marked?: " & vbTab & in_parameter.Marked

	LogMessage vbTab & "SuggestedMin value: " & vbTab & in_parameter.SuggestedMin

	LogMessage vbTab & "SuggestedMax value: " & vbTab & in_parameter.SuggestedMax

	LogMessage vbTab & "Actual Min value: " & vbTab & in_parameter.Min

	LogMessage vbTab & "Actual Max value: " & vbTab & in_parameter.Max

	LogMessage vbTab & "ScriptName: " & vbTab & vbTab & in_parameter.ScriptName

	LogMessage vbTab & "Value Type: " & vbTab & vbTab & in_parameter.ValueType & " (" & TypeName( in_parameter ) & ")"

	LogMessage vbTab & "Actual Value: " & vbTab & vbTab & in_parameter.Value

end function 



' Output of above script:

' ...before editing the parameter definition:

'INFO : "null.Emotions.Happiness information:"

'INFO : "-------------------------------------"

'INFO : "	Default value: 		0"

'INFO : "	Description: 		Happiness"

'INFO : "	Is Happiness marked?: 	False"

'INFO : "	SuggestedMin value: 	0"

'INFO : "	SuggestedMax value: 	1"

'INFO : "	Actual Min value: 	0"

'INFO : "	Actual Max value: 	1"

'INFO : "	ScriptName: 		Happiness"

'INFO : "	Value Type: 		5 (Parameter)"

'INFO : "	Actual Value: 		0"

'

' ...afterwards:

'INFO : "null.Emotions.Happiness information:"

'INFO : "-------------------------------------"

'INFO : "	Default value: 		0"

'INFO : "	Description: 		Happiness"

'INFO : "	Is Happiness marked?: 	False"

'INFO : "	SuggestedMin value: 	-100"

'INFO : "	SuggestedMax value: 	100"

'INFO : "	Actual Min value: 	-100"

'INFO : "	Actual Max value: 	100"

'INFO : "	ScriptName: 		Happiness"

'INFO : "	Value Type: 		5 (Parameter)"

'INFO : "	Actual Value: 		0"

関連項目

SIAddCustomParameter RemoveCustomParam パラメータ CustomProperty