ThreeDModel Object

Description

The ThreeDModel object allows for high fidelity control of an imported 3D model file. The 3D model can be displayed on a Spacecraft in a 3D view. Use the Spacecraft.SetThreeDModel(ThreeDModel) method to assign the ThreeDModel object to the calling Spacecraft.

Inheritance Hierarchy: Object->ThreeDModel

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
BoundingBox	The vector that defines the length, width, and height of the bounding box that contains all the points in the 3D model file, measured from the model origin to the furthest edge.	Type: Array Access: Read-Only Units: km
CullBackFaces	Indicates whether the rear-facing polygons of a 3D model will be not be drawn. This may increase the drawing performance for most models by ignoring polygons that are not visible to the viewer.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
ModelFilename	The filename of the 3D model to import.	Type: String Access: Read/Write
ModelFormat	Shows the currently loaded file format. If no file has been loaded, Unknown(-1) is displayed.	Type: Variable Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
OrientationOffset	The attitude quaternion vector that defines the orientation of the ThreeDModel with respect to the the Body Coordinate System of the owner object.	Type: Array Access: Read/Write
PositionOffset	The vector representing the ThreeDModel, referenced to the Body Coordinate System of the owner object.	Type: Array Access: Read/Write Units: km
Scale	A scale factor to increase or decrease the size of the ThreeDModel's implicit dimensions, such as those returned when using the ThreeDModel.GetGroupBoundingBox method. The Scale property assumes the model dimensions are in units of meters similar to the Spacecraft.BodyScale property. If, for example, the Spacecraft.BodyScale is set to 1, the ThreeDModel.Scale will have to be set to 1 in order to make bounding boxes coincide with the model.	Type: Variable Access: Read/Write
SmoothingAngle	Angle that defines at what point normals are averaged for faces with shared vertices.	Type: Variable Access: Read/Write Units: deg

Name	Description
AddGroup	Create an element or a group which contains elements for which position and orientation offsets can be applied.
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetGroupBoundingBox	Calculates the bounding box of the vertices for a defined group. Returns the volume of the box.
GetGroupVisibility	Gets the visibility parameter for the group specified.
GetModelBoundingBox	Calculates the bounding box of the vertices for the entire ThreeDModel. Returns the volume of the box in km^3.
GetTransformedGroupOrientation	Get the absolute orientation, as a quaternion, of the group after all transformations are applied to a pivot point with respect to the Spacecraft BCS.
GetTransformedGroupPosition	Get the absolute position of the group pivot point after all transformations are applied, referenced to the Spacecraft BCS.
LoadModel	Loads a 3D model into the ThreeDModel object.
MoveGroup	Move an element or group which contains elements for which position and orientation offsets can be applied.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveGroup	Removes a group from the ThreeDModel. If any 3D data was associated with the group, it will be removed as well.
ReportGroupChildren	Returns the names of the immediate children of the specified group.
ReportGroupDescendants	Returns the names of all descendants of the specified group.
ReportGroupParent	Returns the name of the direct parent of the specified group.
ReportGroupTree	Returns the groups associated with the ThreeDModel object.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetGroupOrientation	Set the orientation offset with respect to the Spacecraft BCS for all elements in the 3D model file that are contained within the specified group.
SetGroupPivotPosition	Set the position of the pivot point about which rotations are applied. This point is defined in absolute model coordinates.
SetGroupTransformation	Set the total position and orientation offset for all elements in the 3D model file that are contained within the specified group.
SetGroupTranslation	Set the translational offset for all elements in the 3D model file that are contained within the specified group.
SetGroupVisibility	Sets the visibility parameter for the group specified. Setting a group to false will prevent any child groups from being shown.

Name

Description

Attributes

BoundingBoxHeight

The height of the bounding box that contains all the points in the 3D model file.

This property has been Deprecated. Please use BoundingBox instead.

Type: Variable

Access: Read-Only

BoundingBoxLength

The length of the bounding box that contains all the points in the 3D model file.

This property has been Deprecated. Please use BoundingBox instead.

Type: Variable

Access: Read-Only

BoundingBoxWidth

The width of the bounding box that contains all the points in the 3D model file.

This property has been Deprecated. Please use BoundingBox instead.

Type: Variable

Access: Read-Only

ModelOffsetQ1

The first vector component of the attitude quaternion that defines the orientation of the ThreeDModel with respect to the the Body Coordinate System of the owner object.

This property has been Deprecated. Please use OrientationOffset instead.

Type: Variable

Access: Read/Write

ModelOffsetQ2

The second vector component of the attitude quaternion that defines the orientation of the ThreeDModel with respect to the the Body Coordinate System of the owner object.

This property has been Deprecated. Please use OrientationOffset instead.

Type: Variable

Access: Read/Write

ModelOffsetQ3

The third vector component of the attitude quaternion that defines the orientation of the ThreeDModel with respect to the the Body Coordinate System of the owner object.

This property has been Deprecated. Please use OrientationOffset instead.

Type: Variable

Access: Read/Write

ModelOffsetQ4

The scalar component of the attitude quaternion that defines the orientation of the ThreeDModel with respect to the the Body Coordinate System of the owner object.

This property has been Deprecated. Please use OrientationOffset instead.

Type: Variable

Access: Read/Write

ModelOffsetX

The Cartesian X-component of the ThreeDModel's position vector, referenced to the Body Coordinate System of the owner object.

This property has been Deprecated. Please use PositionOffset instead.

Type: Variable

Access: Read/Write

Units: km

ModelOffsetY

The Cartesian Y-component of the ThreeDModel's position vector, referenced to the Body Coordinate System of the owner object.

This property has been Deprecated. Please use PositionOffset instead.

Type: Variable

Access: Read/Write

Units: km

ModelOffsetZ

The Cartesian Z-component of the ThreeDModel's position vector, referenced to the Body Coordinate System of the owner object.

This property has been Deprecated. Please use PositionOffset instead.

Type: Variable

Access: Read/Write

Units: km

ModelScale

A scale factor to increase or decrease the size of the ThreeDModel's implicit dimensions, such as those returned when using the ThreeDModel.GetGroupBoundingBox method. The ModelScale property assumes the model dimensions are in units of kilometers, unlike the Spacecraft.BodyScale property, which applies the dimensions as meters. If, for example, the Spacecraft.BodyScale is set to 1, the ThreeDModel.ModelScale will have to be set to 0.001 in order to make bounding boxes coincide with the model.

This property has been Deprecated. Please use ThreeDModel.Scale instead.

Type: Variable

Access: Read/Write