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()
buildDeform()
buildRigs()
polishRig()
saveTemplate()
loadTemplate()
deleteTemplate()
updateRigConfiguration()
setFkGuideParent()
addFkGuide()
autoAlignGuides()
setGuideLRA()
- Hive Naming
- Named Graphs
- 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. |