Share

SketchBlockDefinition Object

Derived from: PlanarSketch Object

Description

The SketchBlockDefinition object represents a sketch block definition.

Methods

Name Description
AddArcSlotByCenterPointArc Method that creates an arc slot. The sketch entities represent the sketch slot are returned.
AddArcSlotByThreePointArc Method that creates an arc slot. The sketch entities represent the sketch slot are returned.
AddByProjectingEntity Method that creates a new sketch entity by projecting other entities onto the sketch plane. This method performs the same function as the Project Geometry or Project DWG Geometry command according to the Entity you specified.
AddBySilhouette Method that creates new reference sketch geometry as the silhouette on the input face near the input proximity point.
AddStraightSlotByCenterToCenter Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
AddStraightSlotByOverall Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
AddStraightSlotBySlotCenter Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
AdjustContext Method that returns the specified sketch object scoped into this sketch block definition, trimming any portion of the context from any sketch block in which this definition has been instanced. In other words, for the given object, this method returns the corresponding object in the context of this sketch block definition, by trimming the sketch block path.
BreakLink Method that breaks the link to the source sketch.
CopyContentsTo Method that copies all the contents of the sketch to the \input target sketch.
CopyEntitiesTo Method that copies sketch entities of the sketch to the input target sketch.
CopyTo Method that copies the definition to the target document.
Delete Method that deletes the sketch. This method is only valid for sketches that are not used by a feature.
Edit Method that causes the Sketch environment to be invoked with this sketch available for interactive edit.
ExitEdit Causes the Sketch environment to be closed and the user interface to return to the previous environment. This is equivalent to the Return command. This method is only valid in the case where this sketch is open for edit within the user interface.
GetCustomLineType Method that returns information regarding the custom line type in use. The method returns a failure if the return value of the LineType property is not kCustomLineType.
GetReferenceKey Method that generates and returns the reference key for this entity.
ModelToSketchSpace Method that takes a 3D coordinate in model space, projects it onto the sketch plane along the normal of the plane and returns a Point2d object containing the resulting coordinate point in sketch space.
MoveSketchObjects Method that moves a collection of sketch objects by a specified vector. If the Copy argument is set to True, the newly created objects are returned.
OffsetSketchEntitiesUsingDistance Method that offsets a sketch entity or a group of connected sketch entities. In both cases, the base sketch entity is first offset by the specified distance and along the specified direction. The base sketch entity is determined as follows: * If only one sketch entity needs to be offset, it will be treated as the base sketch entity. * If a group of end-to-end connected entities need to be offset, the first entity in the group will be treated as the base sketch entity. If this method successfully offsets the specified input sketch entities, the newly created sketch entities are returned.
OffsetSketchEntitiesUsingPoint Method that offsets a sketch entity or a group of end-to-end connected sketch entities. In both cases, the offset is first applied to the base sketch entity such that the offset of the base sketch entity passes through the specified offset point on the sketch. The shortest distance of this offset point from the original base sketch entity determines the offset distance.
RotateSketchObjects Method that rotates a collection of sketch objects by a specified angle. If the Copy argument is set to True, the newly created objects are returned.
SetCustomLineType Method that sets a custom line type to the curve from the specified .lin file. The method automatically changes the value of LineType property to kCustomLineType.
SetEndOfPart Method that repositions the end-of-part marker relative to the object this method is called from. The argument defines if the end-of-part marker will be positioned just before or just after the object. If the object is contained within another object and is not in the top level of the browser, the positioning of the marker will be relative to the top-level object the calling object is contained within. An example of this case is a sketch that has not been shared and has been consumed by a feature. Another example is a nested work feature.
SketchToModelSpace Method that takes a 2D coordinate in sketch space, and returns a Point3d containing the coordinates of the point in model space.
Solve Method that causes the sketch to solve.
UpdateProfiles Method that updates all the profiles within the sketch.

Properties

Name Description
Adaptive Gets and sets whether the sketch is adaptive or not.
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.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
AxisEntity Gets and sets the object that defines the X or Y axis of the sketch plane. The AxisIsX property defines whether it is the X or Y axis, and the NaturalAxisDirection property defines the direction of the axis.
AxisEntityGeometry Property that gets the geometry that describes the axis entity.
AxisIsX Gets and sets if the axis entity defines the X or Y axis. True indicates the axis defines the X-axis.
CheckSumValue Gets sketch checksum value.
CircularPatterns Gets the SketchCircularPatterns collection object.
Color Gets and Sets the color for the sketch.
ConstraintStatus Property that returns an enum indicating the constraint status of the sketch entity, signifying whether it is fully constrained, over constrained, or under constrained.
Consumed Gets whether the sketch is consumed or not.
CopyToFlatPattern Gets and sets whether a sheet metal folded model sketch should be copied over (transposed) to the flat pattern.
DataIO Gets the object through which this sketch's data content can be persisted.
DeferUpdates Gets and Sets whether to defer the solving of the sketch or not.
Dependents Gets the dependent objects of the sketch.
Description Gets and sets the description for the sketch block definition.
DimensionConstraints Gets the collection of all dimension constraints on the sketch.
DimensionsVisible Gets and sets whether the dimensions on the sketch are visible.
DisabledActionTypes Gets and sets the action types valid for this sketch.
Exported Read-write property that gets and sets whether the object is exported. Objects must be marked for export in order for them to be derived.
GeometricConstraints Property that returns the collection of all geometric constraints on the sketch.
HasReferenceComponent Property that specifies if the object was created as the result of a derived part.
HealthStatus Property that returns an enum indicating the current state of the object.
InsertionPoint Property that returns the insertion point of the sketch block definition.
IsInsertionPointVisible Gets and sets whether the insertion point is visible.
IsOwnedByFeature Property that returns whether this object is owned by a feature. This property should return True for sketches that are created as a result of an unfold or refold feature.
IsReferenced Property that returns whether this sketch block definition is currently referenced within the document.
LineType Gets and Sets the line type override for the sketch.
LineWeight Gets and Sets the line weight override for the sketch.
ModelToSketchTransform Property that returns the transformation from model space to the 2d sketch coordinate space.
Name Gets and sets name of the sketch.
NaturalAxisDirection Gets and sets if the sketch plane X or Y axis is in the same direction as that defined by axis entity. True indicates the axis direction is in the same direction as the axis.
OriginPoint Gets and sets origin of the sketch. When set this property, the valid object can be a WorkPoint, Vertex or SketchPoint.
OriginPointGeometry Property that gets the geometry that describes the origin point.
OwnedBy Property that returns the PartFeature object. This property should return the UnfoldFeature or RefoldFeature object that created the sketch.
Parent Property that gets the parent object from whom this object can logically be reached.
PlanarEntity Gets and sets the planar object that defines the planar object the sketch is to be built on.
PlanarEntityGeometry Property that returns the geometry that describes the plane the sketch is based on.
Profiles Property that returns the Profiles collection object.
ProjectedCuts Property that returns the ProjectedCuts collection object. This collection provides access to the existing projected cut edges in the sketch and provides functionality to create new projected cut edges.
RectangularPatterns Gets the SketchRectangularPatterns collection object.
ReferenceComponent Property that returns the ReferenceComponent that resulted in the creation of this feature.
ReferencedEntity Property that returns the referenced sketch in the cases where this sketch was created as a result of a "derive" operation or copied over to the sheet metal flat pattern from the folded model.
Shared Gets and sets whether the profile is shared or not.
SketchArcs Property that returns the SketchArcs collection object.
SketchBlocks Property that returns the SketchBlocks collection object. Only the first level sketch blocks in the sketch are returned. Use SketchBlock.ChildBlocks property recursively to get sketch blocks at all levels.
SketchCircles Property that returns the SketchArcs collection object.
SketchControlPointSplines Read-only property that returns the SketchControlPointSplines collection object. This collection provides access to the existing control point splines in the sketch and provides functionality to create new control point splines.
SketchEllipses Property that returns the SketchEllipses collection object.
SketchEllipticalArcs Property that returns the SketchEllipticalArcs collection object.
SketchEntities Property that returns the collection of all entities on the sketch, regardless of their type.
SketchEquationCurves Read-only property that returns the SketchEquationCurves collection object. This collection provides access to the existing equation curves in the sketch and provides functionality to create new equation curves.
SketchFixedSplines Property that gets the collection object.
SketchImages Property that returns a collection of all images on the sketch.
SketchLines Property that returns the SketchLines collection object. This collection provides access to the existing lines in the sketch and provides functionality to create new lines.
SketchOffsetSplines Property that returns the collection object. This collection provides access to the existing offset splines in the sketch.
SketchPoints Property that returns the SketchPoints collection object.
SketchSplines Property that returns the SketchSplines collection object.
SketchToModelTransform Property that returns the transformation from the 2D sketch coordinate space to model space.
TextBoxes Gets the TextBoxes collection associated with this Sketch.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets the visibility of the sketch.

Accessed From

SketchBlock.Definition, SketchBlockDefinition.CopyTo, SketchBlockDefinitionProxy.CopyTo, SketchBlockDefinitionProxy.NativeObject, SketchBlockDefinitions.Add, SketchBlockDefinitions.Item, SketchBlockDefinitionsEnumerator.Item, SketchBlockProxy.Definition

Derived Classes

SketchBlockDefinitionProxy

Samples

Name Description
Create and insert a sketch block definition into a part sketch This sample demonstrates inserting a sketch block into a part sketch.

Version

Introduced in version 2010

Was this information helpful?