EditICECompoundProperties

Introduced

v10.5 (2012)

Description

Modifies the properties of an ICE Compound, such as the version number, the description, the Category or Task (and therefore its location), the construction mode, etc.

This is the scripting equivalent of opening up the Compound Properties property page from the Compounds menu in an ICE Tree.

Scripting Syntax

EditICECompoundProperties( Compound, Name, [Category], [Tasks], [Author], [Description], [URL], [VersionMajor], [VersionMinor], [VersionTag], [ModeForApplyICEOp], [BackgroundColor], [PPGLogic], [PPGLogicLanguage] );

Parameters

Parameter Type Description
Compound Object Name (or a pointer to it). Which ICE Compound you want to modify
Name String Name for the compound
Category String Category for the compound

Default Value: ""

Tasks String Task keyword for the compound

Default Value: ""

Author String Name of the compound's author

Default Value: ""

Description String Description of how the compound can be used

Default Value: ""

URL String URL of any information available for this compound

Default Value: ""

VersionMajor Integer Major version (eg., the '2' of v2.5)

Default Value: 0

VersionMinor Integer Minor version (eg., the '5' of v2.5)

Default Value: 0

VersionTag String A gentle reminder of which version this is

Default Value: ""

ModeForApplyICEOp Integer Construction mode for ApplyICEOp

Default Value: 4

Possible Values:

Description:

0 Modeling
1 Shape
2 Animation
3 Secondary Shape
4 Current (construction mode at the time the ICE compound was saved.)
5 Simulation
6 Post Simulation
BackgroundColor Integer The color that will appear on the compound node when it is successfully connected in an ICE tree.

Default Value: 6732954 (light green)

PPGLogic String A string containing a code block defining callbacks. Similar to the SPDL logic section.

Default Value: ""

PPGLogicLanguage String Scripting Language to use for the PPGLogic.

Default Value: If empty, VBScript will be assumed.

Examples

JScript Example

// See the example on the ReplaceICECompoundNode command reference page

See Also

AddICECompoundNode AddICENode AddExposedParamToICECompoundNode AddNodeToICECompoundNode AddPortToICENode CleanDisconnectedICENodes ConnectICENodes CreateICECompoundNode DisconnectICENodePort EditExposedParamInICECompoundNode EditICECompoundPPGLogic ExplodeICECompoundNode ExportICECompoundNode GetICECompoundPortProperties GetICECompoundProperties RemoveExposedParamFromICECompoundNode RemoveNodeFromICECompoundNode RemovePortFromICENode ReplaceICECompoundNode ICECompoundNode