DriveSettings Object


Description

The DriveSettings object provides access to various drive relationship related settings for assembly constraints and joints.

Methods

Name Description
GetIncrement Method that returns how the increment was specified and the value.
GoToEnd Method that got to the ending frame of the animation.
GoToStart Method that got to the starting frame of the animation.
PlayForward Method that drives the relationship forward. This will fail if start and end values are not set.
PlayReverse Read-write property that gets and sets the delay between steps in seconds.
SetIncrement Method that sets the increment type and the value.
StartAVIRecording Method that starts recording the drive relationship animation for saving to an avi file. Use the StopRecording method to stop recording and generate the animation file.
StartWMVRecording Method that starts recording the drive relationship animation for saving to a wmv file. Use the StopRecording method to stop recording and generate the animation file.
StepForward Method that advances the animation by one step.
StepReverse Method that reverses the animation by one step.
StopRecording Method that stops recording the drive relationship animation and generates the animation file. Use the StartWMVRecording or StartAVIRecording method to start recording the animation.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
CollisionDetection Read-write property that gets and sets whether to drive the constrained assembly until a collision is detected.
DriveAdaptivity Read-write property that gets and sets whether to adapt components while maintaining constraint or connection relationships.
DriveType Read-write property that gets and sets the drive type to specify which value to drive.
EndValue Read-write property that gets and sets the expression for the end value.
FrameRate Read-write property that gets and sets the increments at which a snapshot is taken for inclusion as a frame in a recorded animation.
IsInitialized Read-only property that returns whether the drive parameters have been set for this relationship. If this property returns False, the properties on this object will return hard-coded default values and the methods will fail. Calling properties and methods to set drive parameters will automatically toggle this property to True.
Parent Read-only property that returns the parent assembly constraint or joint object.
PauseDelay Read-write property that gets and sets the delay between steps in seconds.
RepetitionCount Read-write property that gets and sets the number of repetitions for the Start/End sequence and the number of cycles for the Start/End/Start sequence.
RepetitionStartEndStart Read-write property that gets and sets whether to drive the relationship from the start value to the end value and then in reverse to the start value.
StartValue Read-write property that gets and sets the expression for the start value.
Type Returns an ObjectTypeEnum indicating this object's type.

Events

Name Description
OnCollision Event that is fired whenever a collision occurs during the animation/play of the relationship. The event only fires if the CollisionDetection property is set to True.

Accessed From

AngleConstraint.DriveSettings, AngleConstraintProxy.DriveSettings, AssemblyConstraint.DriveSettings, AssemblyJoint.DriveSettings, AssemblyJointProxy.DriveSettings, AssemblySymmetryConstraint.DriveSettings, AssemblySymmetryConstraintProxy.DriveSettings, CustomConstraint.DriveSettings, CustomConstraintProxy.DriveSettings, FlushConstraint.DriveSettings, FlushConstraintProxy.DriveSettings, InsertConstraint.DriveSettings, InsertConstraintProxy.DriveSettings, MateConstraint.DriveSettings, MateConstraintProxy.DriveSettings, RotateRotateConstraint.DriveSettings, RotateRotateConstraintProxy.DriveSettings, RotateTranslateConstraint.DriveSettings, RotateTranslateConstraintProxy.DriveSettings, TangentConstraint.DriveSettings, TangentConstraintProxy.DriveSettings, TransitionalConstraint.DriveSettings, TransitionalConstraintProxy.DriveSettings, TranslateTranslateConstraint.DriveSettings, TranslateTranslateConstraintProxy.DriveSettings

Samples

Name Description
Create rotational assembly joint

This sample demonstrates creating an assembly joint. It connects the midpoints of the edges of two faces using a rotational joint. To do this it first creates a geometry intent object of the midpoint of the edge and then creates another intent using the face and the midpoint intent. It does this to create to midpoint intents which it then uses to create the rotational connection.

The sample uses and existing part that must be set up to allow it to work correctly. To create the sample part you can use any part that has a planar face and a linear edge connected to that planar face. A simple box is sufficient. In this part Add a mate iMate to the planar face and rename the iMate to "Face1". Also add a mate iMate to a linear edge that is on the face previously named and rename this iMate to "Edge1". Save the part to "C:\Temp\SamplePart.ipt" or any other name and edit the code below to reference the file. You can then run the sample code which will create a new assembly, insert two instances of the part and create a rotational connection between them. Then it will animation the rotation by driving the connection.

Version

Introduced in version 2014