!U general doc updates

markj3d · Jul 6, 2017 · 87c0d05 · 87c0d05
1 parent 768fc3a
commit 87c0d05
Show file tree

Hide file tree

Showing 19 changed files with 418 additions and 105 deletions.
diff --git a/Codebase_Tracker.xlsx b/Codebase_Tracker.xlsx
diff --git a/core/Red9_PoseSaver.py b/core/Red9_PoseSaver.py
@@ -1118,14 +1118,39 @@ class PosePointCloud(object):
     PosePointCloud is the technique inside the PoseSaver used to snap the pose into
     relative space. It's been added as a tool in it's own right as it's sometimes
     useful to be able to shift poses in global space.
+    
+    >>> # heres an mRig example, it will also work with any other rigs by just setting up
+    >>> # the filter settings object in the same way for any of the Red9 tools
+    >>> import Red9.core.Red9_PoseSaver as r9Pose
+    >>> import Red9.core.Red9_Meta as r9Meta
+    >>> 
+    >>> # grab our mRig node
+    >>> mrig=r9Meta.getMetaRigs()[0]
+    >>> 
+    >>> ppc=r9Pose.PosePointCloud(nodes=mrig.ctrl_main)
+    >>> ppc.settings.metaRig=True
+    >>> ppc.prioritySnapOnly=True  # for rigs you can turn this on so that ONLY those nodes in the filterPriority list get built and used
+    >>> 
+    >>> # build the cloud system
+    >>> ppc.buildOffsetCloud()   # you can also pass a root point in, used as the base pivot ( rootReference='pSphere1')
+    >>> 
+    >>> # to apply the cloud, snapping the rig into the clouds pose
+    >>> ppc.applyPosePointCloud()
+    >>> 
+    >>> # to sync the cloud to the rigs current frame, allowing you to update the clouds internal pose
+    >>> ppc.updatePosePointCloud()
+    >>> 
+    >>> # delete the ppc node
+    >>> ppc.delete()
     '''
-    def __init__(self, nodes, filterSettings=None, meshes=[], *args, **kws):
+    def __init__(self, nodes, filterSettings=None, meshes=[], prioritySnapOnly=False, *args, **kws):
         '''
         :param nodes: feed the nodes to process in as a list, if a filter is given
                       then these are the rootNodes for it
         :param filterSettings: pass in a filterSettings object to filter the given hierarchy
         :param meshes: this is really for reference, rather than make a locator, pass in a reference geo
                      which is then shapeSwapped for the PPC root node giving great reference!
+        :param prioritySnapOnly: ONLY make ppc points for the filterPriority nodes
         '''
 
         self.meshes = meshes
@@ -1138,7 +1163,7 @@ def __init__(self, nodes, filterSettings=None, meshes=[], *args, **kws):
         self.posePointCloudNodes = []   # generated ppc nodes
         self.posePointRoot = None       # generated rootnode of the ppc
         self.settings = None
-        self.prioritySnapOnly=False     # ONLY make ppc points for the filterPriority nodes
+        self.prioritySnapOnly=prioritySnapOnly     # ONLY make ppc points for the filterPriority nodes
 
         self.rootReference = None   # root node used as the main pivot for the cloud
         self.isVisible = True       # Do we build the visual reference setup or not?

diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle
diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -520,12 +520,12 @@ <h2 id="B">B</h2>
   <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.blends_targetGeo_name_test">blends_targetGeo_name_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9pro_templates/Red9_Pro_skinning.html#Red9.pro_pack.core.skining.R9sknui.browse">browse() (R9sknui method)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9pro_templates/Red9_Pro_project.html#Red9.pro_pack.core.project.ProjectBase.browser_ext_path">browser_ext_path (ProjectBase attribute)</a>
   </dt>
@@ -583,6 +583,16 @@ <h2 id="B">B</h2>
   </dt>
 
 
+  <dt><a href="red9core_templates/Red9_Audio.html#Red9.core.Red9_Audio.AudioHandler.bwav_sync_to_dynamic">bwav_sync_to_dynamic() (AudioHandler method)</a>
+  </dt>
+
+      <dd><dl>
+
+  <dt><a href="red9core_templates/Red9_Audio.html#Red9.core.Red9_Audio.AudioNode.bwav_sync_to_dynamic">(AudioNode method)</a>
+  </dt>
+
+      </dl></dd>
+
   <dt><a href="red9core_templates/Red9_Audio.html#Red9.core.Red9_Audio.AudioHandler.bwav_sync_to_Timecode">bwav_sync_to_Timecode() (AudioHandler method)</a>
   </dt>
 
@@ -851,11 +861,11 @@ <h2 id="C">C</h2>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.constraints_interpType">constraints_interpType() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.constraints_interpType_fix">constraints_interpType_fix() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.constraints_interpType_fix">constraints_interpType_fix() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.constraints_interpType_test">constraints_interpType_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
@@ -1535,16 +1545,20 @@ <h2 id="F">F</h2>
   </dt>
 
 
-  <dt><a href="red9core_templates/Red9_Meta.html#Red9.core.Red9_Meta.MClassNodeUI.fitTextScrollFucker">fitTextScrollFucker() (MClassNodeUI method)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_audio.html#Red9.pro_pack.core.audio.Timecode.find_Timecode_frame">find_Timecode_frame() (Timecode method)</a>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_skinning.html#Red9.pro_pack.core.skining.R9skn.fix_weights">fix_weights() (R9skn method)</a>
+  <dt><a href="red9core_templates/Red9_Meta.html#Red9.core.Red9_Meta.MClassNodeUI.fitTextScrollFucker">fitTextScrollFucker() (MClassNodeUI method)</a>
   </dt>
 
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="red9pro_templates/Red9_Pro_skinning.html#Red9.pro_pack.core.skining.R9skn.fix_weights">fix_weights() (R9skn method)</a>
+  </dt>
+
+
   <dt><a href="red9pro_templates/Red9_Pro_meta .html#Red9.pro_pack.core.metadata_pro.Pro_MetaRig.fk_ik_match">fk_ik_match() (Pro_MetaRig method)</a>
   </dt>
 
@@ -2002,12 +2016,12 @@ <h2 id="G">G</h2>
   <dt><a href="red9pro_templates/Red9_Pro_animation.html#Red9.pro_pack.core.animation.Keyer.getkeyframedata">getkeyframedata() (Keyer method)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9core_templates/Red9_Audio.html#Red9.core.Red9_Audio.AudioNode.getLengthFromWav">getLengthFromWav() (AudioNode method)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9pro_templates/Red9_Pro_meta .html#Red9.pro_pack.core.metadata_pro.Pro_MetaRig_FacialUI.getLipSyncChannels">getLipSyncChannels() (Pro_MetaRig_FacialUI method)</a>
   </dt>
@@ -2261,6 +2275,10 @@ <h2 id="G">G</h2>
   </dt>
 
 
+  <dt><a href="red9pro_templates/Red9_Pro_audio.html#Red9.pro_pack.core.audio.Timecode.getTimecode_bounds">getTimecode_bounds() (Timecode method)</a>
+  </dt>
+
+
   <dt><a href="red9pro_templates/Red9_Pro_audio.html#Red9.pro_pack.core.audio.Timecode.getTimecode_count">getTimecode_count (Timecode attribute)</a>
   </dt>
 
@@ -2334,6 +2352,10 @@ <h2 id="G">G</h2>
   <dt><a href="red9pro_templates/Red9_Pro_animation.html#Red9.pro_pack.core.animation.AnimPointCloud.groupClusterControls">groupClusterControls() (AnimPointCloud method)</a>
   </dt>
 
+
+  <dt><a href="red9pro_templates/Red9_Pro_meta .html#Red9.pro_pack.core.metadata_pro.Pro_MetaRig_SRC.grp_main">grp_main() (Pro_MetaRig_SRC method)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
@@ -3337,7 +3359,7 @@ <h2 id="M">M</h2>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.mRigs_exportSkeletonRoot">mRigs_exportSkeletonRoot() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.mRigs_exportSkeletonRoot_test">mRigs_exportSkeletonRoot_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
@@ -3377,7 +3399,7 @@ <h2 id="M">M</h2>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.mRigs_renderMeshes_hooked">mRigs_renderMeshes_hooked() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.mRigs_renderMeshes_hooked_test">mRigs_renderMeshes_hooked_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
@@ -3468,12 +3490,12 @@ <h2 id="N">N</h2>
   <dt><a href="red9core_templates/Red9_General.html#Red9.core.Red9_General.abcIndex.next">next() (abcIndex method)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9core_templates/Red9_Meta.html#Red9.core.Red9_Meta.nodeLockManager">nodeLockManager() (in module Red9.core.Red9_Meta)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9core_templates/Red9_Core.html#Red9.core.Red9_CoreUtils.nodeNameStrip">nodeNameStrip() (in module Red9.core.Red9_CoreUtils)</a>
   </dt>
@@ -3487,6 +3509,10 @@ <h2 id="N">N</h2>
   </dt>
 
 
+  <dt><a href="red9core_templates/Red9_AnimationUtils.html#Red9.core.Red9_AnimationUtils.nodesDriven">nodesDriven() (in module Red9.core.Red9_AnimationUtils)</a>
+  </dt>
+
+
   <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.nodeTypes_present_fix">nodeTypes_present_fix() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
@@ -4807,6 +4833,10 @@ <h2 id="S">S</h2>
   </dt>
 
 
+  <dt><a href="red9pro_templates/Red9_Pro_export.html#Red9.pro_pack.core.exporter.ExportUI.set_timecode">set_timecode() (ExportUI method)</a>
+  </dt>
+
+
   <dt><a href="red9pro_templates/Red9_Pro_export.html#Red9.pro_pack.core.exporter.ExportLoop_Widget.set_timelines">set_timelines() (ExportLoop_Widget method)</a>
   </dt>
 
@@ -4866,12 +4896,12 @@ <h2 id="S">S</h2>
   <dt><a href="red9core_templates/Red9_Meta.html#Red9.core.Red9_Meta.MetaHIKCharacterNode.setascurrentcharacter">setascurrentcharacter() (MetaHIKCharacterNode method)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9pro_templates/Red9_Pro_animation.html#Red9.pro_pack.core.animation.Fbx_To_Bnd_ui.setbake">setbake() (Fbx_To_Bnd_ui method)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="red9pro_templates/Red9_Pro_animation.html#Red9.pro_pack.core.animation.Fbx_To_Bnd_ui.setbinder">setbinder() (Fbx_To_Bnd_ui method)</a>
   </dt>
@@ -5157,11 +5187,11 @@ <h2 id="S">S</h2>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_has_keys">skeleton_has_keys() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_has_keys_fix">skeleton_has_keys_fix() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_has_keys_fix">skeleton_has_keys_fix() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_has_keys_test">skeleton_has_keys_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
@@ -5173,11 +5203,11 @@ <h2 id="S">S</h2>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_rotate_tolerance">skeleton_rotate_tolerance() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_rotate_tolerance_fix">skeleton_rotate_tolerance_fix() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
-  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_rotate_tolerance_fix">skeleton_rotate_tolerance_fix() (in module Red9.pro_pack.core.optimiser)</a>
+  <dt><a href="red9pro_templates/Red9_Pro_optimiser.html#Red9.pro_pack.core.optimiser.skeleton_rotate_tolerance_test">skeleton_rotate_tolerance_test() (in module Red9.pro_pack.core.optimiser)</a>
   </dt>
 
 
@@ -5533,6 +5563,10 @@ <h2 id="T">T</h2>
   </dt>
 
 
+  <dt><a href="red9pro_templates/Red9_Pro_audio.html#Red9.pro_pack.core.audio.timecode_falls_within">timecode_falls_within() (in module Red9.pro_pack.core.audio)</a>
+  </dt>
+
+
   <dt><a href="red9core_templates/Red9_Meta.html#Red9.core.Red9_Meta.MetaRig.timecode_get">timecode_get() (MetaRig method)</a>
   </dt>
 

diff --git a/docs/html/objects.inv b/docs/html/objects.inv