Dictionary

Object Hierarchy | Related C++ Class: Dictionary

Inheritance

    SIObject
       Dictionary

Introduced

1.5

Description

The dictionary object contains application definitions such as siFamily objects. It also provides a very handy way to get an object using it's path name with the Dictionary.GetObject method. The Dictionary object is a member of the Application object.

Note: This object should not be confused with the "Scripting.Dictionary" ActiveX object available to JScript and VBScript. The Scripting.Dictionary object is useful as a collection for handling named values, whereas this object provides information only about Softimage objects. Tip: See siFamily for a list of available families in the object model.

Methods

GetObject | Info | IsClassOf | IsEqualTo

Properties

Application | Categories | FullName | Help
Name | NestedObjects | Origin | OriginPath
Parent | Type |  |

Examples

1. VBScript Example

    ' *******************************************************************
    ' Demonstrate usage of the Dictionary.Info method with Name parameter
    ' *******************************************************************
    ' Get specific info on ClusterCenter
    LogMessage Application.Dictionary.Info("ClusterCenter")

    ' OUTPUT IS:
    'INFO : "ClusterCenter
    'Families = Operators, DeformOperators
    'Number Of Groups = 2
    '
    '  Group(0)
    '  Flags = E3DOPGROUP_MAIN
    '  Bounds = 1..1
    '  Filter = Components for Deforms
    '  Pick Prompt = Deformation Value
    '
    '  Group(1)
    '  Flags =<undefined>
    '  Bounds = 1..1
    '  Filter = <undefined>
    '  Pick Prompt = Cluster center object
    '
    '"

2. VBScript Example

    ' *********************************************************************
    ' Demonstrate usage of the Dictionary.Info method with Family parameter
    ' *********************************************************************
    ' Get list of available groups
    LogMessage Dictionary.Info(,siGroupFamily)

    ' OUTPUT IS:
    'INFO : "3D group, Entity Name, Partition, Layer, User group, Partition"

3. VBScript Example

    ' ****************************************************
    ' Demonstrate usage of the Dictionary.GetObject method
    ' ****************************************************

    ' Create a new cone named "foozibarr"
    ActiveSceneRoot.AddGeometry "Cone", "MeshSurface", "foozibarr"

    ' Find the subdivu parameter from the cone
    Set oSubdivuParam = Dictionary.GetObject("foozibarr.polymsh.geom.subdivu")
    Application.LogMessage "Found a " & oSubdivuParam.Type & " (" & ClassName(oSubdivuParam) & ")"

    ' Find the cone by its name
    Set oCone = Dictionary.GetObject("foozibarr")
    Application.LogMessage "Found a " & oCone.Type  & " (" & ClassName(oCone) & ")"

    ' OUTPUT OF ABOVE SCRIPT:
    'INFO : "Found a Parameter (CollectionItem)"
    'INFO : "Found a polymsh (X3DObject)"

Autodesk Softimage v7.5