Animation Options#

Animation commands are used to create and control object-based and image-based animations in the viewport.

Object features#

AnimationOptions#

class AnimationOptions[source]#

The AnimationOptions object is used to store values and attributes associated with an AnimationController object. The AnimationOptions object has no constructor command. Abaqus creates the animationOptions member when it creates the AnimationController object.

Note

This object can be accessed by:

import animation
session.animationOptions

Note

Check AnimationOptions on help.3ds.com/0.1..

Public Data Attributes:

`mode`	A SymbolicConstant specifying the animation mode.
`frameRate`	An Int specifying the animation rate in frames/second.
`frameCounter`	A Boolean specifying whether to show the frame counter.
`relativeScaling`	A SymbolicConstant specifying the relative scaling when the AnimationController object's animationType = SCALE_FACTOR or HARMONIC.
`numScaleFactorFrames`	An Int specifying the number of frames to be used when the AnimationController object's animationType = SCALE_FACTOR or HARMONIC.
`timeHistoryMode`	A SymbolicConstant specifying whether the time history animation is time based or frame based.
`maxTime`	A Float specifying the maximum time for time based time history animation when maxTimeAutoCompute = False.
`maxTimeAutoCompute`	A Boolean specifying whether the animation maximum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED.
`maxTimeAutoValue`	A Float specifying the maximum time when timeHistoryMode is set to TIME_BASED and the maxTimeAutoCompute value is True.
`minTime`	A Float specifying the minimum time for time based time history animation when minTimeAutoCompute = False.
`minTimeAutoCompute`	A Boolean specifying whether the animation minimum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED.
`minTimeAutoValue`	A Float specifying the minimum time when timeHistoryMode is set to TIME_BASED and the minTimeAutoCompute value is True.
`timeIncrement`	A Float specifying the time increment for frame selection when timeHistoryMode is set to TIME_BASED.
`xyUseHighlightMethod`	A Boolean specifying whether to use the highlight method to draw the time tracker line and symbols.
`xyShowLine`	A Boolean specifying whether to show the time tracker line.
`xyLineStyle`	A SymbolicConstant specifying the X - Y time tracker line style.
`xyLineThickness`	A SymbolicConstant specifying the X - Y time tracker line thickness.
`xyShowSymbol`	A Boolean specifying whether to show the time tracker symbols.
`xySymbolMarker`	A SymbolicConstant specifying the marker type to be used for all animation capable X - Y curve or the SymbolicConstant DEFAULT specifying that the system will take the marker associated to each curve Possible values are:
`xySymbolSize`	A SymbolicConstant specifying the size of the markers.
`xyLineColor`	A String specifying the color used to plot the X - Y time tracker line when xyUseHighlightMethod = False.
`xySymbolColor`	A String specifying the color used to plot X - Y time tracker symbols when xyUseHighlightMethod = False.

Public Methods:

setValues([mode, frameRate, frameCounter, ...])

This method modifies the AnimationOptions object.

Inherited from _OptionsBase

`get_user_attributes`()	Returns a list of the user attributes of the class.
`setValues`([mode, frameRate, frameCounter, ...])	This method modifies the AnimationOptions object.

frameCounter: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether to show the frame counter. The default value is ON.

frameRate: int = 50[source]#: An Int specifying the animation rate in frames/second. Possible values are 1 ≤ frameRate ≤ 100. The default value is 50.

maxTime: Optional[float] = None[source]#: A Float specifying the maximum time for time based time history animation when maxTimeAutoCompute = False.

maxTimeAutoCompute: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether the animation maximum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.

maxTimeAutoValue: Optional[float] = None[source]#: A Float specifying the maximum time when timeHistoryMode is set to TIME_BASED and the maxTimeAutoCompute value is True. This value is computed as the maximum time of all active frames displayed in viewports where the animation is active.

minTime: Optional[float] = None[source]#: A Float specifying the minimum time for time based time history animation when minTimeAutoCompute = False.

minTimeAutoCompute: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether the animation minimum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.

minTimeAutoValue: Optional[float] = None[source]#: A Float specifying the minimum time when timeHistoryMode is set to TIME_BASED and the minTimeAutoCompute value is True. This value is computed as the minimum time of all active frames displayed in viewports where the animation is active.

mode: SymbolicConstant = LOOP[source]#: A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP, LOOP_BACKWARD, and SWING. The default value is LOOP.

numScaleFactorFrames: int = 7[source]#: An Int specifying the number of frames to be used when the AnimationController object’s animationType = SCALE_FACTOR or HARMONIC. The default value is 7.

relativeScaling: SymbolicConstant = HALF_CYCLE[source]#: A SymbolicConstant specifying the relative scaling when the AnimationController object’s animationType = SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and HALF_CYCLE. The default value is HALF_CYCLE.

setValues(mode=abaqusConstants.LOOP, frameRate=50, frameCounter=ON, relativeScaling=abaqusConstants.HALF_CYCLE, numScaleFactorFrames=7, timeHistoryMode=abaqusConstants.FRAME_BASED, maxTime=None, maxTimeAutoCompute=ON, minTime=None, minTimeAutoCompute=ON, timeIncrement=None, xyUseHighlightMethod=ON, xyShowLine=ON, xyLineStyle=abaqusConstants.SOLID, xyLineThickness=abaqusConstants.MEDIUM, xyLineColor='', xyShowSymbol=ON, xySymbolMarker=abaqusConstants.DEFAULT, xySymbolSize=abaqusConstants.MEDIUM, xySymbolColor='')[source]#

This method modifies the AnimationOptions object.

Note

Check AnimationOptions.setValues on help.3ds.com/0.1..

Parameters:

mode (SymbolicConstant, default: LOOP) – A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP, LOOP_BACKWARD, and SWING. The default value is LOOP.
frameRate (int, default: 50) – An Int specifying the animation rate in frames/second. Possible values are 1 ≤ frameRate ≤ 100. The default value is 50.
frameCounter (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to show the frame counter. The default value is ON.
relativeScaling (SymbolicConstant, default: HALF_CYCLE) – A SymbolicConstant specifying the relative scaling when the AnimationController object’s animationType = SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and HALF_CYCLE. The default value is HALF_CYCLE.
numScaleFactorFrames (int, default: 7) – An Int specifying the number of frames to be used when the AnimationController object’s animationType = SCALE_FACTOR or HARMONIC. The default value is 7.
timeHistoryMode (SymbolicConstant, default: FRAME_BASED) – A SymbolicConstant specifying whether the time history animation is time based or frame based. Possible values are FRAME_BASED and TIME_BASED. The default value is FRAME_BASED.
maxTime (Optional[float], default: None) – A Float specifying the maximum time for time based time history animation when maxTimeAutoCompute = False.
maxTimeAutoCompute (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the animation maximum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
minTime (Optional[float], default: None) – A Float specifying the minimum time for time based time history animation when minTimeAutoCompute = False.
minTimeAutoCompute (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the animation minimum time value should be computed from the active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
timeIncrement (Optional[float], default: None) – A Float specifying the time increment for frame selection when timeHistoryMode is set to TIME_BASED.
xyUseHighlightMethod (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to use the highlight method to draw the time tracker line and symbols. The default value is ON.
xyShowLine (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to show the time tracker line. The default value is ON.
xyLineStyle (SymbolicConstant, default: SOLID) – A SymbolicConstant specifying the X - Y time tracker line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
xyLineThickness (SymbolicConstant, default: MEDIUM) – A SymbolicConstant specifying the X - Y time tracker line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is MEDIUM.
xyLineColor (str, default: '') – A String specifying the color used to plot the X - Y time tracker line when xyUseHighlightMethod = False. The default value is “Yellow”.
xyShowSymbol (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to show the time tracker symbols. The default value is ON.
xySymbolMarker (SymbolicConstant, default: DEFAULT) –
A SymbolicConstant specifying the marker type to be used for all animation capable X - Y curve or the SymbolicConstant DEFAULT specifying that the system will take the marker associated to each curve Possible values are:
- FILLED_CIRCLE
- FILLED_SQUARE
- FILLED_DIAMOND
- FILLED_TRI
- HOLLOW_CIRCLE
- HOLLOW_SQUARE
- HOLLOW_DIAMOND
- HOLLOW_TRI
- CROSS
- XMARKER
- DEFAULT
The default value is DEFAULT.
xySymbolSize (SymbolicConstant, default: MEDIUM) – A SymbolicConstant specifying the size of the markers. Possible values are SMALL, MEDIUM, and LARGE. The default value is MEDIUM.
xySymbolColor (str, default: '') – A String specifying the color used to plot X - Y time tracker symbols when xyUseHighlightMethod = False. When setting the color to ‘Default’ the system will take the color associated to each curve. The default value is “Default”.

timeHistoryMode: SymbolicConstant = FRAME_BASED[source]#: A SymbolicConstant specifying whether the time history animation is time based or frame based. Possible values are FRAME_BASED and TIME_BASED. The default value is FRAME_BASED.

timeIncrement: Optional[float] = None[source]#: A Float specifying the time increment for frame selection when timeHistoryMode is set to TIME_BASED.

xyLineColor: str = ''[source]#: A String specifying the color used to plot the X - Y time tracker line when xyUseHighlightMethod = False. The default value is “Yellow”.

xyLineStyle: SymbolicConstant = SOLID[source]#: A SymbolicConstant specifying the X - Y time tracker line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

xyLineThickness: SymbolicConstant = MEDIUM[source]#: A SymbolicConstant specifying the X - Y time tracker line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is MEDIUM.

xyShowLine: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether to show the time tracker line. The default value is ON.

xyShowSymbol: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether to show the time tracker symbols. The default value is ON.

xySymbolColor: str = ''[source]#: A String specifying the color used to plot X - Y time tracker symbols when xyUseHighlightMethod = False. When setting the color to ‘Default’ the system will take the color associated to each curve. The default value is “Default”.

xySymbolMarker: SymbolicConstant = DEFAULT[source]#

A SymbolicConstant specifying the marker type to be used for all animation capable X - Y curve or the SymbolicConstant DEFAULT specifying that the system will take the marker associated to each curve Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER
DEFAULT

The default value is DEFAULT.

xySymbolSize: SymbolicConstant = MEDIUM[source]#: A SymbolicConstant specifying the size of the markers. Possible values are SMALL, MEDIUM, and LARGE. The default value is MEDIUM.

xyUseHighlightMethod: Union[AbaqusBoolean, bool] = ON[source]#: A Boolean specifying whether to use the highlight method to draw the time tracker line and symbols. The default value is ON.

AnimationSession#

class AnimationSession[source]#

The following commands operate on Session objects. For more information about the Session object, see Session object.

Note

This object can be accessed by:

import animation

Note

Check AnimationSession on help.3ds.com/0.1..

Public Data Attributes:

Inherited from SessionBase

`attachedToGui`	A Boolean specifying whether an Abaqus interactive session is running.
`replayInProgress`	A Boolean specifying whether Abaqus is executing a replay file.
`kernelMemoryFootprint`	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryMaxFootprint`	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryLimit`	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
`colors`	A repository of Color objects.
`journalOptions`	A `JournalOptions` object specifying how to record selection of geometry in the journal and replay files.
`memoryReductionOptions`	A `MemoryReductionOptions` object specifying options for running in reduced memory mode.
`nodeQuery`	A `NodeQuery` object specifying nodes and their coordinates in a path.
`sketcherOptions`	A `ConstrainedSketcherOptions` object specifying common options for all sketches.
`viewerOptions`	A `ViewerOptions` object.
`animationOptions`	An `AnimationOptions` object.
`aviOptions`	An `AVIOptions` object.
`imageAnimationOptions`	An `ImageAnimationOptions` object.
`imageAnimation`	An `ImageAnimation` object.
`quickTimeOptions`	A `QuickTimeOptions` object.
`viewports`	A repository of Viewport objects.
`customData`	A `RepositorySupport` object.
`defaultFieldReportOptions`	A `FieldReportOptions` object.
`defaultFreeBodyReportOptions`	A `FreeBodyReportOptions` object.
`fieldReportOptions`	A `FieldReportOptions` object.
`freeBodyReportOptions`	A `FreeBodyReportOptions` object.
`odbs`	A repository of Odb objects.
`scratchOdbs`	A repository of ScratchOdb objects.
`defaultOdbDisplay`	A `DefaultOdbDisplay` object.
`defaultPlot`	A `DefaultPlot` object.
`defaultChartOptions`	A `DefaultChartOptions` object.
`odbData`	A repository of OdbData objects.
`mdbData`	A repository of MdbData objects.
`paths`	A repository of Path objects.
`freeBodies`	A repository of FreeBody objects.
`streams`	A repository of Stream objects.
`spectrums`	A repository of Spectrum objects.
`currentProbeValues`	A `CurrentProbeValues` object.
`defaultProbeOptions`	A `ProbeOptions` object.
`probeOptions`	A `ProbeOptions` object.
`probeReport`	A `ProbeReport` object.
`defaultProbeReport`	A `ProbeReport` object.
`selectedProbeValues`	A `SelectedProbeValues` object.
`printOptions`	A `PrintOptions` object.
`epsOptions`	An `EpsOptions` object.
`pageSetupOptions`	A `PageSetupOptions` object.
`pngOptions`	A `PngOptions` object.
`psOptions`	A `PsOptions` object.
`svgOptions`	A `SvgOptions` object.
`tiffOptions`	A `TiffOptions` object.
`autoColors`	An `AutoColors` object specifying the color palette to be used for color coding.
`xyColors`	An `AutoColors` object specifying the color palette to be used forXYCurve objects.
`xyDataObjects`	A repository of XYData objects.
`curves`	A repository of XYCurve objects.
`xyPlots`	A repository of XYPlot objects.
`charts`	A repository of Chart objects.
`defaultXYReportOptions`	An `XYReportOptions` object.
`xyReportOptions`	An `XYReportOptions` object.
`views`	A repository of View objects.
`networkDatabaseConnectors`	A repository of NetworkDatabaseConnector objects.
`displayGroups`	A repository of DisplayGroup objects.
`graphicsInfo`	A `GraphicsInfo` object.
`defaultGraphicsOptions`	A `GraphicsOptions` object.
`graphicsOptions`	A `GraphicsOptions` object.
`defaultViewportAnnotationOptions`	A `ViewportAnnotationOptions` object.
`queues`	A repository of Queue objects.
`currentViewportName`	A String specifying the name of the current viewport.
`sessionState`	A Dictionary object specifying the viewports and their associated models.
`images`	A repository of Image objects.
`movies`	A repository of Movie objects.
`defaultLightOptions`	A `LightOptions` object.
`drawingArea`	A `DrawingArea` object.
`defaultMesherOptions`	A `MesherOptions` object specifying how to control default settings in the Mesh module.
`drawings`	A repository of Drawing objects.

Public Methods:

`writeImageAnimation`(fileName, format[, ...])	This method writes the animations present in the list of canvas objects to a file.
`Movie`(name, fileName[, startFrame, ...])	This method creates a Movie object from the contents of the specified file.

Inherited from SessionBase

`setValues`([kernelMemoryLimit])	This method modifies the Session object.
`enableCADConnection`(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
`isCADConnectionEnabled`()	This method checks the status of CAD Connection.
`disableCADConnection`(CADName)	This method disables an associative import CAD connection that was enabled.
`enableParameterUpdate`(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
`setCADPortNumber`(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
`updateCADParameters`(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
`disableParameterUpdate`(CADName)	This method disables an associative CAD connection using parameters.
`printToFile`(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
`printToPrinter`([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
`saveOptions`(directory)	This method saves your customized display settings.
`writeVrmlFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`write3DXMLFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`writeOBJFile`(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
`openOdb`(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

Movie(name, fileName, startFrame=0, endFrame=None, timelineStartFrame=0, timelineEndFrame=None, timelineStartTime=0, timelineEndTime=abaqusConstants.END_FRAME_TIME)[source]#

This method creates a Movie object from the contents of the specified file.

Note

This function can be accessed by:

session.Movie

Note

Check Movie on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the repository name for the movie.
fileName (str) – A String specifying the file from which the movie is to be read. The file extension must be specified and indicates the movie format (.avi, .mov, .mpeg, or .wmv).
startFrame (int, default: 0) – An Int specifying the first frame to be displayed from this movie. The default value is 0.
endFrame (Optional[int], default: None) – An Int specifying the last frame to be displayed from this movie. A negative number will indicate reverse numbering: -1 is the last frame of the movie. The default value is −1.
timelineStartFrame (int, default: 0) – An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0 will indicate the first frame to be displayed in the viewport. The default value is 0.
timelineEndFrame (Optional[int], default: None) – An Int specifying the global timeline frame number that corresponds to endFrame. A negative number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport. The default value is −1.
timelineStartTime (float, default: 0) – A Float specifying the global timeline time that corresponds to the time of startFrame. The default value is 0.0.
timelineEndTime (Union[SymbolicConstant, float], default: END_FRAME_TIME) – The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Returns:

A Movie object.

Return type:

Movie

Raises:

ValueError – If fileName does not exist or can not be read.
ValueError – If fileName references an unsupported movie file format
ValueError – If the contents of fileName are corrupt or can not be decoded.

writeImageAnimation(fileName, format, canvasObjects=())[source]#

This method writes the animations present in the list of canvas objects to a file. It generates an animation file using the given file name and file format and uses the values in the appropriate options object.

Note

Check AnimationSession.writeImageAnimation on help.3ds.com/0.1..

Parameters:

fileName (str) – A String specifying the name of the animation file to generate.
format (SymbolicConstant) – A SymbolicConstant specifying the format of the generated file. Possible values are AVI, QUICKTIME, VRML, and COMPRESSED_VRML.
canvasObjects (tuple, default: ()) – A sequence specifying the canvas objects to capture. The default behavior is to capture all canvas objects.

AVIOptions#

class AVIOptions[source]#

The AVIOptions object is used to store values and attributes to be used in generating AVI animation. The AVIOptions object has no constructor. Abaqus creates the aviOptions member when the animation module is imported.

Note

This object can be accessed by:

import animation
session.aviOptions

Note

Check AVIOptions on help.3ds.com/0.1..

Public Data Attributes:

`compressionMethod`	A SymbolicConstant specifying the compression method for the AVI format.
`compressionQuality`	An Int specifying the quality of the compression as a percentage when the compressionMethod is set to CODEC.
`codecOptions`	A String specifying the system specific options defining the CODEC when the compressionMethod is set to CODEC.
`sizeDefinition`	A SymbolicConstant specifying how the width and height of the image are specified.
`imageSize`	A pair of Ints specifying the width and height of the image in pixels when sizeDefinition = USER_DEFINED.

Public Methods:

setValues([compressionMethod, ...])

This method modifies the AVIOptions object.

Inherited from _OptionsBase

`get_user_attributes`()	Returns a list of the user attributes of the class.
`setValues`([compressionMethod, ...])	This method modifies the AVIOptions object.

codecOptions: str = ''[source]#: A String specifying the system specific options defining the CODEC when the compressionMethod is set to CODEC.

compressionMethod: SymbolicConstant = RLE8[source]#

A SymbolicConstant specifying the compression method for the AVI format. Possible values are:

RAW8, specifying an uncompressed format of 8 bits per pixel.
RAW32, specifying an uncompressed format of 32 bits per pixel.
RLE8, specifying a run length encoded format of 8 bits per pixel.
CODEC, specifying a format defined by CODEC (encoder/decoder). The availability of theCODEC is system dependent

The default value is RLE8.

compressionQuality: Optional[int] = None[source]#: An Int specifying the quality of the compression as a percentage when the compressionMethod is set to CODEC.

imageSize: Optional[int] = None[source]#: A pair of Ints specifying the width and height of the image in pixels when sizeDefinition = USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight) ≤ (width, height) ≤ (maxWidth, maxHeight). The default value is the screen size.

setValues(compressionMethod=abaqusConstants.RLE8, compressionQuality=None, codecOptions='', sizeDefinition=abaqusConstants.SIZE_ON_SCREEN, imageSize=None)[source]#

This method modifies the AVIOptions object.

Note

Check AVIOptions.setValues on help.3ds.com/0.1..

Parameters:

compressionMethod (SymbolicConstant, default: RLE8) –
A SymbolicConstant specifying the compression method for the AVI format. Possible values are:
- RAW8, specifying an uncompressed format of 8 bits per pixel.
- RAW32, specifying an uncompressed format of 32 bits per pixel.
- RLE8, specifying a run length encoded format of 8 bits per pixel.
- CODEC, specifying a format defined by CODEC (encoder/decoder). The availability of theCODEC is system dependent
The default value is RLE8.
compressionQuality (Optional[int], default: None) – An Int specifying the quality of the compression as a percentage when the compressionMethod is set to CODEC.
codecOptions (str, default: '') – A String specifying the system specific options defining the CODEC when the compressionMethod is set to CODEC.
sizeDefinition (SymbolicConstant, default: SIZE_ON_SCREEN) – A SymbolicConstant specifying how the width and height of the image are specified. Possible values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.
imageSize (Optional[int], default: None) – A pair of Ints specifying the width and height of the image in pixels when sizeDefinition = USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight) ≤ (width, height) ≤ (maxWidth, maxHeight). The default value is the screen size. Note:The values of the minimum width (minWidth) and height (minHeight) depend on the following:viewport font size,whether decorations are printed,decoration size, andscreen resolution.The minimum width and height are normally < 50 pixels. The values of the maximum width (maxWidth) and height (maxHeight) depend on the graphics capabilities of the system. The maximum width and height will be at least as large as the screen dimensions.

sizeDefinition: SymbolicConstant = SIZE_ON_SCREEN[source]#: A SymbolicConstant specifying how the width and height of the image are specified. Possible values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.

ImageAnimation#

class ImageAnimation(fileName, format)[source]#

The ImageAnimation object is used to build frame by frame animation.

Note

This object can be accessed by:

import animation
session.imageAnimation

Note

Check ImageAnimation on help.3ds.com/0.1..

Public Data Attributes:

fileName

A String specifying the file to which the animation frames is to be written.

Public Methods:

`__init__`(fileName, format)	This method creates an ImageAnimation object from the specified filename and format.
`writeFrame`([canvasObjects])	This method adds a frame to the ImageAnimation object.
`close`()	This method closes the ImageAnimation object.
`closed`()	This method indicates if the ImageAnimation is open or closed for writing animation frames.

close()[source]#: This method closes the ImageAnimation object.

closed()[source]#: This method indicates if the ImageAnimation is open or closed for writing animation frames.

fileName: str = ''[source]#: A String specifying the file to which the animation frames is to be written.

writeFrame(canvasObjects=())[source]#

This method adds a frame to the ImageAnimation object.

Note

Check ImageAnimation.writeFrame on help.3ds.com/0.1..

Parameters:: canvasObjects (tuple, default: ()) – A sequence specifying the canvas objects to capture. The default is to capture all canvas objects.

ImageAnimationOptions#

class ImageAnimationOptions[source]#

The ImageAnimationOptions object is used to store values and attributes associated with saving viewport animations. The ImageAnimationOptions object has no constructor. Abaqus creates the imageAnimationOptions member when the animation module is imported.

Note

This object can be accessed by:

import animation
session.imageAnimationOptions

Note

Check ImageAnimationOptions on help.3ds.com/0.1..

Public Data Attributes:

`frameRate`	An Int specifying the frame rate to record on the saved animation file.
`vpDecorations`	An Int specifying the time scale to apply to the frame rate.
`vpBackground`	A Boolean specifying whether to capture viewport backgrounds.
`compass`	A Boolean specifying whether to capture the view compass.

Public Methods:

setValues([frameRate, timeScale, ...])

This method modifies the ImageAnimationOptions object.

Inherited from _OptionsBase

`get_user_attributes`()	Returns a list of the user attributes of the class.
`setValues`([frameRate, timeScale, ...])	This method modifies the ImageAnimationOptions object.

compass: Union[AbaqusBoolean, bool] = OFF[source]#: A Boolean specifying whether to capture the view compass. The default value is OFF.

frameRate: Optional[int] = None[source]#: An Int specifying the frame rate to record on the saved animation file. The effective frame rate in frames per second will be obtained by dividing the given frame rate by the time scale.

setValues(frameRate=None, timeScale=None, vpDecorations=ON, vpBackground=OFF, compass=OFF)[source]#

This method modifies the ImageAnimationOptions object.

Note

Check ImageAnimationOptions.setValues on help.3ds.com/0.1..

Parameters:

frameRate (Optional[int], default: None) – An Int specifying the frame rate to record on the saved animation file. The effective frame rate in frames per second will be obtained by dividing the given frame rate by the time scale.
timeScale (Optional[int], default: None) – An Int specifying the time scale to apply to the frame rate.
vpDecorations (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to capture the viewport border and title. The default value is ON.
vpBackground (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to capture viewport backgrounds. The default value is OFF.
compass (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to capture the view compass. The default value is OFF.

vpBackground: Union[AbaqusBoolean, bool] = OFF[source]#: A Boolean specifying whether to capture viewport backgrounds. The default value is OFF.

vpDecorations: Union[AbaqusBoolean, bool] = ON[source]#: An Int specifying the time scale to apply to the frame rate.

Movie#

class Movie(name, fileName, startFrame=0, endFrame=None, timelineStartFrame=0, timelineEndFrame=None, timelineStartTime=0, timelineEndTime=abaqusConstants.END_FRAME_TIME)[source]#

The Movie object is used to store values and attributes associated with a movie file. Upon creation, the Movie object is added to the session.movies repository.

Note

This object can be accessed by:

import animation
session.movies[name]

Note

Check Movie on help.3ds.com/0.1..

Public Data Attributes:

`width`	An Int specifying the width of the movie in pixels.
`height`	An Int specifying the height of the movie in pixels.
`numFrames`	An Int specifying the total number of frames on the movie file.
`duration`	A Float specifying the duration of the movie in seconds.
`memory`	An Int specifying the memory taken by the movie frames as selected.
`startFrame`	An Int specifying the first frame to be displayed from this movie.
`endFrame`	An Int specifying the last frame to be displayed from this movie.
`timelineStartFrame`	An Int specifying the global timeline frame number that corresponds to startFrame.
`timelineEndFrame`	An Int specifying the global timeline frame number that corresponds to endFrame.
`timelineStartTime`	A Float specifying the global timeline time that corresponds to the time of startFrame.
`timelineEndTime`	The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame.

Public Methods:

`__init__`(name, fileName[, startFrame, ...])	This method creates a Movie object from the contents of the specified file.
`setValues`([startFrame, endFrame, ...])	This method modifies the Movie object.

Inherited from _OptionsBase

`get_user_attributes`()	Returns a list of the user attributes of the class.
`setValues`([startFrame, endFrame, ...])	This method modifies the Movie object.

duration: Optional[float] = None[source]#: A Float specifying the duration of the movie in seconds.

endFrame: Optional[int] = None[source]#: An Int specifying the last frame to be displayed from this movie. A negative number will indicate reverse numbering: -1 is the last frame of the movie. The default value is −1.

fileName: str[source]#: A String specifying the file from which the movie is to be read. The file extension must be specified and indicates the movie format (.avi, .mov, .mpeg, or .wmv).

height: Optional[int] = None[source]#: An Int specifying the height of the movie in pixels.

memory: Optional[int] = None[source]#: An Int specifying the memory taken by the movie frames as selected.

name: str[source]#: A String specifying the repository name for the movie.

numFrames: Optional[int] = None[source]#: An Int specifying the total number of frames on the movie file.

setValues(startFrame=0, endFrame=None, timelineStartFrame=0, timelineEndFrame=None, timelineStartTime=0, timelineEndTime=abaqusConstants.END_FRAME_TIME)[source]#

This method modifies the Movie object.

Note

Check Movie.setValues on help.3ds.com/0.1..

Parameters:

startFrame (int, default: 0) – An Int specifying the first frame to be displayed from this movie. The default value is 0.
endFrame (Optional[int], default: None) – An Int specifying the last frame to be displayed from this movie. A negative number will indicate reverse numbering: -1 is the last frame of the movie. The default value is −1.
timelineStartFrame (int, default: 0) – An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0 will indicate the first frame to be displayed in the viewport. The default value is 0.
timelineEndFrame (Optional[int], default: None) – An Int specifying the global timeline frame number that corresponds to endFrame. A negative number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport. The default value is −1.
timelineStartTime (float, default: 0) – A Float specifying the global timeline time that corresponds to the time of startFrame. The default value is 0.0.
timelineEndTime (Union[SymbolicConstant, float], default: END_FRAME_TIME) – The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Raises:

RangeError – If startFrame,*endFrame*,*timelineStartFrame*,*timelineEndFrame*,*timelineStartTime*, or*timelineEndTime* are outside their respective valid range.

startFrame: int = 0[source]#: An Int specifying the first frame to be displayed from this movie. The default value is 0.

timelineEndFrame: Optional[int] = None[source]#: An Int specifying the global timeline frame number that corresponds to endFrame. A negative number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport. The default value is −1.

timelineEndTime: Union[SymbolicConstant, float] = END_FRAME_TIME[source]#: The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

timelineStartFrame: int = 0[source]#: An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0 will indicate the first frame to be displayed in the viewport. The default value is 0.

timelineStartTime: float = 0[source]#: A Float specifying the global timeline time that corresponds to the time of startFrame. The default value is 0.0.

width: Optional[int] = None[source]#: An Int specifying the width of the movie in pixels.

QuickTimeOptions#

class QuickTimeOptions[source]#

The QuickTimeOptions object is used to store values and attributes to be used in generating QuickTime animation. The QuickTimeOptions object has no constructor. Abaqus creates the quickTimeOptions member when the animation module is imported.

Note

This object can be accessed by:

import animation
session.quickTimeOptions

Note

Check QuickTimeOptions on help.3ds.com/0.1..

compressionMethod: SymbolicConstant = RLE24[source]#

A SymbolicConstant specifying the compression method for the QuickTime format. Possible values are:

RAW24, specifying an uncompressed format of 24 bits per pixel.
RLE24, specifying a run length encoded format of 24 bits per pixel.

The default value is RLE24.

imageSize: Optional[int] = None[source]#: A pair of Ints specifying the width and height of the image in pixels when sizeDefinition = USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight) ≤ (width, height) ≤ (maxWidth, maxHeight). The default value is the screen size. Note: The values of the minimum width (minWidth) and height (minHeight) depend on the following:viewport font size,whether decorations are printed,decoration size, and screen resolution.The minimum width and height are normally < 50 pixels. The values of the maximum width (maxWidth) and height (maxHeight) depend on the graphics capabilities of the system. The maximum width and height will be at least as large as the screen dimensions.

setValues(compressionMethod=abaqusConstants.RLE24, sizeDefinition=abaqusConstants.SIZE_ON_SCREEN, imageSize=None)[source]#

This method modifies the QuickTimeOptions object.

Note

Check QuickTimeOptions.setValues on help.3ds.com/0.1..

Parameters:

compressionMethod (SymbolicConstant, default: RLE24) –
A SymbolicConstant specifying the compression method for the QuickTime format. Possible values are:
- RAW24, specifying an uncompressed format of 24 bits per pixel.
- RLE24, specifying a run length encoded format of 24 bits per pixel.
The default value is RLE24.
sizeDefinition (SymbolicConstant, default: SIZE_ON_SCREEN) – A SymbolicConstant specifying how the width and height of the image are specified. Possible values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.
imageSize (Optional[int], default: None) – A pair of Ints specifying the width and height of the image in pixels when sizeDefinition = USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight) ≤ (width, height) ≤ (maxWidth, maxHeight). The default value is the screen size. Note: The values of the minimum width (minWidth) and height (minHeight) depend on the following:viewport font size,whether decorations are printed,decoration size, and screen resolution.The minimum width and height are normally < 50 pixels. The values of the maximum width (maxWidth) and height (maxHeight) depend on the graphics capabilities of the system. The maximum width and height will be at least as large as the screen dimensions.

sizeDefinition: SymbolicConstant = SIZE_ON_SCREEN[source]#: A SymbolicConstant specifying how the width and height of the image are specified. Possible values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.