IModelView Interface Reference

Represents any Renga view that works with model objects. More...

Public Member Functions
HRESULT	GetHiddenObjects ([out, retval] SAFEARRAY(int) *pHiddenObjectIds)
	Returns a collection of IDs of hidden objects in the current view.
HRESULT	GetInterfaceByName ([in] BSTR interfaceName, [out, retval] IDispatch **ppInterface)
	Returns an interface by its name.
HRESULT	GetObjectVisualStyle ([in] int objectId, [out, retval] enum VisualStyle *pVisualStyle)
	Returns the object's visual style.
HRESULT	GetVisibleObjects ([out, retval] SAFEARRAY(int) *pVisibleObjectIds)
	Returns a collection of IDs of visible objects in the current view.
HRESULT	IsObjectVisible ([in] int objectId, [out, retval] VARIANT_BOOL *pVisible)
	Returns the object's visibility state.
HRESULT	SetObjectsVisibility ([in] SAFEARRAY(int) objectIds, [in] VARIANT_BOOL visible_)
	Changes the visibility state of a set of objects.
HRESULT	SetObjectsVisualStyle ([in] SAFEARRAY(int) objectIds, [in] enum VisualStyle visualStyle_)
	Changes the visual style of a set of objects.
HRESULT	ShowObjects ([in] SAFEARRAY(int) objectIds)
	Show objects by a collection of their IDs. Implemented only for 3D view.

Properties
int	RepresentedEntityId [get]
	The ID of the entity represented by the model view.
VisualStyle	VisualStyle [get, set]
	The view's default visual style.
Properties inherited from IView
int	Id [get]
	The view ID.
ViewType	Type [get]
	The actual type of the view.

Detailed Description

Represents any Renga view that works with model objects.

This interface can be obtained as an additional interface from IView if the view type is a View3D, Level, Assembly or Drawing.

Member Function Documentation

GetHiddenObjects()

HRESULT GetHiddenObjects

(

[out, retval] SAFEARRAY(int) *

pHiddenObjectIds

)

Returns a collection of IDs of hidden objects in the current view.

Note

For now, none of the drawing objects can be hidden.

Parameters

[out]

pHiddenObjectIds

An array of hidden object IDs.

GetInterfaceByName()

HRESULT GetInterfaceByName	(	[in] BSTR	interfaceName,
		[out, retval] IDispatch **	ppInterface )

Returns an interface by its name.

This method is provided as an alternative for the standard COM QueryInterface() method for cases where IUnknown is not accessible, like interoperating with the API from some interpreted languages.

Parameters

[in]	interfaceName	The name of the requested interface.
[out]	ppInterface	The requested interface.

GetObjectVisualStyle()

HRESULT GetObjectVisualStyle	(	[in] int	objectId,
		[out, retval] enum VisualStyle *	pVisualStyle )

Returns the object's visual style.

Parameters

[in]	objectId	Object's identifier.
[out]	pVisualStyle	The requested object visual style.

Note

For now, the visual style of drawing objects is always VisualStyle_Undefined.

GetVisibleObjects()

HRESULT GetVisibleObjects

(

[out, retval] SAFEARRAY(int) *

pVisibleObjectIds

)

Returns a collection of IDs of visible objects in the current view.

Note

For now, all drawing objects are visible and can't be hidden.

Parameters

[out]

pVisibleObjectIds

An array of visible object IDs.

IsObjectVisible()

HRESULT IsObjectVisible	(	[in] int	objectId,
		[out, retval] VARIANT_BOOL *	pVisible )

Returns the object's visibility state.

Parameters

[in]	objectId	Object's identifier.
[out]	pVisible	TRUE if the object is visible, FALSE otherwise.

Note

For now, the drawing objects are always visible.

SetObjectsVisibility()

HRESULT SetObjectsVisibility	(	[in] SAFEARRAY(int)	objectIds,
		[in] VARIANT_BOOL	visible_ )

Changes the visibility state of a set of objects.

Parameters

[in]	objectIds	Array of object identifiers.
[in]	visible_	New visibility state.

Note

For now, it is impossible to change the visibility of drawing objects.

SetObjectsVisualStyle()

HRESULT SetObjectsVisualStyle	(	[in] SAFEARRAY(int)	objectIds,
		[in] enum VisualStyle	visualStyle_ )

Changes the visual style of a set of objects.

Parameters

[in]	objectIds	Array of object identifiers.
[in]	visualStyle_	New visual style.

Note

For now, it is impossible to change the visual style of the drawing objects.

ShowObjects()

HRESULT ShowObjects

(

[in] SAFEARRAY(int)

objectIds

)

Show objects by a collection of their IDs. Implemented only for 3D view.

Parameters

[in]

objectIds

An array of object IDs to show.

Property Documentation

RepresentedEntityId

int RepresentedEntityId

get

The ID of the entity represented by the model view.

See also

IApplication::OpenViewByEntity

VisualStyle

VisualStyle VisualStyle

getset

The view's default visual style.

Note

For now, the visual style of the drawing view is always VisualStyle_Undefined.