Skip to content

Update SceneClass docs #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jlanz wants to merge 1 commit into
base: main
Choose a base branch
from
+337 −0
Open

Update SceneClass docs #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cmd/generate_doc/classdoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ def main():
if args.all:
context.loadAllSceneClasses()
for clsname in context.getSceneClassNames():
if clsname.startswith("Test"):
continue
cls = context.getSceneClass(clsname)
obj = context.createSceneObject(clsname,clsname+"_obj")
scncls = ScnClass(cls,obj)
Expand All @@ -240,12 +242,17 @@ def main():
return
context.loadAllSceneClasses()
for clsname in context.getSceneClassNames():
if clsname.startswith("Test"):
continue
cls = context.getSceneClass(clsname)
bits = int(cls.getDeclaredInterface())
if bits & int(interface):
obj = context.createSceneObject(clsname,clsname+"_obj")
generate(ScnClass(cls,obj),template,args.dir)
elif args.class_name:
if args.class_name.startswith("Test"):
print("Skipping test class: "+args.class_name)
return
cls = context.createSceneClass(args.class_name)
obj = context.createSceneObject(args.class_name,args.class_name+"_obj")
generate(ScnClass(cls,obj),template,args.dir)
Expand Down
80 changes: 80 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,86 @@ title: RdlCurveGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.curved_motion_blur_sample_count.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.curved_motion_blur_sample_count.links heading=4-%}
</p>
<h3>local_motion_blur_inner_radius_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point inner radius for each local motion blur region (full-strength core). If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_inner_radius_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_inner_radius_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_inner_radius_list.links heading=4-%}
</p>
<h3>local_motion_blur_multiplier_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point motion blur strength multiplier for each local motion blur region. If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_multiplier_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_multiplier_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_multiplier_list.links heading=4-%}
</p>
<h3>local_motion_blur_orient_list</h3>
<p class="scene-class-type">
<b>Vec4fVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point orientation quaternion (x=i, y=j, z=k, w=r) for each local motion blur region. Combined with the scale list, this orients and shapes the blur falloff region. If empty, identity orientation is used. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_orient_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_orient_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_orient_list.links heading=4-%}
</p>
<h3>local_motion_blur_position_list</h3>
<p class="scene-class-type">
<b>Vec3fVector</b>
<br>
default: {}
<p class="scene-class-comments">World-space center position for each local motion blur region.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_position_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_position_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_position_list.links heading=4-%}
</p>
<h3>local_motion_blur_radius_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point outer radius for each local motion blur region. If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_list.links heading=4-%}
</p>
<h3>local_motion_blur_radius_multiplier</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 1.0
<p class="scene-class-comments">Global radius multiplier applied to per-region radius values, whether supplied via the "radius"/"inner_radius" point attributes or the "local_motion_blur_radius_list"/"local_motion_blur_inner_radius_list" explicit list attributes</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_multiplier.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_multiplier.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_radius_multiplier.links heading=4-%}
</p>
<h3>local_motion_blur_scale_list</h3>
<p class="scene-class-type">
<b>Vec3fVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point non-uniform scale (x,y,z) for each local motion blur region. Non-uniform scale makes the falloff region ellipsoidal rather than spherical. If empty, uniform scale (1,1,1) is used. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_scale_list.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_scale_list.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_scale_list.links heading=4-%}
</p>
<h3>local_motion_blur_strength_multiplier</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 1.0
<p class="scene-class-comments">Global strength multiplier for local motion blur application</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_strength_multiplier.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_strength_multiplier.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.local_motion_blur_strength_multiplier.links heading=4-%}
</p>
<h3>motion_blur_type</h3>
<p class="scene-class-type">
<b>Int</b> <i>enum</i>
Expand Down
80 changes: 80 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,86 @@ title: RdlMeshGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.curved_motion_blur_sample_count.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.curved_motion_blur_sample_count.links heading=4-%}
</p>
<h3>local_motion_blur_inner_radius_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point inner radius for each local motion blur region (full-strength core). If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_inner_radius_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_inner_radius_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_inner_radius_list.links heading=4-%}
</p>
<h3>local_motion_blur_multiplier_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point motion blur strength multiplier for each local motion blur region. If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_multiplier_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_multiplier_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_multiplier_list.links heading=4-%}
</p>
<h3>local_motion_blur_orient_list</h3>
<p class="scene-class-type">
<b>Vec4fVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point orientation quaternion (x=i, y=j, z=k, w=r) for each local motion blur region. Combined with the scale list, this orients and shapes the blur falloff region. If empty, identity orientation is used. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_orient_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_orient_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_orient_list.links heading=4-%}
</p>
<h3>local_motion_blur_position_list</h3>
<p class="scene-class-type">
<b>Vec3fVector</b>
<br>
default: {}
<p class="scene-class-comments">World-space center position for each local motion blur region.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_position_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_position_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_position_list.links heading=4-%}
</p>
<h3>local_motion_blur_radius_list</h3>
<p class="scene-class-type">
<b>FloatVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point outer radius for each local motion blur region. If empty, defaults to 1.0. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_list.links heading=4-%}
</p>
<h3>local_motion_blur_radius_multiplier</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 1.0
<p class="scene-class-comments">Global radius multiplier applied to per-region radius values, whether supplied via the "radius"/"inner_radius" point attributes or the "local_motion_blur_radius_list"/"local_motion_blur_inner_radius_list" explicit list attributes</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_multiplier.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_multiplier.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_radius_multiplier.links heading=4-%}
</p>
<h3>local_motion_blur_scale_list</h3>
<p class="scene-class-type">
<b>Vec3fVector</b>
<br>
default: {}
<p class="scene-class-comments">Per-point non-uniform scale (x,y,z) for each local motion blur region. Non-uniform scale makes the falloff region ellipsoidal rather than spherical. If empty, uniform scale (1,1,1) is used. Must match the length of local_motion_blur_position_list.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_scale_list.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_scale_list.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_scale_list.links heading=4-%}
</p>
<h3>local_motion_blur_strength_multiplier</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 1.0
<p class="scene-class-comments">Global strength multiplier for local motion blur application</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_strength_multiplier.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_strength_multiplier.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.local_motion_blur_strength_multiplier.links heading=4-%}
</p>
<h3>motion_blur_type</h3>
<p class="scene-class-type">
<b>Int</b> <i>enum</i>
Expand Down
Loading