Geometry Module

2 min read

Table of Contents

DoTranslationalRepeat #

This function performs a translational repeat operation on selected entities along a linear path.

Parameters:

  • [in] varLinkBays: Boolean parameter to specify whether to generate new members between each step in the direction of the repeat (1/True = Link Bays, 0/False = Otherwise).
  • [in] varOpenBase: Boolean parameter to specify not to generate linking members at the base of the structure (1/True = Open base, 0/False = Otherwise).
  • [in] varAxisDir: Long value to specify the direction in the global axis along which the translational repeat operation is to be performed (GX = 0, GY = 1, GZ = 2).
  • [in] varSpacingArray: Array of Double to specify spacing between generated bays (size of array = varNoBays).
  • [in] varNoBays: Long parameter to specify the number of generated bays (maximum = 100).
  • [in] varRenumberBay: Boolean parameter to specify whether to use a user-specified starting number for members generated in each newly generated bay (1/True = Renumber, 0/False = Otherwise).
  • [in] varRenumberArray: Array of Long to specify starting member numbers for each newly generated bay (size of array = varNoBays). Can be Null if varRenumberBay is 0.
  • [in] varGeometryOnly: Boolean parameter to specify whether only geometry data is to be copied (1/True = Copy geometry only, 0/False = Copy all).

Return Values:

  • 1: Translational repeat operation is successful.
  • 0: Translational repeat operation is unsuccessful.

VBA Syntax:

vbaCopy codeDim spacingArr(1) As Double
spacingArr(0) = 10
spacingArr(1) = 12
Dim retVal As Variant
'Do translational repeat on selected members.
retVal = objOpenStaad.Geometry.DoTranslationalRepeat(1, 1, 3, spacingArr, 2, 0, Null, 0)

GetFlagForHiddenEntities #

This function retrieves the flag specified for consideration of hidden entities (nodes and plates) when counting or listing them.

Return Values:

  • 0: Consider all entities (default).
  • 1: Ignore hidden entities.
  • 2: Consider only hidden entities.

VBA Syntax:

'Gets flag for consideration of hidden entities.
Dim rValue As Long
rValue = objOpenStaad.Geometry.GetFlagForHiddenEntities()

HasHiddenEntities #

This function checks if there are any hidden plates in the model.

Return Values:

  • 1: Hidden plates are available.
  • 0: No hidden plates are present in the model.

VBA Syntax:

'Check if there are hidden plates in the model.
Dim rValue As Long
rValue = objOpenStaad.Geometry.HasHiddenEntities()

SetFlagForHiddenEntities #

This function sets the flag for consideration of hidden entities (nodes and plates) when counting or listing them.

Parameters:

  • [in] nFlagValue: The flag value:
    • 0: Consider all entities (default).
    • 1: Ignore hidden entities.
    • 2: Consider only hidden entities.

VBA Syntax:

'Set flag to ignore hidden entities.
objOpenStaad.Geometry.SetFlagForHiddenEntities 1
OpenSTAAD
What are your Feelings