VisualizationController Interface CATIVisuFilter

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIVisuFilter

Interface for visibility in layer filter.

Interface implemented by the that you retrieve by the static function .

Method Index

o IsVisible(CATBaseUnknown*,int)

Returns the visibility state of an object or a layer in the current layer filter.

Methods

Returns the visibility state of an object or a layer in the current layer filter.

Role: This method gives the visibility state of an object or a layer. Two usages for this method:

• iObject=NULL, and you only set iLayerNumber

In this case, you want to know whether a layer is visible in the current filter.

• iObject!=NULL, and you don't set iLayerNumber

In this case, you want to know whether an object is visible in the current filter.

The reference layer filter for the query is the layer filter currently applied on the currently edited object. The currently edited object is the UIActive object in the current editor (CATFrmEditor).

This means an interactive context is needed for this method to work correctly. It may not work correctly if used in a batch context because there will be no current editor and no UIActive objects in editors. In a batch context the method will work fine only if the context contains only one editor and if this editor edits a single object and no assembly (i.e. no hierarchy of UIActivable objects).

Parameters:

iObject

The object you want to query. Remember objects placed in no layer are always visible.

iLayerNumber

The number of the layer you want to query:

• a valid value ranges between 0 and 999,
• -1, the method ignores the value.

Remember the current layer is always visible.

Returns:

S_OK if the layer or object is visible, E_FAIL if not visible.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.