Sign in
2024 Class Back to 2024
C

AreaLoad

Version comparison
2020 2021 2022 2023 2024 2025 2025.3 2026 2027

Members across versions

19 members across 9 versions · 7 added later · 3 removed · 4 changed

Member-name color: stable · changed · removed · obsolete · added later

Member 2020 2021 2022 2023 2024 2025 2025.3 2026 2027
M AreCurveLoopsValid(IList<CurveLoop>)
not yet introduced not yet introduced not yet introduced not yet introduced added same same same same
M Create(Document, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
same same same same missing missing missing missing missing
M Create(Document, IList<CurveLoop>, XYZ, AreaLoadType)
same same same same missing missing missing missing missing
M Create(Document, AnalyticalModelSurface, XYZ, AreaLoadType)
same same same missing missing missing missing missing missing
M Create(Document, ElementId, XYZ, AreaLoadType)
not yet introduced not yet introduced not yet introduced added changed changed same same same
M Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
not yet introduced not yet introduced not yet introduced not yet introduced added changed same same same
M Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)
not yet introduced not yet introduced not yet introduced not yet introduced added changed same same same
M GetLoops
same same same same same same same same same
M GetRefPoint(Int32)
same same same same same same same same same
M IsCurveLoopsInsideHostBoundaries(Document, ElementId, IList<CurveLoop>)
not yet introduced not yet introduced not yet introduced not yet introduced added same same same same
M IsValidHostId(Document, ElementId)
not yet introduced not yet introduced not yet introduced added same same same same changed
M SetLoops(Document, IList<CurveLoop>)
same same same same same same same same same
P Area
same same same same same same same same same
P ForceVector1
same same same same same same same same same
P ForceVector2
same same same same same same same same same
P ForceVector3
same same same same same same same same same
P IsProjected
same same same same same same same same same
P NumRefPoints
same same same same same same same same same
P SketchId
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added

Per-version detail

Click a version below to see what changed in that release vs your current frame (2024).
2024 current

Changes in 2020 vs 2024 3 added 6 missing

Flip API Versions →

Added in 2020 (new since 2024)

Create(Document, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, IList<CurveLoop>, XYZ, AreaLoadType) Create(Document, AnalyticalModelSurface, XYZ, AreaLoadType)

Missing in 2020 (only available in 2024)

AreCurveLoopsValid(IList<CurveLoop>) Create(Document, ElementId, XYZ, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType) IsCurveLoopsInsideHostBoundaries(Document, ElementId, IList<CurveLoop>) IsValidHostId(Document, ElementId)

Changes in 2021 vs 2024 3 added 6 missing

Flip API Versions →

Added in 2021 (new since 2024)

Create(Document, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, IList<CurveLoop>, XYZ, AreaLoadType) Create(Document, AnalyticalModelSurface, XYZ, AreaLoadType)

Missing in 2021 (only available in 2024)

AreCurveLoopsValid(IList<CurveLoop>) Create(Document, ElementId, XYZ, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType) IsCurveLoopsInsideHostBoundaries(Document, ElementId, IList<CurveLoop>) IsValidHostId(Document, ElementId)

Changes in 2022 vs 2024 3 added 6 missing

Flip API Versions →

Added in 2022 (new since 2024)

Create(Document, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, IList<CurveLoop>, XYZ, AreaLoadType) Create(Document, AnalyticalModelSurface, XYZ, AreaLoadType)

Missing in 2022 (only available in 2024)

AreCurveLoopsValid(IList<CurveLoop>) Create(Document, ElementId, XYZ, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType) IsCurveLoopsInsideHostBoundaries(Document, ElementId, IList<CurveLoop>) IsValidHostId(Document, ElementId)

Changes in 2023 vs 2024 2 added 4 missing 1 changed

Flip API Versions →

Added in 2023 (new since 2024)

Create(Document, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, IList<CurveLoop>, XYZ, AreaLoadType)

Missing in 2023 (only available in 2024)

AreCurveLoopsValid(IList<CurveLoop>) Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType) Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType) IsCurveLoopsInsideHostBoundaries(Document, ElementId, IList<CurveLoop>)

Changed members

AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType, Document)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
aDoc Document Document to which new area load will be added.
→ returns nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Changes in 2025 vs 2024 3 changed

Flip API Versions →

Changed members

AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVectors IList<XYZ> The array of force vectors applied to the maximum three reference point of the area load.
refPointCurveIndexes IList<Int32> The array of maximum three curve indexes on which reference points should be placed on.
refPointCurveEnds IList<Int32> The array of maximum three curve ends indicating where reference points should be placed on. The array can have only 0 or 1 values, which means 0 - curve start point, 1 - curve end point.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Changes in 2025.3 vs 2024 3 changed

Flip API Versions →

Changed members

AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVectors IList<XYZ> The array of force vectors applied to the maximum three reference point of the area load.
refPointCurveIndexes IList<Int32> The array of maximum three curve indexes on which reference points should be placed on.
refPointCurveEnds IList<Int32> The array of maximum three curve ends indicating where reference points should be placed on. The array can have only 0 or 1 values, which means 0 - curve start point, 1 - curve end point.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Changes in 2026 vs 2024 3 changed

Flip API Versions →

Changed members

AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVectors IList<XYZ> The array of force vectors applied to the maximum three reference point of the area load.
refPointCurveIndexes IList<Int32> The array of maximum three curve indexes on which reference points should be placed on.
refPointCurveEnds IList<Int32> The array of maximum three curve ends indicating where reference points should be placed on. The array can have only 0 or 1 values, which means 0 - curve start point, 1 - curve end point.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Changes in 2027 vs 2024 1 added 4 changed

Flip API Versions →

Added in 2027 (new since 2024)

SketchId

Changed members

AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, IList<XYZ>, IList<Int32>, IList<Int32>, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVectors IList<XYZ> The array of force vectors applied to the maximum three reference point of the area load.
refPointCurveIndexes IList<Int32> The array of maximum three curve indexes on which reference points should be placed on.
refPointCurveEnds IList<Int32> The array of maximum three curve ends indicating where reference points should be placed on. The array can have only 0 or 1 values, which means 0 - curve start point, 1 - curve end point.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList<CurveLoop> The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to use default type.
→ returns AreaLoad→nullNothingnullptr If successful, returns an object of the newly created AreaLoad. null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
AreaLoad.IsValidHostId(Document, ElementId, Document)
pDoc Document
hostId ElementId
doc Document The document containing both the host and the load.
→ returns Boolean True if an area load can be placed on the input host id.