Other Classes

ProjectElement

Available elements are PointSet, LineSet, Surface, and Volume; Project are built with elements.

class omf.base.ProjectElement(**kwargs)

Base ProjectElement class for OMF file

ProjectElement subclasses must define their mesh. ProjectElements include PointSet, LineSet, Surface, and Volume

Required Properties:

• color (Color): Solid color, a color, Default: random
• description (String): Description, a unicode string
• name (String): Title, a unicode string

Optional Properties:

• data (a list of ProjectElementData): Data defined on the element, a list (each item is an instance of ProjectElementData)

Other Properties:

• date_created (GettableProperty): Date project was created
• date_modified (GettableProperty): Date project was modified
• uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()

ProjectElement Data

class omf.base.ProjectElementData(**kwargs)

Data array with values at specific locations on the mesh

Required Properties:

• description (String): Description, a unicode string
• location (StringChoice): Location of the data on mesh, any of “vertices”, “segments”, “faces”, “cells”
• name (String): Title, a unicode string

Other Properties:

• date_created (GettableProperty): Date project was created
• date_modified (GettableProperty): Date project was modified
• uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()

Content Model

class omf.base.ContentModel(**kwargs)

ContentModel is a UidModel with title and description

Required Properties:

• description (String): Description, a unicode string
• name (String): Title, a unicode string

Other Properties:

• date_created (GettableProperty): Date project was created
• date_modified (GettableProperty): Date project was modified
• uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()

Uid Model

UidModel gives all content a name, description, and unique uid.

class omf.base.UidModel(**kwargs)

UidModel is a HasProperties object with uid

Other Properties:

• date_created (GettableProperty): Date project was created
• date_modified (GettableProperty): Date project was modified
• uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()