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

Public Member Functions

 GlsSchematicPolyLineInterconnect (VertexArray &vertices)
 
None SetLineThickness (float val)
 
float GetLineThickness (None)
 
None SetRoundedCorners (bool val)
 
bool GetRoundedCorners (None)
 
None SetCornerRadius (float val)
 
float GetCornerRadius (None)
 
None SetForceExactCornerRadius (bool val)
 
bool GetForceExactCornerRadius (None)
 
None SetCornerSegments (int cornerSegments)
 
int GetCornerSegments ()
 
None SetInterconnectTextureIndex (int interconnectTextureIndex)
 
int GetInterconnectTextureIndex ()
 
None SetInterconnectTextureRepeatLength (float interconnectTextureRepeatLength)
 
float GetInterconnectTextureRepeatLength ()
 
None SetFlowTextureIndex (int flowTextureIndex)
 
int GetFlowTextureIndex ()
 
None SetFlowTextureRepeatLength (float flowTextureRepeatLength)
 
float GetFlowTextureRepeatLength ()
 
None SetShowFlow (bool showFlow)
 
bool GetShowFlow ()
 
None SetFlowRate (float flowRate)
 
float GetFlowRate ()
 
None SetShowFlowBlink (bool showFlowBlink)
 
bool GetShowFlowBlink ()
 
None SetFlowBlinkRate (float flowBlinkRate)
 
float GetFlowBlinkRate ()
 
None SetFlowBlinkStartColor (GlsColor &startColor)
 
GlsColor GetFlowBlinkStartColor ()
 
None SetFlowBlinkEndColor (GlsColor &endColor)
 
GlsColor GetFlowBlinkEndColor ()
 
- 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 GlsSchematicPolyLineInterconnectCastToGlsSchematicPolyLineInterconnect (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 GlsSchematicPolyLineInterconnect.

Constructor & Destructor Documentation

◆ GlsSchematicPolyLineInterconnect()

GlsSchematicPolyLineInterconnect::GlsSchematicPolyLineInterconnect ( VertexArray vertices)

Constructor.

Creates a GlsSchematicPolyLineInterconnect using the specified vertices.

Parameters
verticesThe array of vertices to use

Member Function Documentation

◆ CastToGlsSchematicPolyLineInterconnect()

static GlsSchematicPolyLineInterconnect * GlsSchematicPolyLineInterconnect::CastToGlsSchematicPolyLineInterconnect ( DisplayObject obj)
static

Casts a display object to a schematic polyline interconnect.

Parameters
objThe display object to cast.

◆ GetCornerRadius()

float GlsSchematicPolyLineInterconnect::GetCornerRadius ( None  )

Gets the radius of the rounded corners.

Returns
bool The radius of the rounded corners

◆ GetCornerSegments()

int GlsSchematicPolyLineInterconnect::GetCornerSegments ( )

Get the number of segments used in rounded corners.

Returns
The number of segments used in rounded corners

◆ GetFlowBlinkEndColor()

GlsColor GlsSchematicPolyLineInterconnect::GetFlowBlinkEndColor ( )

Get the flow blink end color.

Returns
The flow blink end color

◆ GetFlowBlinkRate()

float GlsSchematicPolyLineInterconnect::GetFlowBlinkRate ( )

Get the flow blink rate in Hz.

Returns
The flow blink rate in Hz

◆ GetFlowBlinkStartColor()

GlsColor GlsSchematicPolyLineInterconnect::GetFlowBlinkStartColor ( )

Get the flow blink start color.

Returns
The flow blink start color

◆ GetFlowRate()

float GlsSchematicPolyLineInterconnect::GetFlowRate ( )

Get the flow rate in "flow textures" / second.

Returns
The flow rate in "flow textures" / second

◆ GetFlowTextureIndex()

int GlsSchematicPolyLineInterconnect::GetFlowTextureIndex ( )

Get the flow texture index.

Returns
The flow texture index or NO_TEXTURE if no flow texture

◆ GetFlowTextureRepeatLength()

float GlsSchematicPolyLineInterconnect::GetFlowTextureRepeatLength ( )

Get the number of logical units per flow texture repeat.

Returns
The number of logical units per flow texture repeat

◆ GetForceExactCornerRadius()

bool GlsSchematicPolyLineInterconnect::GetForceExactCornerRadius ( None  )

Gets the state of the force exact corner radius flag.

Returns
bool The state of the force exact corner radius flag

◆ GetInterconnectTextureIndex()

int GlsSchematicPolyLineInterconnect::GetInterconnectTextureIndex ( )

Get the interconnect texture index.

Returns
The interconnect texture index or NO_TEXTURE if no interconnect texture

◆ GetInterconnectTextureRepeatLength()

float GlsSchematicPolyLineInterconnect::GetInterconnectTextureRepeatLength ( )

Get the number of logical units per interconnect texture repeat.

Returns
The number of logical units per interconnect texture repeat

◆ GetLineThickness()

float GlsSchematicPolyLineInterconnect::GetLineThickness ( None  )

Gets the line thickness.

Returns
The line thickness in logical units

◆ GetRoundedCorners()

bool GlsSchematicPolyLineInterconnect::GetRoundedCorners ( None  )

Gets the rounded corners flag.

Returns
bool The state of the rounded corners flag

◆ GetShowFlow()

bool GlsSchematicPolyLineInterconnect::GetShowFlow ( )

Get whether or not the flow is displayed.

Returns
True if flow is shown, else false

◆ GetShowFlowBlink()

bool GlsSchematicPolyLineInterconnect::GetShowFlowBlink ( )

Get whether or not the flow blink is displayed.

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

Returns
True if flow blink is shown, else false

◆ SetCornerRadius()

None GlsSchematicPolyLineInterconnect::SetCornerRadius ( float  val)

Sets the rounded corner radius.

Parameters
valThe new rounded corner radius

◆ SetCornerSegments()

None GlsSchematicPolyLineInterconnect::SetCornerSegments ( int  cornerSegments)

Set the number of segments used in rounded corners.

The number of corner segments must be in the range 2 - 100, inclusive.

Parameters
cornerSegmentsNumber of segments to use in rounded corners

◆ SetFlowBlinkEndColor()

None GlsSchematicPolyLineInterconnect::SetFlowBlinkEndColor ( GlsColor endColor)

Set the flow blink end color.

Parameters
endColorThe flow blink end color

◆ SetFlowBlinkRate()

None GlsSchematicPolyLineInterconnect::SetFlowBlinkRate ( float  flowBlinkRate)

Set the flow blink rate in Hz.

Parameters
flowBlinkRateThe flow blink rate in Hz

◆ SetFlowBlinkStartColor()

None GlsSchematicPolyLineInterconnect::SetFlowBlinkStartColor ( GlsColor startColor)

Set the flow blink start color.

Parameters
startColorThe flow blink start color

◆ SetFlowRate()

None GlsSchematicPolyLineInterconnect::SetFlowRate ( float  flowRate)

Set the flow rate in "flow textures" / second.

Parameters
flowRateThe flow rate in "flow textures" / second

◆ SetFlowTextureIndex()

None GlsSchematicPolyLineInterconnect::SetFlowTextureIndex ( int  flowTextureIndex)

Set the flow texture index.

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

◆ SetFlowTextureRepeatLength()

None GlsSchematicPolyLineInterconnect::SetFlowTextureRepeatLength ( float  flowTextureRepeatLength)

Set the number of logical units per flow texture repeat.

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

◆ SetForceExactCornerRadius()

None GlsSchematicPolyLineInterconnect::SetForceExactCornerRadius ( bool  val)

Sets the force exact corner radius flag.

Parameters
valIf true, forces rounded corners to use the exact corner radius specified by SetCornerRadius(). A corner that cannot be made with this radius will not be rounded.

◆ SetInterconnectTextureIndex()

None GlsSchematicPolyLineInterconnect::SetInterconnectTextureIndex ( int  interconnectTextureIndex)

Set the interconnect texture index.

Parameters
interconnectTextureIndexNew interconnect texture index or NO_TEXTURE for no interconnect texture

◆ SetInterconnectTextureRepeatLength()

None GlsSchematicPolyLineInterconnect::SetInterconnectTextureRepeatLength ( float  interconnectTextureRepeatLength)

Set the number of logical units per interconnect texture repeat.

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

◆ SetLineThickness()

None GlsSchematicPolyLineInterconnect::SetLineThickness ( float  val)

Sets the line thickness.

Parameters
valThe new line thickness in logical units

◆ SetRoundedCorners()

None GlsSchematicPolyLineInterconnect::SetRoundedCorners ( bool  val)

Sets the rounded corners flag.

Parameters
valThe new rounded corners flag state

◆ SetShowFlow()

None GlsSchematicPolyLineInterconnect::SetShowFlow ( bool  showFlow)

Set whether or not the flow is displayed.

Parameters
showFlowTrue to show flow, else false

◆ SetShowFlowBlink()

None GlsSchematicPolyLineInterconnect::SetShowFlowBlink ( bool  showFlowBlink)

Set whether or not the flow blink is displayed.

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

Parameters
showFlowBlinkTrue to show flow blink, else false

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