VCOM:VectorWorks:Extension:IObjUpdateSupportContext

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::Extension

..put some descriptoin in here...

Interface

// ----------------------------------------------------------------------------------------------------
class DYNAMIC_ATTRIBUTE IObjUpdateSupportContext
{
public:
	virtual										~IObjUpdateSupportContext()		{}

	// collection
	virtual TParametricFileIndex	VCOM_CALLTYPE	AcceptState(const TXString& objName) = 0;
	virtual void					VCOM_CALLTYPE	DenyState(TParametricFileIndex fileIndex) = 0;
	virtual TParametricFileIndex	VCOM_CALLTYPE	AcceptStateInternal(const TXString& objName) = 0;
	virtual void					VCOM_CALLTYPE	DenyStateInternal(TParametricFileIndex fileIndex) = 0;
	virtual TParametricFileIndex	VCOM_CALLTYPE	AcceptPredraw(const TXString& objName) = 0;
	virtual void 					VCOM_CALLTYPE	DenyPredraw(TParametricFileIndex fileIndex) = 0;
	virtual void 					VCOM_CALLTYPE	AcceptNotification(Uint32 whichChange) = 0;
	virtual void 					VCOM_CALLTYPE	DenyNotification(Uint32 whichChange) = 0;
	virtual TParametricFileIndex	VCOM_CALLTYPE	AcceptWeilerOperations(const TXString& objName) = 0;
	virtual void					VCOM_CALLTYPE	DenyWeilerOperations(TParametricFileIndex fileIndex) = 0;

	// context data
	virtual MCObjectHandle 			VCOM_CALLTYPE	GetObject() = 0;
	virtual MCObjectHandle 			VCOM_CALLTYPE	GetOutputObject() = 0;
	virtual TParametricFileIndex	VCOM_CALLTYPE	GetFileIndex() = 0;
	virtual bool					VCOM_CALLTYPE	GetIsPredrawBoundingCube() = 0;
	virtual size_t					VCOM_CALLTYPE	GetPredrawViewportCount() = 0;
	virtual MCObjectHandle			VCOM_CALLTYPE	GetPredrawViewport(size_t index) = 0;
	virtual void 					VCOM_CALLTYPE	SetPredrawBoundingCube(const WorldCube& boundCube) = 0;
	virtual void 					VCOM_CALLTYPE	GetNotification(Uint32& outWhichChange, Sint32& outAdditionalData) = 0;
	virtual EWeilerClipAction		VCOM_CALLTYPE	GetWeilerClipAction() = 0;

// Vectorworks 2012
public:
	virtual TParametricFileIndex	VCOM_CALLTYPE	AcceptState2(TDType objType) = 0;
	virtual void					VCOM_CALLTYPE	AcceptRightClick() = 0;
	virtual void					VCOM_CALLTYPE	DenyRightClick() = 0;

	// context data
	virtual short					VCOM_CALLTYPE	GetRightClickPickEvent() = 0;

// Vectorworks 2014
public:
	virtual void					VCOM_CALLTYPE	AcceptResourceBrowserDoubleClickOnSymbol() = 0;
	virtual void					VCOM_CALLTYPE	DenyResourceBrowserDoubleClickOnSymbol() = 0;
};

Members

AcceptState
DenyState
AcceptStateInternal
DenyStateInternal
AcceptPredraw
DenyPredraw
AcceptNotification
DenyNotification
AcceptWeilerOperations
DenyWeilerOperations
GetObject
GetOutputObject
GetFileIndex
GetIsPredrawBoundingCube
GetPredrawViewportCount
GetPredrawViewport
SetPredrawBoundingCube
GetNotification
GetWeilerClipAction
AcceptState2
AcceptRightClick
DenyRightClick
GetRightClickPickEvent
AcceptResourceBrowserDoubleClickOnSymbol
DenyResourceBrowserDoubleClickOnSymbol

Remarks

There is predefined type for smart VCOM pointer VCOMPtr to IObjUpdateSupportContext interface:

typedef VCOMPtr<IObjUpdateSupportContext>  IObjUpdateSupportContextPtr;

Version

Available from: Vectorworks 2010

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]