Houdini Python Modules

https://jtomori.github.io/houdini_additional_python_docs
Admin
This documentation provides a comprehensive overview of various Python modules and packages designed...
Tokens:425,658
Snippets:1,998
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Guide Options Helper

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.utils

Utilities for creating UI widgets, specifically toggle buttons, for guide options.

```APIDOC
## autorigs.utils.guideOptionsHelper module

### createToggleButtonsWidget

Creates a widget with toggle buttons.

- **label** (str) - The label for the widget.
- **buttonlabels** (list) - A list of labels for the buttons.
- **default_checked_idx** (int) - The index of the button that should be checked by default.
- **onbuttonclicked** (callable, optional) - A callback function to be executed when a button is clicked. Defaults to None.

```

--------------------------------

### Setup Multi-Parm Visualization

Source: https://jtomori.github.io/houdini_additional_python_docs/dopsmoketoolutils

Configures multi-parameter visualization for a given DOP node. This function helps in managing and visualizing complex parameter setups.

```python
dopsmoketoolutils.setupmultifield(_dopnode_)
```

--------------------------------

### Flask Application Setup Utilities (Python)

Source: https://jtomori.github.io/houdini_additional_python_docs/bookish

A collection of utility functions for setting up a Flask application. This includes general setup, configuration loading from objects or files, logging configuration, and setting up template globals and loaders.

```python
def setup(app):
    """Performs general setup for the Flask application."""
    pass

def setup_config(app, config_obj=None, config_file=None):
    """Sets up the Flask application configuration.

    Args:
        app: The Flask application instance.
        config_obj: An object containing configuration variables.
        config_file: Path to a configuration file.
    """
    pass

def setup_logging(app):
    """Sets up logging for the Flask application."""
    pass

def setup_template_globals(app):
    """Sets up global variables for Flask templates."""
    pass

def setup_template_loader(app):
    """Sets up the template loader for the Flask application."""
    pass

```

--------------------------------

### Rigging and Guide Creation Utilities

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Functions for creating various components of character rigs and guides.

```APIDOC
## createSimpleParentCHOP()

### Description
Creates a simple parent CHOP node.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# buildEyeGuide.EyeGuide.createSimpleParentCHOP()
```

### Response
N/A

---

## createSimpleSpike()

### Description
Creates a simple spike component for a rig.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# AutoRigsQuadFootBuilder.createSimpleSpike()
```

### Response
N/A

---

## createSimpleWidget()

### Description
Creates a simple UI widget.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# UiGeometryContainerFactory.createSimpleWidget()
```

### Response
N/A

---

## createSpike()

### Description
Creates a spike component for an extremity rig.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# AutoRigsExtremityBuilder.createSpike()
```

### Response
N/A

---

## createTab()

### Description
Creates a tab in a UI widget.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# ModuleParamsWidget.createTab()
```

### Response
N/A

---

## createTabs()

### Description
Creates a set of tabs in a UI widget.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# ModuleTabsWidget.createTabs()
```

### Response
N/A

---

## createThreadedGui()

### Description
Creates a GUI element that runs in a separate thread.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# autorig.mocapgui.createThreadedGui()
```

### Response
N/A

---

## createToggleButtonsWidget()

### Description
Creates a widget with toggle buttons.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# guideOptionsHelper.createToggleButtonsWidget()
```

### Response
N/A

---

## createToolButton()

### Description
Creates a button for a tool in a UI list.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# moduleListItemWidget.createToolButton()
```

### Response
N/A

---

## createTransformTemplate()

### Description
Creates a transform template for rigging.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# autoRigsBuilderInterfaceUtils.createTransformTemplate()
```

### Response
N/A

---

## createTransformTemplates()

### Description
Creates multiple transform templates for rigging.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# autoRigsBuilderInterfaceUtils.createTransformTemplates()
```

### Response
N/A

---

## createTwist()

### Description
Creates a twist control for a mocap rig.

### Method
N/A (Assumed function call)

### Endpoint
N/A

### Parameters
None

### Request Example
```python
# Example usage (actual module and call context not provided)
# mocaprigutils.createTwist()
```

### Response
N/A
```

--------------------------------

### autorigs.modules.basicFace.buildBasicFaceGuide

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace

Contains the class for building the basic face guide.

```APIDOC
## Class: BasicFaceGuide

### Description
This class is responsible for building the basic face guide, inheriting from BaseGuide.

### Methods
- **buildFromJsonExisting(json)**: Builds the guide from existing JSON data.
- **buildFromJsonNew(json, paramjson)**: Builds a new guide from JSON data and parameter JSON.
- **getEyeGuide()**: Retrieves the eye guide.
- **getJawGuide()**: Retrieves the jaw guide.
- **toJSON()**: Converts the guide data to a JSON object.
- **updateParent(parent, connect=False)**: Updates the parent of this guide.

### Class Variables
- **FACE_ROOT**: 'faceroot'
```

--------------------------------

### autorigs.modules.quadFoot.buildQuadFootGuide.QuadFootGuide Methods

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Methods for building quad foot guides.

```APIDOC
## QuadFootGuide Methods

### Description
Methods for the construction of quadrupedal foot guides within the autorigs system.

### Method
- `setBigDigitParent(parent)`
```

--------------------------------

### autorigs.modules.extremity.buildExtremityGuide.ExtremityGuide Methods

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Methods for building extremity guides.

```APIDOC
## ExtremityGuide Methods

### Description
Methods for constructing and configuring extremity guides within the autorigs system.

### Methods
- `setBigDigitGuides(value)`
- `setBigDigitParent(parent)`
- `setDefaultDisplayOfAllDigitsGuides()`
- `setDefaultDisplayOfAllMirrorDigitsGuides()`
- `setDefaultDisplayOfBigDigitsGuides()`
- `setDefaultDisplayOfBigMirrorDigitsGuides()`
- `setDisplayOfBigDigitsGuides(value)`
```

--------------------------------

### BuildHeadGuide Module

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.head

Contains classes for building and managing head guide geometry, enabling the creation and manipulation of guide curves for character heads.

```APIDOC
## autorigs.modules.head.buildHeadGuide module

### Description
This module includes classes for defining and manipulating head guide geometry. `HeadFactory` is responsible for creating guide objects, while `HeadGuide` represents the actual guide geometry and its associated operations.

### Classes
#### `HeadFactory`
Bases: `autorigs.modules.base.buildBaseGuide.BaseFactory`

##### Class Methods
- `createFromDefault(_json_, _assetnode_, _parent=None_)`: Creates a head guide from default settings.
- `createFromJsonExisting(_json_, _assetnode_, _parent=None_)`: Creates a head guide from existing JSON data.
- `createFromJsonNew(_json_, _assetnode_, _parent=None_)`: Creates a head guide from new JSON data.

#### `HeadGuide`
Bases: `autorigs.modules.base.buildBaseGuide.BaseGuide`

##### Constructor
`HeadGuide(_assetnode_, _parent=None_)`

##### Class Variables
- `JSON_LABEL`: (dict) - Maps internal guide names to JSON keys, including 'guidecurve', 'head1', 'neck1', etc.

##### Instance Methods
- `createFromJson(_json_, _paramjson_)`: Creates the guide from JSON data and parameters.
- `deleteGuides()`: Deletes all guide geometry.
- `existingFromJson(_json_)`: Initializes the guide from existing JSON data.
- `getChosenParentNode()`: Gets the currently chosen parent node.
- `getGuideObject(_guidename_)`: Retrieves a specific guide object by name.
- `toJSON()`: Converts the guide data to JSON format.
- `updateParent(_parenttext_)`: Updates the parent of the guide.
- `updateToMasterParent(_masternode_)`: Sets the master node as the parent.
- `updateToSpineHookParent(_node_)`: Sets a spine hook node as the parent.
```

--------------------------------

### autorigs.modules.foot.buildFootGuide.FootGuide Methods

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Methods for building foot guides.

```APIDOC
## FootGuide Methods

### Description
Methods related to the construction of foot guides in the autorigs system.

### Method
- `setBigDigitParent(parent)`
```

--------------------------------

### RPC Server Setup with hjsonrpc

Source: https://jtomori.github.io/houdini_additional_python_docs/hjsonrpc

This snippet illustrates the server-side implementation using hjsonrpc. It shows how to define a class with RPC methods decorated by @hjsonrpc.rpcMethod and then create and start an RPC server that listens for requests.

```python
import hjsonrpc

# Define a class that will provide RPC methods
class RPCService(object):
    @hjsonrpc.rpcMethod
    def method_name(self, arg1, arg2):
        # Method implementation goes here
        pass

# Instantiate the service class
rpc_service = RPCService()

# Create and start the RPC server on a specific port and path
port = 8080
server = hjsonrpc.createRPCServer(rpc_service, port, "/rpc")
server.serve_forever()
```

--------------------------------

### Guide Building Utilities

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.utils

Functions for creating, manipulating, and managing guide nodes and their parameters within the autorigs system.

```APIDOC
## autorigs.utils.buildGuideHelper module

### addAngleParameter

Adds an angle parameter to a guide node and drives an associated rotate parameter.

- **guide** (objNode) - The guide node to add the parameter to.
- **r_parm** (str) - The name of the rotate parameter to be driven.
- **r_range** (tuple) - The hard range for the angle (min, max).
- **offset** (int, optional) - An offset for the expression. Defaults to 0.
- **negative** (bool, optional) - Whether to use a negative offset. Defaults to True.

### addPoseScope

Adds a pose scope to a specified node and maps it to a parameter.

- **node** (objNode) - The node to create the pose scope on.
- **parm** (str) - The parameter name to map the pose scope to.
- **input_sop** (str, optional) - A specific input within the node to connect to. Defaults to None.

### copyAllParms

Copies all parameter values from a source node to a destination node.

- **src** (objNode) - The source node.
- **dst** (objNode) - The destination node.

### createAndMirrorNode

Creates a copy of a given node and mirrors it.

- **node** (objNode) - The node to copy and mirror.
- **copyname** (str) - The name for the new node.
- **display** (bool, optional) - Whether to display the new node. Defaults to False.
- **parent** (objNode, optional) - The parent node for the new node. Defaults to None.

### createArrowPicker

Creates an arrow picker SOP.

- **node** (objNode) - The SOP node to create the arrow picker on.

### createGuideLines

Creates line points from a source node to a list of destination nodes.

- **parent** (objNode) - The parent node to create the geometry under.
- **name** (str) - The name of the created node.
- **src** (objNode) - The source node.
- **dests** (list) - A list of destination nodes.
- **color** (tuple, optional) - The color of the lines (R, G, B). Defaults to (0, 0, 0) (black).
- **resample** (bool, optional) - Whether to resample the lines to create dashes. Defaults to False.
- **segment_multiplier** (int, optional) - Multiplier for segmentation if resampling. Defaults to 100.

### createNull

Creates a basic null node (control).

- **parent_node** (objNode) - The parent node for the null.
- **name** (str) - The name of the null node.
- **parent** (objNode, optional) - The parent of the null node. Defaults to None.
- **keeppos** (bool, optional) - Whether to keep the position. Defaults to False.
- **size** (float, optional) - The size of the null. Defaults to 0.05.
- **fxn** (any, optional) - Function to apply. Defaults to None.

### createSimpleParentCHOP

Creates a simple parent blend constraint.

- **node** (objNode) - The node to be parented.
- **parent** (objNode) - The parent node.
- **maskvalue** (any, optional) - The mask value to apply on the blend. Defaults to None.
- **blendvalue** (int, optional) - The blend value. Defaults to 1.
- **keeppos** (bool, optional) - Whether to keep position. Defaults to False.
- **blendparm** (any, optional) - The blend parameter. Defaults to None.

### deleteGuides

Deletes specified guides.

- **nodesdata** (any) - Data representing the guides to delete.

### displayGuides

Controls the display of specified guides.

- **nodesdata** (any) - Data representing the guides.
- **display** (bool) - Whether to display the guides.

### lockGuide

Locks or unlocks a specific guide.

- **guide** (objNode) - The guide node to lock.
- **lock** (bool) - Whether to lock the guide.

### lockGuideData

Locks or unlocks guide data.

- **guidedata** (any) - The guide data to lock.
- **lock** (bool) - Whether to lock the guide data.

### lockGuides

Locks or unlocks a list of guides.

- **nodesdata** (any) - Data representing the guides to lock.
- **lock** (bool) - Whether to lock the guides.

### makeNonRenderable

Sets a geometry node to be non-renderable.

- **geo_node** (objNode) - The geometry node to modify.

### makeReferenceCopy

Creates a reference copy of a node.

- **node** (objNode) - The node to copy.
- **copyname** (str) - The name for the reference copy.
- **display** (bool, optional) - Whether to display the copy. Defaults to False.
- **parent** (objNode, optional) - The parent node for the copy. Defaults to None.

### makeTransformParamReferences

Sets mirrored transform parameter references for a new node.

- **node** (objNode) - The original node.
- **newnode** (objNode) - The new node to set references on.

### mirrorNode

Mirrors a source node onto a destination node.

- **src** (objNode) - The source node.
- **dest** (objNode) - The destination node.
- **display** (bool, optional) - Whether to display the mirrored node. Defaults to False.

### mirrorNodes

Mirrors all source nodes in a list onto corresponding destination nodes.

- **src_list** (list) - A list of source nodes.
- **dest_list** (list) - A list of destination nodes.

### setPosition

Sets the position of a node.

- **node** (objNode) - The node to position.
- **xyztuple** (tuple) - The (x, y, z) coordinates.

### setRotation

Sets the rotation of a node.

- **node** (objNode) - The node to rotate.
- **xyztuple** (tuple) - The (rx, ry, rz) rotation values.

### setTRSPNodeParms

Sets Translate, Rotate, Scale, and Parent parameters between nodes.

- **src** (objNode) - The source node.
- **dst** (objNode) - The destination node.

### toJSON

Converts node data to JSON format.

- **nodesdata** (any) - The node data to convert.

### updateMirror

Updates the mirroring value for specified nodes.

- **nodesdata** (any) - Data representing the nodes.
- **value** (any) - The mirroring value.

### updateSide

Updates the side (mirroring) value for nodes based on mirrored nodes data.

- **nodesdata** (any) - Data representing the nodes.
- **mirrornodesdata** (any) - Data representing the mirrored nodes.
- **value** (any) - The value to update with.

```

--------------------------------

### QuadHead Guide Options

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.quadHead

Documentation for the ModuleOptionsWidget class within the quadHeadGuideOptions module. This class manages the options and widgets for the QuadHead guide.

```APIDOC
## Module autorigs.modules.quadHead.quadHeadGuideOptions

### Class: ModuleOptionsWidget

**Bases:** `sphinx.ext.autodoc.importer._MockObject`

**Description:** Manages the options and widgets for the QuadHead guide.

#### Class Variables
- **HOOK_BUTTON_HEIGHT** (int) - Height of hook buttons.
- **HOOK_BUTTON_WIDTH** (int) - Width of hook buttons.

#### Methods
- **fromJSON(json)**: Loads options from a JSON object.
- **getAllWidgets()**: Retrieves all associated widgets.
- **getBuiltParentInfo()**: Gets information about the built parent.
- **getDefaultParentPath()**: Retrieves the default parent path.
- **getExistingParents(spinemodules)**: Finds existing parent modules.
- **getMasterParentGuides(mastermodule)**: Gets master parent guides.
- **getSpineParentGuides(spinemodule)**: Gets spine parent guides.
- **toJSON()**: Serializes options to a JSON object.
- **unlinkAllNodes()**: Unlinks all associated nodes.
- **updateParent(parentmodule, node)**: Updates the parent module and node.
- **updateParentModules(spinemodules)**: Updates the parent modules.
```

--------------------------------

### autorigs.modules.tail.tailGuideOptions.ModuleOptions Methods

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Options for tail module guides.

```APIDOC
## TailGuideOptions Methods

### Description
Configuration options for tail module guides.

### Method
- `setBoneNumber(number)`
```

--------------------------------

### Render Tracker Initialization

Source: https://jtomori.github.io/houdini_additional_python_docs/rendertracker

Functions for starting the render tracker service.

```APIDOC
## Render Tracker Initialization

### Description
Functions for starting and initializing the render tracker service.

### Methods

#### `rendertracker.start(_debug_ , _verbose_)`

- **Description**: Starts the render tracker service.
- **Parameters**:
  - `debug` (boolean) - Enable debug logging.
  - `verbose` (boolean) - Enable verbose output.

#### `rendertracker.startWithSysArgs()`

- **Description**: Starts the render tracker service using system arguments.

### Request Example (Conceptual)

```json
{
  "debug": true,
  "verbose": false
}
```

### Response Example (Conceptual)

```json
{
  "status": "Render tracker started successfully."
}
```
```

--------------------------------

### QuadHead Guide Parameters

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.quadHead

Documentation for the ModuleParamsWidget class within the quadHeadGuideParams module. This class handles the parameters for the QuadHead guide.

```APIDOC
## Module autorigs.modules.quadHead.quadHeadGuideParams

### Class: ModuleParamsWidget

**Bases:** `sphinx.ext.autodoc.importer._MockObject`

**Description:** Manages the parameters for the QuadHead guide.

#### Methods
- **fromJSON(json)**: Loads parameters from a JSON object.
- **toJSON()**: Serializes parameters to a JSON object.
- **unlinkAllNodes()**: Unlinks all associated nodes.
```

--------------------------------

### sas.localassets.install_url_handler()

Source: https://jtomori.github.io/houdini_additional_python_docs/sas

Installs the URL handler for asset management.

```APIDOC
## `install_url_handler` Function

### Description
Installs the necessary URL handler to manage asset operations via custom URL schemes.

### Function
`sas.localassets.install_url_handler`
```

--------------------------------

### createVisualization API

Source: https://jtomori.github.io/houdini_additional_python_docs/dopfetoolutils

Creates a setup for generating and visualizing output attributes.

```APIDOC
## createVisualization

### Description
Creates a setup where output attributes are generated and visualized.

### Method
(Not specified, likely a function call within a script)

### Endpoint
(Not applicable, this is a Python function)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
- **scriptargs** (object) - Scripting arguments.
- **objecttypename** (string) - The type name of the object.
- **goalseltype** (string) - The selection type for the goal.

### Request Example
(Not applicable for direct API calls)

### Response
#### Success Response (200)
(No specific return value documented)

#### Response Example
(Not applicable)
```

--------------------------------

### autorigs.modules.basicFace.basicFaceGuideController

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace

Handles the control logic for the basic face guide.

```APIDOC
## Class: BasicFaceGuideController

### Description
Manages the control aspects of the basic face guide, interacting with the model.

### Methods
- **getEyeController()**: Retrieves the eye controller.
- **getJawController()**: Retrieves the jaw controller.
- **toggleEyeModule(value)**: Toggles the eye module.
- **toggleJawModule(value)**: Toggles the jaw module.
```

--------------------------------

### autorigs.modules.basicFace.basicFaceGuideOptions

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace

Provides the widget for configuring options for the basic face guide.

```APIDOC
## Class: ModuleOptionsWidget

### Description
A widget for displaying and managing the options related to the basic face guide, inheriting from BaseOptionsWidget.

### Methods
- **fromJSON(json)**: Loads options from a JSON object.
- **getBuiltParentInfo()**: Retrieves information about the built parent.
- **getExistingParents(modulesdict)**: Gets a list of existing parent modules.
- **getEyeOptions()**: Retrieves eye-related options.
- **getJawOptions()**: Retrieves jaw-related options.
- **hasUnsavedChanges()**: Checks if there are unsaved changes.
- **toJSON()**: Converts the current options to a JSON object.
- **unlinkAllNodes()**: Unlinks all associated nodes.
- **updateParent(parentmodule, node)**: Updates the parent module and node linkage.
- **updateParentModules(modulesdict)**: Updates the parent modules based on the provided dictionary.
```

--------------------------------

### autorigs.modules.basicFace.basicFaceGuideParams

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace

Offers a widget for setting parameters for the basic face guide.

```APIDOC
## Class: ModuleParamsWidget

### Description
This widget allows users to set parameters for the basic face guide, inheriting from BaseParamWidget.

### Methods
- **fromJSON(json)**: Loads parameters from a JSON object.
- **hasUnsavedChanges()**: Checks if there are unsaved changes.
- **toJSON()**: Converts the current parameters to a JSON object.
- **unlinkAllNodes()**: Unlinks all associated nodes.
- **updateSize(index)**: Updates the size based on the provided index.
```

--------------------------------

### autorigs.modules.spine.spineGuideOptions.ModuleOptions Methods

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Options for spine module guides.

```APIDOC
## SpineGuideOptions Methods

### Description
Configuration options for spine module guides.

### Method
- `setBoneNumber(number)`
```

--------------------------------

### sas.localassets.begin_uploading_asset()

Source: https://jtomori.github.io/houdini_additional_python_docs/sas

Starts the process of uploading a specified Houdini node as an asset.

```APIDOC
## `begin_uploading_asset` Function

### Description
Initiates the upload process for a given Houdini node.

### Function
`sas.localassets.begin_uploading_asset`

### Parameters
- **node** - The Houdini node to upload.
- **server** (optional) - The server to upload to.
```

--------------------------------

### Fur Tool Utilities

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Utilities for fur tools, including getting default values for guides and hair.

```APIDOC
## GET /utilities/furtool

### Description
Provides utility functions for fur tools, such as retrieving default counts and values for hair and guides.

### Method
GET

### Endpoint
/utilities/furtool

### Parameters
#### Query Parameters
- **function_name** (string) - Required - The name of the fur tool utility function to call.

### Request Example
```json
{
  "function_name": "getDefaultGuideCount"
}
```

### Response
#### Success Response (200)
- **result** (any) - The result of the called fur tool utility function.

#### Response Example
```json
{
  "result": 5
}
```
```

--------------------------------

### serve() Function

Source: https://jtomori.github.io/houdini_additional_python_docs/simtracker

Starts the tracker server and manages communication between peer machines.

```APIDOC
## serve() Function

### Description
Initializes and starts the main tracker server, facilitating communication between peers.

### Method
`simtracker.serve(port, webport)`

### Parameters
- `port` (int) - The primary port for peer-to-peer communication.
- `webport` (int) - The port for the web interface or status monitoring.

### Request Body
(Not applicable)

### Request Example
```python
simtracker.serve(port=8000, webport=8080)
```

### Response
(This function typically runs indefinitely until the server is stopped.)

### Response Example
(Not applicable)
```

--------------------------------

### LegGuide

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.leg

Represents a leg guide, used for defining the initial setup of a leg rig.

```APIDOC
## Class: LegGuide

### Description
This class represents the guide for a leg, inheriting from `LimbGuide`. It defines specific JSON labels for different parts of the leg guide structure.

### Parameters
* **assetnode**: The asset node associated with this leg guide.

### Class Variables
* `JSON_LABELS`: Dictionary mapping internal leg guide component names to their corresponding JSON keys.
* `JSON_PARAM_LABELS`: Dictionary mapping specific leg parameter names to their JSON keys.
```

--------------------------------

### JawGuideModel Class - Jaw Guide Data Management

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace.jaw

The JawGuideModel class is responsible for managing the data and state of the jaw guide. It inherits from BaseGuideModel and provides methods for getting and setting rotation and translation axes, as well as toggling various guide behaviors like rotation and stretching.

```python
class JawGuideModel(autorigs.modules.base.baseGuideModel.BaseGuideModel):
    def getRotateAxis(self):
        pass

    def getTranslateAxis(self):
        pass

    def isRotateToggled(self):
        pass

    def isStretchToggled(self, value):
        pass

    def isTranslateToggled(self):
        pass

    def setRotateAxis(self, value):
        pass

    def setRotateToggle(self, value):
        pass

    def setStretchToggle(self, value):
        pass

    def setTranslateAxis(self, value):
        pass

    def setTranslateToggle(self, value):
        pass
```

--------------------------------

### Get Extremity Match FK to IK String (Python)

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.extremity

Retrieves the string command or setup for matching FK controls to IK controls for extremity setups. It requires the asset node, controls, and prefix to determine the correct operation.

```python
_classmethod_`getExtremityMatchFKtoIKStr`(_assetnode_ , _controls_ , _prefix_)
```

--------------------------------

### Get Extremity Match IK to FK String (Python)

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.extremity

Retrieves the string command or setup for matching IK controls to FK controls for extremity setups. This method includes parameters for root offset and lower limb bend to refine the matching process.

```python
_classmethod_`getExtremityMatchIKtoFKStr`(_assetnode_ , _controls_ , _prefix_ , _rootoffset_ , _lowerlimbend_)
```

--------------------------------

### Get FK Control

Source: https://jtomori.github.io/houdini_additional_python_docs/rigtoolutils

Retrieves the Forward Kinematics (FK) control associated with a given bone. This function is essential for FK rigging setups where individual bone controls are managed.

```python
def getFKControl(_bone_):
    pass
```

--------------------------------

### Get Average Bone Chain Length

Source: https://jtomori.github.io/houdini_additional_python_docs/rigtoolutils

Calculates the average length of a bone chain between a start and end bone. This function is useful for understanding the scale and proportions of skeletal structures.

```python
def getAverageBoneChainLength(_startbone_, _endbone_):
    pass
```

--------------------------------

### Setup FLIP Source

Source: https://jtomori.github.io/houdini_additional_python_docs/dopsmoketoolutils

Configures the source parameters for a FLIP simulation. This function sets up the relationship between a fluid source node and the main fluid node.

```python
dopsmoketoolutils.setupFLIPSource(_fluidsource_, _fluidnode_, _sourcesink_)
```

--------------------------------

### Get Total Bone Chain Length

Source: https://jtomori.github.io/houdini_additional_python_docs/rigtoolutils

Calculates the total length and number of bones within a chain, from a specified start bone to an end bone, inclusive. This provides a comprehensive measurement of a bone segment.

```python
def getTotalBoneChainLength(_startbone_, _endbone_):
    """
    Returns (totalbonelength, numberofbones) from start bone to end bone inclusive
    """
```

--------------------------------

### Initialize Particle Fluid - Python

Source: https://jtomori.github.io/houdini_additional_python_docs/doptoolutils

Sets up parameters specific to particle fluid simulations. It can handle cases where certain input nodes (info, objectnode, sopnode) might be None, allowing for the creation of empty fluids if needed. Requires information about the simulation, DOP object, solver, and optionally a subtype.

```python
doptoolutils.particlefluidDopInit(_info_ , _dopobjectnode_ , _solvernode_ , _subtype=None_)

```

```python
doptoolutils.particlefluidDopObjectInit(_info_ , _dopobjectnode_ , _solvernode_ , _objectnode_ , _sopnode_ , _subtype=None_)

```

--------------------------------

### Create Metadigits

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.quadFoot

This method creates the metatarsal (metadigit) controls for the foot. It requires digit controls, metatarsal start position, extremity guide, extremity rotation, prefix, asset node, main side flag, and side identifier.

```python
createMetadigits(_digitscontrols_ , _metastart_ , _extremityguide_ , _extremityrot_ , _prefix_ , _assetnode_ , _ismain_ , _side_)
```

--------------------------------

### doppoptoolutils.setupAutoFreeze

Source: https://jtomori.github.io/houdini_additional_python_docs/doppoptoolutils

Turns on auto-freezing for a solver.

```APIDOC
## doppoptoolutils.setupAutoFreeze

### Description
Turns on auto-freezing for a solver.

### Method
(Not specified, likely a Python function call)

### Endpoint
(Not applicable, this is a Python module function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **scriptargs** - (type unknown) - Description of scriptargs

### Request Example
```python
doppoptoolutils.setupAutoFreeze(scriptargs)
```

### Response
#### Success Response (200)
(No specific return value documented)

#### Response Example
(No example provided)
```

--------------------------------

### Build Digit Chain with FK Controls

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.quadFoot

This class method constructs a chain of digit controls with FK (Forward Kinematics) setup. It takes various parameters including asset node, prefix, digit guides, subscript, digit index, average toe length, and rig scale.

```python
buildDigitChainWithFKControls(_assetnode_ , _prefix_ , _digitguides_ , _subscript_ , _digitidx_ , _avgtoelength_ , _rigscale_)
```

--------------------------------

### HandFactory Class - Build Hand Guide

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.hand

The HandFactory class in buildHandGuide is responsible for creating hand guides. It inherits from ExtremityFactory and provides methods to create hand guides from existing or new JSON data, and to initialize guides.

```python
class autorigs.modules.hand.buildHandGuide.HandFactory(autorigs.modules.extremity.buildExtremityGuide.ExtremityFactory):
     """
     Factory for creating HandGuide objects.
     """
     @classmethod
     def createFromJsonExisting(_json_ , _assetnode_ , _model_ , _parent=None_):
         pass

     @classmethod
     def createFromJsonNew(_json_ , _guidejson_ , _assetnode_ , _model_ , _parent=None_):
         pass

     @classmethod
     def initializeGuides(_buildguide_):
         pass
```

--------------------------------

### Guide Building Functions

Source: https://jtomori.github.io/houdini_additional_python_docs/genindex

Functions used for building guides for various character parts.

```APIDOC
## Guide Building Functions

### Description
Functions involved in the process of building guides for character components like heads, quad heads, spines, and tails.

### Methods
- **getChosenParentNode()**
  - Description: Retrieves the chosen parent node for a guide.
  - Module/Class: `autorigs.modules.head.buildHeadGuide.HeadGuide`, `autorigs.modules.quadHead.buildQuadHeadGuide.QuadHeadGuide`, `autorigs.modules.spine.buildSpineGuide.SpineGuide`, `autorigs.modules.tail.buildTailGuide.TailGuide`
```

--------------------------------

### soptoolutils.buildBlockBeginCompile

Source: https://jtomori.github.io/houdini_additional_python_docs/soptoolutils

Creates a begin compile block node.

```APIDOC
## soptoolutils.buildBlockBeginCompile

### Description
Creates a begin compile block node next to ourself.

### Method
N/A (Internal utility function)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **node** (HoudiniNode) - The node to build the compile block next to.

### Request Example
```json
{
  "node": "obj/geo1"
}
```

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

--------------------------------

### HeadGuideOptions Module

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.head

Provides widget and option management for head guide configurations, including parent linking and default settings.

```APIDOC
## autorigs.modules.head.headGuideOptions module

### Description
This module contains the `ModuleOptionsWidget` class, which manages the options and widgets associated with head guide configuration. It facilitates the linking of parent modules and the retrieval of default parenting information.

### Class
`ModuleOptionsWidget`

Bases: `sphinx.ext.autodoc.importer._MockObject`

#### Constructor
`ModuleOptionsWidget(_headguide_, _spinemodules_, _mastermodule_)`

#### Class Variables
- `HOOK_BUTTON_HEIGHT`
- `HOOK_BUTTON_WIDTH`
- `button_size`

#### Instance Methods
- `fromJSON(_json_)`: Loads options from JSON data.
- `getAllWidgets()`: Retrieves all associated widgets.
- `getBuiltParentInfo()`: Gets information about the built parent.
- `getDefaultParentPath()`: Gets the default parent path.
- `getExistingParents(_spinemodules_)`: Retrieves existing parent modules.
- `getMasterParentGuides(_mastermodule_)`: Gets master parent guides.
- `getSpineParentGuides(_spinemodule_)`: Gets spine parent guides.
- `toJSON()`: Converts the current options to JSON format.
- `unlinkAllNodes()`: Unlinks all associated nodes.
- `updateParent(_parentmodule_, _node_)`: Updates the parent module and node.
- `updateParentModules(_spinemodules_)`: Updates the list of parent modules.
```

--------------------------------

### sas.localassets.show_asset_in_newly_launched_session()

Source: https://jtomori.github.io/houdini_additional_python_docs/sas

Installs and creates an instance of an asset in a newly launched Houdini session.

```APIDOC
## `show_asset_in_newly_launched_session` Function

### Description
Installs a specified asset and creates an instance of it within a newly started Houdini session. This function is typically invoked by the script that initiates a new Houdini instance.

### Function
`sas.localassets.show_asset_in_newly_launched_session`

### Parameters
- **node_type_category_name** - The category name of the asset's node type.
- **node_type_name** - The name of the asset's node type.
- **current_user** (`CurrentUser`) - Information about the current user.
```

--------------------------------

### soptoolutils.setupBendRegions

Source: https://jtomori.github.io/houdini_additional_python_docs/soptoolutils

Cooks the input to a node to determine its bounding box and sets the node's capture region accordingly.

```APIDOC
## soptoolutils.setupBendRegions

### Description
Cooks the input to node to find its bounding box and sets the capture region of node to encompass that.

### Method
(Not specified, likely a Python function call)

### Parameters
- **scriptargs**: (any) - Script arguments.
- **node**: (hou.Node) - The node to set up bend regions for.
```

--------------------------------

### MasterFactory and MasterGuide Classes in autorigs.modules.master.buildMasterGuide

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.master

Defines classes for creating and managing master guides. MasterFactory provides methods to create guides from JSON data or existing assets, while MasterGuide handles guide creation, JSON conversion, and retrieval.

```python
class MasterFactory:
    @classmethod
    def createFromDefault(cls, json, autorigs_asset, standinnode):
        pass

    @classmethod
    def createFromJsonExisting(cls, autorigs_asset, standinnode, json):
        pass

    @classmethod
    def createFromJsonNew(cls, autorigs_asset, standinnode, json, guidejson):
        pass

class MasterGuide:
    JSON_LABELS = {}

    def __init__(self, assetnode, standinnode):
        pass

    def createFromJson(self, json, guidejson):
        pass

    def existingFromJson(self, json):
        pass

    def getMasterGuide(self):
        pass

    objnames = {'master_node_guide': 'master_node_guide'}

    def toJSON(self):
        pass
```

--------------------------------

### createMaterial

Source: https://jtomori.github.io/houdini_additional_python_docs/dopsmoketoolutils

Creates a material from the gallery and installs it into /mat. Returns the result. Note if it already exists, it will create a new one!

```APIDOC
## createMaterial

### Description
Creates a material from the gallery and installs it into /mat. Returns the result. Note if it already exists, it will create a new one!

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **galleryname** (str) - The name of the gallery to load the material from.
- **nodename** (str) - The name of the material node to create.

### Request Example
```python
dopsmoketoolutils.createMaterial('smoke_gallery', 'my_smoke_material')
```

### Response
#### Success Response
- **material_node** (Node) - The created material node.

#### Response Example
```json
{
  "material_node": "/mat/my_smoke_material"
}
```
```

--------------------------------

### JawGuideController Class - Jaw Guide Control Logic

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace.jaw

The JawGuideController class likely handles the logic for controlling the jaw guide. It has methods such as onStretchToggled and onTranslateToggled, suggesting it manages user interactions and updates the jaw guide's behavior based on these interactions.

```python
class JawGuideController(object):
    def onStretchToggled(self, value):
        pass

    def onTranslateToggled(self, value):
        pass
```

--------------------------------

### DaemonContext Initialization and Usage in Python

Source: https://jtomori.github.io/houdini_additional_python_docs/hutil

Demonstrates how to initialize and use the DaemonContext to configure daemon process behavior. It shows setting options directly during instantiation or by modifying attributes before calling the open method. Options like chroot_directory, working_directory, and signal_map can be customized.

```python
import daemon

# Example 1: Setting options during initialization
foo = daemon.DaemonContext(wibble=bar, wubble=baz)
foo.open()

# Example 2: Setting options after initialization
foo = daemon.DaemonContext()
foo.wibble = bar
foo.wubble = baz
foo.open()
```

--------------------------------

### autorig.utils.prepForAsset

Source: https://jtomori.github.io/houdini_additional_python_docs/autorig

Evaluates the source node to set up names and paths for asset creation.

```APIDOC
## autorig.utils.prepForAsset

### Description
Evaluate the source node to setup names and paths for asset creation.

### Method
`prepForAsset`

### Parameters
#### Path Parameters
- **auto_rig** (Node) - The Auto Rig node.

### Response
#### Success Response (200)
- **result** (None) - This function prepares the rig in place.
```

--------------------------------

### JawGuide Class - Building Jaw Guides

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.basicFace.jaw

The JawGuide class, inheriting from BaseGuide, is used for creating and managing guide geometry for the jaw rig. It defines constants for various curve and node names and includes methods for building guides from JSON data and creating the jaw curve SOP.

```python
class JawGuide(autorigs.modules.base.buildBaseGuide.BaseGuide):
    CURVE_ADD= 'guidecurve_add'
    CURVE_CARVE1= 'guidecurve_carve1'
    CURVE_CARVE2= 'guidecurve_carve2'
    CURVE_MERGE= 'guidecurve_merge'
    CURVE_OBJ_MERGE= 'guidecurve_obj_merge'
    CURVE_OUT= 'guidecurve_out'
    CURVE_POLYWIRE= 'guidecurve_polywire'
    CURVE_SPHERE= 'guidecurve_sphere'
    JAW_CURVE= 'jawcurve'
    JAW_END= 'jawend'
    JAW_ROOT= 'jawroot'

    def buildFromJsonExisting(self, json):
        pass

    def buildFromJsonNew(self, json, parent=None):
        pass

    def createJawCurveSOP(self, parent, jaw_root, jaw_end):
        pass

    def toJSON(self):
        pass
```

--------------------------------

### Arm Guide JSON Labels (Python)

Source: https://jtomori.github.io/houdini_additional_python_docs/autorigs.modules.arm

Defines JSON labels used by the ArmGuide class for identifying key components of an arm rig's guide. It maps semantic names like 'clavicle', 'shoulder', 'elbow', and 'wrist' to specific JSON keys. This structure facilitates the serialization and deserialization of arm guide data.

```python
class ArmGuide(LimbGuide):
    JSON_LABELS = {
        'beforelimb': 'clavicle',
        'guidecurve': 'guidecurve',
        'guidecurve_add': 'guidecurve_add',
        'guidecurve_merge': 'guidecurve_merge',
        'guidecurve_out': 'guidecurve_out',
        'guidecurve_polywire': 'guidecurve_polywire',
        'limbend': 'wrist',
        'limbmiddle': 'elbow',
        'limbstart': 'shoulder',
        'limbtwist': 'elbow_twist',
        'limbtwisttrans': 'elbow_twist_transform',
        'master': 'master'
    }
    JSON_PARAM_LABELS = {
        'beforelimb': 'clavicle',
        'limbend': 'wrist',
        'limbmiddle': 'elbow',
        'limbstart': 'shoulder',
        'master': 'master'
    }
```

--------------------------------

### Open File for Reading (Python)

Source: https://jtomori.github.io/houdini_additional_python_docs/bookish

Returns a file-like object for reading the content at the given path. The mode can be specified, with 'rb' (read binary) being the default. Available in Store, StringStore, SubStore, WrappingStore, and ZipStore.

```python
from bookish.stores import Store, StringStore, SubStore, WrappingStore, ZipStore

# Example usage with a generic store
# store = ...
# with store.open('/path/to/readable/file.txt', 'r') as f:
#     content = f.read()

# Example usage with StringStore
# string_store = StringStore()
# with string_store.open('/data.txt') as f:
#     text = f.read()

# Example usage with ZipStore
# zip_store = ZipStore('archive.zip')
# with zip_store.open('/config.json', 'r') as f:
#     config_data = f.read()

# Example usage with ZipStore in binary mode
# with zip_store.open('/image.png', 'rb') as f:
#     image_bytes = f.read()
```

--------------------------------

### Start RPC Server - Python

Source: https://jtomori.github.io/houdini_additional_python_docs/hutil

Starts a thread to listen on socket connections for incoming RPC requests. This function is typically called on the server-side to enable remote communication.

```python
import hutil.pyrpc
hutil.pyrpc.start_server()
```

--------------------------------

### dopsmoketoolutils.buildMotionOverride

Source: https://jtomori.github.io/houdini_additional_python_docs/dopsmoketoolutils

Builds a SIM_Motion setup that is keyframeable with no extra channels, bypassing it by default.

```APIDOC
## dopsmoketoolutils.buildMotionOverride(_name_ , _bypass_)

### Description
Builds a SIM_Motion setup to be keyframeable with no extra channels. Bypasses by default if so requested.

### Method
N/A

### Endpoint
dopsmoketoolutils.buildMotionOverride(_name_ , _bypass_)

### Parameters
#### Path Parameters
- **name** (string) - Required - The name.
- **bypass** (bool) - Required - If bypassed.

### Request Example
```json
{
  "name": "motion_override",
  "bypass": true
}
```

### Response
#### Success Response (200)
- **status** (string) - Operation status.

#### Response Example
```json
{
  "status": "Motion override built"
}
```
```

--------------------------------

### get_prefixed_paths: Filter Paths by Prefix

Source: https://jtomori.github.io/houdini_additional_python_docs/bookish

Filters a list of paths, returning only those that start with a given prefix. This function is useful for selecting specific subsets of file paths based on a common starting string.

```python
def bookish.util.get_prefixed_paths(pages, prefix):
    pass
```
Tokens:
Raw