Skip to main content

Annotations

Functions for interacting with annotations.

Functions​

TypeName
vrnodevrAnnotationCreate(vrvec3 worldPos, vrvec3 worldRot, vrnode targetNode)
Create an annotation at the specified location, linked to the specified object.
vrnodevrAnnotationCreateComment(vrnode annotation)
Create a comment on an annotation.
vrnodevrAnnotationCreateViewpoint(vrnode annotation)
Create a viewpoint on an annotation.
voidvrAnnotationDelete(vrnode annotation)
Delete an annotation and all associated comments and viewpoints.
voidvrAnnotationDeleteComment(vrnode comment)
Delete a comment from an annotation.
voidvrAnnotationDeleteViewpoint(vrnode viewpoint)
Delete a viewpoint from an annotation.
voidvrAnnotationEditCommentText(vrnode comment)
Activates an interactive editor for editing an annotation comment.
stringvrAnnotationGetCommentText(vrnode comment)
Gets the text from an annotation comment.
tablevrAnnotationListAll()
Lists all annotations in the scene.
tablevrAnnotationListComments(vrnode annotation)
Lists all comments in an annotation.
tablevrAnnotationListViewpoints(vrnode annotation)
Lists all viewpoints in an annotation.
vrnodevrAnnotationNext(number flyTime =0.0)
Flies to and returns the next annotation after the currently active one.
vrnodevrAnnotationPrev(number flyTime =0.0)
Flies to and returns the previous annotation before the currently active one.
voidvrAnnotationSetActive(vrnode annotation, number flyTime =0.0)
Sets the specified annotation as the active one and flies to its default viewpoint.
voidvrAnnotationSetCommentText(vrnode comment, string text)
Sets the text in an annotation comment.
voidvrAnnotationSetDefaultViewpoint(vrnode annotation, vrnode viewpoint)
Sets the default viewpoint for an annotation.
voidvrAnnotationToggleInfoDisplay(vrnode annotation)
Toggles the visibility of annotation comments and other information gizmos.
voidvrAnnotationUpdateViewpoint(vrnode viewpoint)
Recaptures the view from the specified viewpoint.

Functions Documentation​

vrAnnotationCreate​

vrnode vrAnnotationCreate(
    vrvec3 worldPos,
    vrvec3 worldRot,
    vrnode targetNode
)

Create an annotation at the specified location, linked to the specified object.

Parameters:

  • worldPos World location of the annotation point
  • worldRot World rotation of the annotation point
  • targetNode Object being annotated

Return: The new annotation

vrAnnotationCreateComment​

vrnode vrAnnotationCreateComment(
    vrnode annotation
)

Create a comment on an annotation.

Return: The new comment

vrAnnotationCreateViewpoint​

vrnode vrAnnotationCreateViewpoint(
    vrnode annotation
)

Create a viewpoint on an annotation.

Return: The new viewpoint

vrAnnotationDelete​

void vrAnnotationDelete(
    vrnode annotation
)

Delete an annotation and all associated comments and viewpoints.

vrAnnotationDeleteComment​

void vrAnnotationDeleteComment(
    vrnode comment
)

Delete a comment from an annotation.

vrAnnotationDeleteViewpoint​

void vrAnnotationDeleteViewpoint(
    vrnode viewpoint
)

Delete a viewpoint from an annotation.

vrAnnotationEditCommentText​

void vrAnnotationEditCommentText(
    vrnode comment
)

Activates an interactive editor for editing an annotation comment.

vrAnnotationGetCommentText​

string vrAnnotationGetCommentText(
    vrnode comment
)

Gets the text from an annotation comment.

vrAnnotationListAll​

table vrAnnotationListAll()

Lists all annotations in the scene.

Return: List of annotation nodes

vrAnnotationListComments​

table vrAnnotationListComments(
    vrnode annotation
)

Lists all comments in an annotation.

Return: List of comment nodes

vrAnnotationListViewpoints​

table vrAnnotationListViewpoints(
    vrnode annotation
)

Lists all viewpoints in an annotation.

Return: List of viewpoint nodes

vrAnnotationNext​

vrnode vrAnnotationNext(
    number flyTime =0.0
)

Flies to and returns the next annotation after the currently active one.

Parameters:

  • flyTime The number of seconds to spend flying to the viewpoint

vrAnnotationPrev​

vrnode vrAnnotationPrev(
    number flyTime =0.0
)

Flies to and returns the previous annotation before the currently active one.

Parameters:

  • flyTime The number of seconds to spend flying to the viewpoint

vrAnnotationSetActive​

void vrAnnotationSetActive(
    vrnode annotation,
    number flyTime =0.0
)

Sets the specified annotation as the active one and flies to its default viewpoint.

Parameters:

  • flyTime The number of seconds to spend flying to the viewpoint

vrAnnotationSetCommentText​

void vrAnnotationSetCommentText(
    vrnode comment,
    string text
)

Sets the text in an annotation comment.

vrAnnotationSetDefaultViewpoint​

void vrAnnotationSetDefaultViewpoint(
    vrnode annotation,
    vrnode viewpoint
)

Sets the default viewpoint for an annotation.

vrAnnotationToggleInfoDisplay​

void vrAnnotationToggleInfoDisplay(
    vrnode annotation
)

Toggles the visibility of annotation comments and other information gizmos.

vrAnnotationUpdateViewpoint​

void vrAnnotationUpdateViewpoint(
    vrnode viewpoint
)

Recaptures the view from the specified viewpoint.