Detailed Description
The SchematicNode class represents a UI node as displayed in a Schematic view.
- See also:
- SchematicNode
- Since:
- 10.0 (2012)
- Example:
- Demonstrates how to access all nodes in a Schematic view object.
#include <xsi_schematicnode.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
Copy constructor.
- Parameters:
-
in_obj | constant class object. |
Member Function Documentation
bool IsA |
( |
siClassID |
in_ClassID | ) |
const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from UIObject.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from UIObject.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj | constant class object. |
- Returns:
- The new SchematicNode object.
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref | constant class object. |
- Returns:
- The new SchematicNode object.
Reimplemented from UIObject.
bool IsExpanded |
( |
| ) |
const |
Determine if the node is expanded or not. Children nodes are set as expanded if their parent are also expanded.
- Returns:
- True if expanded, false otherwise.
CStatus PutExpanded |
( |
bool |
in_bState | ) |
|
Set the node as expanded or collapsed.
- Parameters:
-
in_bState | true to expand or false to collapse the node. |
- Returns:
- CStatus::OK
Determine if the node is selected (node or branch).
- Returns:
- Branch flag: siNode (node selected), siBranch (branch selected), siNotSelected (node is not selected). Children nodes are also set as branch selected when the top parent is branch selected.
CStatus Move |
( |
LONG |
in_x, |
|
|
LONG |
in_y |
|
) |
| |
Set the x and y position of the node. The position is in screen coordinates and is relative to the node's schematic view.
- Parameters:
-
in_x | Position in x. |
in_y | Position in y. |
- Returns:
- CStatus::Ok Success
Returns the node's underlying Softimage object.
- Returns:
- Softimage object.
CStatus GetUIInfo |
( |
LONG & |
out_x, |
|
|
LONG & |
out_y, |
|
|
LONG & |
out_w, |
|
|
LONG & |
out_h |
|
) |
| const |
Returns the 2D coordinates and size of the node. Cooordinate units are in screen coordinates and relative to the node's schematic view.
- Parameters:
-
out_x | Position in x. |
out_y | Position in y. |
out_w | Width. |
out_h | Height. |
- Returns:
- CStatus::Ok Success
The documentation for this class was generated from the following file: