HShape

HShape class

The HShape provides the defining parameters of an ‘H’ or ‘I’ shape.

Methods

constructor

Name	Description
constructor()	Constructor of HShape

Result:

---

getOverallDepth

Name	Description
getOverallDepth()	Gets or sets the extent of the depth.

Result:

---

setOverallDepth

Name	Description
setOverallDepth(value)	Gets or sets the extent of the depth.

Result:

---

getBottomFlangeWidth

Name	Description
getBottomFlangeWidth()	Gets or sets the extent of the width.

Result:

---

setBottomFlangeWidth

Name	Description
setBottomFlangeWidth(value)	Gets or sets the extent of the width.

Result:

---

getTopFlangeWidth

Name	Description
getTopFlangeWidth()	Gets or sets the width of the top flange.

Result:

---

setTopFlangeWidth

Name	Description
setTopFlangeWidth(value)	Gets or sets the width of the top flange.

Result:

---

getTopFlangeThickness

Name	Description
getTopFlangeThickness()	Gets or sets the thickness of the top flange.

Result:

---

setTopFlangeThickness

Name	Description
setTopFlangeThickness(value)	Gets or sets the thickness of the top flange.

Result:

---

getTopFlangeEdgeRadius

Name	Description
getTopFlangeEdgeRadius()	Gets or sets the radius of the lower edges of the top flange.

Result:

---

setTopFlangeEdgeRadius

Name	Description
setTopFlangeEdgeRadius(value)	Gets or sets the radius of the lower edges of the top flange.

Result:

---

getTopFlangeFilletRadius

Name	Description
getTopFlangeFilletRadius()	Gets or sets the radius of fillet between the web and the top flange.

Result:

---

setTopFlangeFilletRadius

Name	Description
setTopFlangeFilletRadius(value)	Gets or sets the radius of fillet between the web and the top flange.

Result:

---

getBottomFlangeThickness

Name	Description
getBottomFlangeThickness()	Gets or sets the flange thickness of H-shape.

Result:

---

setBottomFlangeThickness

Name	Description
setBottomFlangeThickness(value)	Gets or sets the flange thickness of H-shape.

Result:

---

getWebThickness

Name	Description
getWebThickness()	Gets or sets the thickness of the web of the H-shape.

Result:

---

setWebThickness

Name	Description
setWebThickness(value)	Gets or sets the thickness of the web of the H-shape.

Result:

---

getBottomFlangeFilletRadius

Name	Description
getBottomFlangeFilletRadius()	Gets or sets the radius of fillet between the web and the bottom flange.

Result:

---

setBottomFlangeFilletRadius

Name	Description
setBottomFlangeFilletRadius(value)	Gets or sets the radius of fillet between the web and the bottom flange.

Result:

---

getBottomFlangeEdgeRadius

Name	Description
getBottomFlangeEdgeRadius()	Gets or sets the radius of the upper edges of the bottom flange.

Result:

---

setBottomFlangeEdgeRadius

Name	Description
setBottomFlangeEdgeRadius(value)	Gets or sets the radius of the upper edges of the bottom flange.

Result:

---

getParentNodes

Name	Description
getParentNodes()	Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing The nodes.

Result:

---

getExcluded

Name	Description
getExcluded()	Gets or sets whether to exclude this entity during exporting.

Result:

---

setExcluded

Name	Description
setExcluded(value)	Gets or sets whether to exclude this entity during exporting.

Result:

---

getParentNode

Name	Description
getParentNode()	Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:

---

setParentNode

Name	Description
setParentNode(value)	Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:

---

getScene

Name	Description
getScene()	Gets the scene that this object belongs to

Result:

---

getName

Name	Description
getName()	Gets or sets the name. The name.

Result:

---

setName

Name	Description
setName(value)	Gets or sets the name. The name.

Result:

---

getProperties

Name	Description
getProperties()	Gets the collection of all properties.

Result:

---

getExtent

Name	Description
getExtent()	Gets the extent in x and y dimension.

Result: Vector2

---

getEntityRendererKey

Name	Description
getEntityRendererKey()	Gets the key of the entity renderer registered in the renderer

Result: EntityRendererKey

---

getBoundingBox

Name	Description
getBoundingBox()	Gets the bounding box of current entity in its object space coordinate system.

Result: EntityRendererKey

---

removeProperty

Name	Description
removeProperty(property)	Removes a dynamic property.

Parameters:

Name	Type	Description
property	Property	Which property to remove

Result: boolean

---

removeProperty

Name	Description
removeProperty(property)	Remove the specified property identified by name

Parameters:

Name	Type	Description
propert	String	null

Result: boolean

---

getProperty

Name	Description
getProperty(property)	Get the value of specified property

Parameters:

Name	Type	Description
property	String	Property name

Result: Object

---

setProperty

Name	Description
setProperty(property, value)	Sets the value of specified property

Parameters:

Name	Type	Description
property	String	Property name
value	Object	The value of the property

Result: Object

---

findProperty

Name	Description
findProperty(propertyName)	Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)

Parameters:

Name	Type	Description
propertyName	String	Property name.

Result: Property

---