FormIt Plugin API  v23.0.0 (2023.0.0)
Functions
WSM.GroupInstancePath API
WSM API

Description

Functions

json WSM.GroupInstancePath.IsValid (groupInstancePath)
 
json WSM.GroupInstancePath.GetFinalObjectHistoryID (groupInstancePath)
 GetFinalObjectHistoryID returns the final ObjectHistoryID from the path. More...
 
json WSM.GroupInstancePath.GetTopObjectHistoryID (groupInstancePath)
 GetTopObjectHistoryID returns the top ObjectHistoryID from the path. More...
 
json WSM.GroupInstancePath.AreEqual (path1, path2)
 
json WSM.GroupInstancePath.AppendObjectHistoryID (groupInstancePath, objectHistoryID)
 AppendObjectHistoryID appends the given ObjectHistoryID to the end of the GroupInstancePath In: groupInstancePath WSM.GroupInstancePath In: objectHistoryID WSM.ObjectHistoryID Out: bool. More...
 
json WSM.GroupInstancePath.GetObjectTransform (groupInstancePath)
 GetObjectTransform returns a transform that accounts for the instance transforms, if any. More...
 
json WSM.GroupInstancePath.IsPrefixOf (path1, path2)
 IsPrefixOf returns true if path1 path is a strict prefix of path2. More...
 

Function Documentation

json WSM.GroupInstancePath.AppendObjectHistoryID ( groupInstancePath  ,
objectHistoryID   
)

AppendObjectHistoryID appends the given ObjectHistoryID to the end of the GroupInstancePath In: groupInstancePath WSM.GroupInstancePath In: objectHistoryID WSM.ObjectHistoryID Out: bool.

Parameters
[in]groupInstancePathWSM.GroupInstancePath
[in]objectHistoryIDWSM.ObjectHistoryID
Returns
groupInstancePath
json WSM.GroupInstancePath.AreEqual ( path1  ,
path2   
)
json WSM.GroupInstancePath.GetFinalObjectHistoryID ( groupInstancePath  )

GetFinalObjectHistoryID returns the final ObjectHistoryID from the path.

In: groupInstancePath Out: ObjectHistoryID

Parameters
[in]groupInstancePathWSM.GroupInstancePath
Returns
{...}
json WSM.GroupInstancePath.GetObjectTransform ( groupInstancePath  )

GetObjectTransform returns a transform that accounts for the instance transforms, if any.

If the final object is also an instance, this also includes the transform of that instance. In: groupInstancePath Out: transform

Parameters
[in]groupInstancePathWSM.GroupInstancePath
Returns
transf3d
json WSM.GroupInstancePath.GetTopObjectHistoryID ( groupInstancePath  )

GetTopObjectHistoryID returns the top ObjectHistoryID from the path.

In: groupInstancePath Out: ObjectHistoryID

Parameters
[in]groupInstancePathWSM.GroupInstancePath
Returns
{...}
json WSM.GroupInstancePath.IsPrefixOf ( path1  ,
path2   
)

IsPrefixOf returns true if path1 path is a strict prefix of path2.

In: path1, path2 Out: bool

Parameters
[in]path1WSM.GroupInstancePath
[in]path2WSM.GroupInstancePath
Returns
{...}
json WSM.GroupInstancePath.IsValid ( groupInstancePath  )