DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Collapse ModelsModels
Collapse DG Kernel ComponentsDG Kernel Components
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
Collapse ModelModel
Collapse ViewView
Collapse General ComputingGeneral Computing
Collapse Samples and TutorialsSamples and Tutorials
Collapse GraphicsGraphics
Collapse Math ObjectsMath Objects
Collapse DeprecatedDeprecated
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Search Documentation


IItem Interface

GetVisibleFlag
SetVisible
GetName
SetName
GetParent
IsSelected
SetModified

IItem interface gives access to individual items in the 3D scene rendered during the model display. IItem is a common base for Entities (ISection) and 3D Label items. IItem is used mostly to query from all other interface implemented by the element of the scene.  

Query ITypeBasic_KC from this interface to obtain type of the item

See also Pick Sample, InterfaceInterface List


HRESULT GetVisibleFlag( VARIANT_BOOL *visible)

Parameters

visible - [out] returned value of visibility of the item

Returns

S_OK in case of success.

Remarks:

Returns true or false depending whether the item is visible in the 3D View


HRESULT SetVisible(VARIANT_BOOL visible)

Parameters

visible - [in] new visibility state.

Return Values

S_OK in case of success.
Remarks:
 
This method allows hiding or displaying the item

HRESULT GetName(BSTR *name)

Parameters

name - [out] name of the item

Return Values

S_OK in case of success.

HRESULT SetName(char* name)

Parameters

name - [in] name of the item

Return Values

S_OK in case of success.

HRESULT GetParent(IItem **parent)

Parameters

parent - [out] The returned IItem interface of the parent item or NULL if the item is a top-level one.

Return Values

S_OK in case of success.
Remarks:
 
In this release the parent item, if exists, is always an object, so query for ISection from parent should be always successful.

HRESULT IsSelected(VARIANT_BOOL* selected)

Remarks:
 
Returns true if the scene item (most often entity) is the current item in the model

HRESULT SetModified()

Notifies the software that some attribute of the item or entity has been modified. A call to this method is required after modification of some rare attributes which do not have internally direct access to the model.