anim-3d-obj 1.1.21 → 1.1.22

package/README.md

@@ -3,17 +3,17 @@
 This project allows a user to create Cuboids of any size simply by entering a set of parameters.  
 The program does the leg work with regard to calculating translationZ depth and config on the fly.
 
-- [GIT HOME](https://github.com/mdnelles/anim-3d-objs-launcher)
-- [NPM HOME](https://www.npmjs.com/package/anim-3d-obj) npm i anim-3d-obj
+-  [GIT HOME](https://github.com/mdnelles/anim-3d-objs-launcher)
+-  [NPM HOME](https://www.npmjs.com/package/anim-3d-obj) npm i anim-3d-obj
 
 ## Examples
 
-- [6 sided Cuboid - animate X360 Y360](https://codesandbox.io/s/anim-3d-obj-all-sides-simple-bf67yg)
-- [3 sided Object - animate y-axis](https://codesandbox.io/s/anim-3d-obj-3-sides-wobble-y-axis-wglkms)
-- [Double box spin](https://codesandbox.io/s/react-anim-3d-double-box-spin-vbdhg2)
-- [2 sided object with animation wobble](https://codesandbox.io/s/anim-3d-obj-wobblex-mmidkg)
-- [Parallel divs animated x and y axis in tandem](https://codesandbox.io/s/anim-3d-obj-2-sides-simple-4057y7)
-- [Spinning Slab](https://codesandbox.io/s/react-anim-3d-pulse-kc8g0f)
+-  [6 sided Cuboid - animate X360 Y360](https://codesandbox.io/s/anim-3d-obj-all-sides-simple-bf67yg)
+-  [3 sided Object - animate y-axis](https://codesandbox.io/s/anim-3d-obj-3-sides-wobble-y-axis-wglkms)
+-  [Double box spin](https://codesandbox.io/s/react-anim-3d-double-box-spin-vbdhg2)
+-  [2 sided object with animation wobble](https://codesandbox.io/s/anim-3d-obj-wobblex-mmidkg)
+-  [Parallel divs animated x and y axis in tandem](https://codesandbox.io/s/anim-3d-obj-2-sides-simple-4057y7)
+-  [Spinning Slab](https://codesandbox.io/s/react-anim-3d-pulse-kc8g0f)
 
 ## Config
 
@@ -21,44 +21,44 @@ Animations are optional. Either or both of `anim1Specs` or `anim2Specs` can be a
 
 ```typescript
 const anim1Specs: object = {
-  border: '', // while testing reveal the animation wrapper
-  degreesHi: -45, // degrees if spin
-  degreesLow: 45, // degrees if spin
-  delay: 0, // start delay in seconds
-  direction: 'normal', //normal alternating reverse
-  duration: 8, // seconds
-  fillMode: 'forward', // node forward backward both
-  iterationCount: 'infinite', // number or infinte
-  name: 'Y360', // ** ANIMATIONS
-  timing: 'ease-in-out', // linear ease ease-in-out
-}
+   border: "", // while testing reveal the animation wrapper
+   degreesHi: -45, // degrees if spin
+   degreesLow: 45, // degrees if spin
+   delay: 0, // start delay in seconds
+   direction: "normal", //normal alternating reverse
+   duration: 8, // seconds
+   fillMode: "forward", // node forward backward both
+   iterationCount: "infinite", // number or infinte
+   name: "Y360", // ** ANIMATIONS
+   timing: "ease-in-out", // linear ease ease-in-out
+};
 ```
 
 `** ANIMATIONS`
 
-- X360: rotate 360 degrees on the x-axis
-- Y360: rotate 360 degrees on the y-axis
-- fadeInkf: fade object in from 0 to 1 Opacity
-- wobY: wobble on y-axis (degreesHi <-> degreesLow)
-- wobX: wobble on x-axis (degreesHi <-> degreesLow)
-- fwdx018: spin object on x-axis from 0 degrees to 180 degrees
-- fwdx1836: spin object on x-axis from 180 degrees to 360 degrees
-- fwdx09: spin object on x-axis from 0 degrees to 90 degrees
-- fwdx918: spin object on x-axis from 90 degrees to 180 degrees
-- fwdx1827: spin object on x-axis from 180 degrees to 270 degrees
-- fwdx2736: spin object on x-axis from 270 degrees to 360 degrees
-- fwdy018: spin object on y-axis from 0 degrees to 180 degrees
-- fwdy1836: spin object on y-axis from 180 degrees to 360 degrees
-- fwdy09: spin object on y-axis from 0 degrees to 90 degrees
-- fwdy918: spin object on y-axis from 90 degrees to 180 degrees
-- fwdy1827: spin object on y-axis from 180 degrees to 270 degrees
-- fwdy2736: spin object on y-axis from 270 degrees to 360 degrees
-- floatX: float object so is not stationary
-- floatShadow: float object + add shadow
-- pulseSM: pulse object Small
-- pulseMD: pulse object Medium
-- pulseLG: pulse object Large
-- noAnim: no animation place holder
+-  X360: rotate 360 degrees on the x-axis
+-  Y360: rotate 360 degrees on the y-axis
+-  fadeInkf: fade object in from 0 to 1 Opacity
+-  wobY: wobble on y-axis (degreesHi <-> degreesLow)
+-  wobX: wobble on x-axis (degreesHi <-> degreesLow)
+-  fwdx018: spin object on x-axis from 0 degrees to 180 degrees
+-  fwdx1836: spin object on x-axis from 180 degrees to 360 degrees
+-  fwdx09: spin object on x-axis from 0 degrees to 90 degrees
+-  fwdx918: spin object on x-axis from 90 degrees to 180 degrees
+-  fwdx1827: spin object on x-axis from 180 degrees to 270 degrees
+-  fwdx2736: spin object on x-axis from 270 degrees to 360 degrees
+-  fwdy018: spin object on y-axis from 0 degrees to 180 degrees
+-  fwdy1836: spin object on y-axis from 180 degrees to 360 degrees
+-  fwdy09: spin object on y-axis from 0 degrees to 90 degrees
+-  fwdy918: spin object on y-axis from 90 degrees to 180 degrees
+-  fwdy1827: spin object on y-axis from 180 degrees to 270 degrees
+-  fwdy2736: spin object on y-axis from 270 degrees to 360 degrees
+-  floatX: float object so is not stationary
+-  floatShadow: float object + add shadow
+-  pulseSM: pulse object Small
+-  pulseMD: pulse object Medium
+-  pulseLG: pulse object Large
+-  noAnim: no animation place holder
 
 <>
 
@@ -68,8 +68,8 @@ GLOBAL CONFIG
 // EXAMPLE GLOBAL FACE CONFIG
 // This will be applied to all Faces that do not have their own custom config
 const global: object = {
-  // // face individual styles (over rides global)
-  css: `
+   // // face individual styles (over rides global)
+   css: `
          border: 1px solid #fff;
          background: rgb(2,0,36);
          background: linear-gradient(180deg, rgba(255,255,255,.1) 0%, rgba(141,191,249,.7) 100%);
@@ -80,8 +80,8 @@ const global: object = {
          font-family: Arial, Helvetica, sans-serif;
          border-radius:5px;
          `,
-  body: ' ',
-}
+   body: " ",
+};
 ```
 
 <>
@@ -127,17 +127,17 @@ and
 
 ```typescript
 <Cuboid
-  width={250}
-  height={300}
-  depth={250}
-  perspective={800}
-  perspectiveOrigin='50% 50%'
-  zIndex={10}
-  anim1Specs={anim1Specs}
-  anim2Specs={anim2Specs}
-  custom={custom}
-  faces={faceprops}
-  global={global}
+   width={250}
+   height={300}
+   depth={250}
+   perspective={800}
+   perspectiveOrigin='50% 50%'
+   zIndex={10}
+   anim1Specs={anim1Specs}
+   anim2Specs={anim2Specs}
+   custom={custom}
+   faces={faceprops}
+   global={global}
 />
 ```
 
@@ -147,7 +147,7 @@ will produce the following
 
 ## Authors
 
-- [@mdnelles](https://github.com/mdnelles)
+-  [@mdnelles](https://github.com/mdnelles)
 
 ## License
 

package/babel.config.json

@@ -0,0 +1,18 @@
+{
+   "presets": [
+      [
+         "@babel/env",
+         {
+            "targets": {
+               "edge": "17",
+               "firefox": "60",
+               "chrome": "67",
+               "safari": "11.1"
+            },
+            "useBuiltIns": "usage",
+            "corejs": "3.6.5"
+         }
+      ],
+      "@babel/preset-react"
+   ]
+}

package/dist/components/Card.tsx

@@ -0,0 +1,56 @@
+import React from "react";
+import { AnimWrap } from "./styles/AnimWrap";
+import { SceneStyle } from "./styles/Scene";
+import { ObjProps } from "./Face/face";
+import Face from "./Face";
+import { ObjWrapper } from "./styles/Global";
+
+export const Card = (props: ObjProps): any => {
+   let {
+      anim1Specs,
+      anim2Specs,
+      width = 5,
+      height = 5,
+      faces,
+      global = {},
+      custom = {},
+      tranz = (+height / 2) | 0,
+      perspective,
+      perspectiveOrigin,
+      zIndex,
+   } = props;
+
+   const buildFace = (faceType: any): any => {
+      return (
+         <Face
+            width={width}
+            height={height}
+            depth={0.1}
+            faceType={faceType}
+            id={faceType}
+            tranz={tranz}
+            global={global}
+            custom={custom}
+         />
+      );
+   };
+
+   return (
+      <SceneStyle
+         width={width}
+         height={height}
+         perspective={perspective}
+         perspectiveOrigin={perspectiveOrigin}
+         zIndex={zIndex}
+      >
+         <AnimWrap animSpecs={anim1Specs}>
+            <AnimWrap animSpecs={anim2Specs}>
+               <ObjWrapper>
+                  {!!faces && !!faces.front ? buildFace("front") : null}
+                  {!!faces && !!faces.back ? buildFace("back") : null}
+               </ObjWrapper>
+            </AnimWrap>
+         </AnimWrap>
+      </SceneStyle>
+   );
+};

package/dist/components/Cuboid.tsx

@@ -0,0 +1,61 @@
+import React from "react";
+import { AnimWrap } from "./styles/AnimWrap";
+import { SceneStyle } from "./styles/Scene";
+import { ObjProps } from "./Face/face";
+import Face from "./Face";
+import { ObjWrapper } from "./styles/Global";
+
+export const Cuboid = (props: ObjProps): any => {
+   let {
+      anim1Specs,
+      anim2Specs,
+      width = 5,
+      height = 5,
+      depth = 5,
+      faces,
+      global = {},
+      custom = {},
+      tranz = (+height / 2) | 0,
+      perspective,
+      perspectiveOrigin,
+      zIndex,
+   } = props;
+
+   const buildFace = (faceType: any): any => {
+      return (
+         <Face
+            width={width}
+            height={height}
+            depth={depth}
+            faceType={faceType}
+            id={faceType}
+            tranz={tranz}
+            global={global}
+            custom={custom}
+         />
+      );
+   };
+
+   return (
+      <SceneStyle
+         width={width}
+         height={height}
+         perspective={perspective}
+         perspectiveOrigin={perspectiveOrigin}
+         zIndex={zIndex}
+      >
+         <AnimWrap animSpecs={anim1Specs}>
+            <AnimWrap animSpecs={anim2Specs}>
+               <ObjWrapper>
+                  {!!faces && !!faces.front ? buildFace("front") : null}
+                  {!!faces && !!faces.right ? buildFace("right") : null}
+                  {!!faces && !!faces.back ? buildFace("back") : null}
+                  {!!faces && !!faces.left ? buildFace("left") : null}
+                  {!!faces && !!faces.top ? buildFace("top") : null}
+                  {!!faces && !!faces.bottom ? buildFace("bottom") : null}
+               </ObjWrapper>
+            </AnimWrap>
+         </AnimWrap>
+      </SceneStyle>
+   );
+};

package/dist/components/Face/face.d.ts

@@ -0,0 +1,39 @@
+export interface FaceProps {
+   children?: any;
+   depth?: number | any;
+   faceType?: any;
+   custom?: any;
+   global?: any;
+   height?: number | string;
+   id?: string | number | boolean;
+   styles?: object | any;
+   tranz: any;
+   width?: number | string;
+}
+
+export interface ObjProps {
+   anim1Specs?: object | undefined;
+   anim2Specs?: object | undefined;
+   children: any;
+   depth?: number;
+   global?: { border?: string; bgc?: string; opac?: number | string } | any;
+   faces?:
+      | {
+           front: boolean;
+           back: boolean;
+           left: boolean;
+           right: boolean;
+           top: boolean;
+           bottom: boolean;
+        }
+      | undefined;
+
+   height?: number | string;
+   custom?: object | string | undefined;
+   perspective?: string | number | undefined;
+   perspectiveOrigin?: string | undefined;
+   tranz?: number | undefined;
+   txt?: string | any;
+   width?: number;
+   zIndex?: number | undefined;
+}

package/dist/components/Face/index.tsx

@@ -0,0 +1,85 @@
+import styled from "styled-components";
+import React from "react";
+import { FaceProps } from "./face";
+
+const Face = (props: FaceProps): JSX.Element => {
+   let {
+      depth = 10,
+      faceType,
+      global = {},
+      height = 10,
+      custom = false,
+      tranz = 80,
+      width = 100,
+   } = props;
+
+   let transform;
+   let styles =
+      !!custom[faceType] && !!custom[faceType].css
+         ? custom[faceType].css
+         : global.css;
+   const body =
+      !!custom[faceType] && !!custom[faceType].body
+         ? custom[faceType].body
+         : global.body;
+   if (faceType === "bottom") {
+      tranz = +height - +depth / 2;
+      height = +depth;
+      transform = `transform: rotateX(-90deg) translateZ(${tranz}px);`;
+      //styles = !!custom["top"] ? custom : global;
+   } else if (faceType === "top") {
+      height = +depth;
+      if (!!depth) tranz = +depth / 2;
+      transform = `transform: rotateX(90deg) translateZ(${tranz}px);`;
+   } else if (faceType === "front") {
+      if (!!depth) tranz = +depth / 2;
+      transform = `transform: rotateY(0deg) translateZ(${tranz}px);`;
+   } else if (faceType === "back") {
+      if (!!depth) tranz = +depth / 2;
+      transform = `transform: rotateY(180deg) translateZ(${tranz}px);`;
+   } else if (faceType === "right") {
+      if (height > width && !depth) {
+         tranz = -(+height / 2 - +width);
+         width = +height;
+      } else if (width > height && !depth) {
+         tranz = +height / 2;
+         height = +width;
+      } else {
+         tranz = +width - +depth / 2;
+         width = +depth;
+      }
+      transform = `transform: rotateY(90deg) translateZ(${tranz}px);`;
+      // topr is to of Ribbon which points back
+   } else if (faceType === "topr") {
+      height = +depth;
+      if (!!depth) tranz = +depth / 2;
+      let offset = depth / 2;
+      transform = `transform: rotateX(90deg) translateZ(${tranz}px );  `;
+   } else {
+      if (height > width && !depth) {
+         tranz = -(+height / 2 - +width);
+         width = +height;
+      } else if (width > height && !depth) {
+         tranz = +height / 2;
+         height = +width;
+      } else {
+         tranz = +depth / 2;
+         width = +depth;
+      }
+      transform = `transform: rotateY(-90deg) translateZ(${tranz}px);`;
+   }
+
+   const BackFlip: any = styled.section``;
+
+   const Specs: any = styled.section`
+      ${styles}
+      width: ${width}px;
+      position: absolute;
+      height: ${height}px;
+      ${transform};
+   `;
+
+   return <Specs>{body}</Specs>;
+};
+
+export default Face;

package/dist/components/Ribbon.tsx

@@ -0,0 +1,58 @@
+import React from "react";
+import { AnimWrap } from "./styles/AnimWrap";
+import { SceneStyle } from "./styles/Scene";
+import { ObjProps } from "./Face/face";
+import Face from "./Face";
+import { ObjWrapper } from "./styles/Global";
+
+export const Ribbon = (props: ObjProps): any => {
+   let {
+      anim1Specs,
+      anim2Specs,
+      width = 5,
+      height = 5,
+      depth = 5,
+      faces,
+      global = {},
+      custom = {},
+      tranz = (+height / 2) | 0,
+      perspective,
+      perspectiveOrigin,
+      zIndex,
+   } = props;
+
+   const buildFace = (faceType: any): any => {
+      return (
+         <Face
+            width={width}
+            height={height}
+            depth={depth}
+            faceType={faceType}
+            id={faceType}
+            tranz={tranz}
+            global={global}
+            custom={custom}
+         />
+      );
+   };
+
+   return (
+      <SceneStyle
+         width={width}
+         height={height}
+         perspective={perspective}
+         perspectiveOrigin={perspectiveOrigin}
+         zIndex={zIndex}
+      >
+         <AnimWrap animSpecs={anim1Specs}>
+            <AnimWrap animSpecs={anim2Specs}>
+               <ObjWrapper>
+                  {!!faces && !!faces.bottom ? buildFace("bottom") : null}
+                  {!!faces && !!faces.back ? buildFace("back") : null}
+                  {!!faces && !!faces.top ? buildFace("topr") : null}
+               </ObjWrapper>
+            </AnimWrap>
+         </AnimWrap>
+      </SceneStyle>
+   );
+};

package/dist/components/styles/Anim.d.ts

@@ -0,0 +1,16 @@
+export interface AnimStylesProps {
+   children?: any;
+   animSpecs?: any;
+}
+export interface AnimSpecsProps {
+   border?: string | undefined;
+   degreesHi?: number | undefined;
+   degreesLow?: number | undefined;
+   delay: any;
+   direction?: string | undefined;
+   duration?: number | string | undefined;
+   fillMode?: string | undefined;
+   iterationCount?: number | string | undefined;
+   name?: string | undefined;
+   timing?: string | undefined;
+}

package/dist/components/styles/AnimWrap.tsx

@@ -0,0 +1,85 @@
+import styled from "styled-components";
+import React from "react";
+import { AnimStylesProps } from "./Anim";
+import { allAnims } from "./Anims";
+
+export const AnimWrap = (props: AnimStylesProps) => {
+   const { children, animSpecs } = props;
+   const AS: any = animSpecs;
+
+   const {
+      X360,
+      Y360,
+      fadeInkf,
+      wobY,
+      wobX,
+      fwdx018,
+      fwdx1836,
+      fwdx09,
+      fwdx918,
+      fwdx1827,
+      fwdx2736,
+      fwdy018,
+      fwdy1836,
+      fwdy09,
+      fwdy918,
+      fwdy1827,
+      fwdy2736,
+      floatX,
+      floatShadow,
+      pulseSM,
+      pulseMD,
+      pulseLG,
+      noAnim,
+   } = allAnims({ degreesHi: AS.degreesHi, degreesLow: AS.degreesLow });
+
+   let theAnim: any = "noAnim";
+   // need to iterate through all animation posibilities and not use eval() to satisfy TS
+   if (AS.name === "X360") theAnim = X360;
+   else if (AS.name === "Y360") theAnim = Y360;
+   else if (AS.name === "fadeInkf") theAnim = fadeInkf;
+   else if (AS.name === "wobX") theAnim = wobX;
+   else if (AS.name === "wobY") theAnim = wobY;
+   else if (AS.name === "fwdx018") theAnim = fwdx018;
+   else if (AS.name === "fwdx1836") theAnim = fwdx1836;
+   else if (AS.name === "fwdx09") theAnim = fwdx09;
+   else if (AS.name === "fwdx918") theAnim = fwdx918;
+   else if (AS.name === "fwdx1827") theAnim = fwdx1827;
+   else if (AS.name === "fwdx2736") theAnim = fwdx2736;
+   else if (AS.name === "fwdy018") theAnim = fwdy018;
+   else if (AS.name === "fwdy1836") theAnim = fwdy1836;
+   else if (AS.name === "fwdy09") theAnim = fwdy09;
+   else if (AS.name === "fwdy918") theAnim = fwdy918;
+   else if (AS.name === "fwdy1827") theAnim = fwdy1827;
+   else if (AS.name === "fwdy2736") theAnim = fwdy2736;
+   else if (AS.name === "floatX") theAnim = floatX;
+   else if (AS.name === "floatShadow") theAnim = floatShadow;
+   else if (AS.name === "pulseSM") theAnim = pulseSM;
+   else if (AS.name === "pulseMD") theAnim = pulseMD;
+   else if (AS.name === "pulseLG") theAnim = pulseLG;
+   else theAnim = noAnim;
+
+   const AnimWrapDiv: any = styled.div`
+      width: 100%;
+      height: 100%;
+      position: relative;
+      transform-style: preserve-3d;
+      border: ${AS.border};
+      -webkit-animation-duration: ${AS.duration}s;
+      animation-duration: ${AS.duration}s;
+      -webkit-animation-iteration-count: ${AS.iterationCount};
+      animation-iteration-count: ${AS.iterationCount};
+      -webkit-animation-name: ${theAnim};
+      animation-name: ${theAnim};
+      -webkit-animation-fill-mode: ${AS.fillMode};
+      animation-fill-mode: ${AS.fillMode};
+      animation-direction: ${AS.direction};
+      -webkit-animation-direction: ${AS.direction};
+      -webkit-animation-timing-function: ${AS.timing};
+      animation-timing-function: ${AS.timing};
+      -webkit-animation-delay: ${AS.delay}s;
+      animation-delay: ${AS.delay}s;
+   `;
+
+   return <AnimWrapDiv>{children}</AnimWrapDiv>;
+};