IsApplicable (Filter)

Introduced

4.0

Description

Returns true if the filter is compatible with an input object. This method is used to quickly determine whether a filter can be used on a given type of object.

Scripting Syntax

Filter.IsApplicable( Object )

C# Syntax

Boolean Filter.IsApplicable( Object in_pObjects );

Parameters

Parameter

Type

Description

Object

SIObject, X3DObject,SubComponent, Property

or XSICollection

If this argument is omitted by the caller, the function receives a XSICollection object filled with the currently selected objects.

Return Value

Boolean

Examples

VBScript Example

'--------------------------------------------------------------------
'This example shows how to use the IsApplicable method 
'
' README: install the example from the filter object help 
' page before running this example.
'--------------------------------------------------------------------

set f = Application.Filters("LargeMesh")
   
if ( typename(f) <> "Nothing" ) then

   set model = ActiveSceneRoot
   set cone = model.AddGeometry( "Cone", "MeshSurface" )
   LogMessage f.name & ".IsApplicable("& cone &"): " & f.IsApplicable(cone)
   'INFO : "LargeMesh.IsApplicable(cone): True"

end if

Autodesk Softimage v7.5