OGA Define
pw:: | OGA Define |
Static Actions | |
getTopLevel | This action gets the top-level node for the current overset assembler. |
getDefinitionFileName | This action returns true if an input definition file exists. |
getContainerNodeTypeNames | This action returns the type names of the container elements for the current overset assembler. |
getGridNodeTypeName | This action returns the type name of the grid element for the current overset assembler. |
getNodeByDisplayName | This action gets a node by its display name. |
getContainerNodes | This action returns a list of container nodes in the tree |
Instance Actions | |
getParent | This action gets the parent for this node. |
addChild | This action adds a child node to the node hierarchy. |
removeChild | This action removes the specified node from the parent which causes the specified node to be deleted. |
getChildCount | This action gets the number of children for this node. |
getChild | This action gets the child at the given index or name. |
getChildren | This action gets the children for this node. |
getUnusedChildNames | This action returns the list of possible children. |
resetBodyNames | This action ensures that all children that are container nodes have unique display names. |
getAttributes | This action returns the list of required or optional attributes for a node in the hierarchy. |
getAttributeType | This action returns the type of the attribute for a specified node. |
getAttributeValue | This action gets the value of the given attribute. |
setAttributeValue | This action sets the given attribute with the specified value |
setEntity | This action sets the grid entity linked to a node of the hierarchy. |
getEntity | This action gets the grid entity linked to a node of the hierarchy. |
getXML | This action returns the object as an XML string. |
saveXML | This action saves the object to disk. |
setFromXML | This action sets the contents of the node from an XML string or file. |
copy | This action returns a copy of the object. |
canDelete | This action checks whether a node is required by its parent node. |
delete | This action deletes the node and all its children. |
clear | This action deletes all children and resets all attributes of a node. |
getBaseName | This action returns the base name for the element |
getDisplayName | This action returns the ‘display’ name for the element |
getElementId | This action returns the element ID |
getDocumentation | This action returns the documentation for the element |
getAttributeValueIndex | This action returns index for a value in a list of values |
getEntityNodes | This action returns a list of nodes that have entity references |
Body Motion Actions | |
hasBodyMotionData | This action indicates if the node has body motion data assigned to it. |
supportsBodyMotionData | This action indicates if the node supports body motion data. |
setBodyInertialSystemOrigin | Set the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system |
getBodyInertialSystemOrigin | Get the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system |
setBodyInertialSystemRotation | Set the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system |
getBodyInertialSystemRotation | Get the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system |
importBodyMotionData | This action imports the translation, rotation, and time body motion data from a csv file. |
clearBodyMotionData | This action clears the body motion data linked to a node of the hierarchy. |
getBodyMotionRotation | This action returns the local rotation specified for the body at the given time or position index. |
setBodyMotionScaleFactor | This action sets the translational or rotational scale factor for the body motion data |
getBodyMotionScaleFactor | This action gets the translational or rotational scale factor for the body motion data |
getBodyMotionTransformMatrix | This action returns the total transformation matrix corresponding to the body motion linked to a node of the hierarchy. |
getBodyMotionTranslation | This action returns the local translation specified for the body at the given time or position index. |
getBodyMotionData | This action returns the local translation and rotation specified for the body at the given time or position index. |
getBodyMotionStepsCount | This action returns the number of predefined positions of the grid entities linked to a node of the hierarchy. |
getBodyMotionTimes | This action returns a list of the time stamps for each predefined position. |
pw::OversetNode getTopLevel
This action gets the top-level node for the current overset assembler. The top-level node is created if it does not exist.
None
This action returns the top-level pw::OversetNode object.
pw::OversetNode getDefinitionFileName
This action returns true if an input definition file exists.
None.
This action returns a string representing the name of the input definition file for the current overset assembler.
This action returns the type names of the container elements for the current overset assembler. The container elements are used to build the hierarchical organization of component grids.
None.
This action returns the type names <string list> of the container elements for the current overset assembler.
pw::OversetNode getGridNodeTypeName
This action returns the type name of the grid element for the current overset assembler. The grid element associates a component grid with a container element.
None.
This action returns the type name string of the grid element for the current overset assembler.
pw::OversetNode getNodeByDisplayName ?-body? displayName
This action gets a node by its display name.
-body | This optional flag indicates that only body nodes should be considered. |
displayName | This parameter is a string with the display name. |
This action returns a pw::OversetNode node.
Code
pw::GlyphOversetNode getNodeByDisplayName ?-body?
displayName
pw::OversetNode getContainerNodes
This action returns a list of container nodes in the tree
None.
This action returns a list of pw::OversetNode objects in the tree that are container nodes.
$node getParent
This action gets the parent for this node.
None.
This action returns a pw::OversetNode object.
$node addChild node_or_type
This action adds a child node to the node hierarchy. The argument may be a valid type name or an existing pw::OversetNode.
node_or_type | This parameter is an existing pw::OversetNode object or a string specifying the new node’s element type. |
This action returns the added pw::OversetNode object.
$node removeChild child
This action removes the specified node from the parent which causes the specified node to be deleted.
child | This parameter is an existing pw::OversetNode object (which is deleted as a result of being removed) |
This action returns the parent pw::OversetNode object.
$node getChildCount
This action gets the number of children for this node.
None.
This action returns the integer number of child nodes.
$node getChild ?< -index | -name >? value
This action gets the child at the given index or name.
-index | This optional parameter indicates that the value is the integer index of the child to be returned [1, number of child nodes]. This is the default. |
-name | This optional parameter indicates that the value is the string type name of the child to return. If there is more than one child of the requested type, the first one will be returned. |
value | This parameter is the index or name of the child to be returned. |
This action returns a pw::OversetNode object.
$node getChildren
This action gets the children for this node.
None.
This action returns a list pw::OversetNode of child nodes.
$node getAttributes ?< -required | -optional >?
This action returns the list of required or optional attributes for a node in the hierarchy.
-required | This optional flag returns the required attributes. This is the default. |
-optional | This optional flag returns the optional attributes. |
This action returns a string array of the requested attributes.
$node getAttributeValue name
This action gets the value of the given attribute. It may be empty.
name | attribute name string |
This action returns the value (possibly empty). No indication is given if the attrribute is not an attribute of the element. That should be determined by using the pw::OversetNode getAttributes call
$node setEntity < entity | entity_instance >
This action sets the grid entity linked to a node of the hierarchy.
entity | The pw::GridEntity to link. The entity must be in the active pw::Framework. |
entity_instance | This 2 element list should specify a pw::Framework path and a pw::GridEntity in that path. |
This action returns true if successful.
$node getEntity ?-path?
This action gets the grid entity linked to a node of the hierarchy.
path | If this argument is specified, the return value is a two element list with the pw::Framework path containing the entity as the first element and the entity as the second element. If this argument is not specified, the return value is simply the entity. |
If no grid entity is associated with the node, an empty string value is returned. Otherwise, the action returns a pw::GridEntity object if the “-path” option is not specified, or a two element list consisting of the pw::Framework path and the pw::GridEntity object.
$node getXML
This action returns the object as an XML string.
None.
This action returns the object as a well-formed XML string.
$node saveXML file_name
This action saves the object to disk.
file_name | This parameter is a string representing the path name of the XML file to save |
This action returns true if the file was saved.
$node setFromXML ?< -xml | -file >? xml_or_file
This action sets the contents of the node from an XML string or file.
-xml | This optional flag indicates that the value is a well-formed XML string. This is the default. |
-file | This optional flag indicates that the value is a path to a file that contains well-formed XML |
xml_or_file | This parameter is a string containing XML or file path used to set the contents of the node |
This action returns true if the object was updated from the XML string or file.
$node copy
This action returns a copy of the object.
None.
This action returns a copy of the node including children as new pw::OversetNode object. The copied node does not have a parent node.
$node canDelete
This action checks whether a node is required by its parent node.
None.
This action returns a boolean indicating whether the node can be removed from its parent node.
$node getAttributeValueIndex name value
This action returns index for a value in a list of values
name | This parameter is the string attribute name |
value | This parameter is the string attribute value |
This action returns the index of the given value in the list of values defined for this attribute
$node getEntityNodes
This action returns a list of nodes that have entity references
None.
This action returns a list of pw::OversetNode nodes.
$node hasBodyMotionData
This action indicates if the node has body motion data assigned to it.
None.
This action returns a boolean where true if the node has body motion data assigned to it, false if it doesn’t.
Code
$node hasBodyMotionData
This action indicates if the node supports body motion data.
None.
This action returns a boolean where true if the node supports body motion data, false if it doesn’t.
Code
$node supportsBodyMotionData
$node setBodyInertialSystemOrigin bodySysOrigin
Set the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system
bodyOrigin | This parameter is an xyz vector indicating the location of the body origin with respect to the parent inertial coordinate system. |
This action returns nothing.
Code
$node setBodySystemOrigin bodySysOrigin
$node getBodyInertialSystemOrigin
Get the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system
There are no parameters.
This action returns an xyz vector.
Code
$node getBodyInertialSystemOriginn
$node setBodyInertialSystemRotation bodySysRotation
Set the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system
bodyRotation | This parameter is a xyz vector indicating the rotation of the body inertial coordinate system with respect to the parent inertial coordinate system in degrees. |
This action returns nothing.
Code
$node setBodyInertialSystemRotation bodySysRotation
$node getBodyInertialSystemRotation
Get the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system
There are no parameters.
This action returns an xyz vector.
Code
$node getBodyInertialSystemRotation
$node importBodyMotionData fileName
This action imports the translation, rotation, and time body motion data from a csv file.
fileName | A string with the input file name |
This action returns nothing.
Code
$node importBodyMotionData fileName
$node clearBodyMotionData
This action clears the body motion data linked to a node of the hierarchy.
There are no parameters.
This action returns a boolean where true if body motion was deleted and false otherwise.
Code
$node clearBodyMotionData
$node getBodyMotionRotation ?-scaleFactor? < -index positionIndex | -time time >
This action returns the local rotation specified for the body at the given time or position index. The value is obtained directly from the specified body motion data for the node via importBodyMotionData and does not include motion data from parent nodes.
-scaleFactor | Flag indicating if the retrieved data should be affected by its scale factor. If true, the data will be multiplied by the rotation scale factor, otherwise it will not. |
-index positionIndex | This parameter is an integer indicating the position index. |
-time time | This parameter is a float indicating the position time. |
This action returns a vector representing the rotation about the X-, Y-, and Z-axes.
Code
$node getBodyMotionRotation -scaleFactor -time 2.0
$node setBodyMotionScaleFactor < -translation | -rotation > scaleFactor
This action sets the translational or rotational scale factor for the body motion data
scaleFactor | This parameter is a <real> indicating the scale factor. |
-translation | This optional flag indicates that the scale factor is to be applied to translational motion. |
-rotation | This optional flag indicates that the scale factor is to be applied to rotational motion. |
This action returns nothing.
Code
$node setBodyMotionScaleFactor < -translation | -rotation >
scaleFactor
$node getBodyMotionScaleFactor < -translation | -rotation >
This action gets the translational or rotational scale factor for the body motion data
-translation | This optional flag indicates that the scale factor is to be applied to translational motion. |
-rotation | This optional flag indicates that the scale factor is to be applied to rotational motion. |
This action returns the <real> scale factor.
Code
$node getBodyMotionScaleFactor < -translation | -rotation >
$node getBodyMotionTransformMatrix < -index positionIndex | -time time > ?topNode?
This action returns the total transformation matrix corresponding to the body motion linked to a node of the hierarchy.
-index positionIndex | This parameter is an integer indicating the position index. |
-time time | This parameter is a float indicating the position time. |
topNode | This optional parameter is a string indicating the display name of a parent body. The transformation matrix will be calculated relative to the inertial frame of the parent body. If not specified, the transformation will be calculated relative to the global inertial frame of reference. |
This action returns a <xformmatrix>.
Code
$node getBodyMotionTransformMatrix -index 2 $ogaParent
$node getBodyMotionTranslation ?-scaleFactor? < -index positionIndex | -time time >
This action returns the local translation specified for the body at the given time or position index. The value is obtained directly from the specified body motion data for the node via importBodyMotionData and does not include motion data from parent nodes.
-scaleFactor | Flag indicating if the retrieved data should be affected by its scale factor. If true, the data will be multiplied by the translation scale factor, otherwise it will not. |
-index positionIndex | This parameter is an integer indicating the position index. |
-time time | This parameter is a float indicating the position time. |
This action returns a vector representing the translation X-, Y-, and Z-components.
Code
$node getBodyMotionTranslation -scaleFactor -time 2.0
$node getBodyMotionData ?-scaleFactor? < -index positionIndex | -time time | -all >
This action returns the local translation and rotation specified for the body at the given time or position index. The value is obtained directly from the specified body motion data for the node via importBodyMotionData and does not include motion data from parent nodes. If the -all flag is specified, this function returns an array of arrays with the all the translation, rotation, and time body motion data.
-scaleFactor | Flag indicating if the retrieved data should be affected by their respective scale factors. If true, the data will be multiplied by the scale factors, otherwise it will not. |
-index positionIndex | This parameter is an integer indicating the position index. -time time- This parameter is a float indicating the position time. |
-all | Flag indicating that all the body motion data is required. |
This action returns a list consisting of three elements. The forst two elements are a list of xyz vectors indicating the specified body translation and rotation respectively, the third element is a list of <real> values indicating the specified motion times.
Code
$node getBodyMotionData -scaleFactor -time 2.0
$node getBodyMotionStepsCount
This action returns the number of predefined positions of the grid entities linked to a node of the hierarchy.
There are no parameters.
This action returns an integer.
Code
$node getBodyMotionStepsCount
$node getBodyMotionTimes
This action returns a list of the time stamps for each predefined position.
There are no parameters.
This action returns a list of <real> values.
Code
set i 1 puts "Predefined times:" foreach t [$node getBodyMotionTimes] { puts " $i: $t" incr i }
This action gets the top-level node for the current overset assembler.
pw::OversetNode getTopLevel
This action returns true if an input definition file exists.
pw::OversetNode getDefinitionFileName
This action returns the type name of the grid element for the current overset assembler.
pw::OversetNode getGridNodeTypeName
This action gets a node by its display name.
pw::OversetNode getNodeByDisplayName ?-body? displayName
This action returns a list of container nodes in the tree
pw::OversetNode getContainerNodes
This action gets the parent for this node.
$node getParent
This action adds a child node to the node hierarchy.
$node addChild node_or_type
This action removes the specified node from the parent which causes the specified node to be deleted.
$node removeChild child
This action gets the number of children for this node.
$node getChildCount
This action gets the child at the given index or name.
$node getChild ?< -index | -name >? value
This action gets the children for this node.
$node getChildren
This action returns the list of possible children.
$node getUnusedChildNames
This action ensures that all children that are container nodes have unique display names.
$node resetBodyNames
This action returns the list of required or optional attributes for a node in the hierarchy.
$node getAttributes ?< -required | -optional >?
This action returns the type of the attribute for a specified node.
$node getAttributeType name
This action gets the value of the given attribute.
$node getAttributeValue name
This action sets the given attribute with the specified value
$node setAttributeValue name value
This action sets the grid entity linked to a node of the hierarchy.
$node setEntity < entity | entity_instance >
This action gets the grid entity linked to a node of the hierarchy.
$node getEntity ?-path?
This action returns the object as an XML string.
$node getXML
This action saves the object to disk.
$node saveXML file_name
This action sets the contents of the node from an XML string or file.
$node setFromXML ?< -xml | -file >? xml_or_file
This action returns a copy of the object.
$node copy
This action checks whether a node is required by its parent node.
$node canDelete
This action deletes the node and all its children.
$node delete
This action deletes all children and resets all attributes of a node.
$node clear
This action returns the base name for the element
$node getBaseName
This action returns the ‘display’ name for the element
$node getDisplayName
This action returns the element ID
$node getElementId
This action returns the documentation for the element
$node getDocumentation
This action returns index for a value in a list of values
$node getAttributeValueIndex name value
This action returns a list of nodes that have entity references
$node getEntityNodes
This action indicates if the node has body motion data assigned to it.
$node hasBodyMotionData
Set the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system
$node setBodyInertialSystemOrigin bodySysOrigin
Get the initial location (XYZ) of the body inertial coordinate system wrt the parent inertial coordinate system
$node getBodyInertialSystemOrigin
Set the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system
$node setBodyInertialSystemRotation bodySysRotation
Get the initial rotation of the body inertial coordinate system with respect to the parent inertial coordinate system
$node getBodyInertialSystemRotation
This action imports the translation, rotation, and time body motion data from a csv file.
$node importBodyMotionData fileName
This action clears the body motion data linked to a node of the hierarchy.
$node clearBodyMotionData
This action returns the local rotation specified for the body at the given time or position index.
$node getBodyMotionRotation ?-scaleFactor? < -index positionIndex | -time time >
This action sets the translational or rotational scale factor for the body motion data
$node setBodyMotionScaleFactor < -translation | -rotation > scaleFactor
This action gets the translational or rotational scale factor for the body motion data
$node getBodyMotionScaleFactor < -translation | -rotation >
This action returns the total transformation matrix corresponding to the body motion linked to a node of the hierarchy.
$node getBodyMotionTransformMatrix < -index positionIndex | -time time > ?topNode?
This action returns the local translation specified for the body at the given time or position index.
$node getBodyMotionTranslation ?-scaleFactor? < -index positionIndex | -time time >
This action returns the local translation and rotation specified for the body at the given time or position index.
$node getBodyMotionData ?-scaleFactor? < -index positionIndex | -time time | -all >
This action returns the number of predefined positions of the grid entities linked to a node of the hierarchy.
$node getBodyMotionStepsCount
This action returns a list of the time stamps for each predefined position.
$node getBodyMotionTimes