Skip to content

Commit

Permalink
doc: add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuki Shimada committed Nov 20, 2022
1 parent dcc0891 commit 4219dda
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/foundation/components/Animation/AnimationComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ const ChangeAnimationInfo = Symbol(
);
const PlayEnd = Symbol('AnimationComponentEventPlayEnd');

/**
* A component that manages animation.
*/
export class AnimationComponent extends Component {
/// inner states ///
private __backupDefaultValues: Map<
Expand Down
3 changes: 3 additions & 0 deletions src/foundation/components/BlendShape/BlendShapeComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import {
import {IEntity} from '../../core/Entity';
import {ComponentToComponentMethods} from '../ComponentTypes';

/**
* The Component that manages the blend shape.
*/
export class BlendShapeComponent extends Component {
private __weights: number[] = [];
private __targetNames: string[] = [];
Expand Down
3 changes: 3 additions & 0 deletions src/foundation/components/Camera/CameraComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ import {ComponentToComponentMethods} from '../ComponentTypes';
import { Is } from '../../misc/Is';
import { MiscUtil } from '../../misc';

/**
* The Component that represents a camera.
*/
export class CameraComponent extends Component {
private static readonly _eye: Vector3 = Vector3.zero();
private _eyeInner: MutableVector3 = MutableVector3.dummy();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ import {
import {IEntity} from '../../core/Entity';
import {ComponentToComponentMethods} from '../ComponentTypes';

/**
* The Component that controls camera posture.
*/
export class CameraControllerComponent extends Component {
private __cameraComponent?: CameraComponent;
private __cameraController: ICameraController;
Expand Down
3 changes: 3 additions & 0 deletions src/foundation/core/Entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ export interface IEntity extends IRnObject {
}

/**
* The class that represents an entity.
*
* @remarks
* The Rhodonite Entity Class which are an entities that exists in space.
* Entities can acquire various functions by having components on themselves.
*/
Expand Down
6 changes: 6 additions & 0 deletions src/foundation/core/RnObject.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
import {RnTags, ObjectUID} from '../../types/CommonTypes';
import {deepCopyUsingJsonStringify} from '../misc/MiscUtil';

/**
* A Tag class
*/
export type Tag = {
tag: string;
value: any;
};

/**
* The Interface of the RnObject.
*/
export interface IRnObject {
objectUID: ObjectUID;
uniqueName: string;
Expand Down

0 comments on commit 4219dda

Please sign in to comment.