Slide Resources¶

Slide object holding scene info and annotations

class lfview.resources.scene.slide._BaseSlideComponent(**kwargs)¶: Base class for all slide components

class lfview.resources.scene.slide._BaseAnnotation(**kwargs)¶

Base class for all annotations

Required Properties:

color (Color): Annotation color, a color
position (a list of Float): Location of annotation on slide plane, a list (each item is a float) with length of 2

Optional Properties:

class lfview.resources.scene.slide.AnnotationText(**kwargs)¶

Text comment at a position on a slide

Required Properties:

color (Color): Annotation color, a color
comment (ShortString): Text comment, a unicode string and less than 5000 characters
position (a list of Float): Location of annotation on slide plane, a list (each item is a float) with length of 2

Optional Properties:

class lfview.resources.scene.slide.AnnotationInk(**kwargs)¶

Pen-drawn annotation on a slide

Required Properties:

color (Color): Annotation color, a color
path (a list of a list of Float): Ink path vertices, relative to position, a list (each item is a list (each item is a float) with length of 2) with length between 0 and 2000
position (a list of Float): Location of annotation on slide plane, a list (each item is a float) with length of 2

Optional Properties:

class lfview.resources.scene.slide.DrawingPlane(**kwargs)¶

2D drawing plane of the slide

Required Properties:

axis_u (Vector3): Horizontal axis of drawing plane, a 3D Vector of <class ‘float’> with shape (3)
axis_v (Vector3): Vertical axis of drawing plane, a 3D Vector of <class ‘float’> with shape (3)
origin (Vector3): Origin of drawing plane, a 3D Vector of <class ‘float’> with shape (3)

class lfview.resources.scene.slide._BaseCollaborationModel(**kwargs)¶

Base class for collaboration objects exposed in the API

Optional Properties:

class lfview.resources.scene.slide.Slide(**kwargs)¶

Slides provide a snapshot of a 3D scene

They also provide a canvas for annotating the scene. By creating several slides, you can tell a story around your 3D data.

Required Properties:

annotation_plane (DrawingPlane): Drawing plane for annotations perpendicular to line of sight, an instance of DrawingPlane
annotations (a list of AnnotationText, a list of AnnotationInk): List of annotations on the scene, a list (each item is an instance of AnnotationText or an instance of AnnotationInk) with length between 0 and 30
scene (Scene): Current state of the 3D scene, an instance of Scene

Optional Properties:

description (ShortString): Description of resource, a unicode string and less than 5000 characters
name (ShortString): Name or title of resource, a unicode string and less than 300 characters
uid (String): Unique object identifier, a unicode string

class lfview.resources.scene.slide.Feedback(**kwargs)¶

Feedback allow others to respond slides and other feedback

For now, these are only text comments.

Required Properties:

comment (ShortString): A comment in response to a slide, a unicode string and less than 5000 characters

Optional Properties: