SDK:Parametric Extended Properties

From Vectorworks Developer
Revision as of 23:13, 28 November 2018 by Orso.b.schmid (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

General Info

See SDK:Parametric General Info for more information how to set extended properties for a parametric object.

Extended Properties

kObjXPropHasUIOverride

Allows customization of the shape pane: SDK:Parametric Custom Shape Pane. The plug-in can specify the widgets that appear in the shape pane when this object is selected.

pExtProps->SetObjectProperty( objectID, kObjXPropHasUIOverride, true );

kObjXHasCustomWidgetVisibilities

Setting this property to true will case sending kObjOnWidgetPrep event. Using this event will allow the plug-in to update the shape pane according to that particular instance.

See SDK:Parametric Custom Shape Pane.

pExtProps->SetObjectProperty( objectID, kObjXHasCustomWidgetVisibilities, true );

kObjXHasCustomWidgetValues

Setting this property to true will case sending kObjOnWidgetValueUpdate event. Using this event will allow the plug-in to update the widgets data. This is used for widgets that are not binded to record field but managed manually by the plug-in.

pExtProps->SetObjectProperty( objectID, kObjXHasCustomWidgetValues, true );

kObjXPropAcceptStates

The parametric accepts kObjOnAddState event. This event is send by VectorWorks to notify the parametric object plug-in for state change of an object instance. See SDK:Parametric State Notifications for more information.

pExtProps->SetObjectProperty( objectID, kObjXPropAcceptStates, true );

kObjXPropCustomHideFactor

The parametric object provides custom scale threshold to be used to hide inner objects when displaying the object in a layer or VP

Plug-in provides custom hide factor as a double number. See SDK:Parametric Hide Details.

The property value must be non zero double number. Zero factor is error situation and it is considered as 1.

pExtProps->SetObjectProperty( objectID, kObjXPropCustomHideFactor, double(2) );

kObjXPropHasContextMenu

Set this property to true if all the instances of that parametric object type has customized context menu. See: SDK:Parametric Custom Context Menu

Enabling context menu will cause sending events kObjOnContextMenuInit and kObjOnContextMenuEvent that will allow the plug-in to define and update the custom context menu.

pExtProps->SetObjectProperty( objectID, kObjXPropHasContextMenu, true );

Not Documented

kObjXPropEditGroup

Object has non-default "Enter Group" behavior. PIO objects can enter the profile or path group directly.

This property is designed to work with kObjectEditGroupPropertyID property values below.

Set this using SetObjectPropertyChar(), with one of kEditGroupDefaultProperty, kEditGroupProfile, kEditGroupPath, or kEditGroupCustom.

kEditGroupProfile and kEditGroupPath will take you right into editing the path or profile with no dialog. kEditGroupCustom brings up the "Enter Path/Profile" selection dialog, and lets you set whether a double-click takes you to path or profile. Note that this requires trapping the kObjOnSpecialEditID event as well, and (somehow) finding out what the user set in this dialog.

kObjXPropHasLayerScaleDeps

Object wants to be reset with when its layer scale changes.

kObjXPropSpecialEdit

DEPENDS on

Object has non-default behavior when "Edit..." command is invoked.

Cursor double-click also invokes this "Edit..." behavior.

One of: kSpecialEditDefaultProperty, kSpecialEditCustom, kSpecialEditProperties or kSpecialEditReshape.

Setting kSpecialEditCustom will cause the kObjOnSpecialEditID event to be sent when the user double-clicks the parametric object. Setting kSpecialEditProperties will cause the standard properties dialog for the object (matching the OIP) to display on a double-click.

kObjXPropPreference

Object Definition Procedure (ODP) handles kParametricPreference event.

kObjXPropDirectModeling

Object Definition Procedure (ODP) handles handles Direct Modeling events.

kObjXPropAttributeTool

Object Definition Procedure (ODP) handles handles Attribute Mapping events.

kObjXPropPreventWallInsertion

Object does NOT want to be inserted into walls. Observed by the 2D cursor tool to prevent dragging into a wall.

kObjXPropCustomCursorResize

NNA under development

kObjXPropAcceptsMarkers

none

kObjXPropDefaultPropertyUI

The bits in this property describe the UI displayed

NNA under development

kObjXHandlesCommand

NNA under development

The parametric handles commands.

One source of commands can be custom control points: SDK:Parametric Custom Control Points.

kObjXIs2DSurfaceEligable

Weiler operations operate on 2D path

kObjXPropRotatesWithVCS

Plug-In objects rotates with plan rotation

kObjXPropAcceptStatesInternal

Plug-in accepts about to be deleted state

The plug-in will receive about to be delete and duplicate (internal) states through kObjXPropAcceptStates Must have kObjXPropAcceptStates enabled Note! This is an isolated option to improve speed of plug-ins that are not interested in delete events

kObjXPropHasComponents

The parametric defines components

Extended Properties Uses

Some of the uses of extended Parametric Extended Properties are:

Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox