Development¶
- Terminology
- Build Scripting
- Setting Up A Build Script
- Exporting Hive Rigs
- Naming Conventions
- Components
- API Reference
- Rig
- Component
- Hive Nodes
- Definition
- Build Scripting
- Exporter Plugins
- Utils
- Hive Commands
createRig()
renameRig()
deleteRig()
createComponents()
deleteComponents()
duplicateComponents()
updateGuideSettings()
showComponents()
hideComponents()
toggleBlackBox()
setComponentParent()
setComponentSide()
renameComponent()
matchIKFK()
FixFkRotations()
recalculatePoleVector()
setDeformVisibility()
mirrorComponents()
applySymmetry()
buildGuides()
buildGuideControls()
buildDeform()
buildRigs()
polishRig()
saveTemplate()
loadTemplate()
deleteTemplate()
updateRigConfiguration()
setFkGuideParent()
addFkGuide()
autoAlignGuides()
setGuideLRA()
setGuidesWorldMatrices()
updateRigFromTemplateData()
- Hive Naming
- Named Graphs
- Constants
RIG_TYPE
RIG_LAYER_TYPE
GUIDE_LAYER_TYPE
DEFORM_LAYER_TYPE
CONTROL_PANEL_TYPE
INPUT_LAYER_TYPE
OUTPUT_LAYER_TYPE
XGROUP_LAYER_TYPE
COMPONENT_LAYER_TYPE
GEOMETRY_LAYER_TYPE
SETTINGS_NODE_TYPE
GUIDE_OFFSET_ATTR_NAME
GUIDE_OFFSET_NODE_NAME
INPUT_OFFSET_ATTR_NAME
INPUT_GUIDE_OFFSET_NODE_NAME
ROOT_NODE_TYPE
INPUT_PREFIX
OUTPUT_PREFIX
INPUT_NODE_TYPE
OUTPUT_NODE_TYPE
COMPONENT_TYPE
CONTAINER_TYPE_ASSET
CONTAINER_TYPE_SET
CONTAINER_NAME
IKTYPE
FKTYPE
SKINTYPE
TRANSFORM_ATTRS
LAYER_TYPES
ALL_TYPES
ALL_AXIS
AXIS_DICT
ATTRIBUTES_SERIALIZE_SKIP
TEMPLATE_EXT
GRAPH_EXT
DEFINITION_EXT
INPUTLAYER_DEF_KEY
ATTR_EXPR_SELF_TOKEN
ISCOMPONENT_ATTR
HIVE_EXTERNAL_METADATA_ATTR
DEF_CACHE_INFO_ATTR
GUIDE_PIVOT_STATE
ENV_COMPONENT_KEY
DEFAULT_AIM_VECTOR
DEFAULT_GUIDE_PIVOT_COLOR
GLOBAL_NAME_CONFIG_TYPE
NOT_BUILT
GUIDES_STATE
CONTROL_VIS_STATE
SKELETON_STATE
RIG_STATE
POLISH_STATE
GUIDE_FUNC_TYPE
BUILDSCRIPT_FUNC_MAPPING
- Configuration
- Registry
- Errors
HiveError
HiveRigDuplicateRigsError
ComponentDoesntExistError
ComponentGroupAlreadyExists
TemplateAlreadyExistsError
TemplateMissingComponents
TemplateRootPathDoesntExist
InvalidInputNodeMetaData
InvalidOutputNodeMetaData
InitializeComponentError
MissingRootTransform
RootNamespaceActiveError
BuildComponentGuideUnknownError
BuildComponentDeformUnknownError
BuildComponentRigUnknownError
BuildError
MissingRigForNode
MissingMetaNode
MissingComponentType
ComponentNameError
MissingJoint
MissingControlError
UnSupportedConnectableNode
InvalidDefinitionAttrExpression
InvalidDefinitionAttrForSceneNode
- NamedGraphs
- Examples
Accessing the Hive Api¶
There is a single entry point to the api which contains all functions and classes which we support publicly.
from zoo.libs.hive import api
Environment Variables¶
Name |
Description |
---|---|
HIVE_COMPONENT_PATH |
; Separated paths to each folder containing Hive component files. |
HIVE_DEFINITIONS_PATH |
; Separated paths to each folder containing Hive Definition files. |
HIVE_TEMPLATE_PATH |
; Separated paths to each folder containing Hive .template files. |
HIVE_TEMPLATE_SAVE_PATH |
Default Save path for templates only one path accepted. |
HIVE_BUILD_SCRIPTS_PATH |
; Separated paths to each folder containing Hive build script py files. |
HIVE_NAMING_PATH |
Absolute path to naming configuration json file for hive to use. |
HIVE_EXPORT_PLUGIN_PATH |
; Separated paths to each folder containing Hive exporter py files. |