showInterfaces Inspector Function

showInterfaces {<maxwrapper> | <maxclass> | node} [ to:<stream> ]

where, <maxwrapper> is the 3ds Max object to be inspected.

<maxclass> is the 3ds Max class to be inspected.

The optional to:<stream> keyword argument specifies a Stream Value to output the display to.

When the 3ds Max entity specified is a node (for example, $box01), this function only displays the Interfaces of the base object. It does not show the Interfaces of the transform controllers, modifiers, or materials applied to the object. To display the Interfaces for one of these objects, the object must be specified as the 3ds Max entity.

As a special case, you can also call showInterfaces() on the superclass 'Node' to display the interfaces that are common to all scene nodes.

The display of interface information is divided into three sections: Properties, Methods, and Actions.

In the Properties section, each property exposed by the interface is listed along with its data type or enumeration values and whether the property can be read and written to.

In the Methods section, each method is listed along with its return type and its argument list. The value type for each argument is shown. If the return type is shown as <void>, the method returns a value of 'ok'. Methods that are used by Actions are commented as such. These methods typically require that the object be selected and active in the appropriate command panel.

In the Actions section, each Action is listed along with its category and action description as shown in the Customize User Interface dialog, and the shortcut keys, if any, assigned to the Action.

NOTE:Refer to MAXScript Class Hierarchy to see which objects are exposed using maxwrapper.

EXAMPLE

showinterfaces node

OUTPUT

  Interface: IAssembly
   Properties:
    .assemblyMember : boolean : Read|Write
    .assemblyHead : boolean : Read|Write
    .assemblyMemberOpen : boolean : Read|Write
    .assemblyHeadOpen : boolean : Read|Write
    .assemblyBBoxDisplay : boolean : Read|Write
   Methods:
   Actions:
  Interface: INodeGIProperties
   Properties:
    .isGIExcluded : boolean : Read|Write
    .isGIOccluder : boolean : Read|Write
    .isGIReceiver : boolean : Read|Write
    .isGIDiffuse : boolean : Read|Write
    .isGISpecular : boolean : Read|Write
    .GIUseGlobalMeshing : boolean : Read|Write
    .GIMeshingEnabled : boolean : Read|Write
    .nbGIRefineSteps : integer : Read|Write|Validated by Range: 0 to 65535
    .nbGIRefineStepsDone : integer : Read|Write|Validated by Range: 0 to 65535
    .GIMeshSize : worldUnits : Read|Write|Validated by Range: 0.01 to 1e+009
    .isGIExcludedFromRegather : boolean : Read|Write
    .storeIllumToMesh : boolean : Read|Write
    .GIByLayer : boolean : Read|Write
    .GIRayMult : float : Read|Write
    .GIUseAdaptiveSubdivision : boolean : Read|Write
    .GIMinMeshSize : float : Read|Write
    .GIInitialMeshSize : float : Read|Write
    .GIContrastThreshold : float : Read|Write
   Methods:
   Actions:
  Interface: INodeGIProperties
   Properties:
    .isGIExcluded : boolean : Read|Write
    .isGIOccluder : boolean : Read|Write
    .isGIReceiver : boolean : Read|Write
    .isGIDiffuse : boolean : Read|Write
    .isGISpecular : boolean : Read|Write
    .GIUseGlobalMeshing : boolean : Read|Write
    .GIMeshingEnabled : boolean : Read|Write
    .nbGIRefineSteps : integer : Read|Write|Validated by Range: 0 to 65535
    .nbGIRefineStepsDone : integer : Read|Write|Validated by Range: 0 to 65535
    .GIMeshSize : worldUnits : Read|Write|Validated by Range: 0.01 to 1e+009
    .isGIExcludedFromRegather : boolean : Read|Write
    .storeIllumToMesh : boolean : Read|Write
    .GIByLayer : boolean : Read|Write
    .GIRayMult : float : Read|Write
    .GIUseAdaptiveSubdivision : boolean : Read|Write
    .GIMinMeshSize : float : Read|Write
    .GIInitialMeshSize : float : Read|Write
    .GIContrastThreshold : float : Read|Write
   Methods:
   Actions:
  Interface: INode
   Properties:
    .boneEnable : boolean : Read|Write
    .posTaskWeight : float : Read|Write
    .rotTaskWeight : float : Read|Write
    .boneAutoAlign : boolean : Read|Write
    .boneFreezeLength : boolean : Read|Write
    .boneScaleType : enum : Read|Write
       boneScaleType enums: {#scale|#squash|#none}
    .stretchTM : matrix3 by value : Read
    .boneAxis : enum : Read|Write
       boneAxis enums: {#X|#Y|#Z}
    .boneAxisFlip : boolean : Read|Write
    .primaryVisibility : boolean : Read|Write
    .secondaryVisibility : boolean : Read|Write
    .applyAtmospherics : boolean : Read|Write
    .vertexColorType : enum : Read|Write
       vertexColorType enums: {#color|#illum|#alpha|#color_plus_illum|#soft_select|#map_channel}
    .showVertexColors : integer : Read|Write
    .shadeVertexColors : integer : Read|Write
    .vertexColorMapChannel : integer : Read|Write
    .handle : DWORD : Read
    .posInParent : point3 : Read
    .rotInParent : point3 : Read
    .scaleInParent : point3 : Read
    .scaleOrientInParent : quat : Read
   Methods:
    <void>setBoneEnable <boolean>onOff <time>time
    <void>realignBoneToChild()
    <void>resetBoneStretch()
   Actions:
  Interface: INodeLayerProperties
   Properties:
    .layer : Interface : Read
    .displayByLayer : boolean : Read|Write
    .renderByLayer : boolean : Read|Write
    .motionByLayer : boolean : Read|Write
    .colorByLayer : boolean : Read|Write
    .globalIlluminationByLayer : boolean : Read|Write
   Methods:
   Actions:
  Interface: INodeBakeProperties
   Properties:
    .bakeEnabled : boolean : Read|Write
    .bakeChannel : integer : Read|Write
    .nDilations : integer : Read|Write
    .flags : integer : Read|Write
    .surfaceArea : float : Read|Write
    .areaScale : float : Read|Write
    .activeOriginX : float : Read|Write
    .activeOriginY : float : Read|Write
    .activeWidth : float : Read|Write
    .activeHeight : float : Read|Write
   Methods:
    <boolean>addBakeElement <maxObject>element
    <boolean>removeBakeElement <maxObject>element
    <boolean>removeBakeElementByIndex <index>elementIndex
    <boolean>removeBakeElementByName <string>elementName
    <void>removeAllBakeElements()
    <integer>numBakeElements()
    <maxObject>getBakeElement <index>index
    <index>findByName <string>elementName
    <integer>renderWidth()
    <integer>renderHeight()
    <boolean>effectiveEnable()
    <integer>numElementParams <maxObject>element
    <string>paramName <maxObject>element <index>paramIndex
    <integer>paramType <maxObject>element <index>paramIndex
    <fpvalue by value>paramValue <maxObject>element <index>paramIndex
    <void>setParamValue <maxObject>element <index>paramIndex <fpvalue by value>paramValue
    <fpvalue by value>paramValueMin <maxObject>element <index>paramIndex
    <fpvalue by value>paramValueMax <maxObject>element <index>paramIndex
    <index>findParam <maxObject>element <string>paramName
    <fRGBA color by value>GetBackgroundColor <maxObject>element
    <void>SetBackgroundColor <maxObject>element <fRGBA color by value>color
   Actions:
  Interface: SkinPose
   Properties:
    .skinPos : point3 by value : Read|Write
    .skinRot : point3 by value : Read|Write
    .skinScale : point3 by value : Read|Write
    .skinScaleOrient : quat by value : Read|Write
    .skinPosEnabled : bool : Read|Write
    .skinRotEnabled : bool : Read|Write
    .skinScaleEnabled : bool : Read|Write
    .skinPoseMode : bool : Read|Write
   Methods:
    <void>setSkinPose()
    <void>assumeSkinPose()
   Actions:
  Interface: INodeBakeProjProperties
   Properties:
    .enabled : boolean : Read|Write
    .projectionMod : maxObject : Read|Write
    .projectionModTarget : string : Read|Write
    .cropAlpha : boolean : Read|Write
    .projSpace : enum : Read|Write
       projSpace enums: {#raytrace|#uvw_match}
    .normalSpace : enum : Read|Write
       normalSpace enums: {#world|#screen|#local|#tangent}
    .tangentYDir : enum : Read|Write
       tangentYDir enums: {#Y_Up|#Y_Down}
    .tangentXDir : enum : Read|Write
       tangentXDir enums: {#X_Right|#X_Left}
    .useCage : boolean : Read|Write
    .rayOffset : float : Read|Write
    .hitResolveMode : enum : Read|Write
       hitResolveMode enums: {#closest|#furthest}
    .hitMatchMtlID : boolean : Read|Write
    .hitWorkingModel : boolean : Read|Write
    .warnRayMiss : boolean : Read|Write
    .rayMissColor : color : Read|Write
    .heightMapMin : float : Read|Write
    .heightMapMax : float : Read|Write
    .heightBufMin : float : Read|Write
    .heightBufMax : float : Read|Write
    .BakeObjectLevel : boolean : Read|Write
    .BakeSubObjLevels : boolean : Read|Write
    .useObjectBakeForMtl : boolean : Read|Write
    .proportionalOutput : boolean : Read|Write
    .subObjBakeChannel : integer : Read|Write
   Methods:
   Actions:
  Interface: INodeMentalRayProperties
   Properties:
    .mr_displacementUseGlobalSettings : bool : Read|Write
    .mr_displacementMethod : enum : Read|Write
       mr_displacementMethod enums: {#Fine|#Fine_NoSmoothing}
    .mr_viewDependentDisplacement : bool : Read|Write
    .mr_displacementEdgeLength : float : Read|Write
    .mr_maxDisplace : float : Read|Write
    .mr_displacementMaxLevel : integer : Read|Write
    .mr_rcvFGIllum : bool : Read|Write
    .mr_castModeFGIllum : enum : Read|Write
       mr_castModeFGIllum enums: {#ObjColor|#Black|#Invisible}
    .mr_excludeGlobalIllum : bool : Read|Write
    .mr_excludeCaustics : bool : Read|Write
   Methods:
   Actions:
  Interface: INodeDisplayProperties
   Properties:
    .NeverDegrade : boolean : Read|Write
   Methods:
   Actions:
  Interface: INodeShadingProperties
   Properties:
    .ViewportShadowCasting : bool : Read|Write
    .ViewportIllumination : bool : Read|Write
    .LockedViewportIllumination : bool : Read|Write
   Methods:
   Actions:
OK

showInterfaces Inspector Function

See Also