Method CreateFrameOnFrameConstraint

CreateFrameOnFrameConstraint(ElementId, SmartFrame3D, SmartFrame3D, SmartReal, bool, SmartReal, bool, SmartReal, bool, SmartReal, bool, bool)

Creates a "frame on frame" positioning constraint.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId CreateFrameOnFrameConstraint(ElementId inPositioningId, SmartFrame3D inSourceFrame, SmartFrame3D inDestinationFrame, SmartReal inOffsetDistance, bool inIsOffsetReversed, SmartReal inXRotationAngle, bool inIsXRotationReversed, SmartReal inYRotationAngle, bool inIsYRotationReversed, SmartReal inZRotationAngle, bool inIsZRotationReversed, bool inRotatesZYX)

Parameters

Type	Name	Description
ElementId	inPositioningId	Identifier of the positioning operation that will contain the constraint.
SmartFrame3D	inSourceFrame	Frame on source occurrence.
SmartFrame3D	inDestinationFrame	Destination frame.
SmartReal	inOffsetDistance	Offset distance of the source frame along the destination frame Z direction.
bool	inIsOffsetReversed	Whether the offset is reversed.
SmartReal	inXRotationAngle	Rotation angle of the source frame around its X axis.
bool	inIsXRotationReversed	Whether the rotation around X is reversed.
SmartReal	inYRotationAngle	Rotation angle of the source frame around its Y axis.
bool	inIsYRotationReversed	Whether the rotation around Y is reversed.
SmartReal	inZRotationAngle	Rotation angle of the source frame around its Z axis.
bool	inIsZRotationReversed	Whether the rotation around Z is reversed.
bool	inRotatesZYX	Rotates around Z then Y then X instead of X then Y then Z.

Returns

Type	Description
ElementId	Identifier of the created constraint.

Remarks

StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.