IRdDockingPosition Interface Reference

Inherits IRsObject.

List of all members.

Public Member Functions
HRESULT	GetDockingPosition ([out] RtVector3f *pPosition)
HRESULT	SetDockingPosition ([in] IRsUnknownDocking *pDocking,[in] GUID portGuid)

---

Detailed Description

Widget docking position data object is used to specify position for widget actions and elements.

• The position is specified by RtVector3f, but because this needs to be accessible during rendering of widgets (not just read threads), its evaluation of must be done out of kernel.
• Callback mechanism is used to perform the task.

---

Member Function Documentation

HRESULT IRdDockingPosition::GetDockingPosition

(

[out] RtVector3f *

pPosition

)

Evaluate world-space position defined by internaly held Port and Docking node.

• Evaluation is executed out of kernel and can run from all threads.
• Caller should make sure, that object is not destroyed during the call.

Parameters:

pPosition

[out] Returns world space position.

Returns:

standard HRESULT processing can be applied to returned value.

HRESULT IRdDockingPosition::SetDockingPosition	(	[in] IRsUnknownDocking *	pDocking,
		[in] GUID	portGuid
	)

Set docking position port and interface.

Parameters:

	pDocking	[in] Specified docking port node
	portGuid	[in] Specified docking port connector ID for nodes with multiple docking ports.

Returns:

standard HRESULT processing can be applied to returned value.