IAcadHelix

TeighaX Interface of Helix entity

Supported Platforms: Windows only

Object Inheritance

IAcadHelix

↓

IAcadEntity

↓

IAcadObject

↓

IDispatch

Members

These members are part of this object:

Methods

GetXData
SetXData
Delete
GetExtensionDictionary
ArrayPolar
ArrayRectangular
Highlight
Copy
Move
Rotate
Rotate3D
Mirror
Mirror3D
ScaleEntity
TransformBy
Update
GetBoundingBox
IntersectWith

Properties

Handle
ObjectName
ObjectID
Application
HasExtensionDictionary
OwnerID
Document
TrueColor
Layer
Linetype
LinetypeScale
Visible
PlotStyleName
Lineweight
Hyperlinks
Material
EntityTransparency
Position
Constrain
Height
Turns
TurnHeight
BaseRadius
TopRadius
Twist
TurnSlope
TotalLength

Events

GetXData()

Void GetXData([in] BSTR AppName, [out] Pointer Type XDataType, [out] Pointer Type XDataValue)

Returns the extended data (XData) associated with an object.

SetXData()

Void SetXData([in] VARIANT XDataType, [in] VARIANT XDataValue)

Sets the extended data (XData) associated with an object.

Delete()

Void Delete( )

Deletes a specified object.

GetExtensionDictionary()

IAcadDictionary* GetExtensionDictionary( )

Returns the extension dictionary associated with an object.

ArrayPolar()

VARIANT ArrayPolar([in] Int NumberOfObjects, [in] Double AngleToFill, [in] VARIANT CenterPoint)

Not implemented. Creates an array of selected objects in a polar pattern.

ArrayRectangular()

VARIANT ArrayRectangular([in] Int NumberOfRows, [in] Int NumberOfColumns, [in] Int NumberOfLevels, [in] Double DistBetweenRows, [in] Double DistBetweenCols, [in] Double DistBetweenLevels)

Not implemented. Creates an array of selected objects in a rectangular pattern.

Highlight()

Void Highlight([in] Boolean HighlightFlag)

Not implemented. Highlights or removes highlight from an entity.

Copy()

IDispatch* Copy( )

Copies a specified entity.

Move()

Void Move([in] VARIANT FromPoint, [in] VARIANT ToPoint)

Moves an entity from one point to a second point.

Rotate()

Void Rotate([in] VARIANT BasePoint, [in] Double RotationAngle)

Rotates an entity around a point.

Rotate3D()

Void Rotate3D([in] VARIANT Point1, [in] VARIANT Point2, [in] Double RotationAngle)

Rotates an entity around a line defined by two points, where the direction of the axis if from the first point to the second point.

Mirror()

IDispatch* Mirror([in] VARIANT Point1, [in] VARIANT Point2)

Not implemented. Mirrors an object around a line defined by two points.

Mirror3D()

IDispatch* Mirror3D([in] VARIANT Point1, [in] VARIANT Point2, [in] VARIANT point3)

Not implemented. Mirrors an object around a plane defined by three points.

ScaleEntity()

Void ScaleEntity([in] VARIANT BasePoint, [in] Double ScaleFactor)

Scales an object with respect to a base point and scale factor.

TransformBy()

Void TransformBy([in] VARIANT TransformationMatrix)

Performs the specified transformation on an entity.

Update()

Void Update( )

Not implemented. Updates the display of an entity.

GetBoundingBox()

Void GetBoundingBox([out] Pointer Type MinPoint, [out] Pointer Type MaxPoint)

Returns the minimum and maximum point of an entity's bounding box.

IntersectWith()

VARIANT IntersectWith([in] IDispatch* IntersectObject, AcExtendOptionShort option)

Returns coordinates of intersections with the (input) IntersectObject.

Handle [ReadOnly]

BSTR Handle( )

Returns the handle of an object.

ObjectName [ReadOnly]

BSTR ObjectName( )

Returns the TeighaX class name of an object.

ObjectID [ReadOnly]

LONG_PTR ObjectID( )

Returns the object ID of an object.

Application [ReadOnly]

IDispatch* Application( )

Returns the Application object.

HasExtensionDictionary [ReadOnly]

Boolean HasExtensionDictionary( )

Returns whether an object has an associated extension dictionary.

OwnerID [ReadOnly]

LONG_PTR OwnerID( )

Returns the object ID of the parent object.

Document [ReadOnly]

IDispatch* Document( )

Returns the drawing to which an object belongs.

TrueColor [ReadOnly]

IAcadAcCmColor* TrueColor( )

Specifies or returns the true color of an object.

Layer [ReadOnly]

BSTR Layer( )

Specifies or returns the current layer of an object.

Linetype [ReadOnly]

BSTR Linetype( )

Specifies or returns the current linetype of an object.

LinetypeScale [ReadOnly]

ACAD_NOUNITS LinetypeScale( )

Specifies or returns the linetype scale factor of an object.

Visible [ReadOnly]

Boolean Visible( )

Specifies or returns the visibility of an object or the application.

PlotStyleName [ReadOnly]

BSTR PlotStyleName( )

Specifies or returns the plot style name of an object.

Lineweight [ReadOnly]

ACAD_LWEIGHT Lineweight( )

Specifies or returns the lineweight of an object.

Hyperlinks [ReadOnly]

IAcadHyperlinks* Hyperlinks( )

Assigns a hyperlink to an object and displays the hyperlink name and description (if one is specified).

Material [ReadOnly]

BSTR Material( )

Specifies or returns the material of an object.

EntityTransparency [ReadOnly]

BSTR EntityTransparency( )

Specifies the transparency of the object

Position [ReadOnly]

VARIANT Position( )

Specifies or returns the x, y, and z coordinates for the base center point of a helix.

Constrain [ReadOnly]

AcHelixConstrainType Constrain( )

Specifies or returns the property that is contrained to remain constant when changing other properties of a helix.

Height [ReadOnly]

Double Height( )

Specifies or returns the height of a helix.

Turns [ReadOnly]

ACAD_NOUNITS Turns( )

Specifies or returns the number of turns for a helix.

TurnHeight [ReadOnly]

Double TurnHeight( )

Specifies or returns the height of a single turn for a helix.

BaseRadius [ReadOnly]

Double BaseRadius( )

Specifies or returns the radius of the base of a helix.

TopRadius [ReadOnly]

Double TopRadius( )

Specifies or returns the radius of the top of a helix.

Twist [ReadOnly]

AcHelixTwistType Twist( )

Specifies or returns the direction in which a helix turns.

TurnSlope [ReadOnly]

ACAD_ANGLE TurnSlope( )

Returns the slope angle in which a helix turns along a path.

TotalLength [ReadOnly]

Double TotalLength( )

Specifies the length of a helix.

HOME / PCAD_DB_X

IAcadHelix

Object Inheritance

Members