VCOM:VectorWorks:ISDK::AddToolHighlightingSegment

.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

Add a 2D line segment to the highlight visual feedback list for tools. See SDK:Custom Tool Highlighting for details.

virtual bool VCOM_CALLTYPE AddToolHighlightingSegment(
                            const WorldPt&   startPt,
                            const WorldPt&   endPt);

Parameters

startPt		const WorldPt&		Start point for the 2D line segment.
endPt		const WorldPt&		End point for the 2D line segment.

Return Value

Returns true if the line segment is added.

The function will return false if the start and end points are equal according to Vectorworks inner epsilon value.

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]]