InventorGuard

MacroModule

author

Christian Schumann

package

FMEstable/ReleaseMeVis

definition

InventorGuard.def

see also

SoNodeFilter, SoActionFilter, SoIdentifier

keywords

inventor, guard, node, filter

Purpose

This node is useful if your inventor network / prototype uses inventor filtering (see SoNodeFilter). It adds an identifier to the child graph. The Output can not be used directly. Instead, the guard is searched by a SoNodeFilter using the identifier. If found, the child graph is added to the output of the SoNodeFilter. Even then, not everything can be done with the found graph. The InventorGuard defines which actions will be forwarded to its child graph.

Usage

Use this as a root for your visualization graph, for example inside a visualization macro. The self output could be the output of the macro. At first sight, it will seem as is nothing is outputted at that field. This is because only the identifier is output and it is only visible to SoSearchActions. Use a SoNodeFilter to search for the guard. The output of these nodes will then be visible depending on the action enable settings of the guard. The SoNodeFilter may be used in your viewer macro for example.

Details

Combines SoIdentifier and SoActionFilter such, that the child graph can not be added directly to the scene. Instead, the guard has to be searched using a SoNodeFilter. For the added child, every action can be activated separately.

Windows

Default Panel

../../../Projects/SoFilter/Modules/mhelp/Images/Screenshots/InventorGuard._default.png

Input Fields

child

name: child, type: SoNode

The child graph

Output Fields

self

name: self, type: SoNode

Add this to a graph that is filtered by a SoNodeFilter

Parameter Fields

Field Index

Enable: Bool

Enable Ray Pick: Bool

Enable Callback: Bool

Enable Search: Bool

Enable Get Bounding Box: Bool

Enable Write: Bool

Enable Get Matrix: Bool

hasParent: Bool

Enable GLRender: Bool

Identifier: String

Enable GLRender Below Path: Bool

Identifier Mode: Enum

Enable Handle Event: Bool

Internal Identifier: String

Enable Pick: Bool

Show Hint: Bool

Visible Fields

Enable

name: enable, type: Bool, default: TRUE

If false, the guard and everything below cannot be found.

Identifier

name: identifier, type: String

Id of internal SoIdentifier. Can be searched by SoNodeFilter

Internal Identifier

name: internalIdentifier, type: String, persistent: no

Id of internal SoIdentifier. Can be searched by SoNodeFilter.

Identifier Mode

name: identifierMode, type: Enum, default: Manual

Determines how the identifier is defined

Values:

Title

Name

Description

​Manual

​Manual

​Define identifier manually

​Name

​Name

​Use module name as identifier

​Parent Name

​ParentName

​Use parent name as identifier

Show Hint

name: showHint, type: Bool, default: TRUE

If true, the self output contains a text hint

Enable GLRender

name: enableGLRender, type: Bool, default: TRUE

Define if GLRender action is forwarded to the child graph

Enable GLRender Below Path

name: enableGLRenderBelowPath, type: Bool, default: TRUE

Define if enableGLRenderBelowPath action is forwarded to the child graph

Enable Handle Event

name: enableHandleEvent, type: Bool, default: TRUE

Define if HandleEvent action is forwarded to the child graph

Enable Pick

name: enablePick, type: Bool, default: TRUE

Define if Pick action is forwarded to the child graph

Enable Ray Pick

name: enableRayPick, type: Bool, default: TRUE

Define if RayPick action is forwarded to the child graph

Enable Get Bounding Box

name: enableGetBoundingBox, type: Bool, default: TRUE

Define if GetBoundingBox action is forwarded to the child graph

Enable Callback

name: enableCallback, type: Bool, default: TRUE

Define if Callback action is forwarded to the child graph

Enable Get Matrix

name: enableGetMatrix, type: Bool, default: TRUE

Define if GetMatrix action is forwarded to the child graph

Enable Write

name: enableWrite, type: Bool, default: TRUE

Define if Write action is forwarded to the child graph

Hidden Fields

hasParent (hidden)

name: hasParent, type: Bool, persistent: no