C# Class Nez.Overlap2D.Runtime.CompositeItemVO

Inheritance: MainItemVO
Show file Open project: prime31/Nez Class Usage Examples

Public Properties

Property Type Description
composite CompositeVO
height float
scissorHeight float
scissorWidth float
scissorX float
scissorY float
width float

Public Methods

Method Description
ToString ( ) : string
calculateLayerDepthForChild ( float zIndexMin, float zIndexMax, MainItemVO child, float zIndexMaxChild = 100 ) : float

gets the layerDepth for a child composite. It calculates it by first getting the composite (parent) layerDepth the standard way (via zIndexMin/Max) and then subtracting the inverse of the child (O2DMainItem) layerDepth which uses zIndexMaxChild. For this to work intelligently zIndexMaxComp should be the standard scene.zIndexMax value and zIndexMaxChild should be a much higher number. The reason for this is so that the parent component has a small offset to use for each child and so they dont overflow to the next zIndex. Example: parent is 14. Any children must end up being between 14 and 15 so they dont overflow on top of another composite.

Method Details

ToString() public method

public ToString ( ) : string
return string

calculateLayerDepthForChild() public method

gets the layerDepth for a child composite. It calculates it by first getting the composite (parent) layerDepth the standard way (via zIndexMin/Max) and then subtracting the inverse of the child (O2DMainItem) layerDepth which uses zIndexMaxChild. For this to work intelligently zIndexMaxComp should be the standard scene.zIndexMax value and zIndexMaxChild should be a much higher number. The reason for this is so that the parent component has a small offset to use for each child and so they dont overflow to the next zIndex. Example: parent is 14. Any children must end up being between 14 and 15 so they dont overflow on top of another composite.
public calculateLayerDepthForChild ( float zIndexMin, float zIndexMax, MainItemVO child, float zIndexMaxChild = 100 ) : float
zIndexMin float
zIndexMax float
child MainItemVO Child.
zIndexMaxChild float Z index max child.
return float

Property Details

composite public property

public CompositeVO,Nez.Overlap2D.Runtime composite
return CompositeVO

height public property

public float height
return float

scissorHeight public property

public float scissorHeight
return float

scissorWidth public property

public float scissorWidth
return float

scissorX public property

public float scissorX
return float

scissorY public property

public float scissorY
return float

width public property

public float width
return float