VCOM:VectorWorks:ISDK::AddToolHighlightingPolyAddVertex

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks

Member of VCOM:VectorWorks:ISDK

Adds vertex to 2D polygon definition created by ISDK::AddToolHighlightingPolyCreate. See SDK:Custom Tool Highlighting for details.

virtual bool VCOM_CALLTYPE AddToolHighlightingPolyAddVertex(
long polyID,
const WorldPt& pt,
VertexType type = vtCorner,
WorldCoord arcRadius = 0);

Parameters

polyID long 2D polygon definition identifier provided by ISDK::AddToolHighlightingPolyCreate call.
pt const WorldPt& The new vertex location.
type VertexType The new vertex type.
arcRadius WorldCoord Radius for arc vertex. Zero in all other cases.

Return Value

Returns true if the call succeeds.

Example

long	polyID	= gSDK->AddToolHighlightingPolyCreate();
for(...) {
    gSDK->AddToolHighlightingPolyAddVertex( polyID, vertex.pt, vertex.type, vertex.dRadius );
}

// Add the polygon as highlight visual feed back
gSDK->AddToolHighlightingPoly( polyID, true );

Version

Availability: from Vectorworks 2009

See Also

Functions: ISDK::EmptyToolHighlightingList | ISDK::AddToolHighlighting | ISDK::AddToolHighlightingSegment | ISDK::AddToolHighlightingPolyCreate | ISDK::AddToolHighlightingPoly | ISDK::AddToolHighlightingPolyAddVertex | ISDK::AddToolHighlightingSegment3D | ISDK::AddToolHighlightingPoly3DCreate | ISDK::AddToolHighlightingPoly3D | ISDK::AddToolHighlightingPoly3DAddVertex

Articles: SDK:Custom Tool Highlighting

Functions: [[VCOM:VectorWorks:ISDK::EmptyToolHighlightingList|ISDK::EmptyToolHighlightingList]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingObject|ISDK::AddToolHighlighting]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingSegment|ISDK::AddToolHighlightingSegment]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPolyCreate|ISDK::AddToolHighlightingPolyCreate]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPoly|ISDK::AddToolHighlightingPoly]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPolyAddVertex|ISDK::AddToolHighlightingPolyAddVertex]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingSegment3D|ISDK::AddToolHighlightingSegment3D]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPoly3DCreate|ISDK::AddToolHighlightingPoly3DCreate]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPoly3D|ISDK::AddToolHighlightingPoly3D]] | [[VCOM:VectorWorks:ISDK::AddToolHighlightingPoly3DAddVertex|ISDK::AddToolHighlightingPoly3DAddVertex]] Articles: [[SDK:Custom Tool Highlighting]]