Options

Almost every component in Genesis World is configured through an Options class you pass in, and built into a working object when the scene builds (RigidOptions -> RigidSolver, IMU -> IMUSensor, and so on). Since the options and the object are two halves of one component, we document each Options with the object it configures.

class genesis.options.options.Options → None

This is the base class for all gs.options.* classes. An Options object is a group of parameters for setting a specific component in the scene.

Note

This class should not be instantiated directly.

Tip

We build multiple classes based on this concept throughout Genesis, such as gs.options.morphs, gs.renderers, gs.surfaces, and gs.textures. Note that some of them, although inheriting from Options, are accessible directly under the gs namespace for convenience.

Options classes

Reference page	Options
Scene	gs.options.ProfilingOptions
Simulator	gs.options.SimOptions
Solvers	gs.options.RigidOptions, gs.options.MPMOptions, gs.options.FEMOptions, gs.options.PBDOptions, gs.options.SPHOptions, gs.options.SFOptions, gs.options.ToolOptions, gs.options.KinematicOptions
Couplers	gs.options.LegacyCouplerOptions, gs.options.SAPCouplerOptions, gs.options.IPCCouplerOptions
Morph	gs.morphs.*
Surface	gs.surfaces.*, gs.textures.*
Viewer	gs.options.ViewerOptions, gs.options.VisOptions
Renderers	gs.renderers.*
Sensors	gs.sensors.*
Recording and playback	gs.recorders.*

See also

• API Reference: how the reference is organized, and the options/built-object convention.

• Options system: configuring a scene through options.