DSLoadDefinition Object


Description

DSLoadDefinition Object.

Methods

Name Description
Copy Creates a copy of this DSLoadDefinition object. The new DSLoadDefinition object is independent of any load. It can edited and used as input to edit an existing load or to create a new load. Creating a copy of a definition, editing it, and then assigning it back to the load can be a more efficient way of editing multiple inputs because it results in a single recompute.
SetByMagnitudeAndDirection Specifies the direction and magnitude of this load to be defined by a magnitude value and a direction defined by an entity.
SetByVector Specifies the direction and magnitude of this load to be defined by the x, y, z components of a vector.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
DirectionEntity
GlyphColor
GlyphScale
IsAssociativeLoadDirection
IsDefinedByVectorComponents
IsDirectionEntityNaturalDirection
IsDisplayed
IsSuppressed
Location Gets the location of the load. The location is defined by specifying geometry and the location coordinate is inferred from the selected geometry. This provides that inferred coordinate regardless of the entity that was used to specify the location.
LocationEntity
Magnitude

Gets the DSValue object that defines the magnitude of the load. The value of the magnitude can be accessed through the returned DSValue object.

This property returns Nothing in the case where the IsDefinedByVectorComponents is True. To change the definition of the load to be defined by a magnitude and direction use the SetByMagnitudeAndDirection method.

Setting the magnitude using the SetValueUsingArray method of the DSValue object is currently limited to motion, magnitude, and x,y,z coordinates.

Parent Gets the parent DSLoad object this definition object is associated with. If this definition is not associated with a load then this property returns Nothing.
Type Returns an ObjectTypeEnum indicating this object's type.
Vector Gets a Vector indicating the vector of the load. This can be used to get the load vector regardless of whether it has been defined using geometry or the x, y, z, components.
VectorXComponent Gets the DSValue object that defines the X component of the vector. This property returns Nothing in the case where the IsDefinedByVectorComponents is False. To change the definition of the load to be defined by a vector use the SetByVector method.
VectorYComponent Gets the DSValue object that defines the Y component of the vector. This property returns Nothing in the case where the IsDefinedByVectorComponents is False. To change the definition of the load to be defined by a vector use the SetByVector method.
VectorZComponent Gets the DSValue object that defines the Z component of the vector. This property returns Nothing in the case where the IsDefinedByVectorComponents is False. To change the definition of the load to be defined by a vector use the SetByVector method.

Accessed From

DSLoad.Definition, DSLoadDefinition.Copy

Version

Introduced in version 2013