Development
- Terminology
- Build Scripting
- Setting Up A Build Script
- Exporting Hive Rigs
- Naming Conventions
- Components
- API Reference
- Rig
- Component
- Hive Nodes
SettingsNodeGuideControlNodeJointAnnotationInputNodeOutputNodesetGuidesWorldMatrix()HiveLayerHiveComponentLayerHiveInputLayerHiveOutputLayerHiveGuideLayerHiveRigLayerHiveDeformLayerHiveGeometryLayerHiveXGroupLayerHiveComponentHiveRigaddExtraNodes()addTaggedNode()taggedNode()taggedNodes()findTaggedNodes()
- Definition
GuideLayerDefinitionRigLayerDefinitionInputLayerDefinitionOutputLayerDefinitionDeformLayerDefinitionNamedGraphsNamedGraphTransformDefinitionJointDefinitionInputDefinitionOutputDefinitionControlDefinitionGuideDefinitionAttributeDefinitionVectorAttributeDefinitionattributeClassForDef()attributeClassForType()
- Build Scripting
- Exporter Plugins
- Utils
setMayaUIContainerDisplaySettings()setRigGuidesXRay()- Twist Utils
updateSceneGuideAttributes()generateTwistPositions()generateTwistSegmentGuides()generateTwistJointsFromGuides()createReverseTwistSegmentServer()createStandardTwistServer()rigTwistJoints()createCurveFromDefinition()createSquashGuideCurve()createSquash()createIkSplineJoints()createIkSpline()
- 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()deleteFkGuide()autoAlignGuides()setGuideLRA()setGuidesWorldMatrices()updateRigFromTemplateData()rebuildHiveRig()
- Hive Naming
- Named Graphs
- Constants
RIG_TYPERIG_LAYER_TYPEGUIDE_LAYER_TYPEDEFORM_LAYER_TYPECONTROL_PANEL_TYPEINPUT_LAYER_TYPEOUTPUT_LAYER_TYPEXGROUP_LAYER_TYPECOMPONENT_LAYER_TYPEGEOMETRY_LAYER_TYPESETTINGS_NODE_TYPEGUIDE_OFFSET_ATTR_NAMEGUIDE_OFFSET_NODE_NAMEINPUT_OFFSET_ATTR_NAMEINPUT_GUIDE_OFFSET_NODE_NAMEROOT_NODE_TYPEINPUT_PREFIXOUTPUT_PREFIXINPUT_NODE_TYPEOUTPUT_NODE_TYPECOMPONENT_TYPECONTAINER_TYPE_ASSETCONTAINER_TYPE_SETCONTAINER_NAMEIKTYPEFKTYPESKINTYPETRANSFORM_ATTRSLAYER_TYPESALL_TYPESALL_AXISAXIS_DICTATTRIBUTES_SERIALIZE_SKIPTEMPLATE_EXTGRAPH_EXTDEFINITION_EXTINPUTLAYER_DEF_KEYATTR_EXPR_SELFISCOMPONENT_ATTRHIVE_EXTERNAL_METADATA_ATTRDEF_CACHE_INFO_ATTRGUIDE_PIVOT_STATEENV_COMPONENT_KEYDEFAULT_AIM_VECTORDEFAULT_GUIDE_PIVOT_COLORGLOBAL_NAME_CONFIG_TYPENOT_BUILTGUIDES_STATECONTROL_VIS_STATESKELETON_STATERIG_STATEPOLISH_STATEGUIDE_FUNC_TYPEBUILDSCRIPT_FUNC_MAPPING
- Configuration
- Registry
- Errors
ValidationInfoValidationRigInfoHiveErrorHiveRigDuplicateRigsErrorComponentDoesntExistErrorComponentGroupAlreadyExistsTemplateAlreadyExistsErrorTemplateMissingComponentsTemplateRootPathDoesntExistInvalidInputNodeMetaDataInvalidOutputNodeMetaDataInitializeComponentErrorMissingRootTransformRootNamespaceActiveErrorBuildComponentGuideUnknownErrorBuildComponentDeformUnknownErrorBuildComponentRigUnknownErrorBuildErrorMissingRigForNodeMissingMetaNodeMissingComponentTypeComponentNameErrorMissingJointMissingControlErrorUnSupportedConnectableNodeInvalidDefinitionAttrExpressionInvalidDefinitionAttrForSceneNode
- 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_NAME_PRESET_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. |