Detailed Description
The Annotation class is a specialized X3DObject used for inserting text annotation in a scene.
- Since:
- 10.5 (2012)
- Example:
- How to add a simple text annotation to a model object.
XSI::Model mymodel = Application().GetActiveSceneRoot().AddModel("MyModel");
Annotation annotation = mymodel.AddAnnotation("This model is annotated");
Application().LogMessage( mymodel.GetName() + " is annotated with " + annotation.GetName() + ": " + CString(annotation.GetParameterValue( "Message" )), siComment );
- See also:
- X3DObject::AddAnnotation
#include <xsi_annotation.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 X3DObject.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from X3DObject.
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 Annotation 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 Annotation object.
Reimplemented from X3DObject.
CString GetURLAt |
( |
LONG |
in_viewid, |
|
|
LONG |
in_xcoord, |
|
|
LONG |
in_ycoord |
|
) |
| const |
Returns the URL string from an annotation at a given view position. Returns an empty string if there is no URL found. This is typically used from a custom tool for invoking a URL embedded in an annotation.
- Parameters:
-
in_viewid | The view ID to query. This is typically available from ToolContext::GetViewIndex. |
in_xcoord | The view X coordinate for the query. |
in_ycoord | The view Y coordinate for the query. |
- Returns:
- The URL string.
The documentation for this class was generated from the following file: