SoAction.GetPathCode Method

Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to.

Extender API: this api is available to programmers who wish to extend the toolkit. We strongly suggest to use it only in the cases described in the Toolmaker guide such as creating a new class inherited from SoShape. See Open Inventor Toolmaker.

Namespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)

Syntax

C++

Copy

public SoActionPathCodes GetPathCode(
	out SbNativeArray<int> indices
)

Public Function GetPathCode ( 
	<OutAttribute> ByRef indices As SbNativeArray(Of Integer)
) As SoActionPathCodes

public:
SoActionPathCodes GetPathCode(
	[OutAttribute] SbNativeArray<int>^% indices
)

member GetPathCode : 
        indices : SbNativeArray<int> byref -> SoActionPathCodes

Parameters

indices: Type: OIV.Inventor.GenericSbNativeArrayInt32

Return Value

Type: SoActionPathCodes

Remarks

If this returns IN_PATH, indices is set to point to an array of indices corresponding to the children that must be traversed for a correct traversal of all the paths to which the action is being applied. numIndices is set to the number of such children.

Reference

SoAction Class

OIV.Inventor.Actions Namespace