MovieOptions object

The MovieOptions object stores settings that control how the movie background for an animation is rendered in a particular viewport. MovieOptions objects are accessed from the movie options associated with a particular viewport.

The MovieOptions object has no constructor; Abaqus creates the movieOptions member for a viewport when the viewport is created using the values in the movieOptions member of the current viewport.

This page discusses:

Access

session.viewports[name].movieOptions

setValues(...)

This method modifies the MovieOptions object.

Required arguments

None.

Optional arguments

movieName

A String specifying the name of the movie. A list of valid movie names is in the movies repository in the session object.

showMovie

A Boolean specifying whether a movie should be displayed in the viewport during an animation. The default value is OFF.

positionMethod

A SymbolicConstant specifying which positioning method is used to determine how the movie frames will be scaled and positioned in the viewport. Possible values are:

  • FIT_TO_VIEWPORT, specifying a display mode where the movie frame is scaled to fit in the viewport using the specified fitMethod.

  • AUTO_ALIGN, specifying a display mode where the movie frame is scaled as specified by xScale and yScale and then positioned in the viewport using the specified alignment.

  • MANUAL, specifying a display mode where the movie frame is scaled as specified by xScale and yScale and then positioned in the viewport using the specified origin.

The default value is FIT_TO_VIEWPORT.

fitMethod

A SymbolicConstant specifying which type of fit is performed to scale and position the movie frame in the viewport when positionMethod =FIT_TO_VIEWPORT. Possible values are:

  • BEST_FIT, specifying a mode where the movie frame is scaled to completely fit within the viewport.

  • FIT_WIDTH, specifying a mode where the movie frame width is scaled to match the viewport width.

  • FIT_HEIGHT, specifying a mode where the movie frame height is scaled to match the viewport height.

The default value is BEST_FIT.

alignment

A SymbolicConstant specifying the relative position of the movie frame in the viewport when positionMethod =AUTO_ALIGN. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

The default value is CENTER.

xScale

A Float specifying the scale applied to the movie frame width. The xScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.

When xScale is negative, the movie frame is mirrored about its y-axis but its position is not affected.

yScale

A Float specifying the scale applied to the movie frame height. The yScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.

When yScale is negative, the movie frame is mirrored about its x-axis but its position is not affected.

origin

A pair of Floats specifying theX- and Y-offsets in millimeters from the lower-left corner of the viewport. The origin argument is ignored unless positionMethod =MANUAL. The default value is (0, 0).

translucency

A Float specifying the translucency factor to use when displaying the movie frame. Possible values are 0.0 ≤  translucency  ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

options

None or a MovieOptions object specifying the object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in the options member. The default value is None.

Return value

None.

Exceptions

RangeError.

Members

The MovieOptions object has members with the same names and descriptions as the arguments to the setValues method.