Python Script Engine  8.3
GL Studio Editor Python Script API
GlsSchematicTeeInterconnect Class Reference
+ Inheritance diagram for GlsSchematicTeeInterconnect:

Public Member Functions

 GlsSchematicTeeInterconnect ()
 
None SetLeftLineThickness (float val)
 
float GetLeftLineThickness (None)
 
None SetRightLineThickness (float val)
 
float GetRightLineThickness (None)
 
None SetTopLineThickness (float val)
 
float GetTopLineThickness (None)
 
None SetBaseLineThickness (float val)
 
float GetBaseLineThickness (None)
 
None SetLeftInterconnectTextureIndex (int interconnectTextureIndex)
 
int GetLeftInterconnectTextureIndex ()
 
None SetRightInterconnectTextureIndex (int interconnectTextureIndex)
 
int GetRightInterconnectTextureIndex ()
 
None SetTopInterconnectTextureIndex (int interconnectTextureIndex)
 
int GetTopInterconnectTextureIndex ()
 
None SetBaseInterconnectTextureIndex (int interconnectTextureIndex)
 
int GetBaseInterconnectTextureIndex ()
 
None SetLeftInterconnectTextureRepeatLength (float interconnectTextureRepeatLength)
 
float GetLeftInterconnectTextureRepeatLength ()
 
None SetRightInterconnectTextureRepeatLength (float interconnectTextureRepeatLength)
 
float GetRightInterconnectTextureRepeatLength ()
 
None SetTopInterconnectTextureRepeatLength (float interconnectTextureRepeatLength)
 
float GetTopInterconnectTextureRepeatLength ()
 
None SetBaseInterconnectTextureRepeatLength (float interconnectTextureRepeatLength)
 
float GetBaseInterconnectTextureRepeatLength ()
 
None SetLeftFlowTextureIndex (int flowTextureIndex)
 
int GetLeftFlowTextureIndex ()
 
None SetRightFlowTextureIndex (int flowTextureIndex)
 
int GetRightFlowTextureIndex ()
 
None SetTopFlowTextureIndex (int flowTextureIndex)
 
int GetTopFlowTextureIndex ()
 
None SetBaseFlowTextureIndex (int flowTextureIndex)
 
int GetBaseFlowTextureIndex ()
 
None SetLeftFlowTextureRepeatLength (float flowTextureRepeatLength)
 
float GetLeftFlowTextureRepeatLength ()
 
None SetRightFlowTextureRepeatLength (float flowTextureRepeatLength)
 
float GetRightFlowTextureRepeatLength ()
 
None SetTopFlowTextureRepeatLength (float flowTextureRepeatLength)
 
float GetTopFlowTextureRepeatLength ()
 
None SetBaseFlowTextureRepeatLength (float flowTextureRepeatLength)
 
float GetBaseFlowTextureRepeatLength ()
 
None SetLeftShowFlow (bool showFlow)
 
bool GetLeftShowFlow ()
 
None SetRightShowFlow (bool showFlow)
 
bool GetRightShowFlow ()
 
None SetTopShowFlow (bool showFlow)
 
bool GetTopShowFlow ()
 
None SetBaseShowFlow (bool showFlow)
 
bool GetBaseShowFlow ()
 
None SetLeftFlowRate (float flowRate)
 
float GetLeftFlowRate ()
 
None SetRightFlowRate (float flowRate)
 
float GetRightFlowRate ()
 
None SetTopFlowRate (float flowRate)
 
float GetTopFlowRate ()
 
None SetBaseFlowRate (float flowRate)
 
float GetBaseFlowRate ()
 
None SetLeftShowFlowBlink (bool showFlowBlink)
 
bool GetLeftShowFlowBlink ()
 
None SetRightShowFlowBlink (bool showFlowBlink)
 
bool GetRightShowFlowBlink ()
 
None SetTopShowFlowBlink (bool showFlowBlink)
 
bool GetTopShowFlowBlink ()
 
None SetBaseShowFlowBlink (bool showFlowBlink)
 
bool GetBaseShowFlowBlink ()
 
None SetLeftFlowBlinkRate (float flowBlinkRate)
 
float GetLeftFlowBlinkRate ()
 
None SetRightFlowBlinkRate (float flowBlinkRate)
 
float GetRightFlowBlinkRate ()
 
None SetTopFlowBlinkRate (float flowBlinkRate)
 
float GetTopFlowBlinkRate ()
 
None SetBaseFlowBlinkRate (float flowBlinkRate)
 
float GetBaseFlowBlinkRate ()
 
None SetLeftFlowBlinkStartColor (GlsColor &startColor)
 
GlsColor GetLeftFlowBlinkStartColor ()
 
None SetRightFlowBlinkStartColor (GlsColor &startColor)
 
GlsColor GetRightFlowBlinkStartColor ()
 
None SetTopFlowBlinkStartColor (GlsColor &startColor)
 
GlsColor GetTopFlowBlinkStartColor ()
 
None SetBaseFlowBlinkStartColor (GlsColor &startColor)
 
GlsColor GetBaseFlowBlinkStartColor ()
 
None SetLeftFlowBlinkEndColor (GlsColor &endColor)
 
GlsColor GetLeftFlowBlinkEndColor ()
 
None SetRightFlowBlinkEndColor (GlsColor &endColor)
 
GlsColor GetRightFlowBlinkEndColor ()
 
None SetTopFlowBlinkEndColor (GlsColor &endColor)
 
GlsColor GetTopFlowBlinkEndColor ()
 
None SetBaseFlowBlinkEndColor (GlsColor &endColor)
 
GlsColor GetBaseFlowBlinkEndColor ()
 
None SetTopVisible (bool topVisible)
 
bool GetTopVisible ()
 
- Public Member Functions inherited from GLPolygon
 GLPolygon (VertexArray &vertices)
 
 GLPolygon (VertexArray &vertices, Vector &location)
 
 GLPolygon (list vertices)
 
 GLPolygon (list vertices, Vector &location)
 
- Public Member Functions inherited from DisplayObject
bool isNULL ()
 
str GetName ()
 
str SetName (str name)
 
None SetProtectionMode (DisplayObject::MemberAccess_e mode)
 
DisplayObject::MemberAccess_e GetProtectionMode (None)
 
None SetLocked (bool val)
 
bool GetLocked (None)
 
bool GetGenerateMemberVariable ()
 
None SetGenerateMemberVariable (bool b)
 
bool GetAntiAliasing ()
 
None SetAntiAliasing (bool antiAliasing)
 
bool GetBlinking ()
 
None SetBlinking (bool blinking)
 
float GetBlinkRate ()
 
None SetBlinkRate (float rate)
 
int GetAlphaMode ()
 
None SetAlphaMode (int mode)
 
bool GetCullBackFaces ()
 
None SetCullBackFaces (bool cullFaces)
 
bool GetZBufferTestedFlag ()
 
None SetZBufferTestedFlag (bool tested)
 
bool GetAffectZBufferFlag ()
 
None SetAffectZBufferFlag (bool affect)
 
bool GetLightingEnabledFlag ()
 
None SetLightingEnabledFlag (bool enabled)
 
DisplayObject::PickableType_e GetPickMode ()
 
None SetPickMode (DisplayObject::PickableType_e mode)
 
bool GetVisibilityFlag ()
 
None SetVisibilityFlag (bool visible)
 
PolygonClose_e GetClosePolygonFlag ()
 
None SetClosePolygonFlag (PolygonClose_e closePolygon)
 
PolygonMode_e GetPolygonMode ()
 
None SetPolygonMode (PolygonMode_e polygonMode)
 
ShadingType_e GetShadingMode ()
 
None SetShadingMode (ShadingType_e shadingMode)
 
Vertex GetLocation ()
 
None SetLocation (Vertex loc)
 
Vertex GetRotationPoint ()
 
None SetRotationPoint (Vertex rotPoint)
 
GlsMatrixAffineGetDcsMatrix ()
 
None SetDcsMatrix (GlsMatrixAffine *matrix)
 
int GetMaterialIndex ()
 
None SetMaterialIndex (int matIndex)
 
str GetObjectClassName ()
 
int GetTextureIndex ()
 
None SetTextureIndex (int texIndex)
 
TextureMap_e GetTextureMappingTechnique ()
 
None SetTextureMappingTechnique (TextureMap_e mappingTechnique)
 
bool GetTextureRepeat ()
 
None SetTextureRepeat (bool repeat)
 
disti::GlsColor GetBlendingColor ()
 
None SetBlendingColor (GlsColor blendColor)
 
DisplayObject::TextureFilter_e GetTextureMagnificationFilter ()
 
None SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
 
DisplayObject::TextureFilter_e GetTextureMinificationFilter ()
 
None SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
 
list GetTextureCoordinates ()
 
None SetTextureCoordinates (list &texVerts)
 
None GetTextureCoordinates (VertexArray *texVerts)
 
None SetTextureCoordinates (VertexArray &texVerts)
 
None GetTexturePoints (VertexArray *texVerts)
 
None SetTexturePoints (VertexArray &texVerts)
 
None SetTexturePoints (list &texVerts)
 
list GetTexturePoints ()
 
None GetVertices (VertexArray *verts)
 
None SetVertices (VertexArray &verts)
 
str GetInitialization ()
 
None SetInitialization (str initCode)
 
str GetCallbackCode ()
 
None SetCallbackCode (str cbCode)
 
DisplayObjectDuplicateObject (Document *doc=NULL)
 
DisplayObjectTessellateObject ()
 
DisplayObjectExtrudeObject (float amount)
 
None RotateObject (float amount, RotationAxis_e axis)
 
None TranslateObject (float x, float y, float z)
 
None ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
 
None LineWidth (float width)
 
float LineWidth ()
 
LineStyle_e LineStyle ()
 
None LineStyle (LineStyle_e style)
 
GlsColor LineColor ()
 
None LineColor (GlsColor color)
 
GlsColor FillColor ()
 
None FillColor (GlsColor color)
 
None GetExtents (Vector &min, Vector &max)
 
bool HasUserDefinedAttribute (str attribName)
 
std::map< str, str > GetUserDefinedAttributes ()
 
UserDefinedValueAttributeList GetAllUserDefinedAttributes ()
 
str GetUserDefinedAttributeValue (str attribName)
 
 typemap (check) str attribName
 
None SetUserDefinedAttributeValue (str attribName, str value)
 
DisplayObjectGetParent ()
 
DocumentGetDocument ()
 
str AlternateClassName ()
 
None AlternateClassName (str name)
 
str GetAlternateClassHeaderFile ()
 
None SetAlternateClassHeaderFile (str name)
 
str GetResources ()
 
str GetRuntimeResources (bool recursive)
 
str GetAttributeType (str attribName)
 
str GetAttributeValuestr (str attribName)
 
None SetAttributeValuestr (str attribName, str value)
 
int RegisterObserver (str attribName, PyObject *pyfunc)
 
None UnregisterObserver (str attribName, int id)
 
list GetNormals ()
 
None SetNormals (list &normals)
 
list GetExtraAttributes ()
 
DisplayObjectCloneObject ()
 
None CopyProperties (DisplayObject *sourceObj)
 
None SetLocation (Vector loc)
 
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
 
None CalculateParentBoundingBox ()
 
None SetOrigin (Vertex &vert)
 

Static Public Member Functions

static GlsSchematicTeeInterconnectCastToGlsSchematicTeeInterconnect (DisplayObject *obj)
 
- Static Public Member Functions inherited from GLPolygon
static GLPolygonCastToGLPolygon (DisplayObject *obj)
 

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  MemberAccess_e {
  PUBLIC ,
  PRIVATE ,
  PROTECTED
}
 
enum  PickableType_e {
  UNPICKABLE ,
  FIRST_PICK ,
  BEST_PICK ,
  ALWAYS_PICK
}
 
enum  PolygonClose_e {
  POLY_OPEN ,
  POLY_CLOSED
}
 
enum  PolygonMode_e {
  POLY_MODE_UNDEFINED ,
  POLY_MODE_POINTS ,
  POLY_MODE_OUTLINE ,
  POLY_MODE_FILLED ,
  POLY_MODE_FILL_AND_OUTLINE
}
 
enum  ShadingType_e {
  SHADING_FLAT ,
  SHADING_GOURAUD
}
 
enum  TextureMap_e {
  TEXTURE_MAP_MODULATE ,
  TEXTURE_MAP_DECAL ,
  TEXTURE_MAP_BLEND ,
  TEXTURE_MAP_REPLACE
}
 
enum  TextureFilter_e {
  TEXTURE_FILTER_NEAREST ,
  TEXTURE_FILTER_LINEAR ,
  TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST ,
  TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR ,
  TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR ,
  TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST
}
 
enum  TessellateType_e {
  TESSELLATE_UNION ,
  TESSELLATE_INTERSECT ,
  TESSELLATE_DIFFERENCE
}
 
enum  RotationAxis_e {
  X_AXIS ,
  Y_AXIS ,
  Z_AXIS
}
 
enum  LineStyle_e {
  SOLID_LINE_STYLE ,
  SMALL_DOTTED_LINE_STYLE ,
  DOTTED_LINE_STYLE ,
  DASHED_LINE_STYLE ,
  DOT_DASHED_LINE_STYLE ,
  SMALL_DASHED_LINE_STYLE
}
 
enum  AlphaMode_e {
  ALPHA_MODE_UNDEFINED ,
  ALPHA_MODE_OPAQUE ,
  ALPHA_MODE_2_LEVEL ,
  ALPHA_MODE_256_LEVEL
}
 
- Static Public Attributes inherited from DisplayObject
static int TEXTURE_INDEX_NONE = -1
 

Detailed Description

Class that encapsulates a GlsSchematicTeeInterconnect.

Constructor & Destructor Documentation

◆ GlsSchematicTeeInterconnect()

GlsSchematicTeeInterconnect::GlsSchematicTeeInterconnect ( )

Constructor.

Creates a GlsSchematicPolyLineInterconnect.

Member Function Documentation

◆ CastToGlsSchematicTeeInterconnect()

static GlsSchematicTeeInterconnect * GlsSchematicTeeInterconnect::CastToGlsSchematicTeeInterconnect ( DisplayObject obj)
static

Casts a display object to a schematic tee interconnect.

Parameters
objThe display object to cast.

◆ GetBaseFlowBlinkEndColor()

GlsColor GlsSchematicTeeInterconnect::GetBaseFlowBlinkEndColor ( )

Get the flow blink end color for the base tee.

Returns
The flow blink end color

◆ GetBaseFlowBlinkRate()

float GlsSchematicTeeInterconnect::GetBaseFlowBlinkRate ( )

Get the flow blink rate in Hz for the base tee.

Returns
The flow blink rate in Hz

◆ GetBaseFlowBlinkStartColor()

GlsColor GlsSchematicTeeInterconnect::GetBaseFlowBlinkStartColor ( )

Get the flow blink start color for the base tee.

Returns
The flow blink start color

◆ GetBaseFlowRate()

float GlsSchematicTeeInterconnect::GetBaseFlowRate ( )

Get the flow rate in "flow textures" / second for the base tee.

Returns
The flow rate in "flow textures" / second

◆ GetBaseFlowTextureIndex()

int GlsSchematicTeeInterconnect::GetBaseFlowTextureIndex ( )

Get the flow texture index for the base tee.

Returns
The flow texture index or NO_TEXTURE if no flow texture

◆ GetBaseFlowTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetBaseFlowTextureRepeatLength ( )

Get the number of logical units per flow texture repeat for the base tee.

Returns
The number of logical units per flow texture repeat

◆ GetBaseInterconnectTextureIndex()

int GlsSchematicTeeInterconnect::GetBaseInterconnectTextureIndex ( )

Get the interconnect texture index of the base tee.

Returns
The interconnect texture index or NO_TEXTURE if no interconnect texture

◆ GetBaseInterconnectTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetBaseInterconnectTextureRepeatLength ( )

Get the number of logical units per interconnect texture repeat for the base tee.

Returns
The number of logical units per interconnect texture repeat

◆ GetBaseLineThickness()

float GlsSchematicTeeInterconnect::GetBaseLineThickness ( None  )

Gets the line thickness of the base tee.

Returns
The line thickness in logical units

◆ GetBaseShowFlow()

bool GlsSchematicTeeInterconnect::GetBaseShowFlow ( )

Get whether or not the flow is displayed for the base tee.

Returns
True if flow is shown else false

◆ GetBaseShowFlowBlink()

bool GlsSchematicTeeInterconnect::GetBaseShowFlowBlink ( )

Get whether or not the flow blink is displayed for the base tee.

(NOTE: normal flow is not drawn if flow blink is true)

Returns
True if flow blink is shown else false

◆ GetLeftFlowBlinkEndColor()

GlsColor GlsSchematicTeeInterconnect::GetLeftFlowBlinkEndColor ( )

Get the flow blink end color for the left tee.

Returns
The flow blink end color

◆ GetLeftFlowBlinkRate()

float GlsSchematicTeeInterconnect::GetLeftFlowBlinkRate ( )

Get the flow blink rate in Hz for the left tee.

Returns
The flow blink rate in Hz

◆ GetLeftFlowBlinkStartColor()

GlsColor GlsSchematicTeeInterconnect::GetLeftFlowBlinkStartColor ( )

Get the flow blink start color for the left tee.

Returns
The flow blink start color

◆ GetLeftFlowRate()

float GlsSchematicTeeInterconnect::GetLeftFlowRate ( )

Get the flow rate in "flow textures" / second for the left tee.

Returns
The flow rate in "flow textures" / second

◆ GetLeftFlowTextureIndex()

int GlsSchematicTeeInterconnect::GetLeftFlowTextureIndex ( )

Get the flow texture index for the left tee.

Returns
The flow texture index or NO_TEXTURE if no flow texture

◆ GetLeftFlowTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetLeftFlowTextureRepeatLength ( )

Get the number of logical units per flow texture repeat for the left tee.

Returns
The number of logical units per flow texture repeat

◆ GetLeftInterconnectTextureIndex()

int GlsSchematicTeeInterconnect::GetLeftInterconnectTextureIndex ( )

Get the interconnect texture index of the left tee.

Returns
The interconnect texture index or NO_TEXTURE if no interconnect texture

◆ GetLeftInterconnectTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetLeftInterconnectTextureRepeatLength ( )

Get the number of logical units per interconnect texture repeat for the left tee.

Returns
The number of logical units per interconnect texture repeat

◆ GetLeftLineThickness()

float GlsSchematicTeeInterconnect::GetLeftLineThickness ( None  )

Gets the line thickness of the left tee.

Returns
The line thickness in logical units

◆ GetLeftShowFlow()

bool GlsSchematicTeeInterconnect::GetLeftShowFlow ( )

Get whether or not the flow is displayed for the left tee.

Returns
True if flow is shown else false

◆ GetLeftShowFlowBlink()

bool GlsSchematicTeeInterconnect::GetLeftShowFlowBlink ( )

Get whether or not the flow blink is displayed for the left tee.

(NOTE: normal flow is not drawn if flow blink is true)

Returns
True if flow blink is shown else false

◆ GetRightFlowBlinkEndColor()

GlsColor GlsSchematicTeeInterconnect::GetRightFlowBlinkEndColor ( )

Get the flow blink end color for the right tee.

Returns
The flow blink end color

◆ GetRightFlowBlinkRate()

float GlsSchematicTeeInterconnect::GetRightFlowBlinkRate ( )

Get the flow blink rate in Hz for the right tee.

Returns
The flow blink rate in Hz

◆ GetRightFlowBlinkStartColor()

GlsColor GlsSchematicTeeInterconnect::GetRightFlowBlinkStartColor ( )

Get the flow blink start color for the right tee.

Returns
The flow blink start color

◆ GetRightFlowRate()

float GlsSchematicTeeInterconnect::GetRightFlowRate ( )

Get the flow rate in "flow textures" / second for the right tee.

Returns
The flow rate in "flow textures" / second

◆ GetRightFlowTextureIndex()

int GlsSchematicTeeInterconnect::GetRightFlowTextureIndex ( )

Get the flow texture index for the right tee.

Returns
The flow texture index or NO_TEXTURE if no flow texture

◆ GetRightFlowTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetRightFlowTextureRepeatLength ( )

Get the number of logical units per flow texture repeat for the right tee.

Returns
The number of logical units per flow texture repeat

◆ GetRightInterconnectTextureIndex()

int GlsSchematicTeeInterconnect::GetRightInterconnectTextureIndex ( )

Get the interconnect texture index of the right tee.

Returns
The interconnect texture index or NO_TEXTURE if no interconnect texture

◆ GetRightInterconnectTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetRightInterconnectTextureRepeatLength ( )

Get the number of logical units per interconnect texture repeat for the right tee.

Returns
The number of logical units per interconnect texture repeat

◆ GetRightLineThickness()

float GlsSchematicTeeInterconnect::GetRightLineThickness ( None  )

Gets the line thickness of the right tee.

Returns
The line thickness in logical units

◆ GetRightShowFlow()

bool GlsSchematicTeeInterconnect::GetRightShowFlow ( )

Get whether or not the flow is displayed for the right tee.

Returns
True if flow is shown else false

◆ GetRightShowFlowBlink()

bool GlsSchematicTeeInterconnect::GetRightShowFlowBlink ( )

Get whether or not the flow blink is displayed for the right tee.

(NOTE: normal flow is not drawn if flow blink is true)

Returns
True if flow blink is shown else false

◆ GetTopFlowBlinkEndColor()

GlsColor GlsSchematicTeeInterconnect::GetTopFlowBlinkEndColor ( )

Get the flow blink end color for the top tee.

Returns
The flow blink end color

◆ GetTopFlowBlinkRate()

float GlsSchematicTeeInterconnect::GetTopFlowBlinkRate ( )

Get the flow blink rate in Hz for the top tee.

Returns
The flow blink rate in Hz

◆ GetTopFlowBlinkStartColor()

GlsColor GlsSchematicTeeInterconnect::GetTopFlowBlinkStartColor ( )

Get the flow blink start color for the top tee.

Returns
The flow blink start color

◆ GetTopFlowRate()

float GlsSchematicTeeInterconnect::GetTopFlowRate ( )

Get the flow rate in "flow textures" / second for the top tee.

Returns
The flow rate in "flow textures" / second

◆ GetTopFlowTextureIndex()

int GlsSchematicTeeInterconnect::GetTopFlowTextureIndex ( )

Get the flow texture index for the top tee.

Returns
The flow texture index or NO_TEXTURE if no flow texture

◆ GetTopFlowTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetTopFlowTextureRepeatLength ( )

Get the number of logical units per flow texture repeat for the top tee.

Returns
The number of logical units per flow texture repeat

◆ GetTopInterconnectTextureIndex()

int GlsSchematicTeeInterconnect::GetTopInterconnectTextureIndex ( )

Get the interconnect texture index of the top tee.

Returns
The interconnect texture index or NO_TEXTURE if no interconnect texture

◆ GetTopInterconnectTextureRepeatLength()

float GlsSchematicTeeInterconnect::GetTopInterconnectTextureRepeatLength ( )

Get the number of logical units per interconnect texture repeat for the top tee.

Returns
The number of logical units per interconnect texture repeat

◆ GetTopLineThickness()

float GlsSchematicTeeInterconnect::GetTopLineThickness ( None  )

Gets the line thickness of the top tee.

Returns
The line thickness in logical units

◆ GetTopShowFlow()

bool GlsSchematicTeeInterconnect::GetTopShowFlow ( )

Get whether or not the flow is displayed for the top tee.

Returns
True if flow is shown else false

◆ GetTopShowFlowBlink()

bool GlsSchematicTeeInterconnect::GetTopShowFlowBlink ( )

Get whether or not the flow blink is displayed for the top tee.

(NOTE: normal flow is not drawn if flow blink is true)

Returns
True if flow blink is shown else false

◆ GetTopVisible()

bool GlsSchematicTeeInterconnect::GetTopVisible ( )

Get the current state of the tee top visibility flag.

Returns
The state of the tee top visibility flag

◆ SetBaseFlowBlinkEndColor()

None GlsSchematicTeeInterconnect::SetBaseFlowBlinkEndColor ( GlsColor endColor)

Set the flow blink end color for the base tee.

Parameters
endColorThe flow blink end color

◆ SetBaseFlowBlinkRate()

None GlsSchematicTeeInterconnect::SetBaseFlowBlinkRate ( float  flowBlinkRate)

Set the flow blink rate in Hz for the base tee.

Parameters
flowBlinkRateThe flow blink rate in Hz

◆ SetBaseFlowBlinkStartColor()

None GlsSchematicTeeInterconnect::SetBaseFlowBlinkStartColor ( GlsColor startColor)

Set the flow blink start color for the base tee.

Parameters
startColorThe flow blink start color

◆ SetBaseFlowRate()

None GlsSchematicTeeInterconnect::SetBaseFlowRate ( float  flowRate)

Set the flow rate in "flow textures" / second for the base tee.

This value must be positive.

Parameters
flowRateThe flow rate in "flow textures" / second

◆ SetBaseFlowTextureIndex()

None GlsSchematicTeeInterconnect::SetBaseFlowTextureIndex ( int  flowTextureIndex)

Set the flow texture index for the base tee.

Parameters
flowTextureIndexThe new flow texture index or NO_TEXTURE for no flow texture

◆ SetBaseFlowTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetBaseFlowTextureRepeatLength ( float  flowTextureRepeatLength)

Set the number of logical units per flow texture repeat for the base tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
flowTextureRepeatLengthThe new flow texture repeat length
Precondition
flowTextureRepeatLength > 0.0f

◆ SetBaseInterconnectTextureIndex()

None GlsSchematicTeeInterconnect::SetBaseInterconnectTextureIndex ( int  interconnectTextureIndex)

Set the interconnect texture index of the base tee.

Parameters
interconnectTextureIndexThe new interconnect texture index or NO_TEXTURE for no interconnect texture

◆ SetBaseInterconnectTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetBaseInterconnectTextureRepeatLength ( float  interconnectTextureRepeatLength)

Set the number of logical units per interconnect texture repeat for the base tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
interconnectTextureRepeatLengthThe new interconnect texture repeat length
Precondition
interconnectTextureRepeatLength > 0.0f

◆ SetBaseLineThickness()

None GlsSchematicTeeInterconnect::SetBaseLineThickness ( float  val)

Sets the line thickness of the base tee.

Parameters
valThe new line thickness in logical units

◆ SetBaseShowFlow()

None GlsSchematicTeeInterconnect::SetBaseShowFlow ( bool  showFlow)

Set whether or not the flow is displayed for the base tee.

Parameters
showFlowTrue to show flow else false

◆ SetBaseShowFlowBlink()

None GlsSchematicTeeInterconnect::SetBaseShowFlowBlink ( bool  showFlowBlink)

Set whether or not the flow blink is displayed for the base tee.

(NOTE: normal flow is not drawn if flow blink is true)

Parameters
showFlowBlinkTrue to show flow blink else false

◆ SetLeftFlowBlinkEndColor()

None GlsSchematicTeeInterconnect::SetLeftFlowBlinkEndColor ( GlsColor endColor)

Set the flow blink end color for the left tee.

Parameters
endColorThe flow blink end color

◆ SetLeftFlowBlinkRate()

None GlsSchematicTeeInterconnect::SetLeftFlowBlinkRate ( float  flowBlinkRate)

Set the flow blink rate in Hz for the left tee.

Parameters
flowBlinkRateThe flow blink rate in Hz

◆ SetLeftFlowBlinkStartColor()

None GlsSchematicTeeInterconnect::SetLeftFlowBlinkStartColor ( GlsColor startColor)

Set the flow blink start color for the left tee.

Parameters
startColorThe flow blink start color

◆ SetLeftFlowRate()

None GlsSchematicTeeInterconnect::SetLeftFlowRate ( float  flowRate)

Set the flow rate in "flow textures" / second for the left tee.

This value must be positive.

Parameters
flowRateThe new flow rate in "flow textures" / second

◆ SetLeftFlowTextureIndex()

None GlsSchematicTeeInterconnect::SetLeftFlowTextureIndex ( int  flowTextureIndex)

Set the flow texture index for the left tee.

Parameters
flowTextureIndexThe new flow texture index or NO_TEXTURE for no flow texture

◆ SetLeftFlowTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetLeftFlowTextureRepeatLength ( float  flowTextureRepeatLength)

Set the number of logical units per flow texture repeat for the left tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
flowTextureRepeatLengthThe new flow texture repeat length
Precondition
flowTextureRepeatLength > 0.0f

◆ SetLeftInterconnectTextureIndex()

None GlsSchematicTeeInterconnect::SetLeftInterconnectTextureIndex ( int  interconnectTextureIndex)

Set the interconnect texture index of the left tee.

Parameters
interconnectTextureIndexThe new interconnect texture index, or NO_TEXTURE for no interconnect texture

◆ SetLeftInterconnectTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetLeftInterconnectTextureRepeatLength ( float  interconnectTextureRepeatLength)

Set the number of logical units per interconnect texture repeat for the left tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
interconnectTextureRepeatLengthThe new interconnect texture repeat length
Precondition
interconnectTextureRepeatLength > 0.0f

◆ SetLeftLineThickness()

None GlsSchematicTeeInterconnect::SetLeftLineThickness ( float  val)

Sets the line thickness of the left tee.

Parameters
valThe new line thickness in logical units

◆ SetLeftShowFlow()

None GlsSchematicTeeInterconnect::SetLeftShowFlow ( bool  showFlow)

Set whether or not the flow is displayed for the left tee.

Parameters
showFlowTrue to show flow else false

◆ SetLeftShowFlowBlink()

None GlsSchematicTeeInterconnect::SetLeftShowFlowBlink ( bool  showFlowBlink)

Set whether or not the flow blink is displayed for the left tee.

(NOTE: normal flow is not drawn if flow blink is true)

Parameters
showFlowBlinkTrue to show flow blink else false

◆ SetRightFlowBlinkEndColor()

None GlsSchematicTeeInterconnect::SetRightFlowBlinkEndColor ( GlsColor endColor)

Set the flow blink end color for the right tee.

Parameters
endColorThe flow blink end color

◆ SetRightFlowBlinkRate()

None GlsSchematicTeeInterconnect::SetRightFlowBlinkRate ( float  flowBlinkRate)

Set the flow blink rate in Hz for the right tee.

Parameters
flowBlinkRateThe flow blink rate in Hz

◆ SetRightFlowBlinkStartColor()

None GlsSchematicTeeInterconnect::SetRightFlowBlinkStartColor ( GlsColor startColor)

Set the flow blink start color for the right tee.

Parameters
startColorThe flow blink start color

◆ SetRightFlowRate()

None GlsSchematicTeeInterconnect::SetRightFlowRate ( float  flowRate)

Set the flow rate in "flow textures" / second for the right tee.

This value must be positive.

Parameters
flowRateThe new flow rate in "flow textures" / second

◆ SetRightFlowTextureIndex()

None GlsSchematicTeeInterconnect::SetRightFlowTextureIndex ( int  flowTextureIndex)

Set the flow texture index for the right tee.

Parameters
flowTextureIndexThe new flow texture index or NO_TEXTURE for no flow texture

◆ SetRightFlowTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetRightFlowTextureRepeatLength ( float  flowTextureRepeatLength)

Set the number of logical units per flow texture repeat for the right tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
flowTextureRepeatLengthThe new flow texture repeat length
Precondition
flowTextureRepeatLength > 0.0f

◆ SetRightInterconnectTextureIndex()

None GlsSchematicTeeInterconnect::SetRightInterconnectTextureIndex ( int  interconnectTextureIndex)

Set the interconnect texture index of the right tee.

Parameters
interconnectTextureIndexThe new interconnect texture index or NO_TEXTURE for no interconnect texture

◆ SetRightInterconnectTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetRightInterconnectTextureRepeatLength ( float  interconnectTextureRepeatLength)

Set the number of logical units per interconnect texture repeat for the right tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
interconnectTextureRepeatLengthThe new interconnect texture repeat length
Precondition
interconnectTextureRepeatLength > 0.0f

◆ SetRightLineThickness()

None GlsSchematicTeeInterconnect::SetRightLineThickness ( float  val)

Sets the line thickness of the right tee.

Parameters
valThe new line thickness in logical units

◆ SetRightShowFlow()

None GlsSchematicTeeInterconnect::SetRightShowFlow ( bool  showFlow)

Set whether or not the flow is displayed for the right tee.

Parameters
showFlowTrue to show flow else false

◆ SetRightShowFlowBlink()

None GlsSchematicTeeInterconnect::SetRightShowFlowBlink ( bool  showFlowBlink)

Set whether or not the flow blink is displayed for the right tee.

(NOTE: normal flow is not drawn if flow blink is true)

Parameters
showFlowBlinkTrue to show flow blink else false

◆ SetTopFlowBlinkEndColor()

None GlsSchematicTeeInterconnect::SetTopFlowBlinkEndColor ( GlsColor endColor)

Set the flow blink end color for the top tee.

Parameters
endColorThe flow blink end color

◆ SetTopFlowBlinkRate()

None GlsSchematicTeeInterconnect::SetTopFlowBlinkRate ( float  flowBlinkRate)

Set the flow blink rate in Hz for the top tee.

Parameters
flowBlinkRateThe flow blink rate in Hz

◆ SetTopFlowBlinkStartColor()

None GlsSchematicTeeInterconnect::SetTopFlowBlinkStartColor ( GlsColor startColor)

Set the flow blink start color for the top tee.

Parameters
startColorThe flow blink start color

◆ SetTopFlowRate()

None GlsSchematicTeeInterconnect::SetTopFlowRate ( float  flowRate)

Set the flow rate in "flow textures" / second for the top tee.

This value must be positive.

Parameters
flowRateThe flow rate in "flow textures" / second

◆ SetTopFlowTextureIndex()

None GlsSchematicTeeInterconnect::SetTopFlowTextureIndex ( int  flowTextureIndex)

Set the flow texture index for the top tee.

Parameters
flowTextureIndexThe new flow texture index or NO_TEXTURE for no flow texture

◆ SetTopFlowTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetTopFlowTextureRepeatLength ( float  flowTextureRepeatLength)

Set the number of logical units per flow texture repeat for the top tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
flowTextureRepeatLengthThe new flow texture repeat length
Precondition
flowTextureRepeatLength > 0.0f

◆ SetTopInterconnectTextureIndex()

None GlsSchematicTeeInterconnect::SetTopInterconnectTextureIndex ( int  interconnectTextureIndex)

Set the interconnect texture index of the top tee.

Parameters
interconnectTextureIndexThe new interconnect texture index or NO_TEXTURE for no interconnect texture

◆ SetTopInterconnectTextureRepeatLength()

None GlsSchematicTeeInterconnect::SetTopInterconnectTextureRepeatLength ( float  interconnectTextureRepeatLength)

Set the number of logical units per interconnect texture repeat for the top tee.

This value must be positive. NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures line up.

Parameters
interconnectTextureRepeatLengthThe new interconnect texture repeat length
Precondition
interconnectTextureRepeatLength > 0.0f

◆ SetTopLineThickness()

None GlsSchematicTeeInterconnect::SetTopLineThickness ( float  val)

Sets the line thickness of the top tee.

Parameters
valThe new line thickness in logical units

◆ SetTopShowFlow()

None GlsSchematicTeeInterconnect::SetTopShowFlow ( bool  showFlow)

Set whether or not the flow is displayed for the top tee.

Parameters
showFlowTrue to show flow else false

◆ SetTopShowFlowBlink()

None GlsSchematicTeeInterconnect::SetTopShowFlowBlink ( bool  showFlowBlink)

Set whether or not the flow blink is displayed for the top tee.

(NOTE: normal flow is not drawn if flow blink is true)

Parameters
showFlowBlinkTrue to show flow blink else false

◆ SetTopVisible()

None GlsSchematicTeeInterconnect::SetTopVisible ( bool  topVisible)

Set the flag to determine if the top of the tee is visible.

Parameters
topVisibleThe flag to determine if top of tee is visible

The documentation for this class was generated from the following file: