All files / tools/src/utilities/vtkjs/AnnotatedRhombicuboctahedronActor index.d.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157                                                                                                                                                                                                                                                                                                                         
import vtkActor, {
  IActorInitialValues,
} from '@kitware/vtk.js/Rendering/Core/Actor';
 
export interface IStyle {
  text?: string;
  faceColor?: string;
  faceRotation?: number;
  fontFamily?: string;
  fontColor?: string;
  fontStyle?: string;
  fontSizeScale?: (res: number) => number;
  edgeThickness?: number;
  edgeColor?: string;
  resolution?: number;
}
 
export interface IFaceProperty extends IStyle {
  text?: string;
  faceRotation?: number;
}
 
export interface IAnnotatedRhombicuboctahedronActorInitialValues
  extends IActorInitialValues {
  defaultStyle?: IStyle;
  showMainFaces?: boolean;
  showEdgeFaces?: boolean;
  showCornerFaces?: boolean;
  scale?: number;
  edgeColor?: number[];
  cornerColor?: number[];
}
 
export interface vtkAnnotatedRhombicuboctahedronActor extends vtkActor {
  /**
   * Set the default style.
   * @param {IStyle} style
   */
  setDefaultStyle(style: IStyle): boolean;
 
  /**
   * The +X face property.
   * @param {IFaceProperty} prop +X face property
   */
  setXPlusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * The -X face property.
   * @param {IFaceProperty} prop The -X face property.
   */
  setXMinusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * The +Y face property.
   * @param {IFaceProperty} prop The +Y face property.
   */
  setYPlusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * The -Y face property.
   * @param {IFaceProperty} prop The -Y face property.
   */
  setYMinusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * The +Z face property.
   * @param {IFaceProperty} prop The +Z face property.
   */
  setZPlusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * The -Z face property.
   * @param {IFaceProperty} prop The -Z face property.
   */
  setZMinusFaceProperty(prop: IFaceProperty): boolean;
 
  /**
   * Set whether to show the 6 main square faces.
   * @param {Boolean} show
   */
  setShowMainFaces(show: boolean): void;
 
  /**
   * Get whether the 6 main square faces are shown.
   */
  getShowMainFaces(): boolean;
 
  /**
   * Set whether to show the 12 edge square faces.
   * @param {Boolean} show
   */
  setShowEdgeFaces(show: boolean): void;
 
  /**
   * Get whether the 12 edge square faces are shown.
   */
  getShowEdgeFaces(): boolean;
 
  /**
   * Set whether to show the 8 corner triangular faces.
   * @param {Boolean} show
   */
  setShowCornerFaces(show: boolean): void;
 
  /**
   * Get whether the 8 corner triangular faces are shown.
   */
  getShowCornerFaces(): boolean;
 
  /**
   * Set the scale of the rhombicuboctahedron.
   * @param {Number} scale
   */
  setRhombScale(scale: number): void;
 
  /**
   * Get the scale of the rhombicuboctahedron.
   */
  getScale(): number;
}
 
/**
 * Method use to decorate a given object (publicAPI+model) with vtkAnnotatedRhombicuboctahedronActor characteristics.
 *
 * @param publicAPI object on which methods will be bounds (public)
 * @param model object on which data structure will be bounds (protected)
 * @param {IAnnotatedRhombicuboctahedronActorInitialValues} [initialValues] (default: {})
 */
export function extend(
  publicAPI: object,
  model: object,
  initialValues?: IAnnotatedRhombicuboctahedronActorInitialValues
): void;
 
/**
 * Method use to create a new instance of vtkAnnotatedRhombicuboctahedronActor
 * @param {IAnnotatedRhombicuboctahedronActorInitialValues} [initialValues] for pre-setting some of its content
 */
export function newInstance(
  initialValues?: IAnnotatedRhombicuboctahedronActorInitialValues
): vtkAnnotatedRhombicuboctahedronActor;
 
/**
 * vtkAnnotatedRhombicuboctahedronActor is an actor that displays a rhombicuboctahedron
 * with annotated faces. Similar to vtkAnnotatedCubeActor but uses a rhombicuboctahedron
 * geometry which has 26 faces (6 main squares, 12 edge squares, 8 corner triangles).
 *
 * The 6 main square faces can be annotated with text and custom colors, similar to
 * vtkAnnotatedCubeActor. The edge and corner faces can be toggled on/off.
 */
export declare const vtkAnnotatedRhombicuboctahedronActor: {
  newInstance: typeof newInstance;
  extend: typeof extend;
};
 
export default vtkAnnotatedRhombicuboctahedronActor;