@itwin/core-orbitgt 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/cjs/pointcloud/model/PointAttribute.d.ts

@@ -1,209 +1,209 @@
-/** @packageDocumentation
- * @module OrbitGT
- */
-declare type int32 = number;
-import { AList } from "../../system/collection/AList";
-import { ALong } from "../../system/runtime/ALong";
-import { AttributeValue } from "./AttributeValue";
-/**
- * Class PointAttribute defines an attribute of a point.
- *
- * @version 1.0 August 2013
- */
-/** @internal */
-export declare class PointAttribute {
-    /** The name of the attribute */
-    private _name;
-    /** The description of the attribute */
-    private _description;
-    /** The type of the attribute */
-    private _type;
-    /** The default value of the attribute */
-    private _defaultValue;
-    /** The optional minimum value of the attribute */
-    private _minValue;
-    /** The optional maximum value of the attribute */
-    private _maxValue;
-    /** Is this a standard attribute? (color/intensity/weight)? */
-    private _standardAttribute;
-    /**
-     * Create a new point attribute.
-     * @param name the name of the attribute.
-     * @param description the description of the attribute.
-     * @param type the type of the attribute.
-     * @param default value the default value of the attribute (use null to create a default value).
-     */
-    constructor(name: string, description: string, type: int32, defaultValue: AttributeValue);
-    /**
-     * Get the name.
-     * @return the name.
-     */
-    getName(): string;
-    /**
-     * Set the name.
-     * @param name the new name.
-     */
-    setName(name: string): void;
-    /**
-     * Check the name.
-     * @param name the name to check.
-     * @return true if equal.
-     */
-    hasName(name: string): boolean;
-    /**
-     * Get the description.
-     * @return the description.
-     */
-    getDescription(): string;
-    /**
-     * Get the type.
-     * @return the type.
-     */
-    getType(): int32;
-    /**
-     * Get the byte-size of the type.
-     * @return the byte-size of the type.
-     */
-    getTypeByteSize(): int32;
-    /**
-     * Get the byte-size of a number of values.
-     * @param attributeCount the number of values.
-     * @return the byte-size.
-     */
-    getTypeByteSizeForCount(attributeCount: int32): int32;
-    /**
-     * Get the byte-size of a number of values.
-     * @param attributeCount the number of values.
-     * @return the byte-size.
-     */
-    getTypeByteSizeForLongCount(attributeCount: ALong): ALong;
-    /**
-     * Get the default value.
-     * @return the default value.
-     */
-    getDefaultValue(): AttributeValue;
-    /**
-     * Get the optional minimum value.
-     * @return the optional minimum value.
-     */
-    getMinValue(): AttributeValue;
-    /**
-     * Set the optional minimum value.
-     * @param value the optional minimum value.
-     */
-    setMinValue(value: AttributeValue): void;
-    /**
-     * Get the optional maximum value.
-     * @return the optional maximum value.
-     */
-    getMaxValue(): AttributeValue;
-    /**
-     * Set the optional maximum value.
-     * @param value the optional maximum value.
-     */
-    setMaxValue(value: AttributeValue): void;
-    /**
-     * Set the description of a copy.
-     * @param description the new description.
-     * @return the copy.
-     */
-    setDescription(description: string): PointAttribute;
-    /**
-     * Is this a standard attribute (like color/intensity/weight)?
-     * @return true for a standard attribute.
-     */
-    isStandardAttribute(): boolean;
-    /**
-     * Make this a standard attribute (like color/intensity/weight).
-     * @param standard true if this is a standard attribute.
-     * @return this attribute for convenience.
-     */
-    setStandardAttribute(standard: boolean): PointAttribute;
-    /**
-     * The standard toString method.
-     * @see Object#toString
-     */
-    toString(): string;
-    /**
-     * Get the name of a type.
-     * @param attributeType the type of attributes.
-     * @return the name.
-     */
-    static getTypeName(attributeType: int32): string;
-    /**
-     * Get the bit size for a type.
-     * @param attributeType the type of attributes.
-     * @return the number of bits.
-     */
-    static getBitSize(attributeType: int32): int32;
-    /**
-     * Get the byte size for a number of attributes.
-     * @param attributeType the type of attributes.
-     * @param attributeCount the number of attributes.
-     */
-    static getByteSize(attributeType: int32, attributeCount: int32): int32;
-    /**
-     * Get the byte size for a number of attributes.
-     * @param attributeType the type of attributes.
-     * @param attributeCount the number of attributes.
-     */
-    static getByteSizeForCount(attributeType: int32, attributeCount: ALong): ALong;
-    /**
-     * Find the index of an attribute.
-     * @param attributes the list of attributes.
-     * @param attributeName the name of an attribute.
-     * @return the index (negative if not found).
-     */
-    static indexOfName(attributes: Array<PointAttribute>, attributeName: string): int32;
-    /**
-     * Find the index of an attribute.
-     * @param attributes the list of attributes.
-     * @param attribute the definition of an attribute.
-     * @return the index (negative if not found).
-     */
-    static indexOf(attributes: Array<PointAttribute>, attribute: PointAttribute): int32;
-    /**
-     * Check if an attribute exists.
-     * @param attributes the list of attributes.
-     * @param attributeName the name of an attribute.
-     * @return true if found.
-     */
-    static hasAttributeName(attributes: Array<PointAttribute>, attributeName: string): boolean;
-    /**
-     * Check if an attribute exists.
-     * @param attributes the list of attributes.
-     * @param attribute the definition of an attribute.
-     * @return true if found.
-     */
-    static hasAttribute(attributes: Array<PointAttribute>, attribute: PointAttribute): boolean;
-    /**
-     * Find the index of an attribute.
-     * @param attributes the list of attributes.
-     * @param attributeName the name of an attribute.
-     * @return the index (negative if not found).
-     */
-    static listIndexOfName(attributes: AList<PointAttribute>, attributeName: string): int32;
-    /**
-     * Find the index of an attribute.
-     * @param attributes the list of attributes.
-     * @param attribute the definition of an attribute.
-     * @return the index (negative if not found).
-     */
-    static listIndexOf(attributes: AList<PointAttribute>, attribute: PointAttribute): int32;
-    /**
-     * Check if an attribute exists.
-     * @param attributes the list of attributes.
-     * @param attributeName the name of an attribute.
-     * @return true if found.
-     */
-    static listHasAttributeName(attributes: AList<PointAttribute>, attributeName: string): boolean;
-    /**
-     * Check if an attribute exists.
-     * @param attributes the list of attributes.
-     * @param attribute the definition of an attribute.
-     * @return true if found.
-     */
-    static listHasAttribute(attributes: AList<PointAttribute>, attribute: PointAttribute): boolean;
-}
-export {};
+/** @packageDocumentation
+ * @module OrbitGT
+ */
+declare type int32 = number;
+import { AList } from "../../system/collection/AList";
+import { ALong } from "../../system/runtime/ALong";
+import { AttributeValue } from "./AttributeValue";
+/**
+ * Class PointAttribute defines an attribute of a point.
+ *
+ * @version 1.0 August 2013
+ */
+/** @internal */
+export declare class PointAttribute {
+    /** The name of the attribute */
+    private _name;
+    /** The description of the attribute */
+    private _description;
+    /** The type of the attribute */
+    private _type;
+    /** The default value of the attribute */
+    private _defaultValue;
+    /** The optional minimum value of the attribute */
+    private _minValue;
+    /** The optional maximum value of the attribute */
+    private _maxValue;
+    /** Is this a standard attribute? (color/intensity/weight)? */
+    private _standardAttribute;
+    /**
+     * Create a new point attribute.
+     * @param name the name of the attribute.
+     * @param description the description of the attribute.
+     * @param type the type of the attribute.
+     * @param default value the default value of the attribute (use null to create a default value).
+     */
+    constructor(name: string, description: string, type: int32, defaultValue: AttributeValue);
+    /**
+     * Get the name.
+     * @return the name.
+     */
+    getName(): string;
+    /**
+     * Set the name.
+     * @param name the new name.
+     */
+    setName(name: string): void;
+    /**
+     * Check the name.
+     * @param name the name to check.
+     * @return true if equal.
+     */
+    hasName(name: string): boolean;
+    /**
+     * Get the description.
+     * @return the description.
+     */
+    getDescription(): string;
+    /**
+     * Get the type.
+     * @return the type.
+     */
+    getType(): int32;
+    /**
+     * Get the byte-size of the type.
+     * @return the byte-size of the type.
+     */
+    getTypeByteSize(): int32;
+    /**
+     * Get the byte-size of a number of values.
+     * @param attributeCount the number of values.
+     * @return the byte-size.
+     */
+    getTypeByteSizeForCount(attributeCount: int32): int32;
+    /**
+     * Get the byte-size of a number of values.
+     * @param attributeCount the number of values.
+     * @return the byte-size.
+     */
+    getTypeByteSizeForLongCount(attributeCount: ALong): ALong;
+    /**
+     * Get the default value.
+     * @return the default value.
+     */
+    getDefaultValue(): AttributeValue;
+    /**
+     * Get the optional minimum value.
+     * @return the optional minimum value.
+     */
+    getMinValue(): AttributeValue;
+    /**
+     * Set the optional minimum value.
+     * @param value the optional minimum value.
+     */
+    setMinValue(value: AttributeValue): void;
+    /**
+     * Get the optional maximum value.
+     * @return the optional maximum value.
+     */
+    getMaxValue(): AttributeValue;
+    /**
+     * Set the optional maximum value.
+     * @param value the optional maximum value.
+     */
+    setMaxValue(value: AttributeValue): void;
+    /**
+     * Set the description of a copy.
+     * @param description the new description.
+     * @return the copy.
+     */
+    setDescription(description: string): PointAttribute;
+    /**
+     * Is this a standard attribute (like color/intensity/weight)?
+     * @return true for a standard attribute.
+     */
+    isStandardAttribute(): boolean;
+    /**
+     * Make this a standard attribute (like color/intensity/weight).
+     * @param standard true if this is a standard attribute.
+     * @return this attribute for convenience.
+     */
+    setStandardAttribute(standard: boolean): PointAttribute;
+    /**
+     * The standard toString method.
+     * @see Object#toString
+     */
+    toString(): string;
+    /**
+     * Get the name of a type.
+     * @param attributeType the type of attributes.
+     * @return the name.
+     */
+    static getTypeName(attributeType: int32): string;
+    /**
+     * Get the bit size for a type.
+     * @param attributeType the type of attributes.
+     * @return the number of bits.
+     */
+    static getBitSize(attributeType: int32): int32;
+    /**
+     * Get the byte size for a number of attributes.
+     * @param attributeType the type of attributes.
+     * @param attributeCount the number of attributes.
+     */
+    static getByteSize(attributeType: int32, attributeCount: int32): int32;
+    /**
+     * Get the byte size for a number of attributes.
+     * @param attributeType the type of attributes.
+     * @param attributeCount the number of attributes.
+     */
+    static getByteSizeForCount(attributeType: int32, attributeCount: ALong): ALong;
+    /**
+     * Find the index of an attribute.
+     * @param attributes the list of attributes.
+     * @param attributeName the name of an attribute.
+     * @return the index (negative if not found).
+     */
+    static indexOfName(attributes: Array<PointAttribute>, attributeName: string): int32;
+    /**
+     * Find the index of an attribute.
+     * @param attributes the list of attributes.
+     * @param attribute the definition of an attribute.
+     * @return the index (negative if not found).
+     */
+    static indexOf(attributes: Array<PointAttribute>, attribute: PointAttribute): int32;
+    /**
+     * Check if an attribute exists.
+     * @param attributes the list of attributes.
+     * @param attributeName the name of an attribute.
+     * @return true if found.
+     */
+    static hasAttributeName(attributes: Array<PointAttribute>, attributeName: string): boolean;
+    /**
+     * Check if an attribute exists.
+     * @param attributes the list of attributes.
+     * @param attribute the definition of an attribute.
+     * @return true if found.
+     */
+    static hasAttribute(attributes: Array<PointAttribute>, attribute: PointAttribute): boolean;
+    /**
+     * Find the index of an attribute.
+     * @param attributes the list of attributes.
+     * @param attributeName the name of an attribute.
+     * @return the index (negative if not found).
+     */
+    static listIndexOfName(attributes: AList<PointAttribute>, attributeName: string): int32;
+    /**
+     * Find the index of an attribute.
+     * @param attributes the list of attributes.
+     * @param attribute the definition of an attribute.
+     * @return the index (negative if not found).
+     */
+    static listIndexOf(attributes: AList<PointAttribute>, attribute: PointAttribute): int32;
+    /**
+     * Check if an attribute exists.
+     * @param attributes the list of attributes.
+     * @param attributeName the name of an attribute.
+     * @return true if found.
+     */
+    static listHasAttributeName(attributes: AList<PointAttribute>, attributeName: string): boolean;
+    /**
+     * Check if an attribute exists.
+     * @param attributes the list of attributes.
+     * @param attribute the definition of an attribute.
+     * @return true if found.
+     */
+    static listHasAttribute(attributes: AList<PointAttribute>, attribute: PointAttribute): boolean;
+}
+export {};
 //# sourceMappingURL=PointAttribute.d.ts.map