Interface ICropChildrenComponent

This component allows cropping all children to the parent's size. For example, you can have an object to represent a TV, then crop all of its children entities, so the entities will not get out of the boundaries of the TV (giving the appearance that it's really a TV).

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[RequiredComponent(typeof(IInObjectTreeComponent), true)]
[RequiredComponent(typeof(IScaleComponent), true)]
[RequiredComponent(typeof(IBoundingBoxComponent), true)]
public interface ICropChildrenComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

CropChildrenEnabled

Gets or sets a value indicating whether this ICropChildrenComponent crop children is enabled.

Declaration

bool CropChildrenEnabled { get; set; }

Property Value

Type	Description
System.Boolean	`true` if crop children enabled; otherwise, `false`.

| Improve this Doc View Source

EntitiesToSkipCrop

A list of child entities (their IDs) that will not be cropped by the component.

Declaration

IConcurrentHashSet<string> EntitiesToSkipCrop { get; }

Property Value

Type	Description
IConcurrentHashSet<System.String>	The entities to skip crop.

| Improve this Doc View Source

StartPoint

Gets or sets the start point for the crop area, where (0,0) is the top-left corner.

Declaration

PointF StartPoint { get; set; }

Property Value

Type	Description
PointF	The start point.