MouseEventArgs.viewport Property

Parent Object: MouseEventArgs
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/MouseEventArgs.h>

Description

Returns the viewport where the mouse event occurred, if it was within a viewport. If the mouse is not over a viewport this property will return null.

Syntax

"mouseEventArgs_var" is a variable referencing a MouseEventArgs object.

# Get the value of the property.
propertyValue = mouseEventArgs_var.viewport
"mouseEventArgs_var" is a variable referencing a MouseEventArgs object.
#include <Core/UserInterface/MouseEventArgs.h>

// Get the value of the property.
Ptr<Viewport> propertyValue = mouseEventArgs_var->viewport();

Property Value

This is a read only property whose value is a Viewport.

Version

Introduced in version March 2017