Share

SketchEvents.OnSketch3DChange Event

Parent Object: SketchEvents

Description

The OnSketch3DChange event notifies the client when the geometry of a 3D sketch is changed.

Remarks

Sketch changes that fire this event include adding new geometry, modifying existing geometry either directly or indirectly by editing dimension constraints, deleting geometry, and placing or deleting constraints where it will cause a change in any geometry. For example, placing a perpendicular constraint between two lines will cause this notification to be sent if the orientation of the lines needs to be changed to make them perpendicular. If the lines are already positioned perpendicular to one another, adding the constraint will not cause this notification to fire since the geometry does not change. Deleting the constraint does not cause the notification to be sent since the geometry is not changed as a result. Adding dimension constraints does not change the geometry so it does not result in this notification being sent, but editing the value of the dimension does modify the geometry and will result in this notification being sent.

Syntax

SketchEvents.OnSketch3DChange( DocumentObject As Document, Sketch3D As Sketch3D, BeforeOrAfter As EventTimingEnum, Context As NameValueMap, HandlingCode As HandlingCodeEnum )

Parameters

Name Type Description
DocumentObject Document The Document object the 3D sketch is within.
Sketch3D Sketch3D The 3D sketch that is changing.
BeforeOrAfter EventTimingEnum Input EventTimingEnum indicating when the event is being fired. Notification is sent before and after the sketch is changed.
Context NameValueMap Input NameValueMap object that can be used to determine the context of why the event fired. No context information is provided for this event.
HandlingCode HandlingCodeEnum Output HandlingCodeEnum that indicates how you are handling the event. The value of this argument is currently ignored for this event.

Version

Introduced in version 11

Was this information helpful?