Usage: alias [-u] alias_name [command] alias [-s] Create an alias for a command or sequence of commands If no alias name is given, all aliases are printed out. If the -s option is found, then the aliases are printed in a form useful for sourcing into script files. Options: -u Unset the current alias Example: alias ls opls
This command is obsolete as of 4.0. Similar commands are desk, pane.
Usage: appendseq [-u] file_pattern
This command appends a series of files to the current sequence in
mplay. The sequence length will be extended by the number of images
loaded.
file_pattern can use either \$F or * to specify the frame number.
Options:
-u Load the sequence unbuffered; images will not be
cached.
Examples:
appendseq ~/shot1/frame\$F.pic
appendseq -u ~/shot1/frame*.pic
This command is only available in MPlay.
See also:
loadseq, prependseq
Usage: atjob [-p] seconds command atjob -l atjob -r id [id2...] The atjob command will queue commands so that they can be executed at a future time. The -l option will cause all existing at jobs to be listed. The -r option will remove at jobs. The id of the job (as listed with the -l option) can be used to specify individual jobs. Alternatively the word "all" can be used to remove all queued commands. When adding jobs, the -p option can be used to make the command "periodic". That is, after the command is run, the command will automatically be re-queued to be run again (with the same timing interval). For example, the command "atjob 300 mwrite -i" will cause the mwrite command to be invoked every 300 seconds (5 minutes). At jobs only work correctly inside graphical applications. The job will be run the first chance that the application has the opportunity. This means that if the application is busy (for example rendering a sequence), at jobs are not guaranteed to be called.
Usage: audiopanel [options]
Change parameters for the audiopanel.
Options:
-s n <name> Set the network menu.
-s o <name> Set the CHOP menu.
-s r on|off Set the scrub repeat toggle.
-s s <value> Set the scrub sustain value.
-s f <frequency> Set the scrub rate value.
-t p reverse|stop|play Set the test play direction.
-t l on|off Set the test loop toggle.
-t r on|off Set the test rewind toggle.
-o m on|off Set mono output toggle.
-o t on|off Set volume tied toggle.
-o u on|off Set meter toggle.
-o l <value> Set the left volume.
-o r <value> Set the right volume.
-o d 0 Turn off audio.
-o d 1 Time Line mode.
-o d 2 Time Slice mode.
-o d 3 Test mode.
When no options are specified, the current settings are displayed.
BUGS: There can only be one -s, -t or -o option specified per command.
Usage: boneconvert [-r | -m] [-x] [-t] [-s] [-g] This command is used to update bones from old hip files from Houdini 4 to the latest version of Houdini. Bones created in hip files prior to Houdini 4 require the kinconvert command to be executed first, and then this command be used. The conversions currently performed are: - All bones which have lock channels in their translate parameters are removed and replaced with a locked parameter with values of 0 instead. To force this conversion, use the -t option. - The Top Cap and Bottom parameters in the cregion SOP of bone objects have their multiplication factor removed and multiplied into the values of the object-level cregion parameters. This will only be performed if the object-level cregion parameters have no channels. To deal with special cases, please see the options described below. - All bone objects have their xray flag turned on. Use the -x option to avoid doing this conversion. - Adds the command "bonefixchops $OPSUBNAME" to the delete script - The scale parameters should all be 1 and be locked. To force this conversion use -s. - The bone geometry is updated to the current system. To force this conversion use -g. - The Kinematic Solver parameter is filled with the path of the CHOP overridding its rotate parameter. The -r option forces the conversion of the cregion SOP parameters even if the object-level cregion parameters already have channels. This option is useful if you have channel references in the object-level parameters that mirror other capture regions. The cregion SOP parameters are forced to be correct without interpretation of the parameter. The -m option not only forces the conversion of the cregion SOP parameters like -r, but it will also attempt to add the multiplication factor if the object-level parameters have channels on them. This option will not have different behaviour if the object-level cregion parameters do not have channels. It will also fail to add the multiplication factor if the cregion SOP parameters do not have an expression of the form <number>*<expression>.
Usage: bonefixchops [-r] bone_object This command is used to clean up InverseKin CHOPs that may reference the given bone object before the bone is deleted. For example, if an InverseKin CHOP is using an Inverse Kinematics solver on a bone chain from bone1 to bone4, and you execute "bonefixchops bone4", this CHOP will be changed to apply its solver to the chain from bone1 to bone3. If you have an InverseKin CHOP that is using an Inverse Kinematics solver on bone1 only, and you execute "bonefixchops bone1", the CHOP will be deleted. This command is used in the default delete script of bone objects. If the -r option is given, then it will recursively destroy all outputs of the found InverseKin CHOPs as well.
Usage: bonemoveend bone_object [-o] [-f "world"|"parent"] [-x xpos] [-y ypos] [-z zpos] This command adjusts the length and angles of the given bone object so that in the rest chain the bone would end at the specified position. To only set the rest angles, use the -o option.
Usage: bonealigncapture [-c] bone_objects This command aligns the capture and animation (deform) regions. It sets either capture or animation parameters of bones and its capture regions. The default usage (i.e., without '-c' parameter) will align the animation (deform) region with the capture region. It will reset capture regions of an animation bone setup to match that of a capture setup. It clears any distortions of captured geometry (skin) caused by the change of bone position or orientation. This command is useful during a rigging process. After the geometry has been captured any change in bone position is treated as animation. However during the rigging process, joints are often shifted and adjusted to improve animation. Changing a joint position will cause deformation of the captured geometry, which is not desirable. To reset any deformations of the geometry run this command on the bones whose position or orientation has been modified. If this command is used with '-c' parameter, it will set the capture parameters of bones and their capture regions so that the capture region is aligned with the current non-capture (animation or deform) location of the region. Options: <none> aligns animation pose with capture pose -c aligns capture pose with animation pose Examples: To reset the distortion of the captured object after bone1 and bone2 have been moved: bonealigncapture /obj/bone1 /obj/bone2 To reset the capture regions to the capture configuration (for the whole bone chain): bonealigncapture /obj/bone_chain* To set capture parameters of all bones in a chain to match their corresponding animation setup: bonealigncapture -c /obj/chain_bone* To set capture parameters on all bones (for example, to bring capture parameters up to date for old hip file in order to use new capture system): bonealigncapture -c *bone*
Usage: bookmark [-a path] [-l] [-r path_pattern] This command is used to add, list and remove path bookmarks. Options: -a path add path to bookmarks -r path_pattern remove path from bookmarks, wildcards such as *, ? and [] are valid -l list current bookmarks
Usage: break [levels] Break out of a loop. If levels is given, that is the number of loops that will be broken out of.
Usage: chadd [-f fstart fend] [-t tstart tend] objects name1 [name2...] Adds channels to the objects specified. Objects can be specified using pattern matching (i.e. geo*). By default, the channels will have a segment stretching from the start of the animation to the end of the animation. By specifying a frame (or time) range, the initial segment will use the given range. Example: chadd geo* tx ty tz spare1 This will add channels tx, ty, tz and spare1 to all objects matching "geo*".
Usage: chalias [-r] [-e] {channel_name | node_name} [channel_alias]
This command is used to alias a channel's name, that is, give it
another name by which it can be referenced. The channel's name will
still be valid and can still be used in expressions. References to
a channel name will not be updated, but references to the old alias
will be updated to the new alias.
Options:
-r Recursively list the aliases present
on channels of node_name and its
children.
-e Erase channel alias. If a node
name is specified, all channel aliases
on the node are erased.
Examples:
chalias /obj/model/tx translate_x
Aliases translate_x to /obj/model/tx so that it may be referred
to as /obj/model/translate_x.
chalias /obj/model/tx
Lists the alias on /obj/model/tx, if any.
chalias /obj/model
Lists the aliases on channels of /obj/model, if any.
chalias -e /obj/model
Erases the aliases on all the channels of /obj/model
Usage: chaneditor [options] [-d desktop] pane1 ... Allows different options of the channel editor to be set. A valid pane name must be specified. If no desk name is given then it will assume the current desk is implied Options: -d <string> Desktops to operate on -m 0|1|2 Editor Mode (0 - graph, 1 - spreadsheet, 2 - dopesheet) -s <string> Scope filter (i.e. *, t?, tx,ty,rx) -h <float> <float> Set the horizontal range -i <float> <float> Set the maximum horizontal range -a 0|1 Toggle value handle -b 0|1 Toggle raw value handle -c 0|1 Toggle time mark handle -e 0|1 Toggle time group handle -f 0|1 Toggle slope handle -g 0|1 Toggle segment handle -j 0|1 Toggle scale handle -k <string> Default segment function value -l <int> Grid detail level (0-4) -n 0|1 Toggle long names -o 0|1 Toggle snap to frame -p 0|1 Toggle raw interpolation -q 0|1 Toggle relative moves -r 0|1 Show attached time groups -A 0|1 Dopesheet auto snap -D <float> Dopesheet split fraction -F 0|1 Dopesheet force keys -t <string> Template filter (i.e. *, t?, r?s?) -u <float> The handle scale -v 0|1 Toggle vertical adapt -w 0|1 Minimize scale handle tools -x 0|1 Minimize channel tools gadget -y 0|1 Minimize range gadget -z 0|1 Minimize function gadget -G 0|t|x|z Show channel chooser 0 - don't show t - show with only tree view x - show with channel groups z - show with parameter chooser
Usage: chblockbegin This command tells Houdini that a series of chadd/chkey commands are about to follow. This command causes Houdini to postpone some event propagation to allow these commands to be executed much faster. All required events are sent when the chblockend command is run. This command can only be used when sourcing in a script file. Calls can be nested, but each chblockbegin command must have a corresponding chblockend command. Only chadd and chkey commands should be run between calls to chblockbegin and chblockend commands or dependencies may not be properly maintained. See Also: chadd, chblockend, chkey, source
Usage: chblockend This command signals the end of a block of chadd/chkey commands in a script file. This command can only be run from within a script file. This command must be run once for each time chblockbegin is run in a script. Once all chblockbegin commands have had a matching chblockend call, the events that were being cached will be sent all at once. Only chadd and chkey commands should be run between calls to chblockbegin and chblockend commands or dependencies may not be properly maintained. See Also: chadd, chblockbegin, chkey, source
Usage: chcommit [-l] [-p] [-s] [-g] [channel_pattern...] Commits pending key frame changes. Executing this command is equivalent to manually clicking the red keyframe button. The channels considered are those governed by the main animation setting. Depending on the setting, either all scoped channels are considered, or only those which have pending changes. The setting can be overrided by explicitly providing the -s (for scoped channels) and/or the -g (for pending channels) options. If a channel pattern is specified, then the list of normally considered channels are trimmed down to only those which match the pattern. If the -p option is given, then all the parameters of those considered channels are keyed. If -l option is given, then affected channels are listed to the textport instead of being committed. This provides a way to preview the results of the chcommit command before executing it. See also: chhold
Usage: chcp source_channel_name destination_channel_name Copies the contents of one channel to another. If the destination channel already exists, its contents are deleted first.
Usage: chgadd group_name [second_name...] Creates one or more channel groups.
Usage: chgls [-g] [-l] [pattern...] Lists channel groups. The -l option will list the contents of the channel group as well. If a pattern is specified, then only groups which match the pattern will be listed. If the -g option is specified, then hscript commands will be printed out instead. This can be used to create scripts.
Usage: chgop group_name operation channel_pattern [second_pattern...] This command does operations on groups (i.e. allows addition or removal of channels from the group). group_name The name of the channel group to modify operation Can be one of: set Set the contents of the group add Add channels to group remove Remove channels from group The channel_pattern specifies a list of channels to work on. Example: chgop group1 set /o*/g*/r? Set group contents to channels chgop group1 add /o*/g*/t? Add channels to group1 chgop group1 remove /o*/g*/tx Remove tx channels from group1
Usage: chgrm group_pattern [second_group...] Removes channel groups.
Usage: chhold [-b | -e] [channel_patterns]
Or: chhold [-s] [-l]
Allows putting of channels into a "hold" (or pending) state at the
current time. This can be used in conjunction with the chcommit command
to force the creation of keys.
Options:
-b (begin) Turn on the hold status for the given channels so
that they remain in a pending state even if time
changes. If no patterns are given, then all
currently scoped channels will be affected.
-e (end) Releases the previously held channels. If no
patterns are given, then it will release all held
channels.
-s (status) Queries the current hold status.
-l (list) Lists currently held channels.
See also: chcommit tcur fcur
Usage: chkey [-f frame] [-t time] [-v lvalue] [-m lslope] [-a laccel] [-V rvalue] [-M rslope] [-A raccel] [-T tielist] [-F function] channel_pattern Edit or insert a key frame by specifying: -v The value entering the key frame -m The slope entering the key frame -a The acceleration entering the key frame -V -M -A Same as the lower case, except refer to the value leaving the keyframe -F The expression function for the segment following the keyframe. -T The tielist consists of some or all of the characters "amvAMV", which correspond to accel, slope, and value. The specified attributes will be set to tied - both the right and left settings will be locked together. If a key frame exists at the frame/time specified, then the values for that key frame will be modified. Otherwise a key frame will be inserted. If both the left & right values are specified, the key frame will be untied at the point and the values altered independently. Otherwise, the effect depends on the tied state of the keyframe. The channel pattern specifies which channels will be affected by the command. Example: chkey -f 1 -v 3 -F 'cubic()' geo*/t? Which will set the value to 3 and expression function to cubic() for all channels matching geo*/t?. NOTE: The expression function should usually be protected by '' to prevent any expansion of its contents. In this case, the () would be expanded to give a syntax error on the command.
This command is obsolete and does nothing.
Usage: chlock node_path [+|-]parameter ...
Locks the given parameters so that they no longer be modified until
unlocked. This command can be used either to lock or unlock parameters.
Prefix the parameter pattern with a + to lock the parameter, or - to
unlock the parameter.
Example:
Lock all the translate parameters on the /obj/model object:
chlock /obj/model +t?
Lock the rx and ry parameters on the /obj/model object
chlock /obj/model +rx +ry
Unlock all the rotate parameters in the /obj/model object
chlock /obj/model -r?
Unlock all parameters in the /obj/model object
chlock /obj/model -*
Usage: chls [-l[v]|a] [pattern] List channels. The -l option additionally lists key frames. The optional -v option will do a verbose list of key frames. This will include the incoming and outgoing values of value, slope, and acceleration, along with the tie status of the keyframe. By default, only animated channels are listed. The -a option lists all channels (including non-animated channels). A node or channel path pattern can be used to list sets of channels, however the -a option does not accept path patterns. If no pattern is specified the current node's channels are listed. Examples: chls -l geo*/* chls -a geo*
Usage: chopexportmap -l [-o] <chop_path> [track_pattern] chopexportmap -c <chop_path> [track_pattern] chopexportmap -s <chop_path> <track_name> <overrides...> This command manipulates chop export mapping overrides. These provide a mapping from chop tracks and the node parameters that they override. -l: This option lists the current mappings. A track pattern can be given if only specific tracks are desired. If the -o option is also given of this usage, then the opscript friendly version of the chop is output instead. -c: This option clears (ie. erases) the mappings for the specified track pattern. If no track pattern is given, all mappings are cleared. -s: This option sets the mapping for the given chop and track name. <overrides...> is a list of operator patterns that the specified track is to override. Examples: chopexportmap -l /ch/ch1/wave1 List all export mappings of the chop /ch/ch1/wave1. chopexportmap -c /ch/ch1/wave1 Clear all export mappings of the chop /ch/ch1/wave1. chopexportmap -c /ch/ch1/wave1 c* Clear export mappings of the chop /ch/ch1/wave1 for tracks that begin with the letter c. chopexportmap -s /ch/ch1/wave1 chan1 /obj/model/t? Make the chan1 track of the chop /ch/ch1/wave1 override all the parameters of /obj/model matching the pattern t?.
Usage: chopls operator [pattern1] [pattern2...] Lists the tracks in a chop operator. A track pattern can be used to list a set of trackss. If no pattern is specified all the tracks for that chop will be listed. Examples: chopls /ch/ch1/wave1 chopls /ch/ch1/object1 t? r*
Usage: chopscope [<viewer path> <channels>] ... Assigns CHOP channels to available viewers by pairing CHOP paths with CHOP channels. The viewer path is specified by the full path of the CHOPNet it is looking at, plus the node(s) you want to scope. The channels are specified exactly or using wildcards. The first three examples scope channels into one CHOP viewer. The last example scopes two CHOPNets into two viewers; the ch1/wave1 channels into one viewer and the ch2/noise1 channels into another viewer, creating a floating window if two CHOP viewers are not currently visible. You always need to provide a CHOP node / channel list pair. Examples: chopscope /ch/ch1/wave1 chan1 chopscope /ch/ch1/noise1 t[xyz] chopscope /ch/ch1/wave1 chan1 /ch/ch1/noise1 t[xyz] chopscope /ch/ch1/wave1 t[xyz] /ch/ch2/noise1 t[xyz]
Usage: chopview <options> [-d <desktop_name>] pane1 ... Allows different options of the network editor to be set. A valid pane name must be specified. If no desk name is given then it will assume the current desk. Options: -d <string> Desktops to operate on. If it is blank it will default to the current desktop. -a <int> Set the Notes CHOP index -b <int> Set the number of graphs -B <int> Graph type (0=all, 1=per channel, 2=per CHOP, 3=per name) -c <string> Graph scope exclusions of the form "CHOP channel CHOP channel..." -e 0|1 Toggle extended regions -f 0|1 Toggle frame indicator -g 0|1 Toggle graph disable -H 0|1 Toggle horizontal adapt -i 0|1 Toggle dots -j 0|1 Toggle handles -k 0|1 Toggle scope disable -l <int> Grid detail level (0-4) -m 0|1 Toggle edit raw tools -n 0|1 Toggle labels -o 0|1 Toggle scope controls -h <float> <float> Graph horizontal start/end range -r <float> <float> Bar height start/end range -R <index> <val> <val> Graph height start/end range -s 0|1 Scroll lock toggle -S <float> Scroll lock position -u 0|1|2 Unit type (0 - frames, 1 - samples, 2 - seconds) -v 0|1 Graph viewing mode (0 - graph, 1 - bar) -V 0|1 Vertical adapt toggle -y mode Vertical Adapt Behaviour mode = 0, Auto scale mode = 1, 0 1 mode = 2, -1 1 mode = 3, 0 10 mode = 4, -10 10 mode = 5, 0 100 mode = 6, -100 100 mode = 7, -180 180 -Y min max Vertical Adapt Behaviour specify min and max.
Usages: (NOTE: this command is NOT undoable)
1. chread [-f fstart fend] channel_pattern ... filename.{chan,bchan}
2. chread [-f fstart fend | -o fstart | -n] [-r src_pat dest_pat]
filename.{chn,bchn}
3. chread -i filename.{chn,bchn}
USAGE 1:
The specified file is assumed to be a raw channel data file
(.chan or .bchan) and column data from the file will be read
and matched with the channels listed in the order specified.
Loading will only occur in the frame range specified or will
start at the global animation start time if no range is given.
The order of channels resulting from a pattern match is not well
defined.
Note that only channels with raw segments in the frame range
will have values assigned to them. You must convert segments
to raw before reading values in with chread.
USAGE 2:
The specified file is assumed to be a keyframe data channel file and
loaded into the current hip file. The file extension must be either be
.chn (ASCII) or .bchn (binary).
The -f option gives the frame range to load the data into. Keys will be
scaled into the frame range if the file's range does not match. Instead
of the -f option, the -o option simply gives the starting frame to load
the data into (no scaling will be done). If the -f and -o options are
omitted, then the file's frame range is used. If there are existing
channels, then any animation outside the frame range will be preserved
with keyframes set at the beginning and end of the frame range. If the
-n option is specified, then any previous animation will be deleted
first.
The -r option allows renaming of channel node paths before the channels
are loaded from file. In the chwrite command, full paths of the nodes
are saved out. This option allows the mapping of animation from one
set of nodes into a different set. This renaming function will rename
nodes from the data file in the same manner as how the Rename CHOP
functions. Here are some examples:
old_path src_pat dest_pat result
/obj/apple /obj/a*le /obj/b* /obj/bpp
/obj/a_to_b /obj/*_to_* /obj/*(1)_to_*(0) /obj/b_to_a
/obj/Lleg /obj/L* /obj/R* /obj/Rleg
For any nodes that do not match the src_pat (source pattern), then will
be loaded into their original path. Note that if the destination node
is not found, then loading will stop.
USAGE3:
The -i option takes specified file (.chn or .bchn extension) and gives
information regarding the file. This option is similar in output to
the command line "chinfo" program.
See also: chwrite chadd chkey chls
Usage: chrefit [-v] [-t tolerance] channel_pattern Refits the channels using cubic interpolation, deletes key frames and inserts new ones where appropriate. This is useful when a channel has too many keys and needs to be simplified by approximating it with a cubic interpolation. This command obtains the channel values for each frame and fits curve segments through them within a given tolerance. If tolerance parameter is not specified, a default value of 0.01 is used. The key frames are inserted at the boundaries of the approximating curve segments. Examples: Refitting tx channel for /obj/model/ chrefit /obj/model/tx Refitting all translates (and two-letter channels that start with t) with the tolerance of 1.0 chrefit -t 1.0 /obj/model/t? Refitting all channels in /obj/obj1 with the tolerance of 0.0001 and requesting the verbose report on the operation chrefit -v -t 0.0001 /obj/obj1/*
Usage: chrename channel_spec newname This command will rename the specified channels to a new name. References to the channel are NOT automatically updated. If a parameter channel is renamed, the parameter will no longer reference the renamed channel (i.e. the parameter will be de-animated). If a spare channel is renamed to a parameter channel, the parameter will become animated. Only one channel at a time may be re-named. Examples: chrename /obj/geo1/spare1 temperature chrename geo1/tx translate_in_x See also: opchange
Usage: chreverse [-f fstart fend] [-t tstart tend] channel_pattern Reverses the channels specified over the frame range specified. If no frame/time range is specified, then the channels will be reversed for their total length.
Usage: chrm channel_pattern Removes channels specified
Usage: chrmkey -f frame channel_pattern Or: chrmkey -t time channel_pattern Removes key frames for the specified channels, either -t or -f must be specified to identify the key frame.
Usage: chround [-v] -a Or: chround [-v] channel_pattern The chround command will move keyframes to lie on exact frame values. If the -a (all) option is specified then all channels in the entire session are scanned for keys that require shifting. If instead, a channel pattern is given then only the specified channels are scanned. The -v (verbose) option causes the command to report all keys that are modified, showing the old an new frame positions. This command is useful after changing the frame rate (FPS) of an animation which causes keyframes at the old frame rate to no longer lie on exact frame times at the new frame rate. See also: chkey, chls
Usage: chscope [-w] [-c|-e @group_name] [channel_pattern ...] The chscope command will set or modify the channel scope according to the patterns specified. Patterns may be prefixed by a '+' or ',' character to add channels to the current scope or by a '-' to remove channels from the scope. No prefix or an '=' character will set the scope to the given pattern. A channel group may be specified as '@group_name'. If the -c (collapse) option is specified, then all channel group name patterns will be scoped into the Dopesheet as a single row. Similarly, the -e (expand) option will scope and expand all channel group name patterns into separate rows in the Dopesheet. If the channel editor is open when this command is executed it will load the new channel scope. Multiple patterns may be specified, in which case an implicit '+' operation is assumed between each argument. Note that the results will not be visible if the channel editor is not currently open. Specify the -w option to open a channel editor if it is closed. If no scope patterns are specified this command will list all currently scoped channels from the current folder on down. Examples: chscope tx+ry+sz chscope tx,ry,sz chscope tx ry sz Note: the above three are all equivalent. chscope geo1/*-geo1/r? chscope +light1/t? chscope -light1/ty
Usage: chstretch [options] channels... This command will stretch a channel. Options: -F nframes Number of frames to add -T nseconds Number of seconds to add -f start end Frame range to stretch -t start end Time range to stretch -v Verbose option Either the -F or -T option must be specified. If the -f and -t options are not specified, the whole channel will be stretched. NOTE: chstretch will push/pull segments that occur after the specified time range in order to add or subtract the requested time. To preserve the length of the channel an opposite stretch must be performed on another part of the channel. WARNING: When specifying a frame range which begins and/or ends between keyframes, the segment in which the range boundary falls will be stretched.
Usages:
1. chwrite [-f fstart fend] channel_pattern ... filename.{chan,bchan}
2. chwrite channel_pattern ... filename.{chn,bchn}
USAGE 1:
This command will write out the specified channels as columns
of raw values with one sample per frame across the given frame
range. If no range is given the current global animation time
range will be used. Channels will be output in columns in the
order specified. The output will be saved as ascii data unless
the file has a suffix of ".bchan", in which case binary format
will be used. The order of channels resulting from a pattern
match is not well defined.
Note that channels need not be raw in order to save them using
chwrite. The channel values will be sampled at the current frame
rate.
USAGE 2:
This command writes out the specified channels along with their full
node paths into the specified file as keyframe data. The extension must
be one of .chn (ASCII) or .bchn (binary). The chread command can be
used to read these files.
Note: If you want to save the contents of a CHOP as a bclip, use the
opsave command.
See also: chread chadd chkey chls opsave
Usage: closeport [-i] port_number Closes a communication port created by the openport command. The -i option will close the port immediately, rather than closing it with a message on the event queue. This option is used internally by Houdini, and you should not have to use it. See also: openport
Usage: cmdread [-q] [-v] filename Run the commands in the filename specified. If the -q option is given, then no warnings about missing filenames will be printed. If the -v option is specified each command will be printed out as the command is run. See also: source
Usage: compfree [-c] [-d] [-q]
This command releases all cached data and images in use by
all composite networks. The amount of memory freed is printed.
Options:
-c Clear only the cook cache (size is defined in
Edit->Preferences->Compositing->Cache)
-d Clear only the display cache (size is defined in
the composite viewer preferences, 'd' in the viewport
to display, 'Memory' page)
-q Quiet mode. Don't print out the memory freed.
See also: compopts
Usage: compopts [-c size] [-d size] [-t threads] [-T on|off]
This command controls the cache usage and threading parameters
for the composite engine.
Option:
-a Set the cook cache size to the recommended
size (half the total memory).
-A Set the display cache size to the recommended
size.
-c size Set the cook cache size to 'size' Mb.
-d size Set the display cache size to 'size' Mb.
-q Query the current settings.
-t threads Sets the number of cook threads. Also turns
threading on.
-T on|off Turn threaded cooking on or off.
See also: compfree, compproject
Usage: compproject [-a pixelAspectRatio] [-d i8|i16|i32|fp] [-P zoom]
[-p black white] [-r xres yres] [-f on|off]
[-F on|off] [-l on|off]
Changes the settings for the current composite project. These settings
are saved with the hip file. Changing these settings will change any
COP nodes that are following these settings, and cause a recook the
next time they are output or viewed.
Options:
-a PAR Sets the pixel aspect ratio. A ratio of
2:1 (X:Y) should be passed as 2.
-d i8|i16|i32|fp Sets the project data format, either 8, 16
or 32 bit integer, or floating point.
-p b w Sets the black and white points for integer
formats (defaults are full range).
-P zoom Sets the proxy zoom level. Zoom levels are:
icon 1/8 1/4 1/3 1/2 2/3 3/4 full 1.33 1.5 2 4 8
-r xres yres Sets the project resolution.
-f on|off If on, all File COPs' resolutions are overriden
by the project resolution (as the default
setting for all new File COPs).
If off, the files natural resolution is used.
-F on|off If on, all File COPs' pixel depths are
overriden by the project pixel depth (as the
default setting for all new file COPs).
If off, the files natural depth is used.
-l on|off Turns Large Canvas support on or off. If on,
image data outside of (0,0) - (xres, yres)
will be retained. If off, this data is cropped.
See also: compopts
Usage: continue [levels] Skips the remainder of a loop and continues with the next iteration. If levels is specified, then multiple loops will be continued.
Usage: cplane [options] viewers Modifies or displays current construction plane parameters. Options: -o x y z Sets origin to (x, y, z) -n x y z Sets plane normal to (x, y, z) -x x y z Sets plane horizontal axis to (x, y, z) -u x y z Sets the up-vector to (x, y, z) -l [n|x|y|z] Locks the up-vector to either the plane normal, world X-axis, world Y-axis or world Z-axis. -s x y Sets the grid spacing to x units along the X-axis and y units along the Y-axis. -r a b Sets the grid ruler to x units along the X-axis and y units along the Y-axis. -c a b Sets the number of grid cells to a along X and b along Y. -d [on|off] Turns construction plane display on or off For details on how to specify viewers, type "help viewerformat" Examples: cplane -o 0 0 0 * cplane -o 1 1 1 -n 0 0 1 -r 10 10 Build.pane1.world
Usage: cuadd [-f] -t <type>
Add a custom UI gadget into the current container, where
[type] can be one of the following:
panel channelchooser menu
container checkbutton slider
buttonstrip filechooser
button label
-f is used to automatically 'cd' into the gadget just created
if the gadget is a container or a panel.
Example:
cuadd -f -t panel # add a panel and 'cd' into it
cuadd -t button # add a push button
See also: cucd, curm, cuparm
Usage: cucd [-n] <container_name>
Change the current working container to the container
specified. Containers are akin to directories in unix and
follow the same rules. Note that a panel gadget is a special
type of container.
Example:
cucd -n / # 'cd' to the root container
cucd -n /panel1/container2
cucd ../container5
See also: culs, opcd
Usage: cueventcontrol <0|1> This is an internal command used to turn event processing on/off for custom panels, and should not be used.
Usage: cuexport -n <gadget> -d <filename> Save a gadget as a sequence of commands to the specified file. Example: cuexport -n /panel1 -d /tmp/panel1.cui
Usage: cuimport <filename> Load a specified cui (custom panel) file from disk. Example: cuimport /tmp/panel.cui
Usage: culs
List out the contents of the current working container.
Example:
culs
Usage: cuparm -n <gadget_name> [ parameters ] Sets the parameters for a specific gadget. These range from layouts and sizes to the script associated with a particular gadget. [ parameters ] can be: -w <float> Preferred gadget width -h <float> Preferred gadget height -x [0|1] Stretch horizontal -y [0|1] Stretch vertical -s <float> Margin -t <float> Spacing -l "<string>" Sets the label for a gadget -L <string> Layout for containers (ignored otherwise) Where <string> can be: ver, vercen, verright hor, horcen, hortop -B <string> Look for containers (ignored otherwise) Where <string> can be: background, bevelup, beveldown border, outline, paper paperline, separator -N <string> New name for gadget -v <string> Value name for gadget -m <float> Sets minimum value for slider -M <float> Sets maximum value for slider -i <float> Sets initial value for slider -d [0|1] Connect a gadget directly to a parameter -p <string> Path (usually a channel) to parameter -S "<script>" Sets the script for a gadget Note: Some parameters only make sense with certain typs of gadgets (e.g. setting a layout only makes sense for a container or panel). In other cases, these parameters are ignored. Example: cuparm -n /Panel1 -N Test_Panel # rename the panel cuparm -n ../button1 -l "hit me" # set a label cuparm -n ../container -L hor -B paper cuparm -n button1 -S "unix jot" cuparm -n slider20 -m 1 -M 20 -i 5
Usage: cupwd Display the full path to the current working container. Example: cupwd
Usage: curm -n <gadget_name> Remove the specified gadget. Example: curm -n /Panel1 curm -n ../container1
Usage: cussaveopt -p <panel_name> -o [disk|hip] Determines whether the specified panel is to be saved in the hip file or to an external location. disk - This custom panel will be saved in $HOUDINI_CUSTOM_PATH/ and will automatically be loaded in new sessions. hip - This custom panel will be saved only with this hip file, and any disk file in $HOUDINI_CUSTOM_PATH/ will be removed. Example: cuset -n /Panel1 -o disk
Usage: cuset -p <panel_name> -n <value_name> -v <value> Set the specified value in the specified custom panel. Example: cuset -n /Panel1 -n slider1.val -v 0.5
Usage: desk <operation> [desk_name1 desk_name2 ...] Operation: add Add the specified desktops list List all desktops (does not require desk names) set Set the current desktop swap Swap the two panes in the desktop query Query the name of the current desktop Example: desk set Desk1 -> sets the current desk to be Desk1 desk add Desk1 Desk2 -> adds two desks named Desk1 and Desk2 desk list -> list all desktops desk swap pane2 pane3 -> swaps pane2 and pane3 in current desk desk swap pane2 pane3 Desk1 -> swaps pane2 and pane3 in Desk1
Usage: doublebuffer [ on|off ] Sets the application drawing mode. To avoid flicker turn double buffering on. To increase speed slightly, turn it off. If no options are given the current state is returned.
This command is a built-in alias for otedit.
Usage: dsoinfo [options] Displays all plug-in DSO/DLL files loaded at the current time. This command will show the path of the dynamic link object. Options are: -a Show all plug-in functions OP Related -c Show custom COPs (Composite Operators) -h Show custom CHOPs (Channel Operators) -m Show custom materials -o Show custom objects -s Show custom SOPs (Surface Operators) -S Show custom SHOPs (Shader Operators) -t Show custom TOPs (Texture Functions) -C Show custom COP networks -H Show custom CHOP networks Other Customizations -e Show expressions and commands -i Show image format plug-ins -v Show custom VEX plug-in operators This command will not print out custom operators generated by scripts (i.e. many types of SHOPs, VEX OPs, etc.) If no options are specified, all custom operators will be printed.
Usage: dsreload [-v] This will reload all OPs which are based on scripts. This includes most SHOPs and all VEX Ops. The -v option will cause the command to report dialogs which got re-loaded. Warning: Floating dialog scripts are not affected by this command.
Usage: echo [-n] text Prints text to the textport. The output will be terminated with a new line unless the -n option is used.
This command is obsolete as of 4.0. Similar commands are desk, pane.
Usage: else [ if (statement ) then ] Else conditional for an if statement.
Usage: endif Termination of the if statement.
Usage: excat [pattern] This will print out the source to all expression functions in the current .hip file. If a pattern is specified, only function names matching the current pattern will be listed. See also: exedit, exls, exread, exrm
Usage: exedit [pattern] This command allows the user to edit expression functions. If no pattern is specified, you can add new functions to the current list. If a pattern is specified, the functions which match the pattern will be edited. WARNING: If a function is renamed or removed from the edit session, this does NOT mean that the old function will be removed from the current function list. This must be done through the exrm command. See also: excat, exls, exread, exrm
Usage: exhelp [-k] [pattern] Show usage for the expression matching pattern. If more than one expression matches the pattern (or no pattern is present), and none of the matches are exact, list all expressions that match the pattern. If the -k option is specified, all command help will be searched for the pattern specified. Commands which have the string in their help will be printed out. This allows searching of the help for keywords. See also: help pdfhelp
Usage: exit Exit out of a script file.
Usage: exls List all the current expression functions. See also: excat, exedit, exread, exrm
Usage: exread diskfile [diskfile2...] This command can be used to source in external files of expression functions. See also: excat, exedit, exls, exrm
Usage: exrm pattern All expression functions matching the pattern will be removed. See also: excat, exedit, exls, exread
Usage: fcur [frame] If no frame is specified, the current frame is printed. Otherwise, the current frame is set to the frame specified. See also: fplayback fps frange fset ftimecode tcur tset
Usage: for VARIABLE = START to END [step INC] The for loop construct. The VARIABLE will loop from START to END by the INC specified. Examples: for i = 1 to 3 echo $i end for i = 1 to 100 step 3 echo $i end
Usage: foreach VARIABLE ( list )
The foreach loop construct. The VARIABLE will take on the value
of each element in the list through each iteration of the loop.
Examples:
foreach i ( a b c )
echo $i
end
foreach object ( `execute("opls -d")` )
echo Object $object
end
Usage: fplayback [-i on|off] [-r on|off] [-f factor] [-s step_size] Sets options for the playbar. -i on|off Turn integer frame values on or off -r on|off Turn real-time playback on or off -f factor Set the real time playback factor -s step_size Set the non-real time frame increment Without any options specified, the current states are printed out. See also: fcur fps frange fset ftimecode tcur tset
Usage: fps [frames_per_sec] If no frames_per_second is specified, the current frames per second is printed out. Otherwise, the frames per second is set to the specified value. See also: fcur fplayback frange fset ftimecode tcur tset
Usage: frange [start end] Sets the range of playback on the playbar. If the start and end are not specified, the current frame range is printed out. See also: fcur fplayback fps fset ftimecode tcur tset
Usage: fset [nframes] If no frame count is specified, the current frame range is printed out. Otherwise, the frame range is set to the number of frames specified. See also: fcur fplayback fps frange ftimecode tcur tset
Usage: ftimecode [timecode] If no timecode is given, the current frame is printed in timecode format. Otherwise, the timecode specified is set. See also: fcur fplayback fps frange fset tcur tset
Usage: geocache [-s] [-l] [-c] [-a 0|1] [-m max] This command allows access to the internal geometry cache. The geometry cache is used by VEX geometry functions. Query options: -s See the current settings -l List the contents of the geometry cache Control options: -c Clear the cache -n Clear the cache only if newer files exist on disk. -a Turn auto-flushing of geometry files on or off. Leaving the geometry in the cache (i.e. no auto-flushing) improves performance at the cost of extra memory. -m Specify the cache size (in Kb). This defaults to 8192 (8 Mb). See also: texcache, opupdate, sopcache
Usage: hconnect [-o machine_name port_number] [-q] This command links the textport to an external custom application over a tcp/ip connection. The -o option opens a connection to the named machine and port. Valid port indices are generally 5000 to 10000. Only one connection at a time is permitted. The -q option terminates the current connection.
Usage: help [-k] [command_pattern] With no arguments, the list of all commands is printed out. If a pattern is specified a list of all commands that match that pattern is printed. If only one command matches, or the pattern matches the command exactly, the detailed help for that command will be printed. If the -k option is specified, all command help will be searched for the pattern specified. Commands which have the string in their help will be printed out. This allows searching of the help for keywords. See also: exhelp pdfhelp
Usage: helpbrowser [-d desktop] [-u url] [-h url] [-g url]
[-r data] [-b uri] [-U] [-H] [-G]
[-t Table/Optype] pane1 ...
Set options and perform actions on a help browser pane.
-d Desktop to operate on. If not specified, the command will
operate on the current desktop.
-u Load the specified URL.
-h Set the home page for this pane to the specified URL.
-g Set both the home page for this pane and the home page for
this pane's desktop to the specified URL. Any new
help browser panes in this desktop will use the new
home page. With this option, if this help browser pane
is closed and another one is opened, the new pane will
use the old pane's home page.
-r Display data in the help browser. If the data begins with
"<html>", the browser will treat it as html; otherwise
it will treat it as ascii text.
See the examples for how to add newlines to ascii text in
hscript.
-b Specify the base URI to be used when loading data into
the browser. This option may only be used in conjunction
with -r. The base URI is used to resolve links, image
references, etc. from html data.
For example, if the base URI is "file::///home/joe/html/" and
the html contains a link to "../images/x.jpg", the link will
point to "file:///home/joe/images/x.jpg". If -b is not
specified and -r is used, the base URI defaults to "file://".
-t Load the help for the specified operator type. The Table
value indicates the class of the operator type. A list of
valid values can be found in the help for the ophelp command.
The Optype string is the name of the specific operator type.
-U Return the current URL for this pane.
-H Return the current home page for this pane.
-G Return the current home page for this pane's desktop.
Note that this command cannot be called from embedded hscript in
the browser pane.
Examples:
set nl=\n
helpbrowser -u "http://www.google.com" pane7
helpbrowser -r "Raw text${nl}========${nl}<preformatted> text" pane7
helpbrowser -r "<html><body><h1>HTML</h1><p>HTML text</html>" pane7
helpbrowser -t Object/geo pane7
See also: pane, neteditor, parmeditor, pilist, chanlist, chaneditor,
chopview, ophelp
Usage: history [-c] Print the command history. If the -c option is specified, the command history is cleared. Note that while this matches the Ctrl-RMB history, it is different from the up/down arrow history. This is because the latter reorders the history to avoid duplicate elements, while this shows the true history.
Usage: if (condition) [then]
The if construct. If the condition is met, then the contents
of the if statement will be executed. An endif statement is
required to terminte the if clause. For example:
if ( $F == 1 ) then
echo Frame One
else
echo Another frame
endif
Note: In the current implementation, the statements for the
if clause must occur on separate lines. That is, statements
like "if ($F == 1) echo Frame One" will not work.
Usage: imgview [options] view_name
This command changes the global settings of the COP Image Viewer with
the name 'view_name'. The names are always of the pattern imgview[N]
where N = 1,2,3... (eg, imgview1).
Options:
-c port_num Sets the current port index (0-15)
-i Switch to Image mode.
-h Switch to Histogram mode.
-t Switch to Timeline mode.
-l on|off Links or unlinks the viewports.
-p plane_name plane_array Sets the displayed plane and array
index (normally 0).
-s on|off Links or unlinks viewport scolling.
-z zoom Sets the zoom factor (0.125 to 8,
-1 for icon).
See also:
imgview2d, imgviewtime, imgviewhist
Usage: imgview2d [options] view_name [viewport_index]
This command changes the settings of the 2D Image View of the
COP Image Viewer with the name 'view_name'. The names are always of
the pattern imgview[N] where N = 1,2,3... (eg, imgview1).
If viewport_index is specified, only that viewport is affected (1-16).
If it is not specified, all viewports are affected.
Options:
-V on|off Enable or disable the view.
-L on|off Turns on/off the labels.
-G on|off Turns on/off the guides.
-H on|off Turns on/off the handles.
-P on|off Turns on/off the previews.
-c component Sets the RGBA component (0 to 3) or displays
all components (-1).
-m color_mode Sets the color correction mode to brightness
controls (0) or black/white points (1).
-b bright con shift Sets the brightness, contrast and bright shift
for color correction.
-p black white Sets the black and white points for color
correction.
-t on|off Turn on/off transparency.
-i on|off Turn on/off background images.
-f Show the full image.
-s u1 v1 u2 v2 Show a portion of the image represent by the
rectangle with lower left corner (u1,v1) and
upper right corner (u2,v2) in UV coordinates.
See also:
imgview, imgviewtime, imgviewhist
Usage: imgviewhist [options] view_name [viewport_index]
This command changes the settings of the Histogram View of the
COP Image Viewer with the name 'view_name'. The names are always of
the pattern imgview[N] where N = 1,2,3... (eg, imgview1).
If viewport_index is specified, only that viewport is affected (1-16).
If it is not specified, all viewports are affected.
Options:
-V on|off Enable or disable the view.
-L on|off Turns on/off the labels.
-G on|off Turns on/off the guides.
-H on|off Turns on/off the handles.
-P on|off Turns on/off the previews.
-c component Sets the RGBA component (0 to 3) or displays
all components (-1).
-h histogram Sets the histogram type:
0 Pixel Histogram
1 Hue Histogram
2 Saturation Histogram
3 Value Histogram
4 Pixel vs U
5 Pixel vs V
6 Hue vs U
7 Hue vs V
8 Saturation vs U
9 Saturation vs V
10 Value vs U
11 Value vs V
12 Hue vs Saturation
13 Hue vs Value
-i on|off Turns "Ignore Graph Spikes During Adapt" on/off.
See also:
imgview, imgview2d, imgviewtime
Usage: imgviewtime [options] view_name
This command changes the settings of the Timeline View of the
COP Image Viewer with the name 'view_name'. The names are always of
the pattern imgview[N] where N = 1,2,3... (eg, imgview1).
Options:
-V on|off Enable or disable the view.
-L on|off Turns on/off the labels.
-G on|off Turns on/off the guides.
-H on|off Turns on/off the handles.
-P on|off Turns on/off the previews.
-f on|off Turns on/off the frame boxes.
-e on|off Turns on/off the extend regions.
-b on|off Turns on/off the timebar.
-g grid_level Sets the grid level (0 none, 1 low, 2 med,
3 high).
-u sec|fr Sets the units to seconds or frames.
-r preview_rate Sets the preview rate (1 preview every
'preview_rate' frames).
-a Show all COPs in the network.
-d Show all displayed COPs in the network.
-t Show all time-sensitive COPs in the network.
See also:
imgview, imgview2d, imgviewhist
Usage: java [-cdswx] [class]
This command starts up a Java application. It also opens a
connection (similar to the openport command) that the Java
application can use to communicate with Houdini. In the file
$HH/scripts/java/sesi.jar is the definition of a sesi.Houdini
class with a single static method called hscript. This method
takes a String as an argument which specifies the Houdini
scripting command to run. The result of executing the command
is returned by this function as a String. A second method,
hscriptex, is identical to the hscript method except it will throw
a java.io.IOException if there was an error while executing the
specified command within Houdini. The directory $HH/scripts/java
and the file $HH/scripts/java/sesi.jar are automatically added to
the value of the CLASSPATH environment variable.
The class parameter passed to this command specifies the class
where Java should begin execution. The specified class must
contain a static method called main which takes an array of
strings as an argument, and has a void return type.
If the -d option is set, then even when you exit Houdini, the
Java application will not be terminated. If the -c option is
specified, this command prints out the value of the CLASSPATH
variable that is sent to the Java application. The -x option
stops all currently running Java applications that were not
started with the -d option. If either of the -c or -x options
are set, the class parameter becomes optional. If the -w
option is set, this command does not return until the new
Java application has terminated. The -s option allows the Java
application to run only "safe" commands.
Examples:
The Java code:
import sesi.Houdini;
public class test {
public static void main( String args[] )
{
String oplist;
try {
oplist = Houdini.hscriptex("opls /");
} catch ( java.io.IOException e ) { }
Houdini.hscript( "message " + oplist );
}
}
Would be run with the command:
java -w test
To produce the output:
obj out part ch shop img vex
See also: openport, tcl, tk, unix
Usage: job [unix_path] Print the $JOB variable if no path is specified, otherwise, the $JOB variable is set to the path specified.
Usage: kinconvert Create InverseKin Chops for all bone objects that have a solver type other than "none". This command easily updates old hip files to the new structure for performing IK.
Usage: loadseq [-f frame] [-t time] [-v volume] [-s off|on] [-u]
[audio_file]
Changes the audio options for mplay, loads and unloads audio. If an
audio_file is specified, the file is used as the new audio. Options
not specified are not modified (so you don't need to specify all the
options if some are not changing).
Options:
-f frame Specifies the frame to align the audio start time with
(default frame 1).
-t time Specifies the audio start time to sync with the start
frame (default 0sec).
-v volume Specifies the audio volume (1=normal, 0=mute).
-s off|on Turns audio sustain on or off (default on).
-u Unload the current audio clip.
Examples:
loadaudio talking.aiff # set the audio to 'talking.aiff'
loadaudio -u # unload the audio (turn it off)
loadaudio -v 0.5 # set the volume to half
loadaudio -f 48 -t 2 # sync audio time of 2sec with frame 48
loadaudio -s off # turn sustain off.
This command is only available in MPlay.
See also:
loadseq
Usage: loadseq [-r] [-u] file_pattern
This command loads a sequence of files into mplay.
file_pattern can use either \$F or * to specify the frame number.
Options:
-r Replace - load and discard all currently loaded
sequences.
-u Load the sequence unbuffered; images will not be
cached.
Examples:
loadseq ~/shot1/frame\$F.pic
loadseq -r ~/shot1/frame*.pic
This command is only available in MPlay.
See also:
appendseq, loadaudio, prependseq
Usage: matrman shader_name This command will generate a RenderMan .sl file based on the material specified. To save the .sl file to a disk file, simply redirect the output to the disk file you want.
Usage: matupdateref This command will update all the Palette material references. i.e. If the palette on disk has changed that the material is referencing, then this command will force a reload on the Palette material.
Usage: memory Show the current memory usage
Usage: message text This command presents the specified text to the user. In a non- graphical application such as hscript, this command is similar to the echo command except that the text will always be displayed in the console, even if the command output is being redirected to a file or elsewhere (such as when the message command is being run from an external application using the java command or openport facility). In a graphical application such as Houdini, this command brings up a dialog box with the specified text. All further commands and processing are stopped until the user dismisses the dialog. See also: echo, java, openport
Usage: mplayfit
Fits the mplay window to the image (at 100%). This command is only
available in mplay.
Usage: mplayhome [-e]
Homes all the mplay viewports (fits the image to the viewport size).
Options:
-e Exact image size - set the zoom to 100% and center in viewport.
This command is only available in mplay.
Usage: mplayprofile profile_name
Sets the current mplay profile to profile_name. This will cause the
mplay UI to change to the profile configuration.
The available profiles are:
default - used when mplay is run
viewer - used when mview is run
flipbook - used for COP flipbooks
render - used for renders to ip or md
tools - used for the COP/Halo viewer.
monitor - used for COP/Halo node monitors.
minimal - minimal UI layout; viewport only.
full - All UI exposed.
This command is only available in mplay.
Usage: mread [-m merge_pattern | -M] [-c] [-o] [-i] filename Read a hip file. The -m will merge the file into the current HIP file. A pattern is specified to indicate which sections of the file should be merged in. The -M option is an abbreviation for -m * which will merge the entire contents of the specified file. If the -c option is specified, a merge will not be done, but instead, a list of collisions will be reported. Collisions occur when an object in the merge file has the same name as an existing object in the HIP file. If the -o option is specified the merge will attempt to overwrite the nodes whose names collide with those in the current session. If the -i option (interactive mode) is specified, this command will act as though the file was loaded via "File -> Open...". It will prompt you to save the current file before loading the new file and it will display any load errors in a popup window. Also, it will change the name of the current file at the top of the Houdini window and it will add the file name to the list of most recently used files. This option is not available in hscript. No other options may be specified when using this option. Examples: mread job3.hip # Replace current HIP file with job3 mread -m * job3.hip # Merge in everything from job3 mread -m *geo* job3.hip # Merge in all ops which match *geo* See also: mwrite opread source
Usage: mwrite [-i | -b] [filename] Or: mwrite -c filename Write out a hip file containing the entire active session. If the -i option is specified, then the filename is automatically incremented. If the -b option is specified a numbered backup is created. That is, if filename already exists, then it is renamed to a file name containing the next number in the sequence before saving. The backup files are saved in the directory set in the environment variable HOUDINI_BACKUP_DIR. If HOUDINI_BACKUP_DIR is not set, then a default relative directory called "backup" is used. The -b and -i options are exclusive. If the -c option is specified then the filename is mandatory and a partial hip file will be saved containing only the animation channels. To load such a channels-only hip file into a current session use the command: mread -o -M <filename> See also: mread opwrite opscript
Usage: neteditor <options> [-d <desktop_name>] pane1 ... Allows different options of the network editor to be set. A valid pane name must be specified. If no desk name is given then it will assume the current desk. Options: -d <string> Desktops to operate on. If it is blank it will default to the current desktop. -x 0|1 Display group dialog -w 0|1 Display the world tree control. -p 0|1 Display parameters -c 0|1 Display the color palette -e 0|1 Display expose flag in list mode -I 0|1 Display implicit operators in list mode -n 0|1 Display operator names -o 0|1 Display the network overview -s 0|1|2 Set the connection style 0 - right angle links 1 - straight links 2 - rounded links -z 0|1 Hide operator toolbar -G <float> The split fraction for groups -P <float> The split fraction for parameters -T <float> The split fraction for tree control -S order Set the sort order. The order may be one of: user = User defined order alpha = Alphabetic type = Operator type hier = Hierarchical -v path x y scale Changes how the network specified by path should be displayed. The x and y refer to panning positions, and the scale to the zoom level. - g 0|1|2 Set the grid display option 0 - do not draw grid 1 - draw grid lines 2 - draw grid points - a 0|1 Snap to grid - y <float> Set snap gravity - r <float> <float> Set grid size - m <string> Set the snapping areas. Snapping areas that have their corresponding letter present in the string will be turned on and otherwise turned off. For example an empty string would turn off all snapping areas, whereas the string "ae" would turn on the top left corner and the center and would turn off the rest. a - top left corner b - middle of the left side c - bottom left corner d - middle of the top side e - center f - middle of the bottom side g - top right corner h - middle of the right side i - bottom right corner - b 0|1 Toggle display background image. - l 0|1 Toggle zoom and pan background image. - f <string> Set the background image filename. - q <float> Set the background image quality. - t <str> <str> <str> Set the op name highlight option. Priorities are set from left to right. <str> can be set to one of the following: none comments modified animated overridden subnet
Usage: nextkey [-p]
nextkey [-c channel_list | -s | -q]
If no arguments are specified nextkey will take you to the next
keyframe given the current channel list, which is initially empty.
-p goes to the previous key
-c give a channel list.
-s resets to using the currently scoped channels
-q prints out current channel list
Usage: objcleantransform <object_name> [-t] [-r] [-s] This command will clean the parameters of the given object so that without changing its world position at the current time, its: - translation values will be all 0.0 - rotation values will be all 0.0 - scale values will be all 1.0 - uniform scale value will be 1.0 This command is typically used on an object to define its natural coordinate space prior to animation. If optional arguments are specified, only corresponding transformation component is cleaned: -t cleans translation -r cleans rotation -s cleans scaling (and uniform scaling) Internally, this command will modify the object's pre-transform to accomplish this. See also: objextractpretransform, objresetpretransform, objpretransform
Usage: objextractpretransform <object_name> This command is used to transfer the given object's pre-transform values to the local transform parameters (at the current time). After this command is done, the pre-transform is reset to the identity matrix. Note that this destroys any existing channels or expressions in the translate, rotation, and scale parameters. Typically, this command is only used to help define an object's natural coordinate space prior to animation. See also: objcleantransform, objpretransform, objresetpretransform
Usage: objparent [on|off|useflag] With no arguments, the command prints the state of the "Keep Position when Parenting" option. With an argument, the command will set the option to be on, off, or sometimes. Objects which are re-parented (using opwire) when the option is turned "on" will always maintain their world space position. If the option is "off", then it will never change the object's position. If the option is "useflag", then positioning of objects when re-parented will depend upon the "keeppos" parameter of the object.
Usage: objkinoverride [none|rest|capture] With no arguments, the command prints the state of the "Kinematic Override" option. With an argument, the command will set the option to be: none - no override: bones are affected by transformations and/or kinematic chop solvers. This is a default behaviour. rest - rest position: bones are shown in their rest pose, and no kinematic solvers affect their displayed position. capture - capture pose: bones are shown in their capture position, no kinematic solvers or local transformation are in effect.
Usage: objpretransform <object_name> [matrix] This command sets or displays the pre-transform matrix of the given object. The [matrix] argument specifies a 4x4 double precision matrix in column-major format to set into the object. If the [matrix] argument is omitted, then the pretransform of the given object is echoed in column-major double precision format. Typically, this command is only generated when an object script is created via the opscript command. See also: objcleantransform, objextractpretransform, objresetpretransform, opscript
Usage: objresetpretransform <object_name> This command is used to reset the given object's pre-transform values to the identity matrix. Typically, this command is only used to help define an object's natural coordinate space prior to animation. See also: objcleantransform, objpretransform, objextractpretransform
Usage: ombind [-t <type>] [-d <settings>] <instance> <op_parm> <handle_parm> Binds an operator parameter to the movement of a handle. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. <instance> The label to associate with the bind operation. If the label exists, the new binding is appended to the group of bindings with the existing label. <op_parm> String specifying both the operator and the parameter to be bound, delimited by a colon. <handle_parm> String specifying the handle and parameter to bind, delimited by a colon. <settings> The default settings for this handle type when bound to this type of operator. The meaning of these settings varies between types of handles. This option only has meaning when the instance of the handle does not yet exist (ie. it only works for the first ombind command in the set of commands for one handle). To turn the handle off by default, use a default setting of "i". Example: ombind -t sop "First U" carve:group uisoparm:input ombind -t sop "First U" carve:domainu1 uisoparm:k The first command binds the group parameter of the carve sop, to the movement of the input parameter of the uisoparm handle. The "First U" instance is created assuming it is not already created. The domainu1 binding to the handle parameter k is appended to the existing "First U" instance. See also: ombindinfo, omls, omunbind, omwhere, omwrite
Usage: ombindinfo [-t <type>] <operator>
Lists the parameters that are bound to a handle for the
specified operator.
Options:
-t <type> Network type. Available types are obj,
sop, pop, and top. The default value is
sop if the argument is unspecified.
<operator> The operator.
Output format:
instance handle { op_parm->handle_parm ... }
Example:
ombindinfo carve
Lists the bound parameters of the carve sop operator.
See also: ombind, omls, omunbind, omwhere, omwrite
Usage: omls [-t <type>] [handle] Lists the available handles for the given operator type. If the handle parameter is specified, this command lists the bindable parameters of the specified handle. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. handle If unspecified, omls lists the available handles. Otherwise a list of bindable parameters for the specified handle is displayed. Example: omls domain Lists the bindable parameters of the domain handle. See also: ombind, ombindinfo, omunbind, omwhere, omwrite
Usage: omparm <manip_name> <manip_type> <op_node_name> <settings> For the given handle (handle) and operator node, set the handles's settings to the specified settings string. These settings will be used the next time the user enters the state for this operator node. The values for the settings are specific to the type of handle and are undocumented. This command is used internally to save handle settings to the hip file. See also: ombind, ombindinfo, omunbind, omwhere, omwrite
Usage: omsbind [-t <type>] <op_parm> <selector> <sel_description> <sel_prompt> <op_input_index> <op_intput_required> <primmask> <allow_drag> <menu_name> <ast_sel_all> Binds an operator parameter to a selector. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. of bindings with the existing label. <op_parm> String specifying both the operator and the parameter to be bound, delimited by a colon. The parameter specification is optional. <selector> The name of the selector type. A list of selectors can be obtained using the omsls command. <sel_description> A description of the purpose of the selector. Used with omsunbind. <sel_prompt> The string that is displayed in the status area when the selector is active. <op_input_index> Index of operator input where the result of this selection should be fed. <op_input_required> Specifies if this input is required. <primmask> A string representing the types of primitives that can be picked using this selector. This string can consist of one or more primitive types, or primitive types preceded by a "^" to remove that primitive type from the selectable primitive types. The available primitive types are: all, face, poly, nurbcurve, bezcurve, hull, mesh, nurb, bez, quadric, circle, sphere, tube, particle, and meta. <allow_drag> Determines if the user is allowed to select and begin manipulation with a single mouse click. <menu_name> Name of the operator's "Group Type" parameter (or "" if there is none). This lets the selector set this parameter to "Primitive" if the user selected primitives, "Points" if the user selected points, etc. <ast_sel_all> If set to a non-zero value, this indicates that the group parameter requires a "*" to select all geometry. A zero value indicates that the group parameter should be left blank if the whole geometry is selected. Example: omsbind -t obj blend objselect "Second Input" "Select the second blend input" 1 1 all 0 "" 0 Binds a simple object selector to the second input of the blend object. See also: omsbindinfo, omsls, omsunbind, omswhere, omwrite
Usage: omsbindinfo [-t <type>] <operator> Lists the selectors that are bound to the specified operator. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. <operator> The operator. Output format: selector "Selector Label" "Selector Prompt" op_parameter op_input_index op_input_required primmask allow_drag menu_name ast_sel_all Example: omsbindinfo carve Lists the bound selectors of the carve sop operator. See also: omsbind, omsls, omsunbind, omswhere, omwrite
Usage: omsls [-t <type>] Lists the available selectors for the given operator type. Options: -t <type> Network type. Available types are object, sop, pop, and top. The default value is sop if the argument is unspecified. Example: omsls -t obj Lists the selectors that can be bound to object parameters. See also: omsbind, omsbindinfo, omsunbind, omswhere, omwrite
Usage: omsunbind [-t <type>] <op> [instance] Removes the bindings between an operator and selector that match the specified search criteria. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. <op> Specifies the operator from which to remove bindings. <instance> Specifies the label of the selector that should be disconnected from the specified operator. Example: omsunbind particle Removes all selector bindings for the particle Sop. omsunbind particle "Force Geometry" Removes the selector with the label "Force Geometry" from the particle Sop. See also: omsbind, omsbindinfo, omsls, omswhere, omwrite
Usage: omswhere [-t <type>] [selector] Lists the operators bound to the specified selector. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. [selector] If unspecified, lists all operators bound to a selector. Example: omswhere everything Lists those operators bound to the everything selector. See also: omsbind, omsbindinfo, omsls, omsunbind, omwhere
Usage: omunbind [-t <type>] <op_parm> [instance] Removes the bindings between an operator and handle that match the specified search criteria. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. <op_parm> Specifies the bindings to remove with respect to the bound operator. Legal formats include operator_name operator_name:parm_name The operator name must be specified. <instance> Specifies the label of the handle that should be disconnected from the specified operator or parameter. Example: omunbind xform Removes all bindings for the xform sop. omunbind xform:tx Removes all bindings to xform's tx parameter. omunbind xform:tx Transformer Removes all bindings of xform's tx parameter that are bound to the Transformer handle. See also: ombind, ombindinfo, omls, omwhere, omwrite
Usage: omwhere [-t <type>] [handle] Lists the operators bound to the specified handle. Options: -t <type> Network type. Available types are obj, sop, pop, and top. The default value is sop if the argument is unspecified. [handle] If unspecified, lists all operators bound to a handle. Example: omwhere pivot Lists those operators bound to the pivot handle. See also: ombind, ombindinfo, omls, omunbind, omwrite
Usage: omwrite [bindings_file] This command writes out all handle and selector bindings to the specified file. If no file name is specified, this argument defaults to $HOME/houdini6.5/OPbindings. The format of this file is such that it can replace the default bindings file found in $HH/OPbindings. See also: ombind, ombindinfo, omls, omunbind, omwhere, omsbind, omsbindinfo, omsls, omsunbind, omswhere
Usage: opadd [-n] [-v] type [name] [name2...]
If no arguments are specified, all valid operators are listed.
If the type is specified, an operator of that type will be added.
If a list of names is entered, operators will be created and
given the names specified.
The -n option prevents the initialization script from being run.
The -v option will output the actual name of the new op.
Example:
opadd geo arms legs
Creates two geo objects called "arms" and "legs"
See also: opchangetype opget opparm oprm opset
Usage: opautoplace [-i] node_name
This command autoplaces a node tile within a network.
This is useful for a node that was inserted manually into
the center of a network. Instead of moving all the nodes below
it, you can call opautoplace on that node to insert it nicely
into the network.
This command maintains the structure of the rest of the network,
simply making room for the node(s) in the network. This differs
from oplayout, which replaces the network layout with its own
layout.
The -i flag moves the inputs to accomodate the new node, rather
than the outputs, which is the default behaviour..
Example:
oplayout convert1
oplayout bone*
See also: oplayout
Usage: opcf op_path Change the working OP folder to the path specified. See also: ucd
Usage: opchange [-i] [-s] from_pattern to_pattern This will search all operators for the from_pattern. If the pattern is found, it will be replaced with the to_pattern. All parameters of all operators will be searched for the pattern. The opchange command normally reports changed references, however if the -s option is specified then the command operates silently without reporting results. Without the -i option, this command will only replace full words that match the from_pattern. For example, if from_pattern is "myobj", the string "myobj1" would not be affected. If the -i option is set with a from_pattern of "myobj" and a to_pattern of "yourobj", the string "myobj1" would become "yourobj1". Examples: opchange plastic constant Would change the word plastic to the word constant wherever it is found. See also: opfind
Usage: opchangetype [-n] [-p] [-c] -t operator_type operator_pattern
This will change the given operators to the specified type.
Options:
-n Keep name
-p Keep parameters
-c Keep network contents
Example:
opchangetype -n -p -t null /obj/logo
See also: opadd opget opparm opset
Usage: opchmod mode operator_pattern This command changes the access permissions on the operators specified by operator_pattern. Permissions are broken down into user, group and other permissions, and further to read, write and execute permissions. The mode specified may be either absolute or symbolic. Absolute permissions are given by an octal number constructed from the OR of the following modes: 0400 read by owner 0200 write by owner 0100 execute by owner 0070 read, write, execute by group 0007 read, write, execute by others Symbolic changes are stated using letters that correspond to ownership classes and the permissions themselves. The syntax for symbolic changes is: [who] operator [permissions] Where who is one of u(ser), g(roup), o(ther) or a(ll); the operator is one of +, - or =; and the permissions are r(ead), w(rite) and (e)x(ecute). Example: hscript -> opchmod o-rw /obj/geo1 hscript -> opchmod 777 /out/vmantra*
Usage: opcolor [-c r g b] nodes Without the -c option this will print out the color for the operator(s) specified. If the -c option is specified, the color for the operators will be set to the space separated "r g b" values between 0 and 1 Example: opcolor -c 0.5 0 0.5 geo1
Usage: opcomment [-a] [-c comment_string] nodes Without the -c option the opcomment command will print out the comment for the operator(s) specified. If the -c option is specified, the comment for the operators will be set to the comment_string. If the -c and -a options are specified, the new comment will be appended to any existing comment. No new line is automatically appended. Example: opcomment -c 'This is a comment\nwith a new line' geo* opcomment -a -c '\nThis is an appended comment' geo*
Usage: opcook [-F] [-f frame_range] [-i frame_inc] [-v] object This will force the object to recook for the frame range specified. If no frame range is specified, the object will re-cook for the current frame. The -v option will cook verbosely. The -F option will force the OP to cook even if a cook is not required.
Usage: opcopy [-e] [-i] [-o] [-d] operator This command is similar to the UI operation of copying/paste. However, the command will also copy all operators which the given operator depends on. -i Copy the input nodes to the operator as well -o Copy the output nodes of an the operator as well -e Copy "extra" nodes as well. Extra nodes are ones which are referenced indirectly (i.e. via an expression). If no options are specified, all outputs are copied as well. Outputs consist of all the nodes which the specified operator feeds into. For example, in the Object editor, these would be the children of the object (and their SOPs). The operators are copied to a temporary file and must be pasted back with oppaste: Example: hscript-> opcopy /obj/geo1 hscript-> oppaste /obj See also: opcp, opdepend, oppaste
Usage: opcp [-c] operator1 [operator2...] destination This will copy the operators specified. If the destination directory is specified then it will be copied there. If not, the operator will be copied to a new operator with the destination name (a new name will be generated if there's already an object of that name). If the -c option is specified, all of the operators created by the copy will have their animatable parameters set to reference the original operator. This in fact clones the original operator. It is possible to override specific parameters by changing the channels after the clone. Example: opcp geo* . opcp /obj/geo1/* /obj/geo2 opcp geo1 fred See also: opname, oprm
Usage: opdelscript [-a] [-c delete_script] nodes Without the -c option the opdelscript command will print out the delete script for the operator(s) specified. If the -c option is specified, the delete script for the operators will be set to the delete_script. If the -c and -a options are specified, the new delete script is appended to the current one. No new line is automatically appended. Example: opdelscript -c 'unix echo Deleting Object' geo* opdelscript -a -c 'unix echo Still Deleting Object' geo*
Usage:
opdepend [-b] [-i] [-I] [-o] [-u idx] [-e]
[-p] [-s] [-l level] [-d] [-x] nodes
or opdepend {-c | -n | -N} [-b] [-x] [-l level] nodes
This will list all of the operators that are either dependent
on this node or that this node depends on.
Options:
-b the output does not show full paths
-l Which level to descend to in the hierarchy
-i lists all ops that are inputs to the node
-I lists all ops that are indirect inputs to the node
-o lists all ops that are outputs of the node
-O lists all ops that are extra outputs of the node
(ie. list who depends on the node)
-u with the -o option, specifies the index of the
output to look at when finding outputs of the node
-e lists all extra (reference) inputs to the node
(for example a texture top that references a
COP network for its source image).
-p select the nodes specified
-s silent mode - no output to the textport
-d performs a dependency search among the
nodes contained within a subnetwork (if the argument
is as network of nodes)
-x exclude from output any nodes that are among
or are contained by any of the argument nodes
-c lists all the CHOPs that export to this node,
and all nodes which this node exports to.
-n lists all name references starting from this node
-N lists all name dependents starting from this node
Examples:
opdepend -i -e /mat/blue_plastic
opdepend -i -o -e /obj/geo1
opdepend -i -p -s /obj/logo
opdepend -n /obj/light1
opdepend -N /obj/logo
To print input and extra input nodes referenced by a subnet or its
contained nodes (descentants), without printing the subnet nodes
themselves:
opdepend -i -e -d -x /obj/subnet
To print the channels references of subnet1 and subnet2 and
the nodes they contain:
opdepend -e -d /obj/subnet1 /obj/subnet2
To print the nodes box, sphere, and triangle are wired to,
(outside of the set of box, sphere, and triangle nodes themselves):
opdepend -i -x box sphere triangle
Usage: openport [-aeqsw] [port_number] Opens a communication port to Houdini. This allows the hcommand program to run textport commands from a remote process. The -e option causes commands sent to the port to output errors separately from regular output. Regular output will be sent first, followed by a line containing the string "~~~~~", followed by any error messages. The -q option will prevent this command from printing an error message if the specified port number is already open. Additionally, when using the -a option, the -q option will cause openport to print only the port number opened. The -s option will allow the remote process to run only "safe" commands. The -w option specifies that this command should not return until the newly created port has been closed. It is the responsibility of some external application to send a closeport command through the newly opened port to close it. The -a option will automatically choose a free port and open it instead of opening any specified port number. Until this port is closed, subsequent calls to openport -a will return the same port number. If you don't pass the port number or the -a option to openport, it will list the ports that are currently open. See Also: closeport
Usage: opextern [-g] [-l] [-M] [-m] [-n] [-q] [-R] [-r] node [nodes...]
This command will show all external references (ie, external files)
in the given node(s). It can also check for missing external
references. This command can be used to produce lists of references,
nodes with references or missing references.
-g Group frame ranges together; files like butterfly$F.pic will
be shown as 'bufferfly$F.pic [1-7]'.
-l References that are effectively locked within the network are
not considered external references. This flag relaxes the check
for locks within subnets such that subnet branches that are not
displayed are ignored.
-m Check each file to see if it exists. Missing files are
noted with '(missing)'.
-M Check each file to see if it exists, and only show missing
files. Supercedes -m.
-n Show only the nodes which have external references, or have
missing external references, if -M is specified.
-q Suppress the printing of messages like 'No external references
found'. Useful when using opextern in scripts.
-R Recurse into networks and subnets.
-r Show only the external references themselves (ie, don't print
the node they belong to). If -M is specified, this will show
only missing external references.
Example:
opextern geo1 # show all external refs on geo1 object
opextern -R geo1 # show all external refs in geo1
opextern -RMr geo1 # show all missing external refs in
geo1
opextern -gR / # show all external refs in the current
session grouped by frame range if
animated.
opextern -nR / # show all nodes in the current session
with external references.
opextern -rR / # show all external references in the
current session.
Usage: opextract subnet [subnets...] This command will expand the subnetworks specified. Example: opextract /obj/subnet1 # expands the /obj/subnet1 node
Usage: opfind [-t typename] [-T networktype] [-n opname] [-p rootpath]
[-s] [-i [-w]] pattern
This will search through all operators at, or below, the given
rootpath. If rootpath is not specified, "/" is used. Each of
the other parameters specifies an optional search criteria.
If all the search criteria are met, the full path of the
operator will be printed out.
pattern
All parameters of the operator will be searched for the
pattern.
typename
The operator will be listed if its internal type name
matches the given typename. Wildcards such as * and ?
may be used to do multiple matches.
networktype
The operator will be listed if it is of the given network
type. See the help for optype for a listing of valid
network types.
opname
The operator will be listed if its name matches the given
operator name. Wildcards such as * and ? may be used to
do multiple matches.
rootpath
Only nodes at, or below, this path will be searched. This
path is relative to the current working directory. If not
specified, "/" will be used, unless the -s option is set, in
which case the current path will be used.
The -s option causes this command to search only one network, and
not recurse into child networks. Also, this option changes the
output of this command to only show the node name rather than the
full path of the node.
The -i option will cause this command to return a match even if
the search string is not used as a distinct word. If the -i
option is specified, the -w option can also be set. This option
lets you search for strings with wild cards (such as "?" to match
any single character or "*" to match any sequence of characters).
The -w option cannot be used without the -i option.
Example:
opfind light1 # Find all expressions
# referencing light1
opfind -n light # Find all ops named light
opfind -T SHOP # Find all SHOPs.
opfind -t light # Find all ops of type light
opfind -p /obj # Find all ops under /obj.
opfind -s -t light # Find all lights in the current net
See also: opchange, optype
Usage: ophide networktype opname This command will hide the specified OP from the toolbars. Example: ophide Sop sphere # hides sphere SOP from toolbar See also: opunhide
Usage: opunload [-R] [-f] opname This command will unload the cooked data from the specified op names. It will currently only unload SOP data. It has no effect on locked SOPs. If the node is currently used, it will not be unloaded. The -R flag will cause it to recursively unload all nodes contained within the given node. The -f flag will cause it to only unload those nodes which do not have special flags set (Ie: Display, render, template). Example: opunload /obj/model/* # Unload all SOPs in /obj/model opunload /obj/model/box1 # Unload /obj/model/box1.
Usage: opunhide networktype opname This command will make the specified OP accessible from the toolbars. Example: opunhide Sop sphere # makes sphere SOP accessible in toolbar See also: ophide
Usage: opbadd bundle_name [second_name ...] Creates one or more operator bundles. Use the opbop command to modify the bundle. See also: opbls opbop opbrm opbname opgadd opgop opgrm
Usage: opbrm bundlepattern Removes the specified operator bundle. See also: opbls opbadd opbop opbname opgadd opgls opgop
Usage: opbop [-v] bundlepattern operation operands Modifies the bundle(s) specified using one of the following operations: set - Set the contents of the bundle(s) to be the list of operators specified by the operands add - Add the operators specified by the operands to the contents of the bundle. remove - Remove the operators specified by the operands from the bundle(s) specified. filter - Set the filter of the operator. This limits the bundle to contain a specific type of operator. By specifying an invalid filter type, all possible filters will be listed. lock - By default, every new operator created will be added to all existing bundles. For example, if a new light object is created, it will be added to all bundles which allow light objects (see filter) automatically. By setting the bundle to locked, the automatic addition of operations is turned off. It is still possible to modify the bundle using the set/add/remove options. unlock - Unlock the bundle so that new operators will automatically be added. The -v option will print out information for the set/add/remove operations. See also: opbadd opbls opbrm opbname opgadd opgls opgop
Usage: opbls [-g] [-l] [-L] [bundlepattern] Lists the bundles which match the bundle pattern. The options to this command are: -g Print the information in the form of hscript commands -l Print out a long listing of the bundles -L Print out only the contents of the bundle (suppressing the printing of the bundle name, filter and other information) See also: opbrm opbadd opbop opbname opgadd opgls opgop
Usage: opbname oldname newname This command renames a bundle from the old name to the new name. See also: opbrm opbadd opbop opbls opgadd opgls opgop
Usage: opgadd group_name [second_name...] Creates one or more operator groups. Use the opgop command to add and remove operators from each group. See also: opgls opgop opgrm opbadd opbop opbrm opbls opbname
Usage: opget [-q] [flag] ... operators ...
The opget command queries individual operator flags and outputs the
result as an "opset" command. The -q option will cause no messages to
be printed on an unknown flag or operator.
The flags are:
-d Display
-r Render
-t Template
-b Bypass
-l Lock (off, soft, hard (or equivalently "on"))
-e Expose
-h Highlight
-f Footprint
-s Save data in motion file
-u Unload data after cook
-c Compress icon
-C Set to be the current
-p Set the picked flag
-S Selectable in viewport (objects only)
-x Object pivot axes (objects only)
-y Xray (objects only)
-a Audio (CHOPs only)
-o Export (CHOPs only)
Example:
opget -d geo*
opget -p -r light*
opget geo*/*
See also: opadd opchangetype opparm opset
Usage: opgetinput [-n num | -o outputop [-u outputidx]] inputop With the -n option, this function returns the name of the node that is attached to input num of the inputop. It returns the empty string if no input is attached to the given input. With the -o option, this function returns the input number of the inputop that is connected to the outputop. If the outputop is not connected to the inputop, -1 is returned. If the outputop is connected to more than one input of the inputop, the highest input number is returned. When the -o option is specified, the -u option can also be used to specify which output index of the outputop must be connected to the inputop. The default for this option is -1, which indicates that any output of the outputop should be considered.
Usage: opglob [-r | -f] operator_pattern Does pattern expansion on the given pattern, then prints the output of the expansion. If the operator_pattern starts with the @ symbol, then it is expanded to the given bundle or group. If matching bundles and groups are found, then the bundle is given precedence. The flags are: -r output relative paths -f output full paths Examples: Expands the bundle named package or the group named package in the current working operator: opglob @package Expands the bundle named package or the group named package in the current working operator but exclude the node /obj/light1: opglob @package ^/obj/light1 Expands the bundle named package or the group named package in the current working operator and output full paths: opglob -f @package Expands the group named package even if a bundle with the same name exists: opglob ./@package Expands the group named package that is within /obj/subnet1: opglob /obj/subnet1/@package Expands the group named package that is within /obj/subnet1 but return relative paths: opglob -r /obj/subnet1/@package
Usage: opgls [-g] [-l] [-L] [pattern...] Lists operator groups. The -l option will list the names of the operators in each group as well. If a pattern is specified, then only groups which match the pattern will be listed. The -L option also lists the names of the operators in all groups that match the pattern, but it suppresses the output of the group names. This option makes it easier to use the output of this function as part of an expression. If the -g option is specified, then the output will be a series of commands which describe how the group(s) were created. This can be used to generate scripts which build groups (see the -G option on opscript). See also: opgadd opgop opgrm opbadd opbop opbrm opbls opbname
Usage: opgop group_name <operation> name_pattern [second_pattern...] This command performs operations on operator groups (i.e. allows addition or removal of operators from the group). group_name The name of the operator group to modify <operation> Can be one of: set Set the contents of the group add Add operators to group remove Remove operators from group The name_pattern specifies a list of operator names to be added or removed from the group. Example: opgop group1 set geo* opgop group1 add light1 light2 light3 opgop group1 remove geo4 See also: opgadd opgls opgrm opbadd opbop opbrm opbls opbname
Usage: opgrm group_pattern [second_group...] Removes the specified operator groups from the current network. See also: opgadd opgls opgop opbadd opbop opbrm opbls opbname
Usage: ophelp [operator] [operator type]
Display help for an operator or for an operator type.
"operator type" is of the form <class>/<type>
For example, "ophelp Sop/add" will display the help for
the add SOP. "ophelp /obj/geo1" will display the help
for the geo objects since /obj/geo1 is a geo object.
Available operator classes are:
Object - Object Operators (OBJs)
Sop - Geometry Operators (SOPs)
Particle- Particle Network Operators
Pop - Particle Operators (POPs)
ChopNet - Channel Network Operators
Chop - Channel Operators (CHOPs)
Driver - Output Operators (ROPs)
Shop - Shader Operators (SHOPs)
Cop2 - Composite Operators (COP2s)
CopNet - Composite Network Operators
Vop - VEX Operators (VOPs)
VopNet - VEX Network Operators
Usage: opinfo [-v] operator [operator2...] Displays information about the operator, including the comment. The -v turns on verbose output.
Usage: oplayout [-d direction] [-x space_factor] [-y space_factor] [-s]
-s layout selected operators only.
-d specify the direction to layout operators
Options for direction are:
0 = Top to Bottom
1 = Bot to Top
2 = Right to Left
-x specify the space factor between children
-y specify the space factor between parent/child
Note: the factor is a fraction of the tile width/height
Usage: oplocate [-d] [-x xval] [-y yval] operator_pattern Locates the specified operators in the worksheet view. These coordinates are absolute coordinates on the worksheet, and are unchanged by panning or zooming on the worksheet. -d The -x & -y specified are deltas and are added to the current location -x Specifies the X position -y Specifies the Y position If neither the -x or -y are specified, the current position is printed.
Usage: opls [-a] [-d] [-l] [-t] [-R] [operator_pattern] Lists the operators specified (or all the operators in the current path). Options: -a Print all operators (including hidden ones) -d Do not print contents of networks -R Recurse through all networks and sub-networks -l Print in long format. -t Sort operators by their last modified time The long format lists many flags of the operator. A hyphen is printed if the flag is not active. The meaning of the flags is: d - Display r - Render t - Template l/L - Locked (soft-locked/hard-locked) e/h - Exposed or hidden b - Bypassed c - Current s - Selected If the node contains other operators, the number of operators it contains will be printed in parentheses. For example, an object containing SOPs or a sub-network. Example: opls -lR geo* opls -d /*/*/*
Usage: opmenu [-l] opname parmname Displays the names of all the values that would be accepted by the opparm command for setting the value of a parameter with a menu. If the -l option is specified, the names and the labels for each menu item are displayed. The arguments are the name of the node and the parameter of that node for which the menu items should be displayed. Example: opmenu /obj/model xOrd opmenu -l /obj/model detail See also: opparm opscript
Usage: menurefresh Forces Houdini to reload the contents of the OPmenu and CHGmenu files in the HOUDINI_PATH. These files file provide a means of adding custom script commands to the right mouse button popup menu for operator tiles and channel groups respectively. Changes made to these files while Houdini is running will not be reflected in the menus until this command is run.
Usage: opname old_name new_name Renames the specified operator to the new name.
Usage: oporder operator [operator2...] before oporder [-b | -e] operator [operator2...] Changes the user defined order so that the operators specified are moved before the before operator. If the -e option is set, then all operators listed are moved to the end of the order. The -b option moves the specified nodes to the start of the list. In these cases no before node is required. Example: To move all cameras to before the geo1 object: oporder cam* geo1 To move the model object to the end of the list: oporder -e model
Usage: oppane -t type operator_pattern This command will bring up a floating dialog for the operators specified. The type is one of: neteditor - Not supported yet geosheet - Displays the SOP's geometry spreadsheet parmeditor - Displays the operator's parameters
Usage: opparm [-q] [-r] [-C] operator_pattern [-v [-p | -c]] parameters
Usage: opparm [-q] -c operator_name parameter_names
Usage: opparm [-q] -d operator_pattern [-v] parameter_names
The first form of "opparm" will set parameters for the given operator.
The second form will execute any callbacks associated with the
specified parameter. The third form will display the values of the
listed parameters.
The parameters are operator dependent and thus are different for each
object type. To get a list of parameters, please use "opscript".
If the -q option is used no warning or error messages are printed.
When using "opparm" to set parameter values, the animation channels of
the parameters are deleted by default. But if the -v option is
specified and the value specified for the parameter is a number, then
the channels aren't deleted. The opparm command will behave as if the
values had been entered into a parameter dialog at the current time.
If -p option occurs after -v, and the value is set at a keyframe,
then the new parameter value is forced to a pending state. Similarly,
the -c option forces the value at a keframe to be commited right away.
If the -C option is set, in addition to setting the parameter values,
any callbacks associated with the parameters will be executed. If the
-r option is specified, the opparm command will follow simple channel
references and set the referenced parameter instead of deleting the
channel reference expression and setting the value in the specified
parameter. This is useful when writing scripts to modify parameters
of nodes inside custom subnet operators.
When using "opparm" to query parameter values, the animation channels
of the parameters will be displayed by default. Use the -v option to
evaluate the channels at the current time and display parameter values.
When specifying the names of parameters to display, you can use wild
card characters.
If the parameter is a button which executes a callback, it is possible
to use the second form to invoke the function. Examples of these types
of buttons are in the creep SOP (initialize), and many render output
drivers (the render buttons). If the parameter is a menu with a
callback function, and you wish to execute the callback as if a
specific menu item has been chosen, use the first form of the command
with the -C option set. Use the opmenu command to determine what
are valid menu item values.
It is possible to specify a particular component when setting a
parameter. This can be done either by using an index, as in t[0],
or by using the channel name, as in tx.
Examples:
opparm geo1 t ( 1 2 3 )
opparm geo1 t[2] ( 3 )
opparm geo1 tz ( 3 )
opparm -C /obj/geo1/creep1 Initialize initfill
opparm -c /out/mantra1 execute
opparm -d geo1 t
opparm model -v -p rz ( 4.5 )
See also: opadd opchangetype opget opmenu opscript opset
Usage: oppaste network This command will paste the data copied by opcopy into the network specified. It is not possible to choose the name of the operator being pasted. See also: opcopy, opcp, opdepend
Usage: oppresetload opname presetname This command loads the channels and parameters from the chosen preset into the chosen operator. The operator is set with the opname parameter. The preset to use is set with the presetname parameter. See the oppresetls command to get a list of all presets that are available for a given operator. Use the oppresetsave command to create new presets. Example: oppresetload /obj/model/lsystem1 Lightning See also: opparm, oppresetls, oppresetrm, oppresetsave, oppresetloadfile, oppresetsavefile
Usage: oppresetloadfile opname presetfile This command loads the channels and parameters from the chosen preset file into the chosen operator. The operator is set with the opname parameter. The presetfile parameter is the name of a file on disk. Use the oppresetsavefile command to create new preset files. Example: oppresetload /obj/model/lsystem1 Lightning See also: opparm, oppresetls, oppresetrm, oppresetsave, oppresetsavefile
Usage: oppresetls [-l] opname oppresetls [-l] -t table/operator This command lists all the presets that are available for a given operator. If the -l option is set, in addition to displaying the preset names, the location where each preset is stored on disk will also be displayed. This command can be invoked with either a node name or an operator table and type name (if the -t option is specified). The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. Presets are loaded with the oppresetload command, and saved with the oppresetsave command. Example: oppresetls -l /obj/model/lsystem1 See also: oppresetload, oppresetrm, oppresetsave
Usage: oppresetrm opname presetname [directory] oppresetrm -t table/operator presetname [directory] This command deletes a preset from a file on disk. The operator is specified with the opname parameter. The presetname parameter is the label of the preset that is to be deleted. If the directory parameter is specified, it is the location from which the given preset should be deleted. Executing this command with no parameters will display a list of all valid directory names. If the directory is not specified, this command deletes the preset from the location where the preset is currently defined. The oppresetls command can be used to get a list of all presets currently available for an operator. This command can be invoked with either a node name or an operator table and type name (if the -t option is specified). The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. Example: oppresetrm /obj/model/lsystem1 "My Tree" See also: oppresetload, oppresetls, oppresetsave
Usage: oppresetsave opname presetname directory This command saves the channels and parameter values for the specified operator as a preset. The operator is specified with the opname parameter. The presetname parameter is the label that will be used to identify the preset in the Presets menu, or when using the oppresetload command. The directory parameter is the root directory where the preset should be saved. Presets are always saved inside a presets subdirectory within the specified directory. Only directories listed in the HOUDINI_PATH and for which the user has write access can be specified for this parameter. Executing this command with no parameters will display a list of all valid directory names. Example: oppresetsave /obj/model/lsystem1 "My Tree" $HOME/houdini6.5 See also: oppresetload, oppresetls, oppresetrm, oppresetloadfile, oppresetsavefile
Usage: oppresetsavefile opname presetfile This command saves the channels and parameters from the chosen operator file into a file on disk. The operator is set with the opname parameter. The presetfile parameter is the name of the file on disk where the preset should be saved. Use the oppresetloadfile command to load an existing preset file. Example: oppresetsave /obj/model/lsystem1 Lightning See also: opparm, oppresetls, oppresetrm, oppresetload, oppresetloadfile
Usage: oppwf Prints the current OP working folder. See also: opcf
Usage: opramp operator_name position r g b a Usage: opramp -r operator_name position This command sets a key in a ramp of an operator (e.g the two tone shader). The position should be between 0 and 1. If the position specified is within 0.01 units of an existing key, that key will have its color set. Otherwise, a new key will be added with the color specified. The second usage allows you to remove keys from a ramp in an operator. The first and last keys cannot be removed. To get a list of the keys, use the opscript command on the operator.
Usage: opread filename Read the contents of the file into the current directory (oppwd). The file specified should have been created by the opwrite command. See also: opwrite, opscript, cmdread, source
Usage: oprm [-f] operator_pattern The specified operators will be deleted. The -f option will prevent error messages from being printed. See also: opadd oprmtype
Usage: oprmtype -t operator_type [-r] operator_pattern All specified operators matching operator_pattern that are of type operator_type will be deleted. The -r option will recursively search through children of the operators listed in operator_pattern for those matching operator_type. Example: oprmtype -t visibility -r /obj This command will remove all visibility SOPs from all objects. See also: oprm
Usage: opsave [-q] [-v] [-f start end] [-i inc] operator filename
The data generated by the operator specified will be saved out
to the filename specified. Optionally, a frame range can be
specified and the data will be written out for each frame
of the frame range. Currently CHOP, COP and SOP data are supported.
The -v option will cause verbose output. The -q (quiet) option is the
opposite of -v, it ensures absolutely no messages will be printed
out, not even warnings or errors.
NOTE: The -f paramater will do the equivalent of:
for i = start to end step inc
fcur $i
opsave operator filename
end
Unless you have $F or similar in your filename, you
likely don't want this option (make sure to backslash the
$F variable - "\$F"). CHOPs, for example, save their entire
data and usually don't require the -f parameter.
Examples:
opsave -f 1 10 -i 2 twist1\$F.rib twist1
opsave /ch/ch1/wave1 wave.bclip
opsave /ch/audio/filter1 test.aiff
See also: opscript, opwrite, mwrite
Usage: opscale [-g] [-s scale_factor] networks This command is now obsolete. Use neteditor -v instead.
Usage: opscript [-r] [-m <in_wire> <out_wire> | -g] [-o] [-n] [-b] [-v|-c] [-w|-d] [-s] [-G] [-o] operator_pattern For the specified operator, this will echo the commands necessary to re-create the operator. Options: -r Work recursively through the whole operator hierarchy. -g Top level arguments will be in general form. i.e. the names will have to be specified when sourcing the script file. -m Top level arguments will be in macro form. i.e. the names will have to be specified when sourcing the script file. More general than -g. The <in_wire> specifies the input wire node and the <out_wire> specifies the output wire node. -o Save outgoing wires as well -n Normally this command encloses all chadd and chkey commands inside a pair of chblockbegin and chblockend commands. This option causes these chblock commands to be omitted. -b (brief) The values for parameters at their default values will not be printed. -v Causes channel values to be evaluated and no channel information to be printed. -w Same as the -v option, but only applies to the root node if recursion is specified. -c Causes only the channels for the specified operators to be output (overrides -v). -d Same as the -c option, but only applies to the root node if recursion is specified. -s Output channel and keyframe times in samples (frames) instead of seconds. -G The groups for each node will be saved as well. Note that you need to give a path to a manager or subnet node for this option since groups are only stored in those nodes. -C Generate a creation script for the operator. The script generated with this option is suitable as a creation script (i.e. the script run every time this type of operator is added). The -C option works in conjunction with the -v, -b, -c and -r options. Example: opscript -r /obj/geo* opscript -G /obj > /tmp/objgroups.cmd See also: chblockbegin, chblockend, opmenu, opsave, opwrite
Usage: opset [-q] [flag on|off|toggle|#] ... operators ...
The opset command turns various operator flags on or off.
The -q option will cause no messages to be printed on an
unknown flag or operator.
A numeric value passed will turn it on if it is non-zero,
otherwise turn it off. A value of toggle will cause the flag
to switch to the opposite value. Neither of these is
applicable with the Lock flag.
The flags are:
-d Display
-r Render
-t Template
-b Bypass
-l Lock (off, soft, hard (or equivalently "on"))
-e Expose
-h Highlight
-f Footprint
-s Save data in motion file
-u Unload data after cook (CHOPs only)
-c Compress icon
-C Set to be the current
-p Set the picked flag
-S Selectable in viewport (objects only)
-x Object pivot axes (objects only)
-y Xray (objects only)
-a Audio (CHOPs only)
-o Export (CHOPs only)
Example:
opset -d on geo*
opset -p off light*
opset -l hard -s on geo*/*
See also: opadd opchangetype opparm opget
Usage: opstat [-q] [-c] [-m] [-u] operators... opstat [-T] [table name] Displays stat attributes for the operators given. These attributes include the creation time, modification time and original author of the OP. -q Quiet. Simply print values without syntactic sugar. -c Show when the operator was created -m Show when the operator was last modified -u Show the user who created the OP. The modified time will be updated whenever: A child is created/destroyed/exposed/hidden in a network The operator is renamed An input to the OP is changed Any flag, parameter or channel is modified Any groups are changed in a network Alternatively, if the -T option is specified, statistics for the operator tables are printed out. This shows the total number of operators available for each type of table along with the number of operators in the current file. See also: optype
Usage: optype [-N] [-t] [-e] [-n] [-s] [-i] [-T] [-o] opname This displays various type related infromation about the specified operators. If no options are given, all the options are printed in a readable fashion. If some of the options are given, just their values will be printed out. The choices are: -N The name of the node, likely same as opname. -t The operator type of the node. For example, /obj/model will usually be type "geo". -e The label of the type. An op of type "geo" will usually have the label "Geometry". Be careful as this label may contain spaces. -n The network type of the node. In the case of /obj/model this would be "OBJ". Possible return types are: OBJ, SOP, PART, POP, MAT, TOP, CHOPNET, CHOP, ROP, SHOP, COP2, IMG, VOP, VOPNET, MGR, and DIR. -s The script directory of the optype. This is used internally to locate some files related to the operator. Possible values are: obj, sop, part, pop, mat, top, ch, chop, out, shop, img, cop2, vop, vex, mgr, and dir. -i The index of the network type. This is a number which is unique for each of the network types. It can be used to index into a table, for example. However, the mapping of network types (-n) to indices (-i) is not guaranteed to be consistent from Houdini version to version. -T The table name of the network type. This matches the table names used by other commands. Possible values are: Object, Sop, Particle, Pop, Material, Texture, ChopNet, Chop, Driver, Shop, Cop2, CopNet, Vop, VopNet, Manager, and Director. -o The table name and operator name, separated by a "/". This is the format required for most operator type commands such as otwrite and otdelete. Information for each of the specified choices will be printed out in the above order. See also: otedit, opstat, optypeuninstall,
This command is a built-in alias for optyperead.
Usage: optyperead srcfile.optype installdir Loads a .optype archive and installs the operator type into the specified directory. The install directory should be something on the HOUDINI_PATH. .optype archives describe the user configurable aspects of operators. For built in operators, this includes the label, icon, default parameters, and help text. For HDK created operators it also includes the .so. For Vex and Subnet operators it includes the parameters and script which defines their behaviour. Example: optyperead myvexop.optype $HOME/houdini6.5 optyperead mysubnet.optype $HSITE/houdini6.5 See also: otedit, optypeuninstall
Usage: optypeuninstall Table opbasename uninstalldir This will remove all references to the given operator from the uninstall directory and anywhere higher on the HOUDINI_PATH. This is used to clean up operator types that are no longer desired. The table is the table name of a network. For a full listing, look at the help for otwrite. You will have to restart Houdini before the uninstallation comes into effect. Examples: optypeuninstall Sop clean $HSITE/houdini6.5 optypeuninstall Pop fireworks $HOME/houdini6.5 See also: otedit, optype, optyperead, otwrite
Usage: opunwire object input_number [input_number] Disconnects inputs from a node. The input_number specifies the number of the input to unwire (starts at 0). Example: opunwire box1 0 Disconnects the input from the box SOP. opunwire merge1 1 3 5 Disconnects inputs 1, 3, and 5 from the merge SOP.
Usage: opupdate This command will cause all OPs which reference external disk files to re-cook if the disk file referenced has been changed. As well, any cached textures or geometry files which are out of date are re-loaded. See also: texcache, geocache
Usage: opwire [-o outputidx] [-n] [-i] node -input_number wire_node [-input_number wire_node...] Wires the output one node (specified by node) to the input of another (specified by wire_node). Options: -input_number Specifies the input number -n Specifies that the world position should not be maintained when wiring Objects. -i Specifies that the node name should be a number. In this case the "indirect input" of the given number will be wired. Use this to get at the inputs from within a subnet OP. -o Specifies the output index of node that should be connected to the wire_nodes. Example: opwire twist1 -0 box1 Will connect twist1 to the first input of box1 opwire box1 -0 merge1 ; opwire box2 -1 merge1 Will connect box1 to the first input of merge1, box2 to the second input of merge1. It is recommended that for multiple input OPs like the merge SOP that the inputs are filled up consecutively. opwire -o 4 global1 -3 output1 Will connect output 4 from global1 into input 3 of output1. opwire -i 0 -0 box1 Connects the first indirect input to the first input of the box SOP.
Usage: opwrite operator [operator2...] filename Saves the contents of the operators into the file specified. This is a partial motion file write. The contents are stored in .cpio format and are reloadable into networks of the same type. Such files may be read back in using the opread command. Example: opwrite geo* geometry.cmd opwrite dome1 particle1 rainstorm.cmd See also: opread opsave opscript mwrite
Usage: otcollapse otlfile srcdir This command will rebuild an operator type library file from the specified directory. The directory must contain an index file with a list of files on disk that are merged together to create the operator type library. The index file and disk files can be created from an existing operator type library using the otexpand command. Once expanded, the component files can be edited before collapsing them again. Using this method it is possible to exercise complete control over the contents of an operator type library. See Also: otexpand
Usage: otcomment table/operator otcomment -d table/operator otcomment table/operator comment The first usage of this command queries the comment for the specified operator type. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. The second usage clears the operator type comment. The third usage sets the operator type comment. This command only works if the specified operator type is already defined using an operator type library. See Also: otversion, otwrite
Usage: otconfig [-b 0|1] [-d 0|1] [-i 0|1] [-l 0|1] [-s 0|1] [-u 0|1] [-w 0|1] [-x 0|1] This command configures the Operator Type Manager. The options in this command correspond to the Configuration options available in the Operator Type Manager dialog, which can be accessed from the Tools menu. Each option can be turned on or off by specifying a 1 or a 0 value. If no options are specified, the current values for all configuration options are displayed. All changes take effect immediately and are saved to a configuration file in your HOME directory. The otprefer command provides a means to override these global options for a specific operator type so you can explicitly choose the source for a particular operator type definition. -x Give Preference to Definitions from Index Files. If this option is set, Any operator definitions listed in index files take precedence over definitions for the same operators found in operator type libraries. Turn on this option if you have operator definitions that need to be shared between this version of Houdini and versions 5.5 or earlier. -i Give Preference to Definitions Saved in Hip File. Hip files can optionally embed an operator type library containing definitions for all operators used in the hip file. If this option is turned on, these definitions stored in the Hip file are given precedence over definitions for the same operators stored in other operator type libraries. Turn on this option if you don't want future changes to operator definitions to affect the functioning of your hip files. The "-x" option takes precedence over this option. -l Give Precedence to Definitions with Latest Date. If this option is turned on and there are several definitions available for a single operator, Houdini will use the one which was modified most recently. If this option is turned off, Houdini simply uses the order in which the operator type libraries are loaded to determine which definition to use. The "-x" and "-i" options take precedence over this option. -s Save Operator Definitions to Hip File. If this option is turned on, whenever you save your Hip file, Houdini will embed an operator type library into the file. This library contains the operator definitions for all operators used in the Hip file. Turning off this option will reduce the disk space used by your Hip files. But if you delete one of the operator definitions used by the Hip file, the Hip file will not be able to create the operator whose definition was deleted. -u Leave Values When Defaults Change. If this option is turned on, parameters at their defaults values are not changed when a new definition for the operator type is loaded with a new set of default values. If this option is turned off, then parameters at their old default values are changed to match the new default values. -w Display Warning for Out of Date Operators. If this options is turned on, and the "-i" option is also turned on, Houdini checks the modification times of all operator definitions embedded in the hip file. If it finds that the embedded definition is not as recent as another definition available on disk, it opens a warning dialog to notify you that the Hip file contains operator definitions that are out of date. -b Create Backup Files when Saving Libraries. If this option is turned on, any time an operator type library file is saved a backup copy of the file will be created. This feature ensures that any changes you make to an operator definition can be undone. By default the backups are made in a "backup" subdirectory of the operator type library's path. You can override this location by setting the HOUDINI_BACKUP_DIR environment variable. -d Safeguard Operator Definitions. If this option is turned on, the operator right mouse button menu item "Allow Editing of Contents"/"Match Current Definition" is removed from the menu. Hiding this option affords a level of security preventing the user from modifying operator definitions. See Also: otedit, otprefer
Usage: otcontentadd [-l srcotl] table/operator section file This command lets you add extra data to any operator definition. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. If no srcotl is specified, the current definition for the specified operator is used. The section name specifies the label that will be used to identify the new data within the operator definition. The file parameter is the name of the file on disk that is copied into the operator definition. To access the data stored inside an operator definition, use a string like "opdef:/table/operator?section", where table, operator, and section match the values used in this command. This type of string can be specified anywhere that Houdini accepts a file name. To get a list of all data sections that exist in an operator definition, use the otcontentls command. Use otcontentdelete to remove a data section from an operator definition. See also: otcontentdelete, otcontentls, otcontentsave, otwrite
Usage: otcontentdelete [-l srcotl] table/operator section This command lets you remove extra data from an operator definition. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. If no srcotl is specified, the current definition for the specified operator is used. The section name specifies the label for the data section that should be deleted. To get a list of all data sections that exist in an operator definition, use the otcontentls command. Use otcontentadd to add a new data section to an operator definition. See also: otcontentadd, otcontentls, otcontentsave, otwrite
Usage: otcontentls [-v] [-l srcotl] table/operator This command outputs a list of all sections that are part of the named operator definition. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. If no srcotl is specified, the current definition for the specified operator is used. By default, just the section names are listed. Specify the -v option to also see the size and modification time for each section. Sections can be added with the otcontentadd command, or removed with the otcontentdelete function. See also: otcontentadd, otcontentdelete, otls, otcontentsave, otwrite
Usage: otcontentsave [-l srcotl] [-o saveto] table/operator section This command lets you save extra data embedded in an operator definition into an external file. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. If no srcotl is specified, the current definition for the specified operator is used. The section name specifies the label for the data section that should be saved. If the -o option is specified, saveto is the name of the file that should be created with the data from the specified section. To get a list of all data sections that exist in an operator definition, use the otcontentls command. Use otcontentadd to add a new data section to an operator definition. See also: otcontentadd, otcontentdelete, otcontentls, otwrite
Usage: otcopy [-l srcotl] [-n newname] [-e newlabel] table/operator destotlfile Use this command to copy an operator type definition from one operator type library to another. This function can be used for archiving operator types, or updating an operator definition in one library from a definition in another library. The table value specifies the class of the operator you want to copy. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. If no srcotl is specified, the current definition for the specified operator is used. The destotlfile options specifies the name of the operator type library file to which the operator definition should be copied. If a definition for the specified operator already exists in the destination file, it is overwritten. Use the -n option to specify a new name for the copied operator type. This lets you create a new operator type using an existing type as a starting point. The -e option lets you specify a new description for the operator type. If you use the -e option without the -n option, the new operator type definition will still conflict with the existing definition. The otmerge command can be used to copy all the operator types from one library into another with a single command. Example: To copy the Shop/v_clay definition from $HH/otls/OPlibShop.otl into $HOME/OPcustom.otl: otcopy -l $HH/otls/OPlibShop.otl Shop/v_clay $HOME/OPcustom.otl To copy the current Shop/v_clay definition to $HOME/OPcustom.otl, but rename it to Shop/v_newclay, with the label "New Clay": otcopy -n v_newclay -e "My Clay" Shop/v_clay $HOME/OPcustom.otl See Also: otdelete, otedit, otmerge, otwrite
Usage: otcreatetypefrom [-s] [-f] [-n opname] [-N oplabel] [-m mininputs] [-M maxinputs] [-z] [-c comment] [-v version] [-l otlfile] [-i source] [-r renameto] subnet This command serves the same purpose as the dialog that appears when you choose the "Create Type From..." operation from the RMB menu of a subnet node tile. This command only works if the node specified by the subnet argument is a subnet node. Custom subnet operator types do not support this operation. The various arguments to this command serve the same purpose and have the same defaults as the entries in the "Create Type From..." dialog. This command also attempts to convert absolute paths to relative paths within the subnet first. If there are references which are external, we give an error and do not save. To override this behaviour, the -f option is provided to force a save. Note that references may have been successfully modified even if an error occurs. -s Don't try to detect or fix external references. -f Forces the save despite external references. -n opname Sets the internal name for the new operator type. The default value is the name of the subnet node, preceded by the current user name to help ensure the name is unique. -N oplabel Sets the descriptive name for the new operator type. The default value is derived from the name of the subnet. -m mininputs Sets the minimum number of inputs. By default this is the number of inputs connected to the subnet node. -M maxinputs Sets the maximum number of inputs. By default this is the number of inputs connected to the subnet node. -l otlfile Specifies the name of the operator type library file where the new operator type should be saved. The default value is $HOME/houdini6.5/otls/OPcustom.otl. -i source Specifies the location where the operator type library file should be installed. The default installs the library to the current hip file only. Valid values here are any entry in the HOUDINI_PATH. -r renameto Renames the subnet after creating the new operator type. The default is to not rename the subnet. -z Specifies that the subnet contents should be stored in a compressed format to reduce disk space requirements. -c comment Sets the operator type comment. Equivalent to running an otcomment command after this command. -v version Sets the operator type version. Equivalent to running an otversion command after this command. Example: The following command will create a new operator type called mysubnet in $HOME/mylib.otl and install it to $HOME/houdini6.5. The new operator type will take from 0-1 inputs. The node will be renamed to mysubnet1. otcreatetypefrom -n mysubnet -N "My Subnet" -m 0 -M 1 -l $HOME/mylib.otl -i $HOME/houdini6.5 -r mysubnet1 /obj/subnet1 See Also: otcomment, otversion, otwrite
Usage: otdelete table/operator [table/operator] otlfile This command deletes one or more operator definitions from an operator type library. The table values specify the classes of the operators you want to delete. A list of valid table names can be found in the help for the otwrite command. The operator values are the names of the specific operator types. the otlfile is the name of the operator type library file from which the definitions are to be deleted. If an operator definition being deleted is currently in use by Houdini, and there are no other definitions for this operator available in other operator type libraries, an empty replacement operator definition will be added to the operator type library embedded in the Hip file. But note that this embedded definition will not be saved to disk until you save the Hip file, and then only if the option to save operator definitions to the Hip file is turned on. Example: otdelete Shop/v_clay $HOME/OPcustom.otl See Also: otconfig, otcopy, otedit, otwrite
Usage: otedit [-i] table operator This command will open a property editor for the operator specified. This editor allows the changing of all the user customizable aspects of the named operator. The table is the name of the operator table, a full listing which can be found in the help for otwrite. If the -i option is specified, the current state of the operator type is immediately saved, as if the Apply button on the Type Properties dialog were hit. See Also: optype, optyperead, otwrite, optypeuninstall
Usage: otexpand otlfile destdir This command will split an operator type library into its separate component files. The destination directory will contain an index file with a list of components, and the files on disk that represent them. If the directory specified does not exist, it will be created. Once expanded, the component files can be edited before collapsing them with the otcollapse command. Using this method it is possible to exercise complete control over the contents of an operator type library. See Also: otcollapse
Usage: otgetotl [-b] table/operator This command lets you determine if a given operator type is defined in an operator type library, and which library is currently being used to define the operator type. The output of this command is the full path of the operator type library file that defines the operator. If the -b option is set, the output is 0 or 1, depending on whether the operator type is defined by an operator type library.
Usage: otinuse [-n] [-t] [-l] [-f otlfile] [rootnode] This command helps to determine what Operator Type Libraries are in use in a given Hip file, along with which operator types within those OTLs. The -n option specifies that the names of any nodes matching the search should be output. The -t option indicates the operator type should be output, and -l indicates that the OTL file name should be output for all matching nodes. At least one of these three options must be specified. If more than one is set, the data is output with the node name first, then the operator type, then the OTL file name. If the -f option is specified, only nodes defined by operator types in that OTL file will be output. If the -f option is not given, any operator defined by any OTL will be listed. The rootnode parameter indicates where Houdini should start searching for eligible nodes. The search is performed recursively. If a rootnode is not set, the entire Hip file is searched.
Usage: otload otlfile [source] This command performs the same function as the Install Operator Type Library dialog accessible from the Houdini File menu. It loads an operator type library file into the current Houdini session, and optionally adds the library to the list of libraries that are loaded every time Houdini is started. The otlfile value specifies the name of the operator type library file to load. If the source option is omitted, the library is loaded only into the current Houdini session. The library file name will also be saved in the Hip file so when you edit the same Hip file in the future, the library will be loaded automatically. If the source option is specified, it names a file where the library file name will be added. Whenever Houdini starts, it searches your HOUDINI_PATH environment variable for files called OPlibraries. All files found with this name are read in as lists of operator type library files that are loaded into Houdini. By creating OPlibraries files in appropriate locations in your HOUDINI_PATH ($HOME, $JOB, $HFS) you can set up some libraries that are to be loaded into all Houdini sessions, some specific to a particular job, some specific to a particular user, and so on. Example: otload OPcustom.otl $HOME/houdini6.5 See Also: otrefresh, otunload
Usage: otls [-f format] [otlfile [table/operator]] otls -a table/operator If no options are specified, this command displays a list of all currently installed operator type libraries. If the otlfile value specifies the name of an operator type library file, all the operator types defined in that library are listed, along with whether or not that library is currently loaded. If the table and operator values are specified as well, some basic information about that operator definition in the specified operator type library is displayed. If both an OTL file name and a table/operator are specified, this command also accepts the -f option which allows the command output to be customized. The format argument is a string where each letter represents a particular piece of information. The accepted letters are: n Operator type name. l Descriptive label. p Path to the type definition. c Icon for the operator type. t Operator class (such as Object, Sop, etc.). x Extra info which depends on the operator type. i Minimum number of allowed inputs. I Maximum number of allowed inputs. s Specified if the operator type is a subnet. d Specified if the operator type is a dummy definition. m Modification time for the type definition. If the -a option is specified, this command outputs a list of all OTL files currently installed which contain a definition for the specified operator type. Use otgetotl to find out which definition is currently in use. Example: otls -f "lm" $HH/otls/OPlibShopVMantra.otl Shop/v_decal Will output: VEX Decal Sat Mar 06 19:09:10 2004 See Also: otload, otunload
Usage: otmerge srcotlfile destotlfile This command copies all the operator type definitions from the srcotlfile into the destotlfile. If both srcotlfile and destotlfile have a definition for the same operator type, the one in destotlfile is kept. See Also: otcopy
Usage: otprefer
otprefer -c
otprefer table/operator
otprefer table/operator otlfile
It is possible for the same operator definition to be available from
several different OTL files in the same Houdini session. With this
command it is possible to choose a particular OTL file to use as the
source for an operator definition. These settings override the
global options that are set with the otconfig command. This command
can also query the currently set overrides.
The first form of this command displays all current overrides.
The second form of the command clears all current overrides.
The third form of the command displays the current override set for
a particular operator type. See the otwrite command for information
on what values to use for the table and operator parameters.
The fourth form of the command actually sets the override OTL file
for a particular operator type. Passing an empty string ("") as
the otlfile parameter will clear the override for that one operator
type.
See Also: otconfig, otwrite
Usage: otrefresh [-r] [otlfile] This command forces Houdini to reload one or all operator type libraries from disk. If a specific operator type library file name is specified, only that library is refreshed. Otherwise, all currently loaded libraries are refreshed. This command will rarely be necessary for most users. Any changes made to operator definitions or operator type libraries automatically cause refreshes in the current Houdini session. Only if an operator type library is modified outside the current Houdini session (either by another user, from a shell, or from another Houdini session) is it necessary to execute this command. If the -r option is set, the contents of the OPlibraries files are also reloaded. This takes more time, but allows these files to be changed by external applications and have a running Houdini reflect these changes. Libraries removed from the OPlibraries files are not automatically uninstalled. See Also: otload, otunload
Usage: otrenamesource source newname This command lets you assign a descriptive name to a particular operator type library source location. For example, you might want to name the source in your HOME directory as "My Libraries". All commands that take a source argument can use this descriptive name to identify the source. As another example, the source in $HFS/houdini is given the name "Standard Libraries". This name information is stored in the OPlibraries file at the specified location. Example: otrenamesource $HOME/houdini6.5 "My Libraries" See Also: otls
Usage: otsync [-d | -u] pattern If an operator type defines a subnet type operator, and that operator was saved with its contents locked (see otedit and otwrite), you can use this command to match a set of nodes to the contents found in their operator type definitions. The pattern value specifies the nodes that you wish to make match their operator definitions. The parameters of the node itself are not modified, only its contents. The -d option displays the current synchronization status of the given operators. The -u option performs an unsync operation. If the nodes specified by the pattern value match the locked contents of their operator type definitions, this command unlocks the nodes so that you can edit their contents. It does not actually make any modifications to the contained nodes. See Also: otedit, otunsync, otwrite
Usage: ottouch table/operator otlfile [timestamp] Use this command to set the modification time stamp for an operator type definition. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. The otlfile value specified the name of the operator type library file in which you want to modify the operator definition. If the timestamp value is specified, it is a string representing the date and time to set as the modification time stamp of the operator definition. The time stamp must be in the format: "day mmm dd hh:mm:ss yyyy". If no time stamp value is specified, the current time is used. Example: ottouch Shop/v_clay OPcustom.otl "Fri Feb 07 14:55:26 2003" See Also: otedit
Usage: otunload otlfile [source] This command unloads an operator type library from the current Houdini session. Whenever Houdini starts, it searches your HOUDINI_PATH environment variable for files called OPlibraries. All files found with this name are read in as lists of operator type library files that are loaded into Houdini. The same library can be listed in several OPlibraries files, in which case you may need to specify the source value to tell the command which OPlibraries file from which the library should be removed. The source value should be the name of one of these OPlibraries files. If the source option is not specified, Houdini finds the source value that was used to load the library, and removes the library name from that location. See Also: otload, otrefresh
Usage: otunsync pattern If the nodes specified by the pattern value match the locked contents of their operator type definitions, this command unlocks the nodes so that you can edit their contents. It does not actually make any modifications to the contained nodes. See Also: otedit, otsync
Usage: otversion table/operator otversion -d table/operator otversion table/operator version The first usage of this command queries the version for the specified operator type. The table value specifies the class of the operator you want to modify. A list of valid table names can be found in the help for the otwrite command. The operator value is the name of the specific operator type. The second usage clears the operator type version. The third usage sets the operator type version. This command only works if the specified operator type is already defined using an operator type library. The version string does not have to match a particular format. Any string value can be used. See Also: otcomment, otwrite
Usage: otwrite Table/Optype otlfile
otwrite [-d] [-l] [-u] [-z]
[-c comment] [-v version] -o NodePath otlfile
This command writes the specified operator type into an operator
type library file. All the data needed to define the operator
type is included in the library. Any number of operator types
can be included in a single library. The operator type can be
specified one of two ways. The first way is to provide the
operator table name and the operator type name separated by a
slash ('/'). The second method is to use the -o option to
specify a path to an existing node. The operator type for that
node is used. In addition, the contents of that node are made
a part of the operator definition.
If the -d option is set with the -o option, the current values of
the node are not used as the initial parameter values. Instead, the
default values of the parameters are used as the initial values.
This is equivalent to setting the Save Defaults as Initial Values
check box in the Type Properties dialog.
If the -l option is set with the -o option, new nodes of this type
will be created with their contents locked, and will reference the
contents defined in the operator definition. This option is
equivalent to setting the Save Contents as Locked check box in
the Type Properties dialog.
If the -u option is specified with the -o and -l options, new nodes
of this type will use the locked contents mechanism, but will be
created in an unlocked state. Turning on this option is the same
as choosing the "Allow Editing of Contents" option on every new
instance of this operator type.
The -z option specifies that for a subnet operator type with locked
contents, the contents should be stored in a compressed format to
reduce disk space requirements.
The -c and -v options can be used to set the operator type comment
and version strings respectively. Setting these options is equivalent
to running the otwrite command followed by an otcomment or otversion
command.
The table name can be one of:
Object - Object Operators (OBJs)
Sop - Geometry Operators (SOPs)
Particle- Particle Network Operators
Pop - Particle Operators (POPs)
ChopNet - Channel Network Operators
Chop - Channel Operators (CHOPs)
Driver - Output Operators (ROPs)
Shop - Shader Operators (SHOPs)
Cop2 - Composite Operators (COP2s)
CopNet - Composite Network Operators
Vop - VEX Operators (VOPs)
VopNet - VEX Network Operators
Example:
otwrite Sop/xform OPcustom.otl
otwrite -l -o /obj/geo1/xform1 OPcustom.otl
See also: optype, otcomment, otedit, otload, otversion
Usage: pane <options> [-d desk_name] pane_name
Allows different options of the pane to be set. A valid
pane name must be specified. If no desk name is given then it
will assume the current desk.
Also if no options are specified then all panes of that desktop
will be listed.
Options:
-S Create a new pane to the right of all
existing panes. No pane name is given
when using this option. If no -m option
is specified, a network editor pane will
be created. The name of the new pane is
returned.
-F Create a new floating pane. No pane name
is given when using this option. If no -m
option is specified, a network editor pane
will be created. The name of the new pane
is returned. The -P and -w options can
be used to set the position and size of the
new pane, respectively.
-P <x> <y> Specifies the position, in pixels of the top
left corner of a new floating pane. This
option may only be used when -F is used. Note
that the pane will be created near this
position, not exactly at this position.
-w <w> <h> Specifies the width and height, in pixels of a
new floating pane. This option may only
be used when -F is used.
-c 0|1 Obsolete: This used to set the
follow parent's current node selection
-C 0|1 Obsolete: This used to set the
follow the current node selection.
-f 0|1 Toggle fullscreen mode
-l 0-5 Set the link value on the current pane.
A zero turns linking off.
-L 0|1 Toggles whether this is a parent pane
or a normal pane. Parent panes track
the parent directory of a path.
-m type Valid types are: neteditor
chaneditor
geosheet
listchans
parmeditor
textport
uicustom
viewer
maniplist
helpbrowser
-n name Set the pane name
-h path Set the operator network path
-H nodepath Set the operator node path
-T type Set the operator type. This is used
to determine what sort of network to
go to if the -h path doesn't exist.
-o Open a new copy of the pane
-p Move the playbar to this pane
-s 0|1 Split the pane in two.
0 - top/bottom, 1 - left/right
-t 0|1 Tear off the window (1), or put it back (0)
-z Close the pane
Examples:
pane -f 1 pane2 - turn fullscreen mode on for pane2
pane -h /obj pane2 - set the network path to
objects for pane2
pane -H /obj/model pane2 - set the node path of the
pane2 to have the network
/obj and the specific node model.
pane -H /obj/model/ pane2 - set the pane to point to
the network /obj/model with
no current node.
pane -l 0 -p pane2 - turns linking off and moves the
playbar to pane2
Usage: panepath [-d desktopname] newpath This takes the path to a node. It then sets all the panes in the given desktop (or the current desktop otherwise) to point to the new path. This change only occurs if the pane currently matches the path up to the last directory. Ie, if you have a pane with the path /obj/model/box1, and call panepath /obj/model/sphere1, the pane will change to point to the sphere. If you had called panepath /obj/cam1, the pane would remain unaffected.
Usage: paramset token val
This will set the global value of parameter 'token' to 'val'.
Issuing this command with no arguments will list all current
parameters.
Usage: parmeditor <options> [-d <desktop_name] pane1 ... Allows different options of the parameter editor to be set. A valid pane name must be specified. If no desk name is given then it will assume the current desk. Options: -d <string> Desktops to operate on. If it is blank it will default to the current desktop. -w 0|1 Display the world tree control. -T <float> The split fraction for tree control
Usage: pdfhelp <help-section> Displays the pdf help for the specified help section. Valid help sections are: GettingStarted Interface Objects Geometry Channels (Motion and Audio) Particles VexBuilder Shaders Compositing Outputs (Rendering) ExpressionLanguages Scripting GeometryTypes Formats Spy StandAlone TutorialGuide (Tutorial and User Guide) Glossary See also: help exhelp
Usage: performance [options] Change parameters for the performance monitor. Options: -l off|window|stdout Set the Output Log mode. -c on|off Set Monitor OP Cook toggle. -o on|off Set Monitor Object Display toggle. -v on|off Set Monitor Viewport Display toggle. -f on|off Set Monitor Frame Length toggle. -m on|off Set Memory toggle. -i on|off Set Tile Statistics in OP Info toggle. -h on|off Set Tile Hilight when Cooking toggle. -s on|off Set Single Frame Capture toggle. -p on|off Set Pause toggle. -e on|off Set Enable Output toggle. When no options are specified, the current settings are displayed.
Usage: pilist <options> [-d <desktop_name>] pane1 ... Allows different options of a handle list to be set. A valid pane name must be specified. If no desk name is given then it will assume the current desk. Options: -d <string> Desktops to operate on. If it is blank it will default to the current desktop. -x 0|1 Display handle group dialog -m 0|1 Display handle dialog -G <float> The split fraction for groups
Usage: play [options] Controls the playbar. If the -r and -s options are not specified, then the playbar will start playing forwards. Options: -r Play in reverse -s Stop playing -l Set loop mode on -z Set zigzag mode on -1 Play one time only See also: fcur fplayback fps frange fset ftimecode tcur tset
Usage: pomadd -g [-v] manip_group_name
pomadd [flags on|off] [-m mask] [-r r g b] manip_name type
Create a new persistent handle or group. When creating a
group, only the new group name can be specified. When creating
a handle, the display flags can also be set, as with the
pomset command:
-e Turn on or off the display of the handle.
-p Display the handle when viewing parent ops.
-c Display the handle when viewing child ops.
-s Display the handle when viewing sibling ops.
In addition to these flags, a pane mask and handle color can be
specified using "-m" and "-r" respectively. See the pomset command
for details.
The handle type can be any of the handles returned
from the omls command.
Examples:
pomadd "New Xform" xform
Creates a handle of type xform with the name "New Xform".
pomadd -g "New Group"
Creates a new handle group named "New Group".
set group_name = `execute("pomadd -g -v NewGroup")`
Creates a new handle group named NewGroup and sets the
variable group_name to the actual created name which may
differ if a group by the same name already existed.
See also: pomattach pomclear pomdetach pomls pomremove
pomscript pomset
Usage: pomattach -g manip_group_name manip_name pomattach manip_name op_name [op_parm:manip_parm] Attaches an operator to a handle, or a handle to a group. When attaching an operator to a handle, you can also specify a list of operator parameters to link to the handle parameters. The available handle parameters depend on the type of handle. Use the omls command to determine what parameters are available for a given handle type. Examples: pomattach "New Xform" /obj/geo1 tx:tx ty:ty tz:sz Links operator /obj/geo1 to the "New Xform" handle, and binds the operator tx, ty, tz parameters to the tx, ty, sz parameters of the handle. pomattach -g "New Group" "New Xform" Adds the handle "New Xform" to the "New Group" group. See also: pomadd pomclear pomdetach pomls
Usage: pomclear -g manip_group_name pomclear manip_name Detaches all operators from a persistent handle, or clears all handles from a group. This command is equivalent to executing pomdetach on each operator or handle. See also: pomadd pomattach pomdetach pomls
Usage: pomdetach -g manip_group_name manip_name pomdetach manip_name op_name Detaches a single operator from a handle, or a single handle from a group. See also: pomadd pomattach pomclear pomls
Usage: pomls -g [manip_group_name] pomls [manip_name] Lists all handles or handle groups. If a handle name is specified, it lists all operators attached to that handle. If a handle group name is specified, it lists all handles attached to that group. See also: pomadd pomattach pomclear pomdetach pomremove pomscript pomset
Usage: pomparm manip_name settings Changes the settings of the specified handle. The values for the settings are specific to the type of handle and are undocumented. This command is used internally to save handle settings to the hip file. See also: pomset
Usage: pomremove -g manip_group_name pomremove manip_name Removes a persistent handle or group. See also: pomadd pomls
Usage: pomrename -g manip_group_name new_manip_group_name pomrename manip_name new_manip_name Renames a persistent handle or group. See also: pomls
Usage: pomscript -g [manip_group_name] pomscript [manip_name] Outputs the script commands required to create a persistent handle or handle group. If no name is specified, the commands for all handles or groups will be output. See also: pomadd pomls
Usage: pomset [-e on|off] -g manip_group_name pomset [flags on|off] [-m mask] [-r r g b] manip_name Change the display flags for persistent handles. When modifying a handle, any of these flags can be set: -e Turn on or off the display of the handle. -p Display the handle when viewing parent ops. -c Display the handle when viewing child ops. -s Display the handle when viewing sibling ops. The "-m" option can be used to specify a pane mask. A pane mask specifies in which panes a handle will be visible. This pane mask is generally controlled through the UI using the handle toggle buttons on the left of the viewport. The "-r" option sets the color of the handles for this handle. The color is specified as "red green blue", where each component is a value between 0 and 1. When modifying a handle group, the options in the command are applied to every handle in the group. If no flag values are specified, this command outputs the pomset command that would be used to set the currently set flags for the handle. There is no output for handle groups. Examples: pomset -e on -r 0 1 0 "New Xform" Turns on handle "New Xform", and sets its color to green. pomset -e off -g "New Group" Turns off all handles in the group named "New Group". See also: pomadd pomls pomparm
Usage: prependseq [-u] file_pattern
This command prepends a series of files to the current sequence in
mplay (ie, inserts files before the current sequence). The sequence
length will be extended by the number of images loaded, and the start
time adjusted backwards by the number of frames in the loaded sequence
(so that the original sequence occupies the same frame range).
file_pattern can use either \$F or * to specify the frame number.
Options:
-u Load the sequence unbuffered; images will not be
cached.
Examples:
prependseq ~/shot1/frame\$F.pic
prependseq -u ~/shot1/frame*.pic
This command is only available in MPlay.
See also:
appendseq, loadseq
Usage: prompt new_prompt Change the prompt to the string specified. The prompt string is expanded each time it is printed, therefore, the following command will set the prompt to the current frame number, followed by the current OP working directory. prompt '$F `execute(oppwd)`:'
This command is a built-in alias for otedit.
Usage: quit [-f] [exit_status] Terminate the program. If the -f option is present, it will quit immediately without prompting to save. Many applications (hscript, mantra) allow an optional exit status to be specified. This defaults to 0.
Usage: read [-g] variable_name [variablename2 ..] Will read the following line into the variable names specified. The first argument of the following line will be put into the first variable, the last variable specified will be set to the remaining arguments of the input line. The -g option will make the variables global (see setenv).
Usage: render [-V] output_name This command will cause an output driver to render. The options are: -V Produces output as each frame starts rendering. Example: % render mantra1 will cause the output driver named "mantra1" to render.
Usage: rexport [-g] driver_pattern rexport [-c] driver_pattern rexport [-h hostname] [-u] driver_pattern rexport [-h hostname] driver_pattern [name = value] This command is allows you to edit the export variables for a network render output driver. These variables are exported to the remote machine before the remote command begins. There are several usages: -g Generate a command script containing all the variables information. This is useful for generating a configuration file for loading into other drivers Example: % rexport -g network1 > % $HOME/houdini6.5/netconfig.setup -c Clears all non-built in variables from the list -u Undefines a variable. Optionally, a host name can be given, which will undefine the variable only for the specific host. If no host is specified, the variable will be removed from the export list. Specifying only the output driver will cause the default exports to be printed out. If a host is specified, the values that would be exported to that host are printed. If an assignment is given on the command line, the export variable will be assigned the new value. Example: # Set the HFS default export value rexport net HFS /hfs # Now, override the variable definition for the remote # host named gonzo rexport -h gonzo net HFS /nfs/host/hfs
Usage: rkill [-s | -r] process This command will change the status of a background render. The options are: -s or -p Suspend/Pause the render -c or -r Continue/Restart the render If no options are specified, then the matching renders will be terminated. Any background process matching the pattern specified will be killed. For example: % rkill 8329 # Kills process 8329 % rkill * # Kills all processes % rkill -s * # Suspends all processes % rkill -r * # Restarts all processes
Usage: rps Render Process Status. This command lists the active background render processes which are active. The command lists the PID of the process, the host which the command is running on, the command being run, and the frame being rendered. If the process is suspended, this information will also be shown.
Usage: seqls
Lists all the sequences currently loaded into Mplay. This command is
only available in MPlay.
Usage: set [-g] name = value set -p name = value set -u name set [-s] Set a local variable specified by name to the value given. If no name is specified, then the list of all variables is printed out. If no name is specified and the -s option is given, the output is suitable for loading as a script. The -g option forces the variable to be a global variable, otherwise the variable will be local to the script file where the command is executed. The -p option will set the variable in the caller (or parent) script. If the currently running script is at the topmost level, then this option has no effect. This option lets us return values from within sourced scripts. For example, to set a return value into the variable name passed into our script as the first parameter, we could something similar to this: set -p $arg1 = $returnValue The -u option will un-set the variable specified. See also: setenv
Usage: setenv [-l] name = value setenv -u name setenv [-s] Set a global variable specified by name to the given value. If no name is specified, then the list of all variables is printed out. If no name is specified and the -s option is given, the output is suitable for loading as a script. The -l option forces the variable to be local, meaning that it it destroyed when the currently running script file is terminated. The -u option will un-set the variable specified See also: set
Usage: setcomp [-r] [-g] [-b] -[a]
Sets the component display in MPlay. This command is only available
in MPlay.
Options:
-r Show only the red component.
-g Show only the green component.
-b Show only the blue component.
-a Show only the alpha component, or the fourth component for
planes of size 4.
If no options are specified, the display is reset to show all
components of the plane.
See also:
setplane
Usage: setplane [-i array_index] plane_name
Sets the current plane to plane_name in MPlay. This command is only
available in MPlay.
Options:
-i array_index Chooses the array index of the plane, for
plane arrays (not normally used).
See also:
setcomp
Usage: shift Shift the command line arguments, destroying $arg0 and moving $arg1 into $arg0, $arg2 into $arg1 etc.
Usage: shopconvert This command will build SHOPs for all existing RenderMan shaders. The object's SHOP fields will be filled out to point to the correct SHOP and the existing RenderMan parameters will be cleared out. Generic Surface, Displacement, Light and Fog shaders will be used.
Usage: shopvisible shopvisible [+/-]client ... This command will turn on/off visiblity of SHOPs based on the renderers which they support. With no arguments, the command will display which clients are supported in the interface. When specifying clients, a + will turn support of the client on, a - will turn it off, and a client without the leading +/- will toggle the current state of the client. Turning clients off will hide the operators in the toolbars, simplifying the interface. This command does NOT remove the operators, it simply removes them from the toolbars. Thus, any existing operators will remain, opadd will still add operators, etc. Example: # Disable RenderMan and MentalRay renderer support, # and enable VMantra support. shopvisible -RIB -MI +VMantra WARNING: For graphical applications, this function will cause all dialog scripts for all SHOPs to be loaded and may incur a significant performance penalty if many SHOPs are loaded over a busy network.
Usage: sopcache [-c] [-l] [-L] [-s] [-m memory] [-M enable] [-U enable] [-W name enable depth] [-w name] [-q] [-v] This command manages the caching of SOP nodes. General Options: -q Quiet mode. Nothing will be output to hscript. -v Verbose mode. Some commands will output extra information. Query Options: -s See the current settings -l Print the cache status. This displays the current estimated memory use by SOPs and the number of SOPs that have active data. -L Prints a list of all active SOPs. The full path to each SOP is printed. If the -v option is specified as well, the SOPs will be sorted by size and the size in bytes will also be output. Control Options: -c Clears the SOP cache. Every loaded SOP will attempt to unload itself. This unloading may not be performed if the SOP is currently in use (ie, displayed, etc). -m Set the maximum memory limit (used by -M) -M Behaviour when maximum memory limit is reached. never - The memory limit is ignored. always - When the memory limit is exceeded, SOPs will be unloaded from the least recently used until the memory limit is achieved. Because some SOPs will not be unloadable (due to being in use) the memory limit may still be exceeded. -U Behaviour of the SOP unloading. never - The unload flag in SOPs is ignored. flag - SOPs with the unload flag set will have their contents unloaded when they are finished cooking. always - All SOPs will be unloaded as soon as possible. This is as if the unload flag was set for all SOPs. -W Behaviour of watermarks. The named watermark will be enabled according the enable value and will have a maximum depth set according the the depth value. -w Set a watermark of the given name. If the watermark is enabled, all SOPs not touched since the previous depth watermarks of this name will be unloaded. See also: texcache, geocache, opunload
Usage: sopcreateedit name sop1 sop2 This command will create a Edit SOP describing the edit which transforms the geometry from sop1 to that of sop2. The number of points in sop1 and sop2 must be equal.
Usage: source [-q] [-v] filename Run the commands in the filename specified. If the -q option is given, then no warnings about missing filenames will be printed. If the -v option is specified each command will be printed out as the command is run. See also: cmdread
Usage: tcl [command] Plug in command which starts up a tcl shell. This command doesn't work very well from graphical applications (i.e houdini). If no tcl command is specified a tcl shell is started. There is an additional tcl command available which is "hscript". This command will allow you to run any houdini command from the tcl shell. See also: java, tk, unix
Usage: tcur [time] If no time is specified, the current time is printed. Otherwise, the current time is set to the time specified. See also: fcur fplayback fps frange fset ftimecode tset
Usage: texcache [-v] [-s] [-l] [-c] [-n] [-a on|off] [-r xres yres] [-m max] This command allows access to the internal texture map cache used by Houdini. The texture map cache is used when displaying texture maps in the viewports (or also for background images when texturing is turned on). Query options: -s See the current settings -l List the contents of the texture map cache Control options: -v Verbose -c Clear the cache -n Clear the cache only if newer files exist on disk. -a on/off Turn auto-flushing of maps on or off. Leaving maps in the cache improves performance at the cost of extra memory. -r x y Specify the maximum resolution of an image for the cache. This does not include maps stored in COPs. -m nimages Specify the cache size (maximum number of images stored in the cache). -M megabytes Specify the maximum number of RAM (in Mb) that the cache can use. Example: hscript-> texcache -r 512 512 -M 32 -a on Sets the maximum resolution of images in the cache to 512x512 pixels, the maximum memory to 32 Mb and turns auto-flushing on. See also: geocache, opupdate, sopcache
Usage: time command This command will print out timing information for the command specified. The time is specified at "u" (CPU usage) "s" (System usage) and the real amount of time the command took. i.e. % time echo 0.0u 0.0s 0.0r On Windows, only the real time is provided, so the output will read: % time echo 0.0r To time a complicated set of commands, write it them to a .cmd file and use: time source script.cmd
Usage: timeslice [-m <slice_size>] [-d on|off] [-c smart|always] Changes the timeslice options for timesliced CHOPs. The -m option will limit the maximum size of a timeslice that can be processed in one cook (in frames). If the -d option is enabled (on), all newly created CHOPs that have timeslice capability will be created with their timeslice flag on. If the -c option is set to 'smart', then smart timeslice cooking is enabled. Some timeslice CHOPs will cook only when needed, instead being completely time dependent.
Usage: tk [command] Plug in command which starts a Tcl/Tk graphical shell. If no command is specified, a Tcl/Tk shell is started. Please see help for tcl plug-in. See also: java, tcl, unix
Usage: tmgadd -t time | -f frame group_name [second_name...] Creates one or more time groups.
Usage: tmgls [-l] [-k] [pattern...] Lists time groups. The -l option will list the full contents of the time group as well. The -k option will just list the time marks belonging to the time group. If a pattern is specified, then only groups which match the pattern will be listed.
Usage: tmgname old_name new_name Renames the specified time group to the new name.
Usage: tmgop -t time_from time_to | -f frame_from frame_to group_name operation channel_pattern [second_pattern...] This command does operations on time groups (i.e. allows addition or removal of keyframes from the group). group_name The name of the time group to modify operation Can be one of: set Set the contents of the group add Add keyframes to group remove Remove keyframes from group The channel_pattern specifies a list of channels to work on. Example: tmgop -f 1 50 group1 set /o*/g*/r? Set group contents to channels tmgop -f 1 50 group1 add /o*/g*/t? Add channels to group1 tmgop -f 1 50 group1 remove /o*/g*/tx Remove tx channels from group1
Usage: tmgrm group_pattern [second_group...] Removes the specified time groups.
Usage: tmgshift [-a] [-g] [-r] -f numframes | -t time group_name
Shift the time group by a certain number of frames or a time.
-a will shift everything absolutely
i.e. tmshift -a -f 55 T1 will move the time group to
frame 55
-g will only shift the time group and not its members
-r the shift will only occur if it can within the
keyframe boundaries.
Usage: toolbar -r [-a] -t type -n name or: toolbar -t type -n name -o operation [-s save_directory] operators... The first version of this command (the one with the -r option set) will remove the given toolbar from the current session. -a this option specifies that all toolbars of the given type/name that are found in the search path for toolbars will be removed. Otherwise, only the top-most toolbar (ie the one that is being used in the current session) will be removed. The second version will modify (or create) a toolbar of the specified type and name. -s the directory to save toolbar to. If none is given it one will be chosen for you from the toolbar search path. -o operation can be one of: set Set the contents of the toolbar add Add operators to toolbar remove Remove operators from toolbar The valid types are: sop - surface operators obj - objects pop - particle operators mat - shaders top - texture operators cop - composite operators chop - channel operators out - output drivers Valid operators for each type can be listed using the opadd command from the appropriate houdini folder. For example, to get a list of valid object operators do the following: opcf /obj opadd
Usage: tset [start_time end_time] If no time range is specified, the current time range is printed out. Otherwise, the time range is set to time. Values are specified in seconds. See also: fcur fplayback fps frange fset ftimecode tcur tset
Usage: ucd unix_path Change the unix current working directory to the path specified.
Usage: undoctrl [on|off] Or: undoctrl [-s] [-c] This can turn on or off the undo mechanism in Houdini. With no options, the current state will be printed out. Please use this command with extreme caution. Turning off the undo mechanism can cause scripts to execute with greater speed, but the changes made by the script will not be undo-able. As well, be careful to restore the undo state at the conclusion of the script. The second usage with the -s option queries the memory usage of the undo mechanism. The -c option will clear the memory used by the undo system.
Usage: unix command The unix command specified is run. See also: java, tcl, tk
Usage: upwd Print the current unix working directory
Usage: varchange [-v] [-V] -v Verbose: a list of all changed variables will be printed out -V Really verbose: All operators which use the changed variable will also be printed out. When a variable value changes, the OPs which reference that variable are not automatically cooked. Running the varchange command will cause all OPs which use a variable which has changed to be re-cooked.
Usage: version [-b | -n | -l ] Print the current version of the program running. The -b option will cause the version command to print out the version number only. The -n option will print out the software and version without the compiled date. The -l option will print out whether this is the Commercial or Apprentice version.
Usage: vexinfo [options] Show the VEX functions which are currently loaded. This command shows the path to the copy of VEX code which was actually loaded. Options are: -a Show all VEX code loaded -s Show all VEX SOP functions -p Show all VEX POP functions -c Show all VEX COP functions -h Show all VEX CHOP functions -S Show all Shading functions The VEX code may be loaded by custom VEX operators or by generic VEX functions (no distinction is made).
Usage: vexprofile [options] [start] This command will turn on/off profiling of VEX operators. To start profiling, the following options can be used to control the profiling behaviour. The word "start" must appear after all options are specified. With no options, all VEX functions will be profiled until profiling is turned off. -n Check for invalid arithmetic operations -a Profile all VEX functions -s Profile SOP functions -p Profile POP functions -c Profile COP functions -h Profile CHOP functions -S Profile all shading functions Running the command again (with no arguments) will turn off profiling and all statistics will be printed out at this time. Thus, to save the output of the profiling information to a file, use I/O redirection when turning off the profiling. Example: vexprofile -n -a start opcook /obj/geo1/v_mountain1 vexprofile > /tmp/mountain.stats
Usage: viewbackground [options] viewports/view-memories This command sets background/rotoscoping parameters for the specified viewports and view-memories. Options are: -b on|off Turn display of background images on or off -q quality Quality of the background image. -S file|cop The source of the background image. For 3D viewports/view-memories only: -t on|off Turn texture mapped backgrounds on or off. -a on|off Turn automatically placing background image on or off. To use fixed background image offset and scale, this option must be off and texture mapped backgrounds must be on. -o x y Offsets the image by x and y -s x y Scales the image by x and y For UV viewports/view-memories only: -m x y Minimum u/v values for image. -M x y Maximum u/v values for image. -i on|off Turn filtering on or off. For files only: -F <filename> The filename of the disk file. -O on|off Toggles manual override of the file res. -r <xres> <yres> Manually sets the file res. For COPs only: -c icename copname Specify the COP to use as a background image. This option allows the COP Network and COP to be set separately. -C coppath Also specifies the COP to use as a background image, but the full COP path is specified as one argument. -f frame The frame of the image to display -p <color> <alpha> Sets the Color and Alpha planes to use. When no options are specified, the current settings of the specified viewports and view-memories are displayed. For details on how to specify viewports and view-memories, type "help viewportformat"
Usage: viewcamera [-c camera_name] viewports This command makes the specified viewports look through the given camera. If a camera is not specified with the -c option, then the camera that is already being used by the specified viewports will be printed out. For details on how to specify viewports, type "help viewportformat"
Usage: viewcopy source destinations This command copies the settings of one viewport or view-memory to another. For example, you can set up memory buttons based on the current state of a viewport, copy the state stored in the memory buttons back to a viewport, or copy settings between different viewports. If the destination is a view-memory that doesn't exist, it will be created. You can specify more than one destination at the same time. For details on how to specify viewports and view-memories, type "help viewportformat" Examples: # Copy the perspective view to memory location 1 of pane1 of the # Build desk. viewcopy Build.pane1.world.persp1 Build.pane1.world:1 # Copy memory location 1 to the perspective view and also to a # named memory location in the perspective view of the Build # desktop's viewer in pane1. viewcopy Build.pane1.world:1 Build.pane1.world.persp1 Build.pane1.world:some_name
Usage: viewdisplay [options] viewports/view-memories Change display options of the specified viewports or view-memories. If the view-memory does not already exist, it will be created. <geo_type> is one of: all - Apply to both selected and unselected sel - Apply to selected unsel - Apply to unselected templ - Apply to templates target - Apply to target output (ie. the display sop when in "view current" mode) Options: -M <geo_type> <mode> Change the display mode, where <mode> is one of wire - Wireframe hidden_invis - Hidden Line Invisible hidden_ghost - Hidden Line Ghost flat - Flat Shaded flat_wire - Flat Wire Shaded shade - Smooth Shaded shade_wire - Smooth Wire Shaded vex - VEX Shaded vex_wire - VEX Wire Shaded -N <geo_type> m on|off Set display of points -N <geo_type> n on|off Set display of point numbers -N <geo_type> l on|off Set display of point normals -N <geo_type> t on|off Set display of point texture coords -N <geo_type> p on|off Set display of point positions -E <geo_type> n on|off Set display of vertex numbers -E <geo_type> t on|off Set display of vertex texture -E <geo_type> g on|off Set display of vertex grips -I <geo_type> n on|off Set display of primitive numbers -I <geo_type> l on|off Set display of primitive normals -I <geo_type> h on|off Set display of primitive hulls -I <geo_type> t on|off Set display of primitive profiles -I <geo_type> p on|off Set display of primitive profile numbers -I <geo_type> b on|off Set display of primitive breakpoints -I <geo_type> f on|off Set display of filled backfaces in UV -B bw|wb Set the color scheme: light or dark. -a on|off Turn "match selected with nonselected" on or off. -A templ|target on|off Turn faded look on or off for template or target output geometry. -b on|off Turn backface removal on or off -c on|off Turn shading of open curves on or off. This requires the object to be flagged to allow this. -C <value> Set constant sensitivity level -d on|off Turn particle origin axes on or off -D on|off Turn display geometry on or off -e value Set line width -f on|off Turn field guide on or off -F on|off Turn filled selections on or off -g on|off Turn guide geometry on or off -h on|off Turn "hulls only" display on or off If on, only the hulls will be drawn -i on|off Turn footprint geometry on or off -l <value> Adjust level of detail (default 1.0) -L on|off Turn multi-texturing on or off -n <value> Scale the display normals (default 0.2) -o on|off Turn origin axes on or off -O on|off Turn floating origin axes on or off -p <value> Set the point size -P points|lines|sprites Set how particles are displayed -q on|off Turn transparency on or off -r on|off Turn display of projected textures and spotlights on or off -R on|off Turn target output geometry on or off -s on|off Turn safe area on or off -S on|off Turn specular on or off in shaded mode -t on|off Turn texturing on or off in shaded mode -T on|off Turn templated geometry on or off -V <value> Set variable sensitivity level -w on|off Turn wireframe move on or off -x on|off Turn on grid in YZ plane (normal is X) -y on|off Turn on grid in XZ plane -z on|off Turn on grid in XY plane -Z on|off Turn on z sorting for sprites When no options are specified, the current settings are displayed. Note: There can only be one -N, -E, -I, or -M option specified per command. So, to turn point markers on and point normals off, you would need two commands: viewdisplay -N all m on viewname viewdisplay -N all n off viewname For details on how to specify viewports and view-memories, type "help viewportformat"
Note: "viewport" refers to the individual viewing areas within a "viewer". A viewer can contain up to four viewports in it. For information on specifying viewports or view-memories, type "help viewportformat" All viewers have names of the form: desk.pane.type desk the name of the desktop that contains the viewport. pane the name of the pane containing the viewer that holds the viewport. type One of: world, particle, or texture, depending on the contents of the pane. To get a listing of all viewers, type "viewls -n". For most viewer-related commands, you can apply the command to more than one viewer simultaneously by simply listing them all together. You can also use wildcards to specify more than one. This "command" only exists for help purposes, and is not an actual command accepted by Houdini.
Usage: viewwrite <options> viewername output This will create a flipbook of the viewport specified. A single (open) viewport must be specified for this command to work correctly. As well, no other windows should occlude the viewport when flipbooking occurs. Options: -f start end Specify a frame range to render -i inc Specify the increment for the frame range -r resx resy Override the viewport resolution. Note that there are currently no special considerations made for preserving aspect ratio. -a audiofile Specify the path to an audio file for inclusion. -o frame audiosec Syncronize image frame with audio at audioseconds. -s spooldir Spool directory to use when writing to "md" or "ip". -v visible A mask for the visible objects. Default is "*". -k Renders out only frames at which currently scoped channels have keys. -A Appends the rendered frames to the existing sequence (note, frame numbers will no longer correspond to the images) If the output specified is either "md" or "ip", output will be spooled temporarily to the spool directory (which defaults to $HOUDINI_TEMP_DIR). Examples: To render frames 1 to 10 to a flipbook: houdini-> viewwrite -f 1 10 Build.pane2.world.persp1 ip To render frames 1 to 10 to disk files: houdini-> viewwrite -f 1 10 Build.pane2.world.persp1 '$F.jpg' Note that single quotes protect the $F variable from being expanded when the command is entered.
Usage: vieweroption <options> viewernames Change the options of the named viewer. Unlike viewdisplay, this command affects the entire viewer, rather than one viewport within the viewer. Options: -a 0|1 See all objects while at the SOP level. -c 0|1 Change whether the current or display SOP should be viewed. -l 0|1 Link ortho viewports. -s 0|1 Apply operation to all split views when changing options in the UI. -r renderer Change the currently selected renderer to the output driver "renderer". -F flipcommand Set the flipbook options. For details on how to specify viewers, type "help viewerformat"
Usage: viewerstow <options> viewers Stow or open components of the named viewers. Options: -t open|stow Stow or open the top toolbar. -b open|stow Stow or open the bottom toolbar. -l open|stow Stow or open the left toolbar. -x open|stow Stow or open the toolbox under the top toolbar. -m open|stow Stow or open the state memory bar under the bottom toolbar. -d open|stow Stow or open the display flags toolbar on the right. For details on how to specify viewers, type "help viewerformat"
Usage: viewlayout -q viewers or viewlayout -d h|v 1-4 1-4 viewers or viewlayout -s 1-4 viewers This command allows you to change how a viewer's views are arranged. You can switch to a quad-view layout with the -q option, to a double-view layout with the -d option, and to a single-view layout with the -s option. The h or v after the -d option specifies whether the double-view layout should be arranged horizontally or vertically. The numbers after the -d and -s options refer to the quadrants of the standard quad-view layout: 1 - top-left 2 - top-right 3 - bottom-left 4 - bottom-right For details on how to specify viewers, type "help viewerformat" Examples: # Use the quad-view layout in all viewers of the Build desktop: viewlayout -q Build.*.world # Use views 1 and 3 in a vertical double-view layout in the # viewer that's in the Build desktop's pane1: viewlayout -d h 1 3 Build.pane1.world # Use only the bottom-right view in the above viewer: viewlayout -s 4 Build.pane1.world
Usage: viewls [-n] [-t type] [-l] [-v [-T viewport-type]] [pattern] Lists all the available viewers using the following format: viewername type type will be either "world", "texture", or "particle" viewername will be of the form Desk.pane.type The -n option will output a terse list with the names only. The -t option will restrict output to viewers of the specified type The -l option will list currently used view-memories as well. It uses the following format: viewername:memname view-type The -v option lists the the viewports that are associated with each viewer as well. It uses the format: viewername.viewportname viewport-type The -T option will restrict output to viewports of the given type viewport-type can be one of: perspective, ortho_front, ortho_right, ortho_top, uv If any patterns are specified, then output is also limited to viewers whose names match the given patterns. For help on related commands type "help view"
Usage: viewname [-n name] [-l lock] viewports This command you allows you to rename the given viewports. Viewports in the same viewer must have unique names, so a number will be appended or incremented at the end to make the name unique. The lock flag should be "on" or "off". A lock being on will prevent the name being changed when you change the viewport type. For example, changing a viewport from perspective to top ususally causes it to be renamed "top1", removing any custom name. To ensure the custom name is kept, use -l on. For details on how to specify viewports, type "help viewportformat" Examples: # Change the viewport called persp1 in the the first pane of the # Build desktop to be called custom1. # The name custom will be preserved even if the viewport # changes type. viewname -n custom1 -l on Build.pane1.world.persp1 # Change all four viewports to be called custom, custom1, custom2 # and custom3: # When they are changed to a different type, the name will be # lost. viewname -n custom -l off Build.pane1.world
Note: "viewport" refers to the individual viewing areas within a "viewer". A viewer can contain up to four viewports in it. For information on specifying viewers, type "help viewerformat" All viewports have names of the form: desk.pane.type.viewport desk the name of the desktop that contains the viewport. pane the name of the pane containing the viewer that holds the viewport. type One of: world, particle, or texture, depending on the contents of the pane. viewport the name of the viewport within the name. This name can be chaned in the display options dialog of the viewport. To get a listing of all viewports, type "viewls -n -v". For most viewport-related commands, you can apply the command to more than one viewport simultaneously by simply listing them together. You can also use wildcards to specify more than one. Another option is to specify the name of the viewer instead of listing all viewports of the viewer. For example instead of: viewcamera -c cam1 Build.pane1.world.persp1 Build.pane1.world.top1 etc or viewcamera -c cam1 Build.pane1.world.* you could simply do viewcamera -c cam1 Build.pane1.world With most viewport-related commands, you can apply the command to view-memories in the same way that they are applied to the viewports. They have the format: Desk.pane.type:memory memory a number between 1-9 for the numbered memories, or a name for the named memories. You can apply wildcards to the first three components of the memories' names. To get a listing of all viewmemories, type "viewls -n -l". This "command" only exists for help purposes, and is not an actual command accepted by Houdini.
Usage: vieworthogrid [options] viewports
Modifies or displays the current parametes for controlling the
grid display in the orthographic viewports.
Options:
- o x y z Sets offset to (x, y, z)
- s x y Sets the grid spacing to x units along the
X-axis and y units along the Y-axis.
- r x y Sets the grid ruler to x units along the
X-axis and y units along the Y-axis. The
arguments must be integer values.
- d [on|off] Turns the ortho grid display on or off.
For details on how to specify viewports, type "help viewportformat"
Examples:
vieworthogrid -o 0 0 0 *
vieworthogrid -o 0 0 0 -s 0.1 0.1 -r 10 10 Build.pane1.world
Usage: viewprojection [-o ortho|perspective] viewports/view-memories This command sets the projection type for perspective viewports and view-memories. Note that perspective viewports and view-memories can be put into an "ortho" mode that is different from the orthographic mode of viewports and view-memories of the following types: ortho_front ortho_right ortho_top The above types use an orthographic projection that is fixed in direction (top, right, or front), while the orthographic projection of a perspective viewport or view-memory can be rotated to look in any direction. Options: -o ortho|perspective Set the projection type When the projection type option is omitted, the current types for the given viewports and view-memories are displayed. For details on how to specify viewports and view-memories, type "help viewportformat"
Usage: viewtransform [-p] [-v version] viewport/view-memory parameters The -p option will print the viewing data for the given viewport or view-memory. The data is a series of numbers (more than 70 of them) specifying the viewing projection for the viewport or view-memory. The -v option (1, 2, or 3) is used to differentiate between different versions of this command. For details on how to specify viewports and view-memories, type "help viewportformat" Examples: # Display the viewing parameters of the specified viewport. # view: viewtransform -p Build.pane1.world.persp1 # Change the orthographic width to 4.5 in the specified viewport. To # change more parameters, add them and their values to the command # after the viewport argument. Note the spacing and the bracket style: viewtransform Build.pane1.world.persp1 orthowidth ( 4.5 ) # Turn on the use of the aspect ratio and set it to 1.333. viewtransform Build.pane1.world.persp1 flag ( +a ) aspect ( 1.333 ) # Turn off the use of the aspect ratio. viewtransform Build.pane1.world.persp1 flag ( -a )
Usage: viewtype [-t type] viewports/view-memories This command you allows you to change the type of the given viewports and view-memories. The type can be one of: ortho_top ortho_bottom ortho_right ortho_left ortho_front ortho_back perspective uv For details on how to specify viewports and view-memories, type "help viewportformat" Examples: # Change the viewport called persp1 in the the first pane of the # Build desktop to be an ortho_top viewport. viewtype -t ortho_top Build.pane1.world.persp1 # Change all four viewports to be ortho FRONT viewports: viewtype -t front Build.pane1.world
Usage: viewupdate [-c] [-u update_mode] When changes are made in an interactive Houdini session the viewports will update in one of three possible ways depending on the state of the global update mode. This mode can be set to one of the following values: "off" | "never" - views update only on demand. "on" | "changes" - views update after changes. "continuous" | "always" - views update continuously. The special update mode of "now" will force a single viewport update if the current update mode is "never". With no options specified the viewupdate command will show the current status of the view update mode. If the -c option is specified then this output will be in the form of a valid "viewupdate" command. The -u option allows the current update mode to be modified. Example: viewupdate -u never viewupdate -u now viewupdate -c Note: Currently the update mode applies only to 3D viewports.
Usage: viewuvgrid [options] viewports Modifies or displays the current parametes for controlling the grid display in the UV (texture) viewports. Options: - r [on|off] Turns the reference grid display on or off. - s u v Sets the reference grid spacing to u units along the U-axis and v units along the V-axis. - P [on|off] Sets the pixel grid display on or off. This option requires a background image to be displayed. - S u v Sets the pixel grid spacing to u pixels along the U-axis and v pixels along the V-axis. The arguments must be integer values. - O x y Sets the pixel offset to x units along the X-axis and y units along the Y-axis. - C [on|off] Clamp the pixel grid to only draw on top of the background image. - t [on|off] Turns the tile boundary display on or off. For details on how to specify viewports, type "help viewportformat" Examples: viewuvgrid -r on -s 0.1 0.1 * viewuvgrid -P on -S 2 2 -O 0 0 -C on Build.pane1.world
Usage: vopwritevfl vopnode vflfile This command will write the VFL code generated by a particular VOPNET to the specified file. The vopnode argument can specify either a VOPNET node or a VOP node. If a VOP node is specified, the VFL code for the VOPNET containing that VOP will be written to the file. The vopnode should be specified relative to the current node location. Example: # Write the surface1 VFL code to the proper VEX subdirectory for # VEX Surface shaders. opcf /vex vopwritevfl surface1 $HIH/vex/Surface/surface1.vfl
Usage: while (condition) Execute a loop while the condition specified is true. Example: set i = 0 while ( $i < 10 ) set i = `$i+1` echo $i end