class Extents
Extents holds calculated extents, and can be used to fetch extents positions and radius of scenes and selection sets.
Properties
| Property | Description |
|---|
| Name | The name of the Extents object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| AreValid | Returns true if the extents are valid (all bounding box axes are >= 0). |
| GetBoundingBoxMaximum | The superior (maximum) extent. |
| GetBoundingBoxMinimum | The inferior (minimum) extent. |
| GetBoundingSphereCenter | The superior (maximum) extent. |
| GetBoundingSphereRadius | The the radius of the bounding sphere. |
| GetClass | Get the name of the Extents class. (Inherited from Object) |
| HaveVolume | Returns true if the extents are valid and define an actual volume (all axes are > 0). |
| IsA | Returns true if Extents is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the Extents object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the Extents object is valid. (Inherited from Object) |
| NonNull | Returns true if the Extents object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the Extents object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spExtents, and if this is the case, returns the object cast into spExtents. (Inherited from Object) |
Properties details
Name
The name of the Extents object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
AreValid
Returns true if the extents are valid (all bounding box axes are >= 0).
Syntax
Parameters
AreValid takes no parameters.
Return value
Type: bool
Default: false
Syntax
Parameters
AreValid takes no parameters.
Return value
Type: bool
Default: false
Syntax
Parameters
AreValid takes no parameters.
Return value
Type: bool
Default: false
GetBoundingBoxMaximum
The superior (maximum) extent.
Syntax
Parameters
GetBoundingBoxMaximum takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingBoxMaximum takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingBoxMaximum takes no parameters.
Return value
Type: list[float]
GetBoundingBoxMinimum
The inferior (minimum) extent.
Syntax
Parameters
GetBoundingBoxMinimum takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingBoxMinimum takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingBoxMinimum takes no parameters.
Return value
Type: list[float]
GetBoundingSphereCenter
The superior (maximum) extent.
Syntax
Parameters
GetBoundingSphereCenter takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingSphereCenter takes no parameters.
Return value
Type: spRealData
Syntax
Parameters
GetBoundingSphereCenter takes no parameters.
Return value
Type: list[float]
GetBoundingSphereRadius
The the radius of the bounding sphere.
Syntax
Parameters
GetBoundingSphereRadius takes no parameters.
Return value
Type: real
Syntax
Parameters
GetBoundingSphereRadius takes no parameters.
Return value
Type: float
Syntax
Parameters
GetBoundingSphereRadius takes no parameters.
Return value
Type: float
GetClass
Get the name of the Extents class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
HaveVolume
Returns true if the extents are valid and define an actual volume (all axes are > 0).
Syntax
Parameters
HaveVolume takes no parameters.
Return value
Type: bool
Default: false
Syntax
Parameters
HaveVolume takes no parameters.
Return value
Type: bool
Default: false
Syntax
Parameters
HaveVolume takes no parameters.
Return value
Type: bool
Default: false
IsA
Returns true if Extents is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if Extents is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if Extents is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if Extents is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the Extents object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the Extents object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the Extents object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the Extents object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spExtents, and if this is the case, returns the object cast into spExtents. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: Extents
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: Extents
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: Extents
