hyperShade

Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

hyperShade [-assign string] [-clearWorkArea] [-collapse string] [-createNode string] [-dependGraphArea boolean] [-downStream] [-duplicate] [-fixRenderSize boolean] [-incremental boolean] [-listDownstreamNodes name] [-listDownstreamShaderNodes name] [-listUpstreamNodes name] [-name string] [-networks] [-noSGShapes] [-noShapes] [-noTransforms] [-objects string] [-renderCreateAndDrop string] [-reset] [-resetGraph] [-resetSwatch] [-setAllowsRegraphing boolean] [-setWorkArea string] [-shaderNetwork string] [-shaderNetworks] [-shaderNetworksSelectMaterialNodes] [-snapShot] [-uncollapse string] [-upStream] [-userDefinedLayout boolean] [-workAreaAddCmd string] [-workAreaDeleteCmd string] [-workAreaSelectCmd string]

hyperShade is undoable, NOT queryable, and NOT editable.

Return value

Keywords

Flags

Long name (short name)	Argument types	Properties
-assign(-a)	string
Assign the specified shader node to renderable objects on the active list. The node can either be a shading group or the shader node attached to the shading group.
-clearWorkArea(-cwa)
Push the current work area on to the stack and create a clear work area
-collapse(-clp)	string
Hide the upstream nodes from the specified node.
-createNode(-rcn)	string
Create a node of the specified type. This is called when a new rendering node is created using drag and drop from the image browser or from the RMB context sensitive menu on nodes in the Visor Create folders.
-dependGraphArea(-dg)	boolean
When setting a work area, and the work area doesn't already exist this flag inicates a new graph should be created that is either a depend graph or a folder view.
-downStream(-ds)
Show nodes downstream from the specified node
-duplicate(-dup)
Duplicate upstream nodes. If the node is a shader make sure duplicate include the shading group if there is one
-fixRenderSize(-fix)	boolean
If set to true dont rerender swatches when they change size as the user zooms
-incremental(-inc)	boolean
Enable or disable incremental layout when making new nodes or connections
-listDownstreamNodes(-ldn)	name
List all the downstream render nodes from the specified nodes.
-listDownstreamShaderNodes(-lds)	name
List all the downstream shader nodes from the specified nodes.
-listUpstreamNodes(-lun)	name
List all the upstream render nodes from the specified nodes.
-name(-n)	string
Name for the work area created by this command
-networks(-net)
Do an incremental layout on all of the nodes in the current selection list and that are in the current work area.
-noSGShapes(-nsg)
Display only shapes that are connected to nodes in the network other than a shading group.
-noShapes(-ns)
Display no shapes when graphing networks.
-noTransforms(-nt)
Display no transforms when graphing networks.
-objects(-o)	string
Select the objects which are attached to the specified shader node. The shader node can be either the shading group or the shader attached to the shading group. When this flag's argument is the empty string, we will use the currently selected shder node as the input.
-renderCreateAndDrop(-rcd)	string
Create a render node of the specified type and put user into drag and drop mode to place or connect it.
-reset(-rst)
Reset the Hypershade panel to its initial state. In particular delete all the work areas.
-resetGraph(-rsg)
Reset the current graph. Typically called prior to rebuilding a folder in a Hypershade view.
-resetSwatch(-rss)
For all selected nodes remove user defined swatches if the node has one
-setAllowsRegraphing(-sar)	boolean
For internal use only.
-setWorkArea(-swa)	string
Set the work area to the existing named work area
-shaderNetwork(-sn)	string
Show the shader network for the specified material node. If the materials shading group has a displacement or volume map these will be shown. If not then the shading group will not be shown.
-shaderNetworks(-sns)
Show the shader network for all the objects on the selection list that have shaders.
-shaderNetworksSelectMaterialNodes(-smn)
Select the material nodes in the shader network for all the objects on the selection list that have shaders.
-snapShot(-snp)
Put hypergraph in snapshot mode. This is only for testing
-uncollapse(-ucl)	string
Unhide the upstream nodes from the specified node.
-upStream(-ups)
Show nodes upstream from the specified node
-userDefinedLayout(-udl)	boolean
Enable or disable remembrance of user defined layouts. Default is disabled until this functionality is better tested.
-workAreaAddCmd(-waa)	string
Set the MEL procedure called when a new work area is added to HyperShade
-workAreaDeleteCmd(-wad)	string
Set the MEL procedure called when a work area is deleted in HyperShade
-workAreaSelectCmd(-was)	string
Set the MEL procedure called when a work area is selected in HyperShade

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

sphere;
cone;
string $myBlinn = `shadingNode -asShader blinn`;
select nurbsSphere1;
hyperShade -assign $myBlinn;
select -cl;
hyperShade -objects $myBlinn;

string $blinn = `createNode blinn`;
select lambert1 $blinn;
hyperShade -objects "";